Prefix Encoder and Decoder with PS (#48)

fabianfett · web-flow · commit 64f6532b525d · 2020-06-24T14:49:23.000+02:00
diff --git a/PerfTests/Sources/CodingPerfTests/main.swift b/PerfTests/Sources/CodingPerfTests/main.swift
@@ -20,7 +20,7 @@ func timing(name: String, execute: () throws -> Void) rethrows -> TimeInterval {
 
 let sampleString = SampleStructure.sampleJSON
 let sampleBytes = [UInt8](sampleString.utf8)
-let sampleStruct = try PureSwiftJSON.JSONDecoder().decode([SampleStructure].self, from: sampleBytes)
+let sampleStruct = try PSJSONDecoder().decode([SampleStructure].self, from: sampleBytes)
 let sampleJSON = try JSONParser().parse(bytes: sampleBytes)
 
 print("Number of invocations: \(runs)")
@@ -39,7 +39,7 @@ let toBytes = timing(name: "PureSwift                    ") {
 print("------------------------------------------")
 print("Encoding")
 
-let foundationEncoder = Foundation.JSONEncoder()
+let foundationEncoder = JSONEncoder()
 let foundationEncoding = try timing(name: "Foundation                   ") {
     for _ in 1 ... runs {
         _ = try foundationEncoder.encode(sampleStruct)
@@ -53,7 +53,7 @@ let ikigaEncoding = try timing(name: "Ikiga                        ") {
     }
 }
 
-let pureEncoder = PureSwiftJSON.JSONEncoder()
+let pureEncoder = PSJSONEncoder()
 let pureEncoding = try timing(name: "PureSwift                    ") {
     for _ in 1 ... runs {
         _ = try pureEncoder.encode(sampleStruct)
@@ -128,7 +128,7 @@ let pureParsingBuffer = try timing(name: "PureSwift on NIO.ByteBuffer  ") {
 print("------------------------------------------")
 print("Decoding")
 
-let foundationDecoder = Foundation.JSONDecoder()
+let foundationDecoder = JSONDecoder()
 let foundationDecoding = try timing(name: "Foundation on Foundation.Data") {
     for _ in 1 ... runs {
         _ = try foundationDecoder.decode([SampleStructure].self, from: sampleData)
@@ -165,7 +165,7 @@ let ikigaDecodingBuffer = try timing(name: "IkigaJSON on NIO.ByteBuffer  ") {
     }
 }
 
-let pureDecoder = PureSwiftJSON.JSONDecoder()
+let pureDecoder = PSJSONDecoder()
 let pureDecoding = try timing(name: "PureSwift on [UInt8]         ") {
     for _ in 1 ... runs {
         _ = try pureDecoder.decode([SampleStructure].self, from: sampleBytes)
diff --git a/README.md b/README.md
@@ -54,8 +54,8 @@ Use it as you would use the Foundation encoder and decoder.
 ```swift
 import PureSwiftJSON
 
-let bytesArray  = try JSONEncoder().encode(myEncodable)
-let myDecodable = try JSONDecoder().decode(MyDecodable.self, from: bytes)
+let bytesArray  = try PSJSONEncoder().encode(myEncodable)
+let myDecodable = try PSJSONDecoder().decode(MyDecodable.self, from: bytes)
 ```
 
 ### Use with SwiftNIO ByteBuffer
@@ -83,7 +83,7 @@ Increase the performance of your Vapor 4 API by using `pure-swift-json` instead
 import Vapor
 import PureSwiftJSON
 
-extension PureSwiftJSON.JSONEncoder: ContentEncoder {
+extension PSJSONEncoder: ContentEncoder {
   public func encode<E: Encodable>(
     _ encodable: E,
     to body: inout ByteBuffer,
@@ -96,7 +96,7 @@ extension PureSwiftJSON.JSONEncoder: ContentEncoder {
   }
 }
 
-extension PureSwiftJSON.JSONDecoder: ContentDecoder {
+extension PSJSONDecoder: ContentDecoder {
   public func decode<D: Decodable>(
     _ decodable: D.Type,
     from body: ByteBuffer,
@@ -114,10 +114,10 @@ extension PureSwiftJSON.JSONDecoder: ContentDecoder {
 Next, register the encoder and decoder for use in Vapor:
 
 ```swift
-let decoder = PureSwiftJSON.JSONDecoder()
+let decoder = PSJSONDecoder()
 ContentConfiguration.global.use(decoder: decoder, for: .json)
 
-let encoder = PureSwiftJSON.JSONEncoder()
+let encoder = PSJSONEncoder()
 ContentConfiguration.global.use(encoder: encoder, for: .json)
 ```
 
diff --git a/Sources/PureSwiftJSON/Decoding/JSONDecoder.swift b/Sources/PureSwiftJSON/Decoding/JSONDecoder.swift
@@ -1,5 +1,5 @@
 
-public struct JSONDecoder {
+public struct PSJSONDecoder {
     @usableFromInline var userInfo: [CodingUserInfoKey: Any] = [:]
 
     public init() {}
diff --git a/Sources/PureSwiftJSON/Encoding/JSONEncoder.swift b/Sources/PureSwiftJSON/Encoding/JSONEncoder.swift
@@ -95,7 +95,7 @@ class JSONObject {
     }
 }
 
-public struct JSONEncoder {
+public struct PSJSONEncoder {
     var userInfo: [CodingUserInfoKey: Any] = [:]
 
     public init() {}
diff --git a/Tests/PureSwiftJSONTests/DateCodingTests.swift b/Tests/PureSwiftJSONTests/DateCodingTests.swift
@@ -46,7 +46,7 @@ class DateCodingTests: XCTestCase {
         do {
             let dateString = "2020-03-18T13:11:10.000Z"
             let json = #"{"eventTime": "\#(dateString)"}"#
-            let result = try PureSwiftJSON.JSONDecoder().decode(MyEvent.self, from: [UInt8](json.utf8))
+            let result = try PSJSONDecoder().decode(MyEvent.self, from: [UInt8](json.utf8))
 
             let components = DateComponents(
                 calendar: Calendar(identifier: .gregorian), timeZone: TimeZone(secondsFromGMT: 0),
@@ -69,7 +69,7 @@ class DateCodingTests: XCTestCase {
             )
 
             let event = MyEvent(eventTime: components.date!)
-            let bytes = try PureSwiftJSON.JSONEncoder().encode(event)
+            let bytes = try PSJSONEncoder().encode(event)
             XCTAssertEqual(String(decoding: bytes, as: Unicode.UTF8.self), json)
         } catch {
             XCTFail("Unexpected error: \(error)")
diff --git a/Tests/PureSwiftJSONTests/Decoding/JSONDecoderTests.swift b/Tests/PureSwiftJSONTests/Decoding/JSONDecoderTests.swift
@@ -32,7 +32,7 @@ class JSONDecoderTests: XCTestCase {
             }
             """
 
-            let result = try JSONDecoder().decode(HelloWorld.self, from: [UInt8](string.utf8))
+            let result = try PSJSONDecoder().decode(HelloWorld.self, from: [UInt8](string.utf8))
 
             XCTAssertEqual(result.hello, "world")
             XCTAssertEqual(result.subStruct, HelloWorld.SubStruct(name: "hihi"))
@@ -53,7 +53,7 @@ class JSONDecoderTests: XCTestCase {
         }
 
         let json = #"{"hello":"world"}"#
-        XCTAssertThrowsError(_ = try PureSwiftJSON.JSONDecoder().decode(HelloWorld.self, from: json.data(using: .utf8)!)) {
+        XCTAssertThrowsError(_ = try PSJSONDecoder().decode(HelloWorld.self, from: json.data(using: .utf8)!)) {
             error in
             guard case let Swift.DecodingError.typeMismatch(type, context) = error else {
                 XCTFail("Unexpected error: \(error)"); return
@@ -77,7 +77,7 @@ class JSONDecoderTests: XCTestCase {
         }
 
         let json = #"["haha", "hihi"]"#
-        XCTAssertThrowsError(_ = try PureSwiftJSON.JSONDecoder().decode(HelloWorld.self, from: json.data(using: .utf8)!)) {
+        XCTAssertThrowsError(_ = try PSJSONDecoder().decode(HelloWorld.self, from: json.data(using: .utf8)!)) {
             error in
             guard case let Swift.DecodingError.typeMismatch(type, context) = error else {
                 XCTFail("Unexpected error: \(error)"); return
@@ -100,7 +100,7 @@ class JSONDecoderTests: XCTestCase {
         }
 
         let json = #"{"hello👩‍👩‍👧‍👧" 123 }"#
-        XCTAssertThrowsError(_ = try PureSwiftJSON.JSONDecoder().decode(HelloWorld.self, from: json.data(using: .utf8)!)) {
+        XCTAssertThrowsError(_ = try PSJSONDecoder().decode(HelloWorld.self, from: json.data(using: .utf8)!)) {
             error in
             guard case let Swift.DecodingError.dataCorrupted(context) = error else {
                 XCTFail("Unexpected error: \(error)"); return
diff --git a/Tests/PureSwiftJSONTests/Encoding/JSONEncoderTests.swift b/Tests/PureSwiftJSONTests/Encoding/JSONEncoderTests.swift
@@ -12,7 +12,7 @@ class JSONEncoderTests: XCTestCase {
     func testEncodeHelloWorld() {
         let hello = HelloWorld(hello: "world")
         var result: [UInt8]?
-        XCTAssertNoThrow(result = try PureSwiftJSON.JSONEncoder().encode(hello))
+        XCTAssertNoThrow(result = try PSJSONEncoder().encode(hello))
         var parsed: JSONValue?
         XCTAssertNoThrow(parsed = try JSONParser().parse(bytes: XCTUnwrap(result)))
 
@@ -26,30 +26,30 @@ class JSONEncoderTests: XCTestCase {
 
     func testEncodeTopLevel12() {
         var result: [UInt8]?
-        XCTAssertNoThrow(result = try PureSwiftJSON.JSONEncoder().encode(12))
+        XCTAssertNoThrow(result = try PSJSONEncoder().encode(12))
         XCTAssertEqual(String(bytes: try XCTUnwrap(result), encoding: .utf8), "12")
     }
 
     func testEncodeTopLevelTrue() {
         var result: [UInt8]?
-        XCTAssertNoThrow(result = try PureSwiftJSON.JSONEncoder().encode(true))
+        XCTAssertNoThrow(result = try PSJSONEncoder().encode(true))
         XCTAssertEqual(String(bytes: try XCTUnwrap(result), encoding: .utf8), "true")
     }
 
     func testEncodeTopLevelNull() {
         var result: [UInt8]?
-        XCTAssertNoThrow(result = try PureSwiftJSON.JSONEncoder().encode(nil as String?))
+        XCTAssertNoThrow(result = try PSJSONEncoder().encode(nil as String?))
         XCTAssertEqual(String(bytes: try XCTUnwrap(result), encoding: .utf8), "null")
     }
 
     func testEncodeTopLevelString() {
         var result: [UInt8]?
-        XCTAssertNoThrow(result = try PureSwiftJSON.JSONEncoder().encode("Hello World"))
+        XCTAssertNoThrow(result = try PSJSONEncoder().encode("Hello World"))
         XCTAssertEqual(String(bytes: try XCTUnwrap(result), encoding: .utf8), #""Hello World""#)
     }
 
     func testEncodeDoubleNAN() {
-        XCTAssertThrowsError(_ = try PureSwiftJSON.JSONEncoder().encode(Double.nan)) { error in
+        XCTAssertThrowsError(_ = try PSJSONEncoder().encode(Double.nan)) { error in
             guard case let Swift.EncodingError.invalidValue(value as Double, context) = error else {
                 XCTFail("Unexpected error: \(error)"); return
             }
@@ -61,7 +61,7 @@ class JSONEncoderTests: XCTestCase {
     }
 
     func testEncodeDoubleInf() {
-        XCTAssertThrowsError(_ = try PureSwiftJSON.JSONEncoder().encode(Double.infinity)) { error in
+        XCTAssertThrowsError(_ = try PSJSONEncoder().encode(Double.infinity)) { error in
             guard case let Swift.EncodingError.invalidValue(value as Double, context) = error else {
                 XCTFail("Unexpected error: \(error)"); return
             }
@@ -73,7 +73,7 @@ class JSONEncoderTests: XCTestCase {
     }
 
     func testEncodeFloatNAN() {
-        XCTAssertThrowsError(_ = try PureSwiftJSON.JSONEncoder().encode(Float.nan)) { error in
+        XCTAssertThrowsError(_ = try PSJSONEncoder().encode(Float.nan)) { error in
             guard case let Swift.EncodingError.invalidValue(value as Float, context) = error else {
                 XCTFail("Unexpected error: \(error)"); return
             }
@@ -85,7 +85,7 @@ class JSONEncoderTests: XCTestCase {
     }
 
     func testEncodeFloatInf() {
-        XCTAssertThrowsError(_ = try PureSwiftJSON.JSONEncoder().encode(Float.infinity)) { error in
+        XCTAssertThrowsError(_ = try PSJSONEncoder().encode(Float.infinity)) { error in
             guard case let Swift.EncodingError.invalidValue(value as Float, context) = error else {
                 XCTFail("Unexpected error: \(error)"); return
             }
@@ -98,7 +98,7 @@ class JSONEncoderTests: XCTestCase {
 
     func testEncodeQuote() {
         var result: [UInt8]?
-        XCTAssertNoThrow(result = try PureSwiftJSON.JSONEncoder().encode("\""))
+        XCTAssertNoThrow(result = try PSJSONEncoder().encode("\""))
         XCTAssertEqual(String(bytes: try XCTUnwrap(result), encoding: String.Encoding.utf8), "\"\\\"\"")
     }
 
@@ -127,7 +127,7 @@ class JSONEncoderTests: XCTestCase {
         let object = Object(sub: SubObject(value: 12))
 
         var result: [UInt8]?
-        XCTAssertNoThrow(result = try PureSwiftJSON.JSONEncoder().encode(object))
+        XCTAssertNoThrow(result = try PSJSONEncoder().encode(object))
         var parsed: JSONValue?
         XCTAssertNoThrow(parsed = try JSONParser().parse(bytes: XCTUnwrap(result)))
         XCTAssertEqual(parsed, .object(["sub": .object(["key": .string("sub"), "value": .number("12")])]))
diff --git a/Tests/PureSwiftJSONTests/Encoding/JSONKeyedEncodingContainerTests.swift b/Tests/PureSwiftJSONTests/Encoding/JSONKeyedEncodingContainerTests.swift
@@ -10,7 +10,7 @@ class JSONKeyedEncodingContainerTests: XCTestCase {
 
     func testEncodeDoubleNAN() {
         do {
-            let result = try PureSwiftJSON.JSONEncoder().encode(DoubleBox(number: .nan))
+            let result = try PSJSONEncoder().encode(DoubleBox(number: .nan))
             XCTFail("Did not expect to have a result: \(result)")
         } catch let Swift.EncodingError.invalidValue(value as Double, context) {
             XCTAssert(value.isNaN) // expected
@@ -24,7 +24,7 @@ class JSONKeyedEncodingContainerTests: XCTestCase {
 
     func testEncodeDoubleInf() {
         do {
-            let result = try PureSwiftJSON.JSONEncoder().encode(DoubleBox(number: .infinity))
+            let result = try PSJSONEncoder().encode(DoubleBox(number: .infinity))
             XCTFail("Did not expect to have a result: \(result)")
         } catch let Swift.EncodingError.invalidValue(value as Double, context) {
             XCTAssert(value.isInfinite) // expected
@@ -43,7 +43,7 @@ class JSONKeyedEncodingContainerTests: XCTestCase {
 
     func testEncodeFloatNAN() {
         do {
-            let result = try PureSwiftJSON.JSONEncoder().encode(FloatBox(number: .nan))
+            let result = try PSJSONEncoder().encode(FloatBox(number: .nan))
             XCTFail("Did not expect to have a result: \(result)")
         } catch let Swift.EncodingError.invalidValue(value as Float, context) {
             XCTAssert(value.isNaN) // expected
@@ -57,7 +57,7 @@ class JSONKeyedEncodingContainerTests: XCTestCase {
 
     func testEncodeFloatInf() {
         do {
-            let result = try PureSwiftJSON.JSONEncoder().encode(FloatBox(number: .infinity))
+            let result = try PSJSONEncoder().encode(FloatBox(number: .infinity))
             XCTFail("Did not expect to have a result: \(result)")
         } catch let Swift.EncodingError.invalidValue(value as Float, context) {
             XCTAssert(value.isInfinite) // expected
@@ -98,7 +98,7 @@ class JSONKeyedEncodingContainerTests: XCTestCase {
 
         do {
             let object = Object(firstName: "Adam", surname: "Fowler")
-            let json = try PureSwiftJSON.JSONEncoder().encode(object)
+            let json = try PSJSONEncoder().encode(object)
 
             let parsed = try JSONParser().parse(bytes: json)
             XCTAssertEqual(parsed, .object(["name": .object(["firstName": .string("Adam"), "surname": .string("Fowler")])]))
@@ -127,7 +127,7 @@ class JSONKeyedEncodingContainerTests: XCTestCase {
 
         do {
             let object = NumberStruct()
-            let json = try PureSwiftJSON.JSONEncoder().encode(object)
+            let json = try PSJSONEncoder().encode(object)
 
             let parsed = try JSONParser().parse(bytes: json)
             XCTAssertEqual(parsed, .object(["numbers": .array([.number("1"), .number("2"), .number("3"), .number("4")])]))
diff --git a/Tests/PureSwiftJSONTests/Encoding/JSONSingleValueEncodingContainerTests.swift b/Tests/PureSwiftJSONTests/Encoding/JSONSingleValueEncodingContainerTests.swift
@@ -19,7 +19,7 @@ class JSONSingleValueEncodingContainerTests: XCTestCase {
 
         let object = Object(name: Name(firstName: "Adam", surname: "Fowler"))
         var json: [UInt8]?
-        XCTAssertNoThrow(json = try PureSwiftJSON.JSONEncoder().encode(object))
+        XCTAssertNoThrow(json = try PSJSONEncoder().encode(object))
 
         var parsed: JSONValue?
         XCTAssertNoThrow(parsed = try JSONParser().parse(bytes: XCTUnwrap(json)))
diff --git a/Tests/PureSwiftJSONTests/Encoding/JSONUnkeyedEncodingContainerTests.swift b/Tests/PureSwiftJSONTests/Encoding/JSONUnkeyedEncodingContainerTests.swift
@@ -15,7 +15,7 @@ class JSONUnkeyedEncodingContainerTests: XCTestCase {
 
     func testEncodeDoubleNAN() {
         do {
-            let result = try PureSwiftJSON.JSONEncoder().encode(DoubleInArrayBox(number: .nan))
+            let result = try PSJSONEncoder().encode(DoubleInArrayBox(number: .nan))
             XCTFail("Did not expect to have a result: \(result)")
         } catch let Swift.EncodingError.invalidValue(value as Double, context) {
             XCTAssert(value.isNaN) // expected
@@ -29,7 +29,7 @@ class JSONUnkeyedEncodingContainerTests: XCTestCase {
 
     func testEncodeDoubleInf() {
         do {
-            let result = try PureSwiftJSON.JSONEncoder().encode(DoubleInArrayBox(number: .infinity))
+            let result = try PSJSONEncoder().encode(DoubleInArrayBox(number: .infinity))
             XCTFail("Did not expect to have a result: \(result)")
         } catch let Swift.EncodingError.invalidValue(value as Double, context) {
             XCTAssert(value.isInfinite) // expected
@@ -53,7 +53,7 @@ class JSONUnkeyedEncodingContainerTests: XCTestCase {
 
     func testEncodeFloatNAN() {
         do {
-            let result = try PureSwiftJSON.JSONEncoder().encode(FloatInArrayBox(number: .nan))
+            let result = try PSJSONEncoder().encode(FloatInArrayBox(number: .nan))
             XCTFail("Did not expect to have a result: \(result)")
         } catch let Swift.EncodingError.invalidValue(value as Float, context) {
             XCTAssert(value.isNaN) // expected
@@ -67,7 +67,7 @@ class JSONUnkeyedEncodingContainerTests: XCTestCase {
 
     func testEncodeFloatInf() {
         do {
-            let result = try PureSwiftJSON.JSONEncoder().encode(FloatInArrayBox(number: .infinity))
+            let result = try PSJSONEncoder().encode(FloatInArrayBox(number: .infinity))
             XCTFail("Did not expect to have a result: \(result)")
         } catch let Swift.EncodingError.invalidValue(value as Float, context) {
             XCTAssert(value.isInfinite) // expected
@@ -102,7 +102,7 @@ class JSONUnkeyedEncodingContainerTests: XCTestCase {
 
         do {
             let object = ObjectInArray(firstName: "Adam", surname: "Fowler")
-            let json = try PureSwiftJSON.JSONEncoder().encode(object)
+            let json = try PSJSONEncoder().encode(object)
 
             let parsed = try JSONParser().parse(bytes: json)
             XCTAssertEqual(parsed, .array([.object(["firstName": .string("Adam"), "surname": .string("Fowler")])]))
@@ -128,7 +128,7 @@ class JSONUnkeyedEncodingContainerTests: XCTestCase {
 
         do {
             let object = NumbersInArray(numbers: [1, 2, 3, 4])
-            let json = try PureSwiftJSON.JSONEncoder().encode(object)
+            let json = try PSJSONEncoder().encode(object)
 
             let parsed = try JSONParser().parse(bytes: json)
             XCTAssertEqual(parsed, .array([.array([.number("1"), .number("2"), .number("3"), .number("4")])]))

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ class JSONObject {`
`95`	`95`	`}`
`96`	`96`	`}`
`97`	`97`
`98`		`-public struct JSONEncoder {`
	`98`	`+public struct PSJSONEncoder {`
`99`	`99`	`var userInfo: [CodingUserInfoKey: Any] = [:]`
`100`	`100`
`101`	`101`	`public init() {}`