YamlDotNet

/!\ This release fixes a security issue. It is strongly recommended to upgrade,
mainly if you are parsing documents from sources that you do not trust.

Many thanks to Kurt Boberg, from the DocuSign Application Security Team, who identified this issue and provided feedback on mitigation strategies.

• Remove the legacy backwards-compatibe syntax that enabled to create
  Serializer and Deserializer directly then changing their configutation.
  In most cases, the calls to the constructors should be replaced by
  instantiations of SerializerBuilder and DeserializerBuilder.
  These can be configured at will, then used to create instances of
  (De)serializer.
  It is still possible to use the default constructors, if no configuration is needed.

• Drop support for specifying arbitrary type names in tags.
  Support for automatically resolving a fully qualified type name
  from a tag has been discontinued. That feature was poorly designed
  and not standard.
  During deserialization, each tag mapping must be explicitly registered.
  During serialization, when using the EnsureRoundtrip method, it is necessary to
  register tag mappings for each type that will require a tag, that is, any type that
  is used as the value of a property with a different declared type.

• Fix bug where deserialized values were not being converted to the destination type.

  var sut = new DeserializerBuilder()
      .WithTagMapping("!dbl", typeof(DoublyConverted))
      .Build();
  
  // The scalar "hello" will first be converted to DoublyConverted
  // then that value will be converted to int.
  var result = sut.Deserialize<int>("!dbl hello");
  
  Assert.Equal(5, result);
  

• Refactored the project and solution so that they load and build cleanly in VS2017.
• Reviewed the target platforms.
  • The currently supported platforms are now:
    • .NET Framework 4.5
    • .NET Framework 3.5
    • .NET Framework 2.0 (experimental)
    • .NET Standard 1.3
    • Unity Subset v3.5
  • The following platforms are no longer supported:
    • Profile259 (please upgrade to netstandard)

• Fix nested reference merging.
• Don't force coercion of dictionary keys to string.
• Fix public static method determining in PORTABLE mode.

Actualy cache in CachedTypeInspector.

• Fix parser behavior when skipComments == false
  In most cases, the parser failed to parse after encountering a comment.

New features

• Support for .NET Core (netstandard1.3).
  The project files have been converted to the new format, which means that older versions of Visual Studio may be unable to load them.

New features

• 32bits Unicode code points in escape sequences and url-encoded tags are now properly handled.

• Anchors can now be redefined in a document.
  This is to conform to the 1.1 spec as well as the 1.2 spec:

  3.2.2.2. Anchors and Aliases

  When composing a representation graph from serialized events, an alias node refers to the most recent node in the serialization having the specified anchor. Therefore, anchors need not be unique within a serialization.

• Added support for tag mappings on the serializer.
  Use SerializerBuilder.WithTagMapping() to register a new tag mapping on the serializer.

• Allow to unregister components from the SerializerBuilder and DeserializerBuilder.
  Use the Without... methods on SerializerBuilder and DeserializerBuilder for that.

• New DateTimeConverter

  • It accepts DateTimeKind.Utc and Standard Date and Time Format Strings of "G" as its default parameters, if they are omitted.
  • For deserialisation, it accepts as many number of formats as we want. If a value doesn't match against provided formats, it will return FormatException. Please refer to my whole test cases.
  • For serialisation, it only considers the first format in the format list.

• Improve the (de)serializer builders so that it is possible to wrap existing component registrations.

• Added the ApplyNamingConventions property to YamlMemberAttribute.
  When this property is true, naming conventions are not applied to the associated member. This solves issue 228.

Bug fixes

• Fixed issue 189: extra '\0' after indentation indicators.
• Fixed some issues related to parsing and emitting comments.
• Fixed deserialization of ulongs greater than long.MaxValue.
• Fixed issue 218: Objects with custom type converters are traversed.
• Avoid crashing with a StackOverflowException when iterating over the AllNodes property when it's infinitely recursive.

Other

• The samples have been added to the project as a new unit test project, to ensure that they stay up-to-date with the code.
  In the future, a documentation page will be generated from the samples, that will show the sample, its documentation and respective output.

This a major release that introduces a few breaking changes.

Breaking changes

• The constructors of Serializer and Deserializer are now obsolete
  Except for the parameterless versions. The SerializerBuilder and DeserializerBuilder
  classes should now be used to configure and create instances of the (de)serializer.
• Replaced the IYamlSerializable interface with IYamlConvertible
  The IYamlSerializable is now obsolete, but will be kept until the next major release.
