Merge pull request #2 from mattpolzin/bugfix/omitting-null-values

Bugfix/omitting null values

Author: mattpolzin

Sources/OpenAPIKit/Content.swift

@@ -118,20 +118,39 @@ extension OpenAPI.Content {
 }
 
 extension OpenAPI.Content {
-    public struct Encoding: Codable, Equatable {
+    public struct Encoding: Equatable {
+        public typealias Style = OpenAPI.PathItem.Parameter.Schema.Style
+
         public let contentType: OpenAPI.ContentType?
         public let headers: OpenAPI.Header.Map?
-//        public let style: String?
-//        public let explode: Bool (defaults for this need to be tied to style making style a good candidate for abstraction)
+        public let style: Style
+        public let explode: Bool
         public let allowReserved: Bool
 
         public init(contentType: OpenAPI.ContentType? = nil,
                     headers: OpenAPI.Header.Map? = nil,
+                    style: Style = Self.defaultStyle,
+                    allowReserved: Bool = false) {
+            self.contentType = contentType
+            self.headers = headers
+            self.style = style
+            self.explode = style.defaultExplode
+            self.allowReserved = allowReserved
+        }
+
+        public init(contentType: OpenAPI.ContentType? = nil,
+                    headers: OpenAPI.Header.Map? = nil,
+                    style: Style = Self.defaultStyle,
+                    explode: Bool,
                     allowReserved: Bool = false) {
             self.contentType = contentType
             self.headers = headers
+            self.style = style
+            self.explode = explode
             self.allowReserved = allowReserved
         }
+
+        public static let defaultStyle: Style = .default(for: .query)
     }
 }
 
@@ -160,16 +179,9 @@ extension OpenAPI.Content: Encodable {
             try container.encode(example, forKey: .example)
         }
 
-        if encoding != nil {
-            try container.encode(encoding, forKey: .encoding)
-        }
+        try encoding.encodeIfNotNil(to: &container, forKey: .encoding)
 
-        if vendorExtensions != [:] {
-            for (key, value) in vendorExtensions {
-                let xKey = key.starts(with: "x-") ? key : "x-\(key)"
-                try container.encode(value, forKey: .extended(xKey))
-            }
-        }
+        try encodeExtensions(to: &container)
     }
 }
 
@@ -256,3 +268,54 @@ extension OpenAPI.Content {
         }
     }
 }
+
+// MARK: Content.Encoding
+
+extension OpenAPI.Content.Encoding: Encodable {
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+
+        try contentType.encodeIfNotNil(to: &container, forKey: .contentType)
+
+        try headers.encodeIfNotNil(to: &container, forKey: .headers)
+
+        if style != Self.defaultStyle {
+            try container.encode(style, forKey: .style)
+        }
+
+        if explode != style.defaultExplode {
+            try container.encode(explode, forKey: .explode)
+        }
+
+        if allowReserved != false {
+            try container.encode(allowReserved, forKey: .allowReserved)
+        }
+    }
+}
+
+extension OpenAPI.Content.Encoding: Decodable {
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        contentType = try container.decodeIfPresent(OpenAPI.ContentType.self, forKey: .contentType)
+
+        headers = try container.decodeIfPresent(OpenAPI.Header.Map.self, forKey: .headers)
+
+        let style: Style = try container.decodeIfPresent(Style.self, forKey: .style) ?? Self.defaultStyle
+        self.style = style
+
+        explode = try container.decodeIfPresent(Bool.self, forKey: .explode) ?? style.defaultExplode
+
+        allowReserved = try container.decodeIfPresent(Bool.self, forKey: .allowReserved) ?? false
+    }
+}
+
+extension OpenAPI.Content.Encoding {
+    private enum CodingKeys: String, CodingKey {
+        case contentType
+        case headers
+        case style
+        case explode
+        case allowReserved
+    }
+}

Sources/OpenAPIKit/Discriminator.swift

@@ -1,5 +1,5 @@
 //
-//  File.swift
+//  Discriminator.swift
 //  
 //
 //  Created by Mathew Polzin on 10/6/19.
