encounter/JSONAPI
0
0
Fork 0
mirror of https://github.com/encounter/JSONAPI.git synced 2026-03-30 11:18:38 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add Sampleable conformances. Make blanket JSONEncoder change I am not happy with; will try to walk back requirement that encoder gets passed to all functions creating OpenAPI Nodes

Browse Source
This commit is contained in:
Mathew Polzin
2019-01-23 22:21:27 -08:00
parent 57df6b147e
commit 951c04ad44
6 changed files with 211 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/JSONAPIOpenAPI/OpenAPI/OpenAPITypes.swift
+16 -14
View File
@@ -13,12 +13,12 @@ import Foundation
/// Anything conforming to `OpenAPINodeType` can provide an
/// OpenAPI schema representing itself.
public protocol OpenAPINodeType {
static func openAPINode() throws -> JSONNode
static func openAPINode(using encoder: JSONEncoder) throws -> JSONNode
}
extension OpenAPINodeType where Self: Sampleable, Self: Encodable {
public static func openAPINodeWithExample() throws -> JSONNode {
return try openAPINode().with(example: Self.successSample ?? Self.sample)
public static func openAPINodeWithExample(using encoder: JSONEncoder = JSONEncoder()) throws -> JSONNode {
return try openAPINode(using: encoder).with(example: Self.successSample ?? Self.sample, using: encoder)
}
}
@@ -29,7 +29,7 @@ extension OpenAPINodeType where Self: Sampleable, Self: Encodable {
/// different schema. The "different" conditions have to do
/// with Raw Representability, hence the name of this protocol.
public protocol RawOpenAPINodeType {
static func rawOpenAPINode() throws -> JSONNode
static func rawOpenAPINode(using encoder: JSONEncoder) throws -> JSONNode
}
/// Anything conforming to `RawOpenAPINodeType` can provide an
@@ -39,7 +39,7 @@ public protocol RawOpenAPINodeType {
/// different schema. The "different" conditions have to do
/// with Optionality, hence the name of this protocol.
public protocol WrappedRawOpenAPIType {
static func wrappedOpenAPINode() throws -> JSONNode
static func wrappedOpenAPINode(using encoder: JSONEncoder) throws -> JSONNode
}
/// Anything conforming to `RawOpenAPINodeType` can provide an
@@ -52,18 +52,18 @@ public protocol DoubleWrappedRawOpenAPIType {
// NOTE: This is definitely a rabbit hole... hopefully I
// will realize I've been missing something obvious
// and dig my way back out at some point...
static func wrappedOpenAPINode() throws -> JSONNode
static func wrappedOpenAPINode(using encoder: JSONEncoder) throws -> JSONNode
}
/// Anything conforming to `AnyJSONCaseIterable` can provide a
/// list of its possible values.
public protocol AnyJSONCaseIterable {
static var allCases: [AnyCodable] { get }
static func allCases(using encoder: JSONEncoder) -> [AnyCodable]
}
extension AnyJSONCaseIterable {
/// Given an array of Codable values, retrieve an array of AnyCodables.
static func allCases<T: Codable>(from input: [T]) throws -> [AnyCodable] {
static func allCases<T: Codable>(from input: [T], using encoder: JSONEncoder) throws -> [AnyCodable] {
if let alreadyGoodToGo = input as? [AnyCodable] {
return alreadyGoodToGo
}
@@ -76,7 +76,7 @@ extension AnyJSONCaseIterable {
// by AnyCodable, but AnyCodable wants it to actually BE a String
// upon initialization.
guard let arrayOfCodables = try JSONSerialization.jsonObject(with: JSONEncoder().encode(input), options: []) as? [Any] else {
guard let arrayOfCodables = try JSONSerialization.jsonObject(with: encoder.encode(input), options: []) as? [Any] else {
throw OpenAPICodableError.allCasesArrayNotCodable
}
return arrayOfCodables.map(AnyCodable.init)
@@ -91,7 +91,7 @@ extension AnyJSONCaseIterable {
/// The "different" conditions have to do
/// with Optionality, hence the name of this protocol.
public protocol AnyWrappedJSONCaseIterable {
static var allCases: [AnyCodable] { get }
static func allCases(using encoder: JSONEncoder) -> [AnyCodable]
}
public protocol SwiftTyped {
@@ -282,14 +282,15 @@ public enum JSONNode: Equatable {
nullable: Bool = false,
// constantValue: Format.SwiftType? = nil,
allowedValues: [AnyCodable]? = nil,
example: AnyCodable? = nil) {
example: AnyCodable? = nil,
using encoder: JSONEncoder = JSONEncoder()) {
self.format = format
self.required = required
self.nullable = nullable
// self.constantValue = constantValue
self.allowedValues = allowedValues
self.example = example
.flatMap { try? JSONEncoder().encode($0)}
.flatMap { try? encoder.encode($0)}
.flatMap { String(data: $0, encoding: .utf8) }
}
@@ -550,12 +551,13 @@ public enum JSONNode: Equatable {
}
}
public func with<T: Encodable>(example codableExample: T) throws -> JSONNode {
public func with<T: Encodable>(example codableExample: T,
using encoder: JSONEncoder) throws -> JSONNode {
let example: AnyCodable
if let goodToGo = codableExample as? AnyCodable {
example = goodToGo
} else {
example = AnyCodable(try JSONSerialization.jsonObject(with: JSONEncoder().encode(codableExample), options: []))
example = AnyCodable(try JSONSerialization.jsonObject(with: encoder.encode(codableExample), options: []))
}
switch self {
Sources/JSONAPIOpenAPI/OpenAPI/SwiftPrimitiveTypes+OpenAPI.swift
+20 -19
View File
@@ -6,6 +6,7 @@
//
import AnyCodable
import Foundation
/**
@@ -32,37 +33,37 @@ Any object:
**/
extension Optional: OpenAPINodeType where Wrapped: OpenAPINodeType {
static public func openAPINode() throws -> JSONNode {
return try Wrapped.openAPINode().optionalNode()
static public func openAPINode(using encoder: JSONEncoder) throws -> JSONNode {
return try Wrapped.openAPINode(using: encoder).optionalNode()
}
}
extension Optional: RawOpenAPINodeType where Wrapped: RawRepresentable, Wrapped.RawValue: OpenAPINodeType {
static public func rawOpenAPINode() throws -> JSONNode {
return try Wrapped.RawValue.openAPINode().optionalNode()
static public func rawOpenAPINode(using encoder: JSONEncoder) throws -> JSONNode {
return try Wrapped.RawValue.openAPINode(using: encoder).optionalNode()
}
}
extension Optional: WrappedRawOpenAPIType where Wrapped: RawOpenAPINodeType {
static public func wrappedOpenAPINode() throws -> JSONNode {
return try Wrapped.rawOpenAPINode().optionalNode()
static public func wrappedOpenAPINode(using encoder: JSONEncoder) throws -> JSONNode {
return try Wrapped.rawOpenAPINode(using: encoder).optionalNode()
}
}
extension Optional: DoubleWrappedRawOpenAPIType where Wrapped: WrappedRawOpenAPIType {
static public func wrappedOpenAPINode() throws -> JSONNode {
return try Wrapped.wrappedOpenAPINode().optionalNode()
static public func wrappedOpenAPINode(using encoder: JSONEncoder) throws -> JSONNode {
return try Wrapped.wrappedOpenAPINode(using: encoder).optionalNode()
}
}
extension Optional: AnyJSONCaseIterable where Wrapped: CaseIterable, Wrapped: Codable {
public static var allCases: [AnyCodable] {
return (try? allCases(from: Array(Wrapped.allCases))) ?? []
public static func allCases(using encoder: JSONEncoder) -> [AnyCodable] {
return (try? allCases(from: Array(Wrapped.allCases), using: encoder)) ?? []
}
}
extension String: OpenAPINodeType {
static public func openAPINode() throws -> JSONNode {
static public func openAPINode(using encoder: JSONEncoder) throws -> JSONNode {
return .string(.init(format: .generic,
required: true),
.init())
@@ -70,22 +71,22 @@ extension String: OpenAPINodeType {
}
extension Bool: OpenAPINodeType {
static public func openAPINode() throws -> JSONNode {
static public func openAPINode(using encoder: JSONEncoder) throws -> JSONNode {
return .boolean(.init(format: .generic,
required: true))
}
}
extension Array: OpenAPINodeType where Element: OpenAPINodeType {
static public func openAPINode() throws -> JSONNode {
static public func openAPINode(using encoder: JSONEncoder) throws -> JSONNode {
return .array(.init(format: .generic,
required: true),
.init(items: try Element.openAPINode()))
.init(items: try Element.openAPINode(using: encoder)))
}
}
extension Double: OpenAPINodeType {
static public func openAPINode() throws -> JSONNode {
static public func openAPINode(using encoder: JSONEncoder) throws -> JSONNode {
return .number(.init(format: .double,
required: true),
.init())
@@ -93,7 +94,7 @@ extension Double: OpenAPINodeType {
}
extension Float: OpenAPINodeType {
static public func openAPINode() throws -> JSONNode {
static public func openAPINode(using encoder: JSONEncoder) throws -> JSONNode {
return .number(.init(format: .float,
required: true),
.init())
@@ -101,7 +102,7 @@ extension Float: OpenAPINodeType {
}
extension Int: OpenAPINodeType {
static public func openAPINode() throws -> JSONNode {
static public func openAPINode(using encoder: JSONEncoder) throws -> JSONNode {
return .integer(.init(format: .generic,
required: true),
.init())
@@ -109,7 +110,7 @@ extension Int: OpenAPINodeType {
}
extension Int32: OpenAPINodeType {
static public func openAPINode() throws -> JSONNode {
static public func openAPINode(using encoder: JSONEncoder) throws -> JSONNode {
return .integer(.init(format: .int32,
required: true),
.init())
@@ -117,7 +118,7 @@ extension Int32: OpenAPINodeType {
}
extension Int64: OpenAPINodeType {
static public func openAPINode() throws -> JSONNode {
static public func openAPINode(using encoder: JSONEncoder) throws -> JSONNode {
return .integer(.init(format: .int64,
required: true),
.init())