https://github.com/uvlad7/ruby-jsoncons
Ruby gem that wraps jsoncons library
https://github.com/uvlad7/ruby-jsoncons
gem json json-parse json-parser json-parsing json-path jsonparser jsonpath ruby ruby-gem rubygem
Last synced: 3 months ago
JSON representation
Ruby gem that wraps jsoncons library
- Host: GitHub
- URL: https://github.com/uvlad7/ruby-jsoncons
- Owner: uvlad7
- License: mit
- Created: 2023-01-05T22:30:29.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-07T23:33:45.000Z (over 1 year ago)
- Last Synced: 2025-02-23T13:22:11.298Z (3 months ago)
- Topics: gem, json, json-parse, json-parser, json-parsing, json-path, jsonparser, jsonpath, ruby, ruby-gem, rubygem
- Language: Ruby
- Homepage: https://rubygems.org/gems/jsoncons
- Size: 87.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://badge.fury.io/rb/jsoncons)
# Jsoncons
This gem is a thin Ruby wrapper over a C++ [jsoncons](https://github.com/danielaparker/jsoncons) library.
But while the original library is designed as a multi-purpose tool for processing json and json-like data in C++, in the Ruby world, most of these features are not needed.
We already have libraries like Json, CSV, Bson and JMESPath, designed for Ruby and following its style.
But [JsonPath](https://goessner.net/articles/JsonPath/) support is [missing](https://cburgmer.github.io/json-path-comparison/).
The [existing library](https://github.com/joshbuddy/jsonpath) is really slow and contains a lot of bugs.
So, the purpose of this gem is to access the power of a well-crafted already existing solution at the cost of the inconvenience of C++ style in Ruby.
Wrappers for other features, as well as Ruby-style data converters, will probably never be created.
But if you believe that these features might be useful, feel free to open an issue or start a discussion. Pull requests are welcome, too.
The [latest version](https://github.com/danielaparker/jsoncons/tree/73c85182dc56d4441cdcd97255b23aa6f15b9121) of the library was used to build the [current version](https://github.com/uvlad7/ruby-jsoncons/releases/tag/v0.1.0) of the gem.
New versions of the gem will target the latest releases of the library, but you cat still try to build it with an older version or your custom version.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'jsoncons'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install jsoncons
Or, if you downloaded the sources:
$ rake install
If you want to install the gem with a different version of the `jsoncons` library, you can use the following commands:
$ gem install jsoncons -- --with-jsoncons-dir=/path/to/jsoncons
or
$ gem install jsoncons -- --with-jsoncons-include=/path/to/jsoncons/include
or when building from source
$ CONFIGURE_ARGS='--with-jsoncons-dir=/path/to/jsoncons' rake install
## Usage
[Tests](https://github.com/uvlad7/ruby-jsoncons/blob/master/test/jsoncons_test.rb) are the best example
Parse data from [this example](https://github.com/danielaparker/jsoncons/blob/master/doc/ref/jsonpath/json_query.md)
```ruby
require 'jsoncons'
data = Jsoncons::Json.parse(File.read("store.json"))
# => {"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}]}}
# The authors of books that are cheaper than $10
data.query("$.store.book[?(@.price < 10)].author")
# => ["Nigel Rees","Herman Melville"]
# The number of books
data.query("length($..book)")
# => [1]
# The third book
data.query("$..book[2]")
# => [{"category":"fiction","author":"Herman Melville","title":"Moby Dick","isbn":"0-553-21311-3","price":8.99}]
# All books whose author's name starts with Evelyn (C++ regex)
data.query("$.store.book[?(@.author =~ /Evelyn.*?/)]")
# => [{"category":"fiction","author":"Evelyn Waugh","title":"Sword of Honour","price":12.99}]
# The titles of all books that have isbn number
data.query("$..book[?(@.isbn)].title")
# => ["Moby Dick","The Lord of the Rings"]
# And so on
```
Please note that this is the very first version of the gem and its API is likely to change in the future.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/uvlad7/jsoncons.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).