@@ -8,7 +8,7 @@
 import Foundation
 
 extension OpenAPI {
-    public struct Discriminator: Equatable, Codable {
+    public struct Discriminator: Equatable {
         public let propertyName: String
         public let mapping: [String: String]?
 
@@ -19,3 +19,32 @@ extension OpenAPI {
         }
     }
 }
+
+// MARK: - Codable
+
+extension OpenAPI.Discriminator: Encodable {
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+
+        try container.encode(propertyName, forKey: .propertyName)
+
+        try mapping.encodeIfNotNil(to: &container, forKey: .mapping)
+    }
+}
+
+extension OpenAPI.Discriminator: Decodable {
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        propertyName = try container.decode(String.self, forKey: .propertyName)
+
+        mapping = try container.decodeIfPresent([String: String].self, forKey: .mapping)
+    }
+}
+
+extension OpenAPI.Discriminator {
+    private enum CodingKeys: String, CodingKey {
+        case propertyName
+        case mapping
+    }
+}

Sources/OpenAPIKit/Document.swift

@@ -159,9 +159,7 @@ extension OpenAPI.Document: Encodable {
             try container.encode(encodableTags, forKey: .tags)
         }
 
-        if externalDocs != nil {
-            try container.encode(externalDocs, forKey: .externalDocs)
-        }
+        try externalDocs.encodeIfNotNil(to: &container, forKey: .externalDocs)
     }
 }
 

Sources/OpenAPIKit/Example.swift

@@ -45,13 +45,9 @@ extension OpenAPI.Example: Encodable {
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
 
-        if summary != nil {
-            try container.encode(summary, forKey: .summary)
-        }
+        try summary.encodeIfNotNil(to: &container, forKey: .summary)
 
-        if description != nil {
-            try container.encode(description, forKey: .description)
-        }
+        try description.encodeIfNotNil(to: &container, forKey: .description)
 
         switch value {
         case .a(let url):
@@ -60,9 +56,7 @@ extension OpenAPI.Example: Encodable {
             try container.encode(example, forKey: .value)
         }
 
-        for (key, value) in vendorExtensions {
-            try container.encode(value, forKey: .extended(key))
-        }
+        try encodeExtensions(to: &container)
     }
 }
 

Sources/OpenAPIKit/ExternalDoc.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 extension OpenAPI {
-    public struct ExternalDoc: Codable, Equatable {
+    public struct ExternalDoc: Equatable {
         public let description: String?
         public let url: URL
 
@@ -19,3 +19,32 @@ extension OpenAPI {
         }
     }
 }
+
+// MARK: - Codable
+
+extension OpenAPI.ExternalDoc: Encodable {
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+
+        try description.encodeIfNotNil(to: &container, forKey: .description)
+
+        try container.encode(url, forKey: .url)
+    }
+}
+
+extension OpenAPI.ExternalDoc: Decodable {
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        description = try container.decodeIfPresent(String.self, forKey: .description)
+
+        url = try container.decode(URL.self, forKey: .url)
+    }
+}
+
+extension OpenAPI.ExternalDoc {
+    private enum CodingKeys: String, CodingKey {
+        case description
+        case url
+    }
+}

Sources/OpenAPIKit/Header.swift

@@ -66,9 +66,7 @@ extension OpenAPI.Header: Encodable {
             try container.encode(stringKeyedDict, forKey: .content)
         }
 
