Skip to content
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.

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

Add Encodable conformance to JSONValue #113

Merged
merged 3 commits into from
Feb 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions Sources/GoogleAI/JSONValue.swift
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,29 @@ extension JSONValue: Decodable {
}
}

extension JSONValue: Encodable {
public func encode(to encoder: Encoder) throws {
var container = encoder.singleValueContainer()
switch self {
case .null:
try container.encodeNil()
case let .number(numberValue):
// Convert to `Decimal` before encoding for consistent floating-point serialization across
// platforms. E.g., `Double` serializes 3.14159 as 3.1415899999999999 in some cases and
// 3.14159 in others. See
// https://forums.swift.org/t/jsonencoder-encodable-floating-point-rounding-error/41390/4 for
// more details.
try container.encode(Decimal(numberValue))
case let .string(stringValue):
try container.encode(stringValue)
case let .bool(boolValue):
try container.encode(boolValue)
case let .object(objectValue):
try container.encode(objectValue)
case let .array(arrayValue):
try container.encode(arrayValue)
}
}
}

extension JSONValue: Equatable {}
94 changes: 77 additions & 17 deletions Tests/GoogleAITests/JSONValueTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -16,46 +16,53 @@ import XCTest
@testable import GoogleGenerativeAI

final class JSONValueTests: XCTestCase {
let decoder = JSONDecoder()
let encoder = JSONEncoder()

let numberKey = "pi"
let numberValue = 3.14159
let numberValueEncoded = "3.14159"
let stringKey = "hello"
let stringValue = "Hello, world!"

override func setUp() {
encoder.outputFormatting = .sortedKeys
}

func testDecodeNull() throws {
let jsonData = try XCTUnwrap("null".data(using: .utf8))

let jsonObject = try XCTUnwrap(JSONDecoder().decode(JSONValue.self, from: jsonData))
let jsonObject = try XCTUnwrap(decoder.decode(JSONValue.self, from: jsonData))

XCTAssertEqual(jsonObject, .null)
}

func testDecodeNumber() throws {
let expectedNumber = 3.14159
let jsonData = try XCTUnwrap("\(expectedNumber)".data(using: .utf8))
let jsonData = try XCTUnwrap("\(numberValue)".data(using: .utf8))

let jsonObject = try XCTUnwrap(JSONDecoder().decode(JSONValue.self, from: jsonData))
let jsonObject = try XCTUnwrap(decoder.decode(JSONValue.self, from: jsonData))

XCTAssertEqual(jsonObject, .number(expectedNumber))
XCTAssertEqual(jsonObject, .number(numberValue))
}

func testDecodeString() throws {
let expectedString = "hello-world"
let jsonData = try XCTUnwrap("\"\(expectedString)\"".data(using: .utf8))
let jsonData = try XCTUnwrap("\"\(stringValue)\"".data(using: .utf8))

let jsonObject = try XCTUnwrap(JSONDecoder().decode(JSONValue.self, from: jsonData))
let jsonObject = try XCTUnwrap(decoder.decode(JSONValue.self, from: jsonData))

XCTAssertEqual(jsonObject, .string(expectedString))
XCTAssertEqual(jsonObject, .string(stringValue))
}

func testDecodeBool() throws {
let expectedBool = true
let jsonData = try XCTUnwrap("\(expectedBool)".data(using: .utf8))

let jsonObject = try XCTUnwrap(JSONDecoder().decode(JSONValue.self, from: jsonData))
let jsonObject = try XCTUnwrap(decoder.decode(JSONValue.self, from: jsonData))

XCTAssertEqual(jsonObject, .bool(expectedBool))
}

func testDecodeObject() throws {
let numberKey = "pi"
let numberValue = 3.14159
let stringKey = "hello"
let stringValue = "world"
let expectedObject: JSONObject = [
numberKey: .number(numberValue),
stringKey: .string(stringValue),
Expand All @@ -68,18 +75,71 @@ final class JSONValueTests: XCTestCase {
"""
let jsonData = try XCTUnwrap(json.data(using: .utf8))

let jsonObject = try XCTUnwrap(JSONDecoder().decode(JSONValue.self, from: jsonData))
let jsonObject = try XCTUnwrap(decoder.decode(JSONValue.self, from: jsonData))

XCTAssertEqual(jsonObject, .object(expectedObject))
}

func testDecodeArray() throws {
let numberValue = 3.14159
let expectedArray: [JSONValue] = [.null, .number(numberValue)]
let jsonData = try XCTUnwrap("[ null, \(numberValue) ]".data(using: .utf8))

let jsonObject = try XCTUnwrap(JSONDecoder().decode(JSONValue.self, from: jsonData))
let jsonObject = try XCTUnwrap(decoder.decode(JSONValue.self, from: jsonData))

XCTAssertEqual(jsonObject, .array(expectedArray))
}

func testEncodeNull() throws {
let jsonData = try encoder.encode(JSONValue.null)

let json = try XCTUnwrap(String(data: jsonData, encoding: .utf8))
XCTAssertEqual(json, "null")
}

func testEncodeNumber() throws {
let jsonData = try encoder.encode(JSONValue.number(numberValue))

let json = try XCTUnwrap(String(data: jsonData, encoding: .utf8))
XCTAssertEqual(json, "\(numberValue)")
}

func testEncodeString() throws {
let jsonData = try encoder.encode(JSONValue.string(stringValue))

let json = try XCTUnwrap(String(data: jsonData, encoding: .utf8))
XCTAssertEqual(json, "\"\(stringValue)\"")
}

func testEncodeBool() throws {
let boolValue = true

let jsonData = try encoder.encode(JSONValue.bool(boolValue))

let json = try XCTUnwrap(String(data: jsonData, encoding: .utf8))
XCTAssertEqual(json, "\(boolValue)")
}

func testEncodeObject() throws {
let objectValue: JSONObject = [
numberKey: .number(numberValue),
stringKey: .string(stringValue),
]

let jsonData = try encoder.encode(JSONValue.object(objectValue))

let json = try XCTUnwrap(String(data: jsonData, encoding: .utf8))
XCTAssertEqual(
json,
"{\"\(stringKey)\":\"\(stringValue)\",\"\(numberKey)\":\(numberValueEncoded)}"
)
}

func testEncodeArray() throws {
let arrayValue: [JSONValue] = [.null, .number(numberValue)]

let jsonData = try encoder.encode(JSONValue.array(arrayValue))

let json = try XCTUnwrap(String(data: jsonData, encoding: .utf8))
XCTAssertEqual(json, "[null,\(numberValueEncoded)]")
}
}
Loading