jeg 0.2.1

data/LICENSE

@@ -0,0 +1,10 @@
+THE DRINK-WARE LICENSE (forked from BEER-WARE r42)
+
+Gabriele Renzi (http://www.riffraff.info) 
+wrote this code, whereas not specified otherwise. 
+
+As long as you retain this notice you can do whatever you want with this stuff. 
+If we meet some day, and you think this stuff is worth it, you can buy me 
+a beer, coffee, palinka shot or any other drink in return.
+
+

data/README.mkd

@@ -0,0 +1,80 @@
+jeg, a json grep
+===========
+
+Jeg was born from the repeated annoyance of trying to quickly glance at
+some JSON-fomatted data and being unable to really get it, then have to
+pass it through a javascript formatter and then later go and trying to
+find the data that I alread know was under the "name" field but was
+impossible to discern in a 800 character single line string.
+
+Ah, how I craved for the simplicty of tabular data that I could slice
+and dice with grep and cut.
+
+Thus, Jeg was born.
+
+So what is it, concretely?
+--------------------------
+
+Simply put, it allows you to select parts of a json structure using
+JSONPath. For example, if you want to find a user's real name on twitter  from
+this
+
+    {"url":"http://www.riffraff.info","description":"Code Monkey, Professional Student, Geek","time_zone":"Rome","profile_sidebar_fill_color":"e0ff92","status":{"in_reply_to_user_id":null,"in_reply_to_status_id":null,"in_reply_to_screen_name":null,"created_at":"Sun Jan 24 16:16:28 +0000 2010","source":"<a href=\"http://www.tweetdeck.com/\" rel=\"nofollow\">TweetDeck</a>","truncated":false,"id":8153979023,"favorited":false,"text":"darn I have to publish a forked gem, and can't understand the state of the art in how to do so :("},"statuses_count":447,"created_at":"Tue Jan 02 11:27:37 +0000 2007","profile_sidebar_border_color":"87bc44","contributors_enabled":false,"favourites_count":3,"followers_count":142,"profile_image_url":"http://a3.twimg.com/profile_images/88180929/nyussi_normal.jpg","profile_text_color":"000000","lang":"en","geo_enabled":true,"notifications":null,"profile_background_image_url":"http://s.twimg.com/a/1264119427/images/themes/theme1/bg.png","friends_count":171,"protected":false,"screen_name":"riffraff","following":null,"profile_link_color":"0000ff","location":"milan/rome/budapest","name":"gabriele renzi","verified":false,"profile_background_tile":false,"id":446303,"utc_offset":3600,"profile_background_color":"9ae4e8"
+
+
+you can simply query the api via curl and use jeg to extract the name
+field:
+    
+    $ curl  http://twitter.com/users/show.json?screen_name=riffraff -s | jeg name
+      gabriele renzi
+
+Or if you want the 'text' fields in a list of objects from the Cascaad
+APIs
+
+    $ curl api.cascaad.com/2/messages/latest.json?type=NEWS -s  | jeg $..text
+      counter the Tea Party movement, which is abt stopping things, with Innovation Movement, which is abt starting things.  http://bit.ly/4o35m4
+      Bringing Silicon Valley to Sacramento: Why Entrepreneurs Need to Help Rebuild California's IT Systems http://tcrn.ch/8pD3Ki by @vwadhwa
+      Spectacular Thomas Friedman OpEd on making 2010 the Year of Innovation and Start-Up America  - http://nyti.ms/4qk8Jh
+
+
+
+Just this?
+----------
+
+Well, a bit more, see `jeg -h`
+
+
+Installation
+------------
+
+Jeg depends on the riffraff_jsonpath and json libraries.
+The former is a small fork of the original jsonpath gem without warnings and with a couple of tiny fixes.
+
+You can  just dump the single `jeg` script in some directory in your path and make it executable to install it, 
+or you can user rubygems
+    
+    gem install jeg
+
+And that's it. 
+
+Running the tests
+-----------------
+As of now no unit tests were written but the command line examples are extracted and executed by
+the code in `test/` (if you have a checkout and you are reading this file) just run them with 
+ruby having the script in your path, or use `rake test` you shall see something like
+
+    Loaded suite test/docs
+    Started
+    ...............
+    Finished in 9.999814 seconds.
+
+    15 tests, 15 assertions, 0 failures, 0 errors
+
+If you don't please report it at http://github.com/riffraff/jeg/issues
+
+License
+-------
+
+jeg is free software (pretend you wrote it, sell it for huge profit) but see
+accompanying LICENSE file for the full text of the license.
+

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'rake'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "jeg"
+    s.executables = "jeg"
+    s.summary = "jeg a json grep"
+    s.email = "rff.rff@gmail.com"
+    s.homepage = "http://github.com/riffraff/jeg"
+    s.description = "A command line tool to slice and dice JSON-encoded data as simple a structured text format"
+    s.authors = ["Gabriele Renzi"]
+    s.files =  FileList["**/*"]
+    s.add_dependency 'riffraff_jsonpath'
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*.rb']
+  t.verbose = true
+end
+
+

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/bin/jeg

@@ -0,0 +1,158 @@
+#!/usr/bin/env ruby -w
+# vim: syntax=ruby ts=2 sts=2 expandtab
+#
+
+require 'rubygems'
+require 'json'
+require 'jsonpath'
+require 'optparse'
+
+class Jeg
+  Version = 0.2
+
+  attr :options
+  attr :input
+
+  def mk_expr(v)
+    v = '.'+v if v =~ /^\w/
+    v = "$"+v if v =~ /^\./
+    v
+  end
+
+  def initialize(arguments=ARGV, input=ARGF)
+    @input = input
+    @options = {:format=>:smart}
+    OptionParser.new(arguments) do |opts|
+      opts.banner = <<-Banner
+    Usage: jeg [options] [file]"
+
+    jeg interprets JSONPath queries on a JSON stream (line-separated blocks).
+    It is designed for quick & dirty work so it assumes things for you.
+    The default output (--smart) will print simple strings if the result is a single basic type, one per line
+    (grep style) while if the match is structured data it will be presented as json. 
+    Also, by default if the JSONPath expression does not start with $. (top element) it will be added automatically.
+    You can override this with a switch.
+
+    Examples:
+      Select a top level field in top struct
+        {"text":"babble babble"} | jeg -e $.text => babble babble
+        {"text":"babble babble"} | jeg -e $.text -f json => ["babble babble"]
+        {"text":"babble babble"} | jeg -e $.text -f ruby => ["babble babble"]
+        {"obj":{"key":"value","index":1}} | jeg -e $.obj -f smart => {"index":1,"key":"value"}
+        {"obj":{"key":"value","index":1}} | jeg -e $.obj -f json => [{"key":"value","index":1}]
+        {"obj":{"key":"value","index":1}} | jeg -e $.obj -f ruby => [{"key"=>"value","index"=>1}]
+      The -e option is implicit if none is provided
+        {"text":"babble babble"} | jeg $.text => babble babble 
+
+      Leading '$' ("top") and '.' ("this object") can be omitted
+        {"text":"babble babble"} | jeg -e .text => babble babble
+        {"text":"babble babble"} | jeg -e text => babble babble 
+      Select subfield
+        {"results":[{"text":"foo"},{"text":"bar"}]} | jeg results.text -f json => []
+        {"results":[{"text":"foo"},{"text":"bar"}]} | jeg results..text -f json => ["foo","bar"]
+      Array access
+        {"results":[{"a":"b"},{"a":"d"}]} | jeg results[0] -f json => [{"a":"b"}]
+
+      Select a sub field everywhere, most always you want this
+        {"result":[{"text":"babble babble"}]} | jeg -e ..text => babble babble
+      So you also have a shortcut
+        {"result":[{"text":"babble babble"}]} | jeg -a text => babble babble
+
+      Select all equal fields in an array element
+        {"ary":[[{"name":"joe"}, {"name":"jean"}, {"name":"jane"}],[{"name":"wally"}]]} | jeg -e ary[0]..name -f json => ["joe", "jean", "jane"]
+
+
+     See JSONPath specs at  http://goessner.net/articles/JsonPath/ .
+
+
+      Banner
+
+      opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+        options[:verbose] = v
+      end
+      opts.on("-a", "--anywhere FIELD", "Matches a field anywhere") do |v|
+        options[:expression] = "$.." + v
+      end
+      opts.on("-e", "--expression JSONPATHEXPR", <<-Eof.strip ) do |v|
+        Specify a jsonpath expr, leading '$' or '.' are automatically added
+        Eof
+        options[:expression] = mk_expr(v)
+      end
+      opts.on("-x", "--explain", "Show what jeg is doing to your input and what is the actual expression used") do |v|
+        options[:explain] = v
+      end
+      opts.on("-p", "--pretty-print", "Print the input objects as pretty ruby") do |v|
+        options[:pretty_print] = v
+      end
+      opts.on_tail("-f", "--format FORMAT", [:smart, :json, :ruby], "Select output format (smart, json ruby)" ) do |v|
+        options[:format] = v
+      end
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+      # Another typical switch to print the version.
+      opts.on_tail("--version", "Show version") do
+        puts Version
+        exit
+      end
+    end.parse!
+
+    def print_smart(list)
+      list.each do |arg|
+        if arg.is_a?(Array) || arg.is_a?(Hash)
+          puts arg.to_json
+        else
+          puts arg
+        end
+      end
+    end
+
+    def loop
+
+      if options[:expression].nil?
+        options[:expression] = mk_expr(ARGV.shift)
+      end
+      if options[:pretty_print]
+        require 'pp'
+      end
+      if options[:explain]
+        puts "Using path '#{options[:expression]}'"
+      end
+      input.each do |line|
+        begin 
+          json = JSON.parse(line)
+          if options[:verbose]
+            puts line
+            puts json
+          end
+          if options[:pretty_print]
+            pp json
+          end
+          res = JSONPath.lookup(json, options[:expression])
+          case options[:format]
+          when :smart
+            print_smart(res)
+          when :json
+            puts res.to_json
+          when :ruby
+            p res
+          else 
+            abort("invalid format")
+          end
+
+        rescue JSON::ParserError=>e
+          STDERR.puts "Something went wrong parsing:\n#{line}"
+          STDERR.puts e.message
+        end
+      end
+    end
+  end
+end
+
+if __FILE__==$0
+  # To get rid of the annoying stack trace on ctrl-C:
+  trap("INT") { abort }
+  Jeg.new.loop
+end

data/jeg.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jeg}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gabriele Renzi"]
+  s.date = %q{2010-02-03}
+  s.default_executable = %q{jeg}
+  s.description = %q{A command line tool to slice and dice JSON-encoded data as simple a structured text format}
+  s.email = %q{rff.rff@gmail.com}
+  s.executables = ["jeg"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.mkd"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.mkd",
+     "Rakefile",
+     "VERSION",
+     "bin/jeg",
+     "jeg.gemspec",
+     "pkg/jeg-0.2.1.gem",
+     "test/docs.rb"
+  ]
+  s.homepage = %q{http://github.com/riffraff/jeg}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{jeg a json grep}
+  s.test_files = [
+    "test/docs.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<riffraff_jsonpath>, [">= 0"])
+    else
+      s.add_dependency(%q<riffraff_jsonpath>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<riffraff_jsonpath>, [">= 0"])
+  end
+end
+

data/test/docs.rb

@@ -0,0 +1,26 @@
+require 'test/unit'
+require 'rubygems'
+require 'json'
+abort("jeg is not in path") if %x{jeg -h}.empty?
+
+class T < Test::Unit::TestCase
+  jeg_file=%x(which jeg).chomp
+  examples = File.readlines(jeg_file).grep(/jeg .*=>/)
+  examples.each_with_index do |line,idx|
+    define_method("test_#{idx}")  do
+      #p line
+      cmd, exp = line.scan(%r-(.*?)=>(.*)-)[0] 
+      json, pipe = cmd.split('|')
+      res = %x{echo '#{json}' | #{pipe}}
+      #print 'json:'+json, 'pipe:'+pipe, 'exp:'+exp, 'res:'+res, "\n"
+      if pipe =~ /-f json/
+        assert_equal JSON.parse(exp.strip), JSON.parse(res.strip),"#{json} failed with cmd #{cmd}"
+      elsif pipe =~ /-f ruby/
+        assert_equal eval(exp.strip), eval(res.strip),"#{json} failed with cmd #{cmd}"
+      else
+        assert_equal exp.strip, res.strip,"#{json} failed with cmd #{cmd}"
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: jeg
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Gabriele Renzi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-03 00:00:00 +01:00
+default_executable: jeg
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riffraff_jsonpath
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A command line tool to slice and dice JSON-encoded data as simple a structured text format
+email: rff.rff@gmail.com
+executables: 
+- jeg
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.mkd
+files: 
+- LICENSE
+- README.mkd
+- Rakefile
+- VERSION
+- bin/jeg
+- jeg.gemspec
+- pkg/jeg-0.2.1.gem
+- test/docs.rb
+has_rdoc: true
+homepage: http://github.com/riffraff/jeg
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: jeg a json grep
+test_files: 
+- test/docs.rb