Skip to content

Fix nested choice array #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 12 commits into from
Closed

Fix nested choice array #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4ce74e2
Decoding choice elements that can hold empty structs (#120)
bwetherfield Jul 31, 2019
86ac6ef
Fix typo in README.md
MaxDesiatov Jul 31, 2019
823bd44
Update README and CHANGELOG, bump version to 0.8.0
MaxDesiatov Aug 4, 2019
fd645f6
Fix formatting in CHANGELOG.md
MaxDesiatov Aug 4, 2019
f68964b
Highlight breaking changes, fix typo in CHANGELOG
MaxDesiatov Aug 4, 2019
01dd2a5
Fix typo in README.md
MaxDesiatov Aug 4, 2019
5bbac92
Clarify availability of features in README.md
MaxDesiatov Aug 4, 2019
b26fcfc
Add nested choice unkeyed container decoding test
bwetherfield Aug 10, 2019
e147033
Fix nested unkeyed container implementation for nested keyed box
bwetherfield Aug 22, 2019
686a2a3
Clean up unwrapping syntax
bwetherfield Aug 25, 2019
eb90eba
Add Xcode 11, Swift 5.1 support (#133)
MaxDesiatov Sep 25, 2019
1893b1c
Merge branch 'master' into fix-nested-choice-array
MaxDesiatov Sep 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 72 additions & 41 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,36 @@
# 0.7.0 (July 2, 2019)
# 0.8.0 (August 4, 2019)

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](https://github.com/jsbean),
[@bwetherfield](https://github.com/bwetherfield) and
[@drewag](https://github.com/drewag) for implementing this!

**Breaking changes:**

- Fixed typo in `XMLDecoder` property: `errorContextLenght` has been renamed to `errorContextLength` in [\#114](https://github.com/MaxDesiatov/XMLCoder/pull/114).

**Closed issues:**

- XML with autoclosed tags [\#116](https://github.com/MaxDesiatov/XMLCoder/issues/116)
- Arrays of enums [\#91](https://github.com/MaxDesiatov/XMLCoder/issues/91)
- Array of enums with associated values [\#25](https://github.com/MaxDesiatov/XMLCoder/issues/25)

**Merged pull requests:**

- Decoding choice elements that can hold empty structs
[\#120](https://github.com/MaxDesiatov/XMLCoder/pull/120)
([@bwetherfield](https://github.com/bwetherfield))
- `Encodable` and `Decodable` support for choice elements
[\#119](https://github.com/MaxDesiatov/XMLCoder/pull/119)
([@jsbean](https://github.com/jsbean))
- Add Linux support [\#117](https://github.com/MaxDesiatov/XMLCoder/pull/117)
([@drewag](https://github.com/drewag))
- Fix typo: `errorContextLenght` -\> `errorContextLength`
[\#114](https://github.com/MaxDesiatov/XMLCoder/pull/114)
([@jsbean](https://github.com/jsbean))

# 0.7.0 (July 2, 2019)

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
Expand All @@ -9,19 +41,19 @@ Travis for CI with great improvements to overall CI stability, speed, and
parallel builds. Thanks to [Andrés Cecilia Luque](https://github.com/acecilia)
and [Jay Hickey](https://github.com/jayhickey) for the contributions!

## Merged pull requests
**Merged pull requests:**

- Change components variable from var to let
[\#107](https://github.com/MaxDesiatov/XMLCoder/pull/107)
([jayhickey](https://github.com/jayhickey))
([@jayhickey](https://github.com/jayhickey))
- Keep the order of the attributes during encoding operations
[\#110](https://github.com/MaxDesiatov/XMLCoder/pull/110)
([acecilia](https://github.com/acecilia))
([@acecilia](https://github.com/acecilia))
- Migrate from Travis to Azure Pipelines
[\#111](https://github.com/MaxDesiatov/XMLCoder/pull/111)
([MaxDesiatov](https://github.com/MaxDesiatov))
([@MaxDesiatov](https://github.com/MaxDesiatov))

# 0.6.0 (June 17, 2019)
# 0.6.0 (June 17, 2019)

An improvement release that introduces `convertFromKebabCase` and
`convertToKebabCase` key decoding strategies. There were a few changes that
Expand All @@ -30,76 +62,75 @@ has changed and a few more tests added. Thanks to [Andrés Cecilia
Luque](https://github.com/acecilia) and [Vincent
Esche](https://github.com/regexident) for the contributions!

## Merged pull requests
**Merged pull requests:**

- Add support for kebab-case KeyDecodingStrategy
[\#105](https://github.com/MaxDesiatov/XMLCoder/pull/105)
([acecilia](https://github.com/acecilia))
([@acecilia](https://github.com/acecilia))
- Replace UnkeyedBox with Array, refine KeyedStorage
[\#102](https://github.com/MaxDesiatov/XMLCoder/pull/102)
([MaxDesiatov](https://github.com/MaxDesiatov))
([@MaxDesiatov](https://github.com/MaxDesiatov))
- Add tests for nested keyed/unkeyed collections
[\#38](https://github.com/MaxDesiatov/XMLCoder/pull/38)
([regexident](https://github.com/regexident))

([@regexident](https://github.com/regexident))

# 0.5.1 (May 2, 2019)
# 0.5.1 (May 2, 2019)

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

## Merged pull requests
**Merged pull requests:**

- Fix decoding of empty sequences
[\#98](https://github.com/MaxDesiatov/XMLCoder/pull/98)
([MaxDesiatov](https://github.com/MaxDesiatov))
([@MaxDesiatov](https://github.com/MaxDesiatov))
- Rename `flatten` to `transformToBoxTree`, rename tests
[\#97](https://github.com/MaxDesiatov/XMLCoder/pull/97)
([MaxDesiatov](https://github.com/MaxDesiatov))
([@MaxDesiatov](https://github.com/MaxDesiatov))

# 0.5.0 (May 2, 2019)
# 0.5.0 (May 2, 2019)

A small improvement release tagged early to resolve blocking issues in
[CoreXLSX](https://github.com/MaxDesiatov/CoreXLSX).

## Notable changes
**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
**Closed issues:**

- Trimmed whitespace on decoding `String`
[\#94](https://github.com/MaxDesiatov/XMLCoder/issues/94)

## Merged pull requests
**Merged pull requests:**

- Fixed a bug when decoding a key with one character only
[\#96](https://github.com/MaxDesiatov/XMLCoder/pull/96)
([TheFlow95](https://github.com/TheFlow95))
([@TheFlow95](https://github.com/TheFlow95))
- Add more cases to `AttributedIntrinsicTest`
[\#95](https://github.com/MaxDesiatov/XMLCoder/pull/95)
([MaxDesiatov](https://github.com/MaxDesiatov))
([@MaxDesiatov](https://github.com/MaxDesiatov))
- Use `map` instead of `mapValues`/`shuffle` in `XMLCoderElement.flatten`
[\#93](https://github.com/MaxDesiatov/XMLCoder/pull/93)
([jsbean](https://github.com/jsbean))
([@jsbean](https://github.com/jsbean))
- Fix decoding empty element as optional
[\#92](https://github.com/MaxDesiatov/XMLCoder/pull/92)
([MaxDesiatov](https://github.com/MaxDesiatov))
([@MaxDesiatov](https://github.com/MaxDesiatov))

# 0.4.1 (April 12, 2019)
# 0.4.1 (April 12, 2019)

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

## Notable changes
**Notable changes:**

* Remove unused scheme in Xcode project, [@MaxDesiatov](https://github.com/MaxDesiatov))
* Remove unused scheme in Xcode project ([@MaxDesiatov](https://github.com/MaxDesiatov))

# 0.4.0 (April 8, 2019)
# 0.4.0 (April 8, 2019)

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
Expand All @@ -111,7 +142,7 @@ also improved. A huge thank you to [@JoeMatt](https://github.com/JoeMatt) and
[@khoogheem](https://github.com/khoogheem) and
[@thecb4](https://github.com/thecb4) for reporting issues during development!

## Notable changes
**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
Expand Down Expand Up @@ -139,7 +170,7 @@ also improved. A huge thank you to [@JoeMatt](https://github.com/JoeMatt) and
(`"value"` or empty string `""` if you already have an XML attribute named
`"value"`).

## Closed issues
**Closed issues:**

- Crash: Range invalid bounds in XMLStackParser.swift [\#83](https://github.com/MaxDesiatov/XMLCoder/issues/83)
- Document DynamicNodeEncoding and attributed intrinsic [\#80](https://github.com/MaxDesiatov/XMLCoder/issues/80)
Expand All @@ -148,7 +179,7 @@ also improved. A huge thank you to [@JoeMatt](https://github.com/JoeMatt) and
- XmlEncoder: ordering of elements [\#17](https://github.com/MaxDesiatov/XMLCoder/issues/17)
- Can’t reach an XML value [\#12](https://github.com/MaxDesiatov/XMLCoder/issues/12)

## Merged pull requests
**Merged pull requests:**

- Make value intrinsic smarter
[\#89](https://github.com/MaxDesiatov/XMLCoder/pull/89)
Expand Down Expand Up @@ -181,25 +212,25 @@ also improved. A huge thank you to [@JoeMatt](https://github.com/JoeMatt) and
([@MaxDesiatov](https://github.com/MaxDesiatov))
- Attributed Intrinsic \(value coding key\)
[\#73](https://github.com/MaxDesiatov/XMLCoder/pull/73)
([JoeMatt](https://github.com/JoeMatt))
([@JoeMatt](https://github.com/JoeMatt))
- Dynamic node encoding + new formatters + various fixes
[\#70](https://github.com/MaxDesiatov/XMLCoder/pull/70)
([@JoeMatt](https://github.com/JoeMatt))
- Add `NodeDecodingStrategy`, mirroring `NodeEncodingStrategy `
[\#45](https://github.com/MaxDesiatov/XMLCoder/pull/45)
([@regexident](https://github.com/regexident))

# 0.3.1 (February 6, 2019)
# 0.3.1 (February 6, 2019)

A bugfix release that adds missing `CFBundleVersion` in generated framework's
`Info.plist` ([#72](https://github.com/MaxDesiatov/XMLCoder/issues/72) reported by
[@stonedauwg](https://github.com/stonedauwg)).

## Changes
**Changes:**

* Set `CURRENT_PROJECT_VERSION` in project file ([#74](https://github.com/MaxDesiatov/XMLCoder/pull/74), [@MaxDesiatov](https://github.com/MaxDesiatov))

# 0.3.0 (January 22, 2019)
# 0.3.0 (January 22, 2019)

A maintenance release focused on fixing bugs, improving error reporting and
overall internal architecture of the library. For this release we've started
Expand All @@ -208,23 +239,23 @@ Thanks to [@hodovani](https://github.com/hodovani) and
[@regexident](https://github.com/regexident) for their work on improving test
coverage in this release.

## Additions
**Additions:**

You can now set `errorContextLength: UInt` property on `XMLDecoder` instance,
which will make it add a snippet of XML of at most this length from parser state
when a parsing error occurs. This change was provided by
[@hodovani](https://github.com/hodovani) and can greatly help with attempts to
parse invalid XML, where previously only a line and column number were reported.

## Deprecations
**Deprecations:**

`NodeEncodingStrategies` was renamed to `NodeEncodingStrategy` for consistency.
`NodeEncodingStrategies` is still available as a deprecated typealias, which
will be removed in future versions. Thanks to
[@regexident](https://github.com/regexident) for cleaning this up and providing
many more changes in this release that make `XMLCoder` better and easier to use.

## Changes
**Changes:**

* Add SwiftLint and fix linter errors
([#35](https://github.com/MaxDesiatov/XMLCoder/pull/35),
Expand Down Expand Up @@ -365,19 +396,19 @@ many more changes in this release that make `XMLCoder` better and easier to use.
* Run tests with coverage, upload to codecov.io
([@MaxDesiatov](https://github.com/MaxDesiatov))

# 0.2.1 (November 18, 2018)
# 0.2.1 (November 18, 2018)

* watchOS deployment target set to 2.0 for Carthage ([@MaxDesiatov](https://github.com/MaxDesiatov))

# 0.2.0 (November 18, 2018)
# 0.2.0 (November 18, 2018)

* Add watchOS 2.0 deployment target ([@MaxDesiatov](https://github.com/MaxDesiatov))

# 0.1.1 (November 18, 2018)
# 0.1.1 (November 18, 2018)

* Set iOS deployment target to 9.0 ([@MaxDesiatov](https://github.com/MaxDesiatov))

# 0.1.0 (November 8, 2018)
# 0.1.0 (November 8, 2018)

* Add support for decoupled, type-dependent node-encoding strategies
([@regexident](https://github.com/regexident))
Expand Down
74 changes: 64 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ let returnData = try? XMLEncoder().encode(note, withRootKey: "note")

## Advanced features

These features are available in [0.4.0
release](https://github.com/MaxDesiatov/XMLCoder/releases/tag/0.4.0) or later:
The following features are available in [0.4.0
release](https://github.com/MaxDesiatov/XMLCoder/releases/tag/0.4.0) or later
(unless stated otherwise):

### Stripping namespace prefix

Expand Down Expand Up @@ -160,6 +161,9 @@ works for this XML:
</book>
```

Please refer to PR [\#70](https://github.com/MaxDesiatov/XMLCoder/pull/70) by
[@JoeMatt](https://github.com/JoeMatt) for more details.

### Coding key value intrinsic

Suppose that you need to decode an XML that looks similar to this:
Expand Down Expand Up @@ -199,6 +203,9 @@ struct Foo: Codable, DynamicNodeEncoding {
}
```

Thanks to [@JoeMatt](https://github.com/JoeMatt) for implementing this in
in PR [\#73](https://github.com/MaxDesiatov/XMLCoder/pull/73).

### Preserving whitespaces in element content

By default whitespaces are trimmed in element content during decoding. This
Expand All @@ -209,11 +216,58 @@ you can now set a property `trimValueWhitespaces` to `false` (the default value

### Choice element coding

Starting with [version 0.8](https://github.com/MaxDesiatov/XMLCoder/releases/tag/0.8.0), you
now encode and decode union-type–like enums with associated values by conforming your
`CodingKey` type additionally to `XMLChoiceCodingKey`.
Starting with [version 0.8](https://github.com/MaxDesiatov/XMLCoder/releases/tag/0.8.0),
you can encode and decode `enum`s with associated values by conforming your
`CodingKey` type additionally to `XMLChoiceCodingKey`. This allows decoding
XML elements similar in structure to this example:

```xml
<container>
<int>1</int>
<string>two</string>
<string>three</string>
<int>4</int>
<int>5</int>
</container>
```

To decode these elements you can use this type:

```swift
enum IntOrString: Equatable {
case int(Int)
case string(String)
}

extension IntOrString: Codable {
enum CodingKeys: String, XMLChoiceCodingKey {
case int
case string
}

func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
switch self {
case let .int(value):
try container.encode(value, forKey: .int)
case let .string(value):
try container.encode(value, forKey: .string)
}
}

init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
do {
self = .int(try container.decode(Int.self, forKey: .int))
} catch {
self = .string(try container.decode(String.self, forKey: .string))
}
}
}
```

For more information, see the [pull request](https://github.com/MaxDesiatov/XMLCoder/pull/119).
This is described in more details in PR [\#119](https://github.com/MaxDesiatov/XMLCoder/pull/119)
by [@jsbean](https://github.com/jsbean) and [@bwetherfield](https://github.com/bwetherfield).

## Installation

Expand All @@ -225,7 +279,7 @@ For more information, see the [pull request](https://github.com/MaxDesiatov/XMLC
- iOS 9.0 / watchOS 2.0 / tvOS 9.0 / macOS 10.10 or later deployment targets

**Linux**
- Ubuntu 14.04 or Later
- Ubuntu 14.04 or later
- Swift 5.0.1 or later

### Swift Package Manager
Expand All @@ -240,7 +294,7 @@ easy as adding it to the `dependencies` value of your `Package.swift`.

```swift
dependencies: [
.package(url: "https://github.com/MaxDesiatov/XMLCoder.git", from: "0.7.0")
.package(url: "https://github.com/MaxDesiatov/XMLCoder.git", from: "0.8.0")
]
```

Expand Down Expand Up @@ -269,7 +323,7 @@ target 'YourApp' do
use_frameworks!

# Pods for Test
pod 'XMLCoder', '~> 0.7.0'
pod 'XMLCoder', '~> 0.8.0'
end
```

Expand Down Expand Up @@ -297,7 +351,7 @@ $ brew install carthage
Inside of your `Cartfile`, add GitHub path to `XMLCoder`:

```ogdl
github "MaxDesiatov/XMLCoder" ~> 0.7.0
github "MaxDesiatov/XMLCoder" ~> 0.8.0
```

Then, run the following command to build the framework:
Expand Down
Loading