Alembic - GitLite

KO | EN

gitlite — search

#python #ai #typescript #llm #go #machine-learning #rust #deep-learning #linux #docker #nodejs #java #vue #openai

Alembic

(★ 117)

:alembic: Functional JSON Parser - Linux Ready :penguin:

파일 탐색기

최종 버전 다운로드 (.zip)

- - contents.xcworkspacedata
- contents.xcplayground
- - contents.xcworkspacedata
- project.pbxproj
- - IDEWorkspaceChecks.plist
- contents.xcworkspacedata
- Alembic_Logo.png
- install_swiftlint.sh
- test_linux.sh
- Error.swift
- Info.plist
- JSON.swift
- OptionalProtocol.swift
- Parsable.swift
- ParseInitializable.swift
- Parser.swift
- ParserProtocol.swift
- Path.swift
- ThrowParser.swift
- - ErrorTest.swift
  - Info.plist
  - JSONTest.swift
  - OptionTest.swift
  - ParserTest.swift
  - ParseTest.swift
  - PathTest.swift
  - ThrowParserTest.swift
  - ValueTest.swift
- LinuxMain.swift
.gitignore
.swift-version
.swiftlint.yml
.travis.yml
Alembic.podspec
Gemfile
Gemfile.lock
LICENSE
Makefile
Package.swift
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/ra1028/Alembic

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd Alembic

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Ruby

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Ruby bundle 명령어를 쓰려면 Ruby가 필요합니다.

bundle install

Gemfile에 명시된 루비 라이브러리를 설치합니다.

✅ bundle install이 에러 없이 끝나면 README에 안내된 실행 명령어(예: rails server)로 마저 실행해보세요.

3. Make

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.

make

생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.

✅ 에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
<img src="https://raw.githubusercontent.com/ra1028/Alembic/master/Assets/Alembic_Logo.png" alt="Alembic" width="70%">
</p>
<H4 align="center">Functional JSON Parser</H4>
</br>

<p align="center">
<a href="https://developer.apple.com/swift"><img alt="Swift4" src="https://img.shields.io/badge/language-swift4-orange.svg?style=flat"/></a>
<a href="https://travis-ci.org/ra1028/Alembic"><img alt="Build Status" src="https://travis-ci.org/ra1028/Alembic.svg?branch=master"/></a>
<a href="https://codebeat.co/projects/github-com-ra1028-alembic"><img alt="CodeBeat" src="https://codebeat.co/badges/09cc20c0-4cba-4c78-8e20-39f41d86c587"/></a>
</p>
</br>

<p align="center">
<a href="https://cocoapods.org/pods/Alembic"><img alt="CocoaPods" src="https://img.shields.io/cocoapods/v/Alembic.svg"/></a>
<a href="https://github.com/Carthage/Carthage"><img alt="Carthage" src="https://img.shields.io/badge/Carthage-compatible-yellow.svg?style=flat"/></a>
<a href="https://github.com/apple/swift-package-manager"><img alt="Swift Package Manager" src="https://img.shields.io/badge/SwiftPM-compatible-blue.svg"/></a>
</p>
</br>

<p align="center">
<a href="https://developer.apple.com/swift/"><img alt="Platform" src="https://img.shields.io/badge/platform-iOS%20%7C%20OSX%20%7C%20tvOS%20%7C%20watchOS%20%7C%20Linux-green.svg"/></a>
<a href="https://github.com/ra1028/Alembic/blob/master/LICENSE"><img alt="Lincense" src="http://img.shields.io/badge/license-MIT-000000.svg?style=flat"/></a>
</p>

---

## Feature
- Linux Ready
- Type-safe JSON parsing
- Functional value transformation
- Easy to parse nested value
- Dependency free
- No defined custom operators

---

## Requirements
- Swift4.1 or later
- OS X 10.9 or later
- iOS 9.0 or later
- watchOS 2.0 or later
- tvOS 9.0 or later
- Linux

---

## Installation

### [CocoaPods](https://cocoapods.org/)  
Add the following to your Podfile:  
```ruby
use_frameworks!

target 'TargetName' do
  pod 'Alembic'
end
```

