Skip to content

Releases: CoreOffice/XMLCoder

0.10.0

04 Apr 13:22
eae6266
Compare
Choose a tag to compare

This is a bugfix release, which improves encoding and decoding of enums with associated values (also known as "choice coding") with the XMLChoiceCodingKey protocol. This release is also tested on Xcode 11.4 and Swift 5.2.1 on Linux. A few breaking changes were introduced, which were needed to simplify and improve internals of the library. Please refer to the corresponding section below for more details.

Thanks to @bwetherfield and @ultramiraculous for their contributions!

Breaking changes:

This change was needed to accommodate for multiple edges cases with how arrays of empty elements and empty strings are decoded.

The value intrinsic now only accepts the empty string key "", as the previous "value" key caused naming collisions with attributes and elemenents that had the same name.

Closed issues:

  • Bundle identifier in wrong format (#164)
  • Can inheritance be implemented? (#159)
  • EXC_BAD_ACCESS when running tests (#153)
  • EXC_BAD_ACCESS on XCode 11.2 and iOS13.2 (#150)
  • Date formatting on 24h region with display set to 12h (#148)
  • Decoding containers with (potentially)-empty elements (#123)

Merged pull requests:

0.9.0

19 Oct 11:46
96d210e
Compare
Choose a tag to compare

This release fixes a few bugs with Float type parsing and Swift 5.1 support on Linux. It also adds a helper extension to improve compatibility with Combine and adds a few tests to confirm that a few edges cases are working well. Thanks to @bwetherfield, @DJBen, @jsbean, @mxcl, @marcblanchet and @sharplet for bug reports and pull requests!

Implemented enhancements:

  • Conditionally conform to Combine.TopLevelDecoder #132 (sharplet)

Fixed bugs:

  • Value with copyright symbol © has its preceding whitespace trimmed off even trimValueWhitespaces is set to false #141
  • Float vs Float64=Double not parsing 3.14 #130

Closed issues:

  • TrackPoint position parameter is ignored #125
  • TCX file need an XML root node #124
  • [Swift 5.1] Import FoundationXML rather than Foundation #121

Merged pull requests:

0.8.0

04 Aug 12:26
f68964b
Compare
Choose a tag to compare

This release adds support for decoding and encoding ordered sequences of different elements as enums with associated values. In addition, XMLCoder now supports Linux. Many thanks to @jsbean, @bwetherfield and @drewag for implementing this!

Breaking changes:

  • Fixed typo in XMLDecoder property: errorContextLenght has been renamed to errorContextLength in #114.

Closed issues:

  • XML with autoclosed tags #116
  • Arrays of enums #91
  • Array of enums with associated values #25

Merged pull requests:

0.7.0

02 Jul 12:07
06295cb
Compare
Choose a tag to compare

This release changes the behavior of attributes coding: now order of XML attributes is fully preserved. One of the benefits is that it improves unit testing for users of XMLCoder, which allows testing against specific encoded attributes without accounting for their randomized order. Also a small coding style fix is included. In addition, XMLCoder now uses Azure Pipelines instead of Travis for CI with great improvements to overall CI stability, speed, and parallel builds. Thanks to Andrés Cecilia Luque and Jay Hickey for the contributions!

Merged pull requests

0.6.0

17 Jun 16:38
ae732b9
Compare
Choose a tag to compare

An improvement release that introduces convertFromKebabCase and convertToKebabCase key decoding strategies. There were a few changes that aren't visible to end-users: the way that keys and values are stored internally has changed and a few more tests added. Thanks to Andrés Cecilia Luque and Vincent Esche for the contributions!

Merged pull requests

0.5.1

02 May 13:47
80fdf8c
Compare
Choose a tag to compare

Bugfix release that restores decoding of empty sequences, which became broken in 0.5.0.

Merged pull requests

0.5.0

02 May 10:54
9f11e62
Compare
Choose a tag to compare

A small improvement release tagged early to resolve blocking issues in CoreXLSX.

Notable changes

  • Empty value strings are no longer decoded as nil when a String is expected, but are decoded as empty strings, which represents the actual value.
  • trimValueWhitespaces property was added on XMLDecoder, which allows overriding the default behaviour, where starting and trailing whitespaces are trimmed from string values.

Closed issues

  • Trimmed whitespace on decoding String #94

Merged pull requests

  • Fixed a bug when decoding a key with one character only #96 (TheFlow95)
  • Add more cases to AttributedIntrinsicTest #95 (MaxDesiatov)
  • Use map instead of mapValues/shuffle in XMLCoderElement.flatten #93 (jsbean)
  • Fix decoding empty element as optional #92 (MaxDesiatov)

0.4.1

12 Apr 07:46
5cd2ebb
Compare
Choose a tag to compare

A bugfix release removing unused Xcode project scheme to improve build time for Carthage users.

Notable changes

0.4.0

08 Apr 09:46
34c178b
Compare
Choose a tag to compare

This is a release with plenty of new features that allow you to parse many more XML variations than previously. Compatibility with Xcode 10.2 and Swift 5.0 is also improved. A huge thank you to @JoeMatt and @regexident for their contributions, to @hodovani for maintaining the project, and to @Inukinator, @qmoya, @Ma-He, @khoogheem and @thecb4 for reporting issues during development!

Notable changes

  • Ordered encoding: this was one of the most requested changes and it's finally here! 🎉 Now both keyed and unkeyed elements are encoded in the exactly same order that was used in original containers. This is applicable to both compiler-generated encoding implementations (just reorder properties or cases in your CodingKeys enum if you have it) and manually implemented func encode(to: Encoder).
  • Stripping namespace prefix: now if your coding key string values contain an XML namespace prefix (e.g. prefix h in <h:td>Apples</h:td>), you can set shouldProcessNamespaces property to true on your XMLDecoder instance for the prefix to be stripped before decoding keys in your Decodable types.
  • Previously it was possible to customize encoding with NodeEncodingStrategy, but no such type existed for decoding. A corresponding NodeDecodingStrategy type was added with nodeDecodingStrategy property on XMLDecoder.
  • Thanks to the previous change, XMLCoder now provides two helper protocols that allow you to easily customize whether nodes are encoded and decoded as attributes or elements for conforming types: DynamicNodeEncoding and DynamicNodeDecoding.
  • Previously if you needed to decode or encode an XML element with both attributes and values, this was impossible to do with XMLCoder. Now with the addition of coding key value intrinsic, this is as easy as adding one coding key with a specific string raw value ("value" or empty string "" if you already have an XML attribute named "value").

Closed issues

  • Crash: Range invalid bounds in XMLStackParser.swift #83
  • Document DynamicNodeEncoding and attributed intrinsic #80
  • Fix nested attributed intrinsic #78
  • nodeEncodingStrategy #49
  • XmlEncoder: ordering of elements #17
  • Can’t reach an XML value #12

Merged pull requests

0.3.1

06 Feb 11:05
bd22c20
Compare
Choose a tag to compare

A bugfix release that adds missing CFBundleVersion in generated framework's Info.plist (#72 reported by @stonedauwg).

Changes