yq 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b006998403bcb560004a4796d7d62d959eabb2c1
-  data.tar.gz: 77b6a955d63ffdb64c4cb3ae8af5866fc736b165
+  metadata.gz: 3e23c35d91bbddf1f3e3dfa4a8de8059899303c7
+  data.tar.gz: f5afc4871b9483ce357dcf4d857595e7c46e3aa6
 SHA512:
-  metadata.gz: c397cc7308ffb55641a523f7be3a0c411bc7e8f267f7b604bd3a9fcac989256817a205caa1b749822eb698e3c70059dd6b73106a2880a376744c17d8484a25e6
-  data.tar.gz: 5aaba3f55ea899c0b53099d4042555bf8c828b6cefe81f4d0700fb0034339b1846e3c426600a093a603a96471b2a4ff2b858b2bc6d1efedec30f7f89deb0f4ff
+  metadata.gz: 9a0deb2bbf42f6e90fa203cc51ddd8927b5ad4813c6c9a078ae983ee5425b35c6d662cf577089bb408997be8641a6de94f02f3efc382f635f85278eafa210cbb
+  data.tar.gz: cd2a097c740d0d9309cd04e67fedbe0b2522926ee89e992cb2ee2635e5bfb5bfa01d90d994773d2b4edae4e12055736cf94cc5ab9d0c2aa1a6df209365fb14df

data/.gitignore

@@ -115,3 +115,5 @@ Gemfile.lock
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
+spec/helpers/failures.txt
+

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'jmespath'
+gem 'contracts'
 
 group :development, :test do 
   gem 'pry'

data/README.md

@@ -1,6 +1,6 @@
 # Yq
 
