feat: adds JSON string initialization (#4)

Author: kevinhermawan

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+github: ["kevinhermawan"]
+custom:
+  [
+    "https://buymeacoffee.com/kevinhermawan"
+  ]

README.md

@@ -132,6 +132,67 @@ let productSchema = JSONSchema.object(
 )
 ```
 
+You can also create the same schema using a JSON string:
+
+```swift
+do {
+    let jsonString = """
+    {
+        "type": "object",
+        "properties": {
+            "id": {
+                "type": "integer",
+                "minimum": 1
+            },
+            "name": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 100
+            },
+            "price": {
+                "type": "number",
+                "minimum": 0.01,
+                "exclusiveMaximum": 1000000
+            },
+            "tags": {
+                "type": "array",
+                "items": {
+                    "type": "string"
+                },
+                "uniqueItems": true
+            },
+            "settings": {
+                "type": "object",
+                "properties": {
+                    "inStock": {
+                        "type": "boolean"
+                    },
+                    "size": {
+                        "type": "string",
+                        "enum": ["small", "medium", "large"]
+                    }
+                }
+            }
+        },
+        "required": ["id", "name", "price"]
+    }
+    """
+
+    let productSchema = try JSONSchema(jsonString: jsonString)
+} catch {
+    print(String(describing: error))
+}
+```
+
+## Donations
+
+If you find `JSONSchema` helpful and would like to support its development, consider making a donation. Your contribution helps maintain the project and develop new features.
+
+- [GitHub Sponsors](https://github.com/sponsors/kevinhermawan)
+- [Buy Me a Coffee](https://buymeacoffee.com/kevinhermawan)
+
+Your support is greatly appreciated!
+
 ## Contributing
 
 Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.

Sources/JSONSchema/Documentation.docc/Documentation.md

@@ -104,3 +104,55 @@ let productSchema = JSONSchema.object(
     required: ["id", "name", "price"]
 )
 ```
+
+You can also create the same schema using a JSON string:
+
+```swift
+do {
+    let jsonString = """
+    {
+        "type": "object",
+        "properties": {
+            "id": {
+                "type": "integer",
+                "minimum": 1
+            },
+            "name": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 100
+            },
+            "price": {
+                "type": "number",
+                "minimum": 0.01,
+                "exclusiveMaximum": 1000000
+            },
+            "tags": {
+                "type": "array",
+                "items": {
+                    "type": "string"
+                },
+                "uniqueItems": true
+            },
+            "settings": {
+                "type": "object",
+                "properties": {
+                    "inStock": {
+                        "type": "boolean"
+                    },
+                    "size": {
+                        "type": "string",
+                        "enum": ["small", "medium", "large"]
+                    }
+                }
+            }
+        },
+        "required": ["id", "name", "price"]
+    }
+    """
+
+    let productSchema = try JSONSchema(jsonString: jsonString)
+} catch {
+    print(String(describing: error))
+}
+```

Sources/JSONSchema/JSONSchema.swift

@@ -101,4 +101,29 @@ public class JSONSchema: Codable {
     private enum CodingKeys: String, CodingKey {
         case type, description, `enum`
     }
+    
+    /// Creates a new instance of ``JSONSchema`` from a JSON string.
+    public convenience init(jsonString: String) throws {
+        guard let data = jsonString.data(using: .utf8) else {
+            throw DecodingError.dataCorrupted(.init(codingPath: [], debugDescription: "Invalid UTF-8 string"))
+        }
+        
+        let decoder = JSONDecoder()
+        let decodedData = try decoder.decode(JSONSchema.self, from: data)
+        
+        self.init(from: decodedData)
+    }
+    
+    private init(from decodedSchema: JSONSchema) {
+        self.type = decodedSchema.type
+        self.description = decodedSchema.description
+        self.arraySchema = decodedSchema.arraySchema
+        self.booleanSchema = decodedSchema.booleanSchema
+        self.enumSchema = decodedSchema.enumSchema
+        self.integerSchema = decodedSchema.integerSchema
+        self.nullSchema = decodedSchema.nullSchema
+        self.numberSchema = decodedSchema.numberSchema
+        self.objectSchema = decodedSchema.objectSchema
+        self.stringSchema = decodedSchema.stringSchema
+    }
 }

Tests/JSONSchemaTests/JSONStringTests.swift

@@ -0,0 +1,59 @@
+//
+//  JSONStringTests.swift
+//  JSONSchema
+//
+//  Created by Kevin Hermawan on 9/28/24.
+//
+
+import XCTest
+@testable import JSONSchema
+
+final class JSONStringTests: XCTestCase {
+    func testValidJSON() throws {
+        let jsonString = """
+        {
+            "type": "object",
+            "properties": {
+                "location": {
+                    "type": "string",
+                    "description": "The location to get the weather for, e.g. Bogor, Indonesia"
+                },
+                "format": {
+                    "type": "string",
+                    "description": "The format to return the weather in, e.g. 'celsius' or 'fahrenheit'",
+                    "enum": ["celsius", "fahrenheit"]
+                }
+            },
+            "required": ["location", "format"]
+        }
+        """
+        
+        let schema = try JSONSchema(jsonString: jsonString)
+        XCTAssertEqual(schema.type, .object)
+        XCTAssertNil(schema.description)
+        
+        let objectSchema = schema.objectSchema
+        XCTAssertNotNil(objectSchema)
+        
+        let properties = objectSchema?.properties
+        XCTAssertEqual(properties?.count, 2)
+        
+        let locationSchema = properties?["location"]
+        XCTAssertEqual(locationSchema?.type, .string)
+        XCTAssertEqual(locationSchema?.description, "The location to get the weather for, e.g. Bogor, Indonesia")
+        
+        let formatSchema = properties?["format"]
+        XCTAssertEqual(formatSchema?.description, "The format to return the weather in, e.g. 'celsius' or 'fahrenheit'")
+        XCTAssertEqual(formatSchema?.enumSchema?.values, [.string("celsius"), .string("fahrenheit")])
+        
+        XCTAssertEqual(objectSchema?.required, ["location", "format"])
+    }
+    
+    func testInvalidJSON() {
+        let invalidJsonString = "{ invalid json }"
+        
+        XCTAssertThrowsError(try JSONSchema(jsonString: invalidJsonString)) { error in
+            XCTAssertTrue(error is DecodingError)
+        }
+    }
+}