Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/julianalonso/jasoon
Swift JSON parsing library
https://github.com/julianalonso/jasoon
json json-parser parsing parsing-library swift swift3
Last synced: 16 days ago
JSON representation
Swift JSON parsing library
- Host: GitHub
- URL: https://github.com/julianalonso/jasoon
- Owner: JulianAlonso
- License: mit
- Created: 2017-03-23T02:42:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-04T20:30:55.000Z (about 6 years ago)
- Last Synced: 2024-10-30T19:06:56.832Z (16 days ago)
- Topics: json, json-parser, parsing, parsing-library, swift, swift3
- Language: Swift
- Size: 30.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JASOON
[](http://cocoapods.org/pods/JASON)
[](http://cocoapods.org/pods/JASON)
## What?
So simple, library to parse JSON Objects.
## Where is the value?
Provide very useful errors, with them you will know what value is missing and from where. If you are parsing some property to one object wich property is not optional, the error will tell you what property is and what object. Forgot spend time debugging to find out the error.
Also will tell you if the error is a type error. If you are parsing a string to int, it will fail and also will tell you where and why.
Debugging JSON parsing never has been so easy.
### Really simple to use.
To make objects created by json you only need implement `ExpressibleByJSON` like this:
```
struct Person {
let name: String
let age: Int
}
extension Person: ExpressibleByJSON {
init(_ json: JSON) throws {
self.name = try json <<< "name"
self.age = try json <<< "age"
}
}
```
Then create the object:
```
session.dataTaskWithRequest(someRequest) { data, response, error in
if let data = data {
do {
let json = try JSON(data)
let person = try Person(json)
} catch {
//Elevate error...
}
}
}
```
## Forgot optional types.
Yes, right now, you can forgot parsing json like this:
```swift
if let string = json["string"] as? String {
//Do something...
}
```
JASON works with operators, `<<<` for all types and `<<` for optional types.
The usage its simply, get the JSON object (provided by JASON), and get fields.
If you want a string:
`let string = try json <<< "name" as String`, (if the type is previus declarated like in classes or structs, you dont need the as keyword `self.name = try json <<< "name"`)
And optional types are the same, but using the optional operator that not throws an error.
`let optionalString: String? = json << "name"`
JASON also will infer types for us, any type that implements `ExpressibleByJSON` or `ConvertibleFromJSON` can be parsed, by this way, all the types that you want can be parsed.
This allow us to have nested types, parse arrays and dictionarys in the most simple way possible and of course, on failing cases will provide us **very useful debug info**
**¿Why throwing?**
We know that some type requires some fiels, and some fields aren't optional, when we got that situation, why we unwrapp optionals all the time?
We spent a lot of time taking care about this errors, processing them, logging some info...
We don't need optional types when types aren't optional, we need not optional types, then we throw very **useful** errors.
When we parse JSON objects and the parsing process fails, we want get info about the error, something like `required field "name" not found`, or `trying cast String to Int`, whatever... But we not only want this, when we are making complex request with nested objects, we also want know what object has failed. JASON provide all that data for us.
When something fail, the error will print `required field "name" not found at Person.self` for example.
## Extending framework types.
Yes, you can directly parse Foundation or whatever framework type. URL for example. We want cast strings into URL directly then...
```swift
///Create an extension of type implementing ConvertibleFromJSON
extension URL: ConvertibleFromJSON {
/// We only need the method from(_, at:), with this, we create the URL
/// casting the given data, and taking care about possible casting errors.
///
/// at: String its provided to us to bring the possiblity of give information about the parsing object.
public static func from(_ object: Any, at: String) throws -> URL {
guard let string = object as? String else {
throw JASONError.TryingCast(object: object, to: "String", at: at)
}
guard let url = URL(string: string) else {
throw JASONError.TryingCast(object: object, to: "URL", at: at)
}
return url
}
}
```
## Your custom types
And when we have nested objects, our objest only need implement `ExpressibleByJSON`, like `Person` declared above.
Then we can parse `Persons` like parse `String`
```
let person: Person = try json <<< "person"
```
And not only that!
JASON also will parse for you arrays of persons if you want. when you have a JSON like this...
```json
{
"employees": [{
"name": "Ram",
"email": "[email protected]",
"age": 23
}, {
"name": "Shyam",
"email": "[email protected]",
"age": 28
}, {
"name": "John",
"email": "[email protected]",
"age": 33
}, {
"name": "Bob",
"email": "[email protected]",
"age": 41
}]
}
```
We only do this:
```swift
let employees: [Employee] = try json <<< "employees"
```
And all work done.
## No key needed
If your json data comes without key, you can parse it too.
```json
[{
"name": "Ram",
"email": "[email protected]",
"age": 23
}, {
"name": "Shyam",
"email": "[email protected]",
"age": 28
}, {
"name": "John",
"email": "[email protected]",
"age": 33
}, {
"name": "Bob",
"email": "[email protected]",
"age": 41
}]
```
```swift
let employees = try json<<< as [Employee]
```
## Installation
JASOON is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod "JASOON"
```
## Author
Julián Alonso, [email protected]
## License
JASON is available under the MIT license. See the LICENSE file for more info.