-        if description != nil {
-            try container.encode(description, forKey: .description)
-        }
+        try description.encodeIfNotNil(to: &container, forKey: .description)
 
         if deprecated {
             try container.encode(deprecated, forKey: .deprecated)

Sources/OpenAPIKit/JSON Utility/JSONReference.swift

@@ -1,5 +1,5 @@
 //
-//  Reference.swift
+//  JSONReference.swift
 //  
 //
 //  Created by Mathew Polzin on 6/22/19.

Sources/OpenAPIKit/Path Item/Operation.swift

@@ -70,31 +70,19 @@ extension OpenAPI.PathItem.Operation: Encodable {
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
 
-        if tags != nil {
-            try container.encode(tags, forKey: .tags)
-        }
+        try tags.encodeIfNotNil(to: &container, forKey: .tags)
 
-        if summary != nil {
-            try container.encode(summary, forKey: .summary)
-        }
+        try summary.encodeIfNotNil(to: &container, forKey: .summary)
 
-        if description != nil {
-            try container.encode(description, forKey: .description)
-        }
+        try description.encodeIfNotNil(to: &container, forKey: .description)
 
-        if externalDocs != nil {
-            try container.encode(externalDocs, forKey: .externalDocs)
-        }
+        try externalDocs.encodeIfNotNil(to: &container, forKey: .externalDocs)
 
-        if operationId != nil {
-            try container.encode(operationId, forKey: .operationId)
-        }
+        try operationId.encodeIfNotNil(to: &container, forKey: .operationId)
 
         try container.encode(parameters, forKey: .parameters)
 
-        if requestBody != nil {
-            try container.encode(requestBody, forKey: .requestBody)
-        }
+        try requestBody.encodeIfNotNil(to: &container, forKey: .requestBody)
 
         // Hack to work around Dictionary encoding
         // itself as an array in this case:
@@ -106,9 +94,7 @@ extension OpenAPI.PathItem.Operation: Encodable {
 
         try container.encode(deprecated, forKey: .deprecated)
 
-        if servers != nil {
-            try container.encode(servers, forKey: .servers)
-        }
+        try servers.encodeIfNotNil(to: &container, forKey: .servers)
     }
 }
 

Sources/OpenAPIKit/Path Item/Parameter.swift

@@ -374,9 +374,7 @@ extension OpenAPI.PathItem.Parameter: Encodable {
             try container.encode(stringKeyedDict, forKey: .content)
         }
 
-        if description != nil {
-            try container.encode(description, forKey: .description)
-        }
+        try description.encodeIfNotNil(to: &container, forKey: .description)
 
         if deprecated {
             try container.encode(deprecated, forKey: .deprecated)

Sources/OpenAPIKit/Path Item/PathItem.swift

@@ -170,51 +170,22 @@ extension OpenAPI.PathItem: Encodable {
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
 
-        if summary != nil {
-            try container.encode(summary, forKey: .summary)
-        }
+        try summary.encodeIfNotNil(to: &container, forKey: .summary)
 
-        if description != nil {
-            try container.encode(description, forKey: .description)
-        }
+        try description.encodeIfNotNil(to: &container, forKey: .description)
 
-        if servers != nil {
-            try container.encode(servers, forKey: .servers)
-        }
+        try servers.encodeIfNotNil(to: &container, forKey: .servers)
 
         try container.encode(parameters, forKey: .parameters)
 
-        if get != nil {
-            try container.encode(get, forKey: .get)
-        }
-
-        if put != nil {
-            try container.encode(put, forKey: .put)
-        }
-
-        if post != nil {
-            try container.encode(post, forKey: .post)
-        }
-
-        if delete != nil {
-            try container.encode(delete, forKey: .delete)
-        }
-
-        if options != nil {
-            try container.encode(options, forKey: .options)
-        }
-
-        if head != nil {
-            try container.encode(head, forKey: .head)
-        }
-
-        if patch != nil {
-            try container.encode(patch, forKey: .patch)
-        }
-
-        if trace != nil {
-            try container.encode(trace, forKey: .trace)
-        }
+        try get.encodeIfNotNil(to: &container, forKey: .get)
+        try put.encodeIfNotNil(to: &container, forKey: .put)
+        try post.encodeIfNotNil(to: &container, forKey: .post)
+        try delete.encodeIfNotNil(to: &container, forKey: .delete)
+        try options.encodeIfNotNil(to: &container, forKey: .options)
+        try head.encodeIfNotNil(to: &container, forKey: .head)
+        try patch.encodeIfNotNil(to: &container, forKey: .patch)
+        try trace.encodeIfNotNil(to: &container, forKey: .trace)
     }
 }