### [Carthage](https://github.com/Carthage/Carthage)  
Add the following to your Cartfile:  
```ruby
github "ra1028/Alembic"
```

### [Swift Package Manager](https://github.com/apple/swift-package-manager)
Add the following to your Package.swift:  
```Swift
// swift-tools-version:4.0

let package = Package(
    name: "ProjectName",
    dependencies : [
        .package(url: "https://github.com/ra1028/Alembic.git", .upToNextMajor(from: "3"))
    ]
)
```

---

## Example  
In example, parse the following JSON:  
```json
{
    "teams": [
        {
            "name": "Team ra1028",
            "url": "https://github.com/ra1028",
            "members": [
                {
                    "name": "Ryo Aoyama",
                    "age": 23
                },
                {
                    "name": "John Doe",
                    "age": 30
                }
            ]
        }
    ]
}
```

#### Make the JSON instance from `Any`, `Data` or `String` type JSON object.
```swift
// from `Any` type JSON object
let json = JSON(object)
```
```swift
// from JSON Data
let json = try JSON(data: data)
```
```swift
// from JSON String
let json = try JSON(string: string)
```

#### Parse value from JSON:
__Parse the values type-safely__
```swift
let memberName: String = try json.value(for: ["teams", 0, "members", 0, "name"])
```
__Parse nullable value__
```swift
let missingText: String? = try json.option(for: "missingKey")
```

#### Parse value from JSON with transforming:
__Transform value using various monadic functions.__
```swift
let teamUrl: URL = try json.parse(String.self, for: ["teams", 0, "url"])
        .filterMap(URL.init(string:))
        .value()
```
__Transform nullable value if exist__
```swift
let missingUrl: URL? = try json.parse(String.self, for: "missingKey")
        .filterMap(URL.init(string:))
        .option()
```

#### Mapping to model from JSON:
__All types conforming to `Parsable` protocol and it's Array, Dictionary can be parsed.__  
```swift
struct Member: Parsable {
    let name: String
    let age: Int

static func value(from json: JSON) throws -> Member {
        return try .init(
            name: json.value(for: "name"),
            age: json.value(for: "age")
        )
    }
}

extension URL: Parsable {
    public static func value(from json: JSON) throws -> URL {
        guard let url = try URL(string: json.value()) else {
            throw JSON.Error.dataCorrupted(value: json.rawValue, description: "The value was not valid url string.")
        }
        return url
    }
}

struct Team: Parsable {
    let name: String
    let url: URL
    let members: [Member]

static func value(from json: JSON) throws -> Team {
        return try .init(
            name: json.value(for: "name"),
            url: json.value(for: "url"),
            members: json.value(for: "members")
        )
    }
}
```
```swift
let team: Team = try json.value(for: ["teams", 0])
```

---

## Tips
#### The types conformed to `Parsable` as default.  
```swift
JSON
String
Int
UInt
Double
Float
Bool
NSNumber
Int8
UInt8
Int16
UInt16
Int32
UInt32
Int64
UInt64
Decimal
Array where Element: Parsable
Dictionary where Key == String, Value: Parsable
Optional where Wrapped: Parsable
```

#### Conform to `Parsable` with initializer
```swift
struct Member: ParseInitializable {
    let name: String
    let age: Int

init(with json: JSON) throws {
        name = try json.value(for: "name")
        age = try json.value(for: "age")
    }
}
```

#### Usage Reference Files
Functional operators for value transforming:
- [ParserProtocol.swift](./Sources/ParserProtocol.swift)
- [Parser.swift](./Sources/Parser.swift)
- [ThrowParser.swift](./Sources/ThrowParser.swift)

Errors
- [Error.swift](./Sources/Error.swift)

#### More Example
See the [Test files](./Tests/AlembicTests)

---

## Playground
1. Open Alembic.xcworkspace.
2. Build the Alembic for Mac.
3. Open Alembic playground in project navigator.

---

## Contribution
Welcome to fork and submit pull requests!

Before submitting pull request, please ensure you have passed the included tests.
If your pull request including new function, please write test cases for it.

---

## License
Alembic is released under the MIT License.

---