Project

ruby-jq

0.05
No release in over 3 years
Low commit activity in last 3 years
There's a lot of open issues
Ruby bindings for jq
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

 Project Readme

ruby-jq

Ruby bindings for jq.

see http://stedolan.github.io/jq/.

Gem Version Build Status

Prerequisites

jq requires the Oniguruma library to provide regex support. To install Oniguruma for your system, please follow the instructions in the jq FAQ.

Installation

Add this line to your application's Gemfile:

gem 'ruby-jq'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ruby-jq

Using system libraries

By default, ruby-jq downloads and compiles its own version of libjq. If you would like to use your own version of libjq, you can skip this process by passing the --use-system-libraries flag to gem install, or by setting the RUBYJQ_USE_SYSTEM_LIBRARIES env var.

Usage

require 'jq'

src = <<EOS
[
  "FOO",
  {
    "BAR": [100, 200]
  },
  1.23,
  [1, "2", 3]
]
EOS

jq = JQ(src)

jq.search('.[]') do |value|
  p value
  # => "FOO"
  # => {"BAR"=>[100, 200]}
  # => 1.23
  # => [1, "2", 3]
end

p jq.search('.[]')
# => ["FOO", {"BAR"=>[100, 200]}, 1.23, [1, "2", 3]]

jq = JQ(src, parse_json: false)

jq.search('.[1].BAR') do |value|
  p value
  # => "[100,200]"
end

Query for Hash/Array

require 'jq/extend'

p {'FOO' => 100, 'BAR' => [200, 200]}.jq('.BAR[]')
# => [200, 200]

['FOO', 100, 'BAR', [200, 200]].jq('.[3][]') do |value|
  p value
  # => 200
end