-TODO: Write a gem description
+Use `yq` to parse YAML documents using [JMESPath](http://jmespath.org/). This gem is a simple wrapper around the [jmespath gem](https://github.com/jmespath/jmespath.rb). 
 
 ## Installation
 
@@ -20,7 +20,20 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+`yq` takes input from STDIN: 
+
+```
+$ cat stuff.yml | yq '.'
+---
+stuff:
+  foo: 
+    bar: baz
+   
+$ cat stuff.yml | yq 'stuff.foo'
+---
+bar: baz
+    
+```
 
 ## Contributing
 

data/bin/yq

@@ -43,8 +43,10 @@ def prereqs
     raise "#{v} must be specified in the environment variables" unless ENV[v]
   end
 
+  raise "jq not installed" unless Yq.which('jq')
 end
 
+
 def start
   begin
     @yaml = $stdin.read
@@ -66,7 +68,6 @@ def develop
   LOGGER.level = Logger::DEBUG
   LOGGER.info "Develop mode"
   start
-  binding.pry
 end
 
 def main_loop

data/lib/yq/version.rb

@@ -1,3 +1,3 @@
 module Yq
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/lib/yq.rb

@@ -1,19 +1,67 @@
 require "yq/version"
-require 'jmespath'
+require 'open3'
+require 'contracts'
 require 'stringio'
 require 'yaml'
+require 'json'
+require 'timeout'
 
 module Yq
+  def self.which(cmd)
+    exts = ENV['PATH'] ? ENV['PATH'].split(':') : ['']
+    exts.each { |ext|
+      exe = File.join(ext, cmd)
+      return exe if File.executable?(exe) && !File.directory?(exe)
+    }
+    return nil
+  end
+
   def self.search_yaml(query, yaml)
-    hash = yaml_to_hash(yaml)
-    resp_hash = search(query, hash)
-    resp_yaml = hash_to_yaml(resp_hash)
+    req_json = yaml_to_json(yaml)
+    resp_json = search(query, req_json)
+    resp_yaml = json_to_yaml(resp_json)
     return resp_yaml
   end
 
-  def self.search(query, hash)
-    return hash if query == '.'
-    JMESPath.search(query, hash)
+  def self.search(query, json)
+    cmd = which('jq') + %Q[ '#{query}']
+    input = json
+    output = ""
+    LOGGER.debug "sending jq #{cmd}"
+
+    Open3.popen2(cmd) do |i, o, t|
+      begin
+        pid = t.pid
+
+        if input
+          i.puts input
+          i.close
+        end
+
+        Timeout.timeout(5) do
+          o.each { |v|
+            output << v
+          }
+        end
+      rescue Timeout::Error
+        LOGGER.warn "Timing out #{t.inspect} after 1 second"
+        Process.kill(15, pid)
+      ensure
+        status = t.value
+        raise "JQ failed to exit cleanly" unless status.success?
+      end
+    end
+    return output
+  end
+
+  def self.yaml_to_json(yaml)
+    a = yaml_to_hash(yaml)
+    hash_to_json(a)
+  end
+
+  def self.json_to_yaml(json)
+    a = json_to_hash(json)
+    hash_to_yaml(a)
   end
 
   def self.yaml_to_hash(yaml)
@@ -23,4 +71,12 @@ module Yq
   def self.hash_to_yaml(hash)
     hash.to_yaml
   end
+
+  def self.json_to_hash(json)
+    JSON.parse(json)
+  end
+
+  def self.hash_to_json(hash)
+    hash.to_json
+  end
 end

data/spec/spec_helper.rb

@@ -27,7 +27,7 @@ RSpec.configure do |config|
     config.default_formatter = 'doc'
   end
 
-  config.order = :random
+  config.example_status_persistence_file_path = File.join(SPEC_ROOT, 'helpers', 'failures.txt')
 
   Kernel.srand config.seed
 end

data/spec/yq_bin_spec.rb

@@ -56,16 +56,15 @@ describe 'bin/yq' do
     expect(status).to be_success
   end
 
-  context 'parses' do
-    let(:query) { 'foo.bar' }
+  describe 'parses' do
     let(:yaml) { <<-EOF }
 foo:
   bar:
     baz: value
 EOF
 
-    it 'foo.bar' do
-      out_err, status = run_bin(query, yaml)
+    it '.foo.bar' do
+      out_err, status = run_bin('.foo.bar', yaml)
       expect(out_err).to match('baz: value')
       expect(status).to be_success
     end

data/spec/yq_spec.rb

@@ -1,48 +1,93 @@
 describe Yq do
   subject { described_class }
 
-  let(:query) { 'foo.bar' }
-
-  let (:hash) {
+  let(:hash) {
     { "foo" => { "bar" => { "baz" => "value" }}}
   }
 
-  let (:yaml) {<<EOF}
+  let(:yaml) {<<EOF}
 foo:
   bar:
     baz: value
 EOF
 
-  describe '#search' do
-    subject { described_class.search(query, hash) }
+  let(:json) {<<EOF.chomp}
+{"foo":{"bar":{"baz":"value"}}}
+EOF
+
+  let(:jq_response) {<<EOF}
+{
+  "baz": "value"
+}
+EOF
+
+  describe '.search' do
+    subject { described_class.search('.foo.bar', json) }
 
-    it { is_expected.to match("baz" => "value") }
+    it { is_expected.to match(jq_response) }
 
-    it 'passes it through to JMESPath' do
-      expect(JMESPath).to receive(:search).with(query, hash)
+    it 'passes it through to jq' do
+      allow(Yq).to receive(:which).with('jq').and_return('/bin/jq')
+      expect(Open3).to receive(:popen2).with('/bin/jq .foo.bar').and_return(jq_response)
       subject
     end
 
-    describe "'.'" do
-      subject { described_class.search('.', hash) }
-      it { is_expected.to match(hash) }
+    subject { described_class.search'.foobar', json }
+
+    it 'stops processing when jq exits uncleanly' do
+      # not mocking at this level, see implementation
     end
   end
 
-  describe '#yaml_to_hash' do
+  describe '.yaml_to_hash' do
     subject { described_class.yaml_to_hash(yaml) }
     it { is_expected.to match(hash) }
   end
 
-  describe '#hash_to_yaml' do
+  describe '.hash_to_yaml' do
     subject { described_class.hash_to_yaml(hash) }
     it { is_expected.to match(yaml) }
   end
 
-  describe '#search_yaml' do
-    subject { described_class.search_yaml(query, yaml) }
+  describe '.yaml_to_json' do
+    subject { described_class.yaml_to_json(yaml) }
+    it { is_expected.to match(json) }
+  end
+
+  describe '.json_to_yaml' do
+    subject { described_class.json_to_yaml(json) }
+    it { is_expected.to match(yaml) }
+  end
+
+  describe '.search_yaml' do
+    subject { described_class.search_yaml('.foo.bar', yaml) }
 
     it { is_expected.to match("baz: value") }
   end
 
+
+  describe '.which' do
+    subject { described_class.which('jq') }
+
+    before(:each) {
+      allow(ENV).to receive(:[]).with('PATH').and_return("/bin:/other/bin")
+      allow(File).to receive(:executable?).with("/bin/jq").and_return(false)
+      allow(File).to receive(:directory?).with("/bin/jq").and_return(false)
+      allow(File).to receive(:directory?).with("/other/bin/jq").and_return(false)
+    }
+
+    context 'but it does not exist' do
+      before(:each) {
+        allow(File).to receive(:executable?).with("/other/bin/jq").and_return(false)
+      }
+      it  { is_expected.to be_falsey }
+    end
+
+    context 'and it does exist' do
+      before(:each) {
+        allow(File).to receive(:executable?).with("/other/bin/jq").and_return(true)
+      }
+      it  { is_expected.to eq('/other/bin/jq') }
+    end
+  end
 end

data/yq.gemspec

@@ -18,8 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'jmespath'
-
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", '~> 3.3'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: yq
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jim Park
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-09-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: jmespath
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement