Bump version to 0.11.0 (#176)

* Bump version to 0.11.0

* Link to relevant issues and PRs in CHANGELOG.md

Author: MaxDesiatov

CHANGELOG.md

@@ -1,3 +1,45 @@
+# 0.11.0 (13 April 2020)
+
+This is a bugfix and feature release, which fixes [an issue with CDATA
+decoding](https://github.com/MaxDesiatov/XMLCoder/issues/168)
+and adds [`TopLevelEncoder` conformance to
+`XMLEncoder`](https://github.com/MaxDesiatov/XMLCoder/pull/175). New
+[`rootAttributes` argument](https://github.com/MaxDesiatov/XMLCoder/pull/160)
+has been added to the `encode` function on `XMLEncoder` that allows
+adding attributes on root elements without adding them to your model types.
+Thanks to [@portellaa](https://github.com/portellaa),
+[@Kirow](https://github.com/Kirow) and others for their contributions and
+bug reports!
+
+**Closed issues:**
+
+- CDATA Decoding not working
+([#168](https://github.com/MaxDesiatov/XMLCoder/issues/168))
+- Decode special XML Structure
+([#156](https://github.com/MaxDesiatov/XMLCoder/issues/156))
+- Root level attributes don't get encoded back to attribute when converting back to XML file from Plist
+([#127](https://github.com/MaxDesiatov/XMLCoder/issues/127))
+- Bad access error when running on device
+([#100](https://github.com/MaxDesiatov/XMLCoder/issues/100))
+
+**Merged pull requests:**
+
+- Add TopLevelEncoder implementation
+([#175](https://github.com/MaxDesiatov/XMLCoder/pull/175))
+[@MaxDesiatov](https://github.com/MaxDesiatov)
+- Add support for root attributes propagation
+([#160](https://github.com/MaxDesiatov/XMLCoder/pull/160))
+[@portellaa](https://github.com/portellaa)
+- Fix RJITest RSS encoding and decoding
+([#171](https://github.com/MaxDesiatov/XMLCoder/pull/171))
+[@MaxDesiatov](https://github.com/MaxDesiatov)
+- Cleanup tests, support OpenCombine
+([#169](https://github.com/MaxDesiatov/XMLCoder/pull/169))
+[@MaxDesiatov](https://github.com/MaxDesiatov)
+- Fix CDATA issue
+([#170](https://github.com/MaxDesiatov/XMLCoder/pull/170))
+[@MaxDesiatov](https://github.com/MaxDesiatov)
+
 # 0.10.0 (4 April 2020)
 
 This is a bugfix release, which improves encoding and decoding of enums with associated values

README.md

@@ -290,6 +290,61 @@ func fetchBook(from url: URL) -> AnyPublisher<Book, Error> {
 This was implemented in PR [\#132](https://github.com/MaxDesiatov/XMLCoder/pull/132)
 by [@sharplet](https://github.com/sharplet).
 
+Additionally, starting with [XMLCoder
+0.11](https://github.com/MaxDesiatov/XMLCoder/releases/tag/0.11.0) `XMLEncoder`
+conforms to the `TopLevelEncoder` protocol:
+
+```swift
+import Combine
+import XMLCoder
+
+func encode(book: Book) -> AnyPublisher<Data, Error> {
+    return Just(book)
+        .encode(encoder: XMLEncoder())
+        .eraseToAnyPublisher()
+}
+```
+
+The resulting XML in the example above will start with `<book`, to customize
+capitalization of the root element (e.g. `<Book`) you'll need to set an
+appropriate `keyEncoding` strategy on the encoder. To change the element name
+altogether you'll have to change the name of the type, which is an unfortunate
+limitation of the `TopLevelEncoder` API.
+
+### Root element attributes
+
+Sometimes you need to set attributes on the root element, which aren't
+directly related to your model type. Starting with [XMLCoder
+0.11](https://github.com/MaxDesiatov/XMLCoder/releases/tag/0.11.0) the `encode`
+function on `XMLEncoder` accepts a new `rootAttributes` argument to help with
+this:
+
+```swift
+struct Policy: Encodable {
+    var name: String
+}
+
+let encoder = XMLEncoder()
+let data = try encoder.encode(Policy(name: "test"), rootAttributes: [
+    "xmlns": "http://www.nrf-arts.org/IXRetail/namespace",
+    "xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
+    "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
+])
+```
+
+The resulting XML will look like this:
+
+```xml
+<policy xmlns="http://www.nrf-arts.org/IXRetail/namespace"
+        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <name>test</name>
+</policy>
+```
+
+This was implemented in PR [\#160](https://github.com/MaxDesiatov/XMLCoder/pull/160)
+by [@portellaa](https://github.com/portellaa).
+
 ## Installation
 
 ### Requirements
@@ -316,7 +371,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.10.0")
+    .package(url: "https://github.com/MaxDesiatov/XMLCoder.git", from: "0.11.0")
 ]
 ```
 
@@ -347,7 +402,7 @@ target 'YourApp' do
   use_frameworks!
 
   # Pods for YourApp
-  pod 'XMLCoder', '~> 0.10.0'
+  pod 'XMLCoder', '~> 0.11.0'
 end
 ```
 
@@ -376,7 +431,7 @@ $ brew install carthage
 Inside of your `Cartfile`, add GitHub path to `XMLCoder`:
 
 ```ogdl
-github "MaxDesiatov/XMLCoder" ~> 0.10.0
+github "MaxDesiatov/XMLCoder" ~> 0.11.0
 ```
 
 Then, run the following command to build the framework:
@@ -403,10 +458,10 @@ appreciated and helps in maintaining the project.
 
 ### Coding Style
 
-This project uses [SwiftFormat](https://github.com/nicklockwood/SwiftFormat) 
+This project uses [SwiftFormat](https://github.com/nicklockwood/SwiftFormat)
 and [SwiftLint](https://github.com/realm/SwiftLint) to
-enforce formatting and coding style. We encourage you to run SwiftFormat within 
-a local clone of the repository in whatever way works best for you either 
+enforce formatting and coding style. We encourage you to run SwiftFormat within
+a local clone of the repository in whatever way works best for you either
 manually or automatically via an [Xcode
 extension](https://github.com/nicklockwood/SwiftFormat#xcode-source-editor-extension),
 [build phase](https://github.com/nicklockwood/SwiftFormat#xcode-build-phase) or
@@ -424,8 +479,8 @@ pre-commit install # installs pre-commit hook to run checks before you commit
 Refer to [the pre-commit documentation page](https://pre-commit.com/) for more details
 and installation instructions for other platforms.
 
-SwiftFormat and SwiftLint also run on CI for every PR and thus a CI build can 
-fail with incosistent formatting or style. We require CI builds to pass for all 
+SwiftFormat and SwiftLint also run on CI for every PR and thus a CI build can
+fail with incosistent formatting or style. We require CI builds to pass for all
 PRs before merging.
 
 ### Test Coverage

Sources/XMLCoder/Encoder/XMLEncoder.swift

@@ -317,7 +317,8 @@ open class XMLEncoder {
     /// Encodes the given top-level value and returns its XML representation.
     ///
     /// - parameter value: The value to encode.
-    /// - parameter withRootKey: the key used to wrap the encoded values.
+    /// - parameter withRootKey: the key used to wrap the encoded values. The
+    ///   default value is inferred from the name of the root type.
     /// - parameter rootAttributes: the list of attributes to be added to the root node
     /// - returns: A new `Data` value containing the encoded XML data.
     /// - throws: `EncodingError.invalidValue` if a non-conforming

XMLCoder.podspec

@@ -1,12 +1,12 @@
 Pod::Spec.new do |s|
   s.name          = "XMLCoder"
-  s.version       = "0.10.0"
+  s.version       = "0.11.0"
   s.summary       = "XMLEncoder & XMLDecoder using the Codable protocol in Swift"
   s.description   = "XMLCoder allows Swift Codable-conforming objects to be translated to and from XML"
   s.homepage      = "https://github.com/MaxDesiatov/XMLCoder"
   s.license       = { :type => "MIT", :file => "LICENSE" }
-  s.authors        = { 
-    "Shawn Moore" => "[email protected]", 
+  s.authors        = {
+    "Shawn Moore" => "[email protected]",
     "Max Desiatov" => "[email protected]"
   }
   s.watchos.deployment_target = "2.0"

XMLCoder.xcodeproj/project.pbxproj

@@ -962,7 +962,7 @@
 				CLANG_ENABLE_OBJC_ARC = YES;
 				COMBINE_HIDPI_IMAGES = YES;
 				COPY_PHASE_STRIP = NO;
-				CURRENT_PROJECT_VERSION = 0.10.0;
+				CURRENT_PROJECT_VERSION = 0.11.0;
 				DEBUG_INFORMATION_FORMAT = dwarf;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				ENABLE_NS_ASSERTIONS = YES;
@@ -990,7 +990,7 @@
 				CLANG_ENABLE_OBJC_ARC = YES;
 				COMBINE_HIDPI_IMAGES = YES;
 				COPY_PHASE_STRIP = YES;
-				CURRENT_PROJECT_VERSION = 0.10.0;
+				CURRENT_PROJECT_VERSION = 0.11.0;
 				DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				GCC_OPTIMIZATION_LEVEL = s;