Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/f3ath/jessie
RFC 9535 - JSONPath: Query Expressions for JSON implementation in Dart
https://github.com/f3ath/jessie
dart hacktoberfest json json-path jsonpath stupidity
Last synced: 1 day ago
JSON representation
RFC 9535 - JSONPath: Query Expressions for JSON implementation in Dart
- Host: GitHub
- URL: https://github.com/f3ath/jessie
- Owner: f3ath
- License: mit
- Created: 2020-07-24T03:32:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-03T21:01:00.000Z (2 months ago)
- Last Synced: 2024-12-25T08:07:05.747Z (9 days ago)
- Topics: dart, hacktoberfest, json, json-path, jsonpath, stupidity
- Language: Dart
- Homepage: https://pub.dev/packages/json_path
- Size: 248 KB
- Stars: 37
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# RFC 9535 - [JSONPath]: Query Expressions for JSON in Dart
[](https://pub.dev/packages/json_path)
[](https://github.com/f3ath/jessie/issues)
[](https://github.com/f3ath/jessie/network)
[](https://github.com/f3ath/jessie/stargazers)
[](https://raw.githubusercontent.com/f3ath/jessie/master/LICENSE)
JSONPath defines a string syntax for selecting and extracting JSON (RFC 8259) values from within a given JSON value.
This library is a Dart implementation of the RFC 9535 [JsonPath] specification. It is also expected to pass the latest version
of the [Compliance Test Suite]. If you find a missing or incorrectly implemented feature, please open an issue.
For installation instructions and a detailed API documentation, see the [pub.dev page](https://pub.dev/packages/json_path).
### Usage example:
```dart
import 'dart:convert';
import 'package:json_path/json_path.dart';
void main() {
final json = jsonDecode('''
{
"store": {
"book": [
{
"category": "reference",
"author": "Nigel Rees",
"title": "Sayings of the Century",
"price": 8.95
},
{
"category": "fiction",
"author": "Evelyn Waugh",
"title": "Sword of Honour",
"price": 12.99
},
{
"category": "fiction",
"author": "Herman Melville",
"title": "Moby Dick",
"isbn": "0-553-21311-3",
"price": 8.99
},
{
"category": "fiction",
"author": "J. R. R. Tolkien",
"title": "The Lord of the Rings",
"isbn": "0-395-19395-8",
"price": 22.99
}
],
"bicycle": {
"color": "red",
"price": 19.95
}
}
}
''');
final prices = JsonPath(r'$..price');
print('All prices in the store:');
/// The following code will print:
///
/// $['store']['book'][0]['price']: 8.95
/// $['store']['book'][1]['price']: 12.99
/// $['store']['book'][2]['price']: 8.99
/// $['store']['book'][3]['price']: 22.99
/// $['store']['bicycle']['price']: 19.95
prices
.read(json)
.map((match) => '${match.path}:\t${match.value}')
.forEach(print);
}
```
## Data manipulation
Each `JsonPathMatch` produced by the `.read()` method contains the `.pointer` property which is a valid [JSON Pointer]
and can be used to alter the referenced value. If you only need to manipulate JSON data,
check out my [JSON Pointer implementation].
## User-defined functions
The JSONPath parser may be extended with user-defined functions. The user-defined functions
take precedence over the built-in ones specified by the standard. Currently, only
functions of 1 and 2 arguments are supported.
To create your own function:
1. Import `package:json_path/fun_sdk.dart`.
2. Create a class implementing either `Fun1` (1 argument) or `Fun2` (2 arguments).
To use it:
1. Create a new JsonPathParser with your function: `final parser = JsonPathParser(functions: [MyFunction()]);`
2. Use it to parse you expression: `final jsonPath = parser.parse(r'$[?my_function(@)]');`
For more details see the included example.
This package comes with some non-standard functions which you might find useful.
- `count()` - returns the number of nodes selected by the argument
- `index()` - returns the index under which the array element is referenced by the parent array
- `key()` - returns the key under which the object element is referenced by the parent object
- `is_array()` - returns true if the value is an array
- `is_boolean()` - returns true if the value is a boolean
- `is_number()` - returns true if the value is a number
- `is_object()` - returns true if the value is an object
- `is_string()` - returns true if the value is a string
- `reverse()` - reverses the string
- `siblings()` - returns the siblings for the nodes
- `xor(, )` - returns the XOR of two booleans arguments
To use them, import `package:json_path/fun_extra.dart` and supply them to the `JsonPath()` constructor:
```dart
final jsonPath = JsonPathParser(functions: [
const Key(),
const Reverse(),
]).parse(r'$[?key(@) == reverse(key(@))]');
```
## References
- [Standard development](https://github.com/ietf-wg-jsonpath/draft-ietf-jsonpath-base)
- [Feature comparison matrix](https://cburgmer.github.io/json-path-comparison/)
[Compliance Test Suite]: https://github.com/jsonpath-standard/jsonpath-compliance-test-suite
[JSONPath]: https://datatracker.ietf.org/doc/rfc9535/
[JSON Pointer]: https://datatracker.ietf.org/doc/html/rfc6901
[JSON Pointer implementation]: https://pub.dev/packages/rfc_6901