• Removed EventReader
EventReader was a wrapper over IParser that offered some abstractions for parsing,
  but also had some design flaws. It has been replaced by extension methods for IParser.
  The extension methods provide the same functionality,
  and allow to always use the same type to represent the parser.
• Dropped support for YamlAliasAttribute
  This class has been obsolete for many releases, and it was time to let it go.

New features

• SerializerBuilder and DeserializerBuilder
  This is an important change that adds "builders" that can be used
  to configure the Serializer and Deserializer through a fluent syntax.
  The main objective of this is to allow more control over
  the composition of services performed by these two classes.
  This means that every aspect of the composition should be
  extensible / overridable. Things like injecting a custom TypeInspector
  or replacing the the default ArrayNodeDeserializer with
  an alternative implementation become possible and easy.
  In order to avoid breaking existing code,
  the constructors of Serializer and Deserializer have been kept
  but marked as obsolete. In a future release they will be discarded.
• Added the IYamlConvertible interface
  This new interface differs in that its methods receive a delegate that can be used
  to reuse the current serializer or deserializer.
• Improved the usability of YamlDocument
  and other RepresentationModel classes:
  • Added conversion operators and indexers for easier parsing and construction of YamlNodes.
  • YamlMappingNode, YamlSequenceNode and YamlScalarNode now implement IYamlConvertible,
    which means that these types can appear in the middle of an object that is being serialized or
    deserialized, and produce the expected result.
• Added support for alternative Boolean values
  • True: true, y, yes, on
  • False: false, n, no, off.

Bug fixes

• Serialization Error when string starts with quote
• YamlVisitor is marked as obsolete, but no YamlVisitorBase class exists
• Do not assign anchors to scalars during serialization.

Version 3.9.0

New features:

• Add YamlVisitorBase as an improved replacement for YamlVisitor
  • YamlVisitor is now obsolete, and will be removed in a future release.
• Ensure compatibility with AOT compilation, for platforms that do not allow dynamic code generation, such as IOS or PS4.
• Add Yaml attribute overrides feature, similar to XML Serializer attribute overrides behavior.
• Add a YamlNodeType enumeration property to nodes.

Bug fixes:

• Fix #166 - Guid conversion to JSON is unquoted.
• Ignore enum value case during deserialization.
• Improve newline handling
  • In some cases, consecutive newlines were incorrectly parsed or emitted.
• Fix #177 - double.MaxValue serialization.
• Register custom type converters with higher precedence than the built-in converters.

New features:

• Add support for different scalar integer bases.
  Addresses issue #113. Adds basic support for deserializing scalar integers
  written in binary, octal, decimal, hex, and base 60, as allowed in the YAML
  specification; see http://yaml.org/type/int.html. Adds unit tests for each
  of these bases as well.
• Add dnx compatibility to the NuGet packages.
• Do not throw exception if a tag does not contain a valid type name.

Fixes and improvements:

• Cache type metadata.
• Fix wrong type when deserializing UInt16.
• Fix handling of special float values, such as NaN, PositiveInfinity and NegativeInfinity.
• Properly quote empty strings.
• Properly handle non-Unicode encodings when emitting scalars.

This is a minor update that simply adds an overload of YamlStream.Load to be able to specify the EventReader.

Bug fixes:

• Bug in the GetPublicMethods implementation for portable.

New features:

• Ability to opt out of anchor assignment during YamlStream.Save().
• Allow the style of scalar properties to be specified through the YamlMember attribute.
• Add solution configuration to target "Unity 3.5 .net Subset Base Class Libraries".

Bug fixes:

• Do not compare nodes by value while assigning anchors. It is the responsibility of the user to use the same reference if they want an alias.
• Fixed #121: Finding properties in parent interfaces

• Add native support of System.Guid serialization.
• Add properties to YamlMemberAttribute:
  • Order: specifies the order of the members when they are serialized.
  • Alias: instructs the deserializer to use a different field name for serialization.
• The YamlAliasAttribute is now obsolete. New code should use YamlMemberAttribute instead.
• Throw proper exceptions, with correct marks, when deserialization of a node fails.

• Report the location of comments correctly, when the scanner is created with "skipComments = false"
• In case of syntax error, do not report an empty range and skip to the next token.
• Make the scanner and related types serializable, so that the state of the scanner can be captured and then restored later (assuming that the TextReader is also serializable).

This release adds a signed package and portable versions of the library.

Added suport for .NET binary serialization.

Fix DuplicateAnchorException when using merge keys do merge mappings that contain aliases.

Implement merging a sequence of aliases.

Fix AnchorNotFoundException when another exception occurs during deserialization.