Skip to content
Ruby bindings for jq.
Ruby C
Branch: master
Clone or download
Latest commit 3796fb7 Jun 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ext Fix for rubocop Jun 24, 2019
lib Bump up vertion Jun 24, 2019
spec Fix for rubocop Jun 24, 2019
.gitignore add files Nov 13, 2013
.rspec Add .rspec Jul 12, 2015
.rubocop.yml Fix for rubocop Jun 24, 2019
.travis.yml Fix .travis.yml: Remove jq cache Jun 24, 2019
Gemfile Fix for rubocop Jun 24, 2019
LICENSE.txt add files Nov 13, 2013
README.md Fix README example code Jun 24, 2019
Rakefile Fix for rubocop Jun 24, 2019
ruby-jq.gemspec Fix for rubocop Jun 24, 2019

README.md

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
You can’t perform that action at this time.