https://github.com/g-mark/SwiftPath

JSONPath for Swift
https://github.com/g-mark/SwiftPath

json jsonpath swift

Last synced: 28 days ago
JSON representation

JSONPath for Swift

• Host: GitHub
• URL: https://github.com/g-mark/SwiftPath
• Owner: g-mark
• License: mit
• Created: 2017-08-21T19:28:21.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2023-07-08T16:40:47.000Z (over 1 year ago)
• Last Synced: 2024-11-28T20:25:35.490Z (28 days ago)
• Topics: json, jsonpath, swift
• Language: Swift
• Size: 105 KB
• Stars: 57
• Watchers: 6
• Forks: 15
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SwiftPath

[![Build Status](https://travis-ci.org/g-mark/SwiftPath.svg?branch=develop)](https://travis-ci.org/g-mark/SwiftPath)

[![Swift 4.2-5.3 compatible](https://img.shields.io/badge/Swift%204.2%20--%205.3-compatible-4BC51D.svg?style=flat)](https://developer.apple.com/swift)

[![swift-package-manager](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)

[![CocoaPods compatible](https://img.shields.io/cocoapods/v/SwiftPath.svg)](https://cocoapods.org/pods/SwiftPath)

[![License: MIT](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/g-mark/SwiftPath/master/LICENSE)

JSONPath for Swift

### Problem

Sometimes, you don't want to hard-code the mapping from JSON to your model. You may want a generic way to model data from different sources. You may want to be able to update your remote data structure without having to update your app binary.

### Solution

SwiftPath allows you to keep your data source **and** your data mapping dynamic.

## Installation

SwiftPath is available through [CocoaPods](http://cocoapods.org) and [Carthage](https://github.com/Carthage/Carthage).

### CocoaPods

```ruby

pod "SwiftPath"

```

### Carthage

```

github "g-mark/SwiftPath" "master"

```

## Documentation

SwiftPath is a Swift implementation of JSONPath, which allows you to extract a subset of data from a larger chunk of JSON.

### Sipmle usage

### Wildcards

You can add a wildcard to objects to convert the current object to an array of it's values:

```js

// Given:

{

  "books" : {

    "one" : { "title": "one" },

    "two" : { "title": "two" },

    "three" : { "title": "three" }

  }

}

// When using this path:

$.books.*

// Then you'll get this output:

[ { "title": "one" }, { "title": "two" }, { "title": "three" } ]

```

### Mapping properties

This is a difference from the JSONPath 'spec'.  With SwiftPath, you can re-map property names to match your model in code.  When collecting a subset of properties, you can do things like this (renamning the `value` property to `id`):

```js

// Given:

[

  {"name": "one", "value": 1, "extra": true },

  {"name": "one", "value": 2, "extra": true },

  {"name": "one", "value": 3, "extra": true }

]

// When using this path:

$['name', 'value'=>'id']

// Then you'll get this output:

[

  {"name": "one", "id": 1 },

  {"name": "one", "id": 2 },

  {"name": "one", "id": 3 }

]

```

## Publishing

To publish a new version of SwiftPath:

1. Update version number in `SwiftPath.podspec`

1. Create a release branch off of `production` with version: e.g., `release/#.#.#`

1. Merge `develop` into release/version branch

1. Create PR into `production` from release/version branch

1. Once CI passess, tag it with `#.#.#`, merge into `production`, and delete the release/version branch

1. Run `pod trunk push SwiftLint.podspec`