Project

qig

0.0
There's a lot of open issues
Combining the powers of `dig` and `jq`
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies
 Project Readme

Qig

Gem Version CircleCI

qig is dig extended with jq's "value iterator" [] operator and some other goodies.

Usage

Qig.qig(subject, *path) # => contents of subject at path

examples:

# dig-like usage
Qig.qig({ a: { b: { c: 1 } } }, :a, :b, :c) # => 1

# dig-like usage augmented with jq's [] operator
Qig.qig({ a: { b: [{ c: 1 }, { c: 2 }] } }, :a, :b, [], :c) # => [1, 2]

# after expanding values, collect them back into an array for indexing into with `[[]]`
Qig.qig({ a: { b: [{ c: 1 }, { c: 2 }] } }, :a, :b, [], :c, [[]], 1) # => 2

More documentation in the literate specs

Features

  • compatible with dig (see (dig conformance specs)[spec/literate/qig/02_conformance/dig_conformance_spec.rb])
  • jq-like value iteration ([] operator)
  • invoke ruby methods during inside the filter chain
  • value collect: [[]], inverse of the [] operator. Collect streamed values back into an array
  • Qig::Qiggable mixin for more dig-like subject.qig(*path) syntax
  • works with lazy collections
  • extensive literate specs

Installation

Add this line to your application's Gemfile:

gem 'qig'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install qig

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/NAR8789/qig-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Qig project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.