jsonpath 0.4.2 → 0.5.0

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - rbx-18mode

data/README.md

@@ -1,9 +1,16 @@
-# Jsonpath
+# JsonPath
 
 This is an implementation of http://goessner.net/articles/JsonPath/.
 
+## What is JsonPath?
+
+JsonPath is a way of addressing elements within a JSON object. Similar to xpath of yore, JsonPath lets you
+traverse a json object and manipulate or access it.
+
 ## Usage
 
+### Command-line
+
 There is stand-alone usage through the binary `jsonpath`
 
     jsonpath [expression] (file|string)
@@ -11,52 +18,115 @@ There is stand-alone usage through the binary `jsonpath`
     If you omit the second argument, it will read stdin, assuming one valid JSON object
     per line. Expression must be a valid jsonpath expression.
 
-As well, you can include it as a library.
+### Library
+
+To use JsonPath as a library simply include and get goin'!
+
+~~~~~ {ruby}
+require 'jsonpath'
+
+json = <<-HERE_DOC
+{"store":
+  {"bicycle":
+    {"price":19.95, "color":"red"},
+    "book":[
+      {"price":8.95, "category":"reference", "title":"Sayings of the Century", "author":"Nigel Rees"},
+      {"price":12.99, "category":"fiction", "title":"Sword of Honour", "author":"Evelyn Waugh"},
+      {"price":8.99, "category":"fiction", "isbn":"0-553-21311-3", "title":"Moby Dick", "author":"Herman Melville","color":"blue"},
+      {"price":22.99, "category":"fiction", "isbn":"0-395-19395-8", "title":"The Lord of the Rings", "author":"Tolkien"}
+    ]
+  }
+}
+HERE_DOC
+~~~~~
+
+Now that we have a JSON object, let's get all the prices present in the object. We create an object for the path
+in the following way.
+
+~~~~~ {ruby}
+path = JsonPath.new('$..price')
+~~~~~
+
+Now that we have a path, let's apply it to the object above.
+
+~~~~~ {ruby}
+path.on(json)
+# => [19.95, 8.95, 12.99, 8.99, 22.99]
+~~~~~
+
+Or on some other object ...
+
+~~~~~ {ruby}
+path.on('{"books":[{"title":"A Tale of Two Somethings","price":18.88}]}')
+# => [18.88]
+~~~~~
+
+You can also just combine this into one mega-call with the convenient `JsonPath.on` method.
 
 ~~~~~ {ruby}
-    object = JSON.parse(<<-HERE_DOC)
-    {"store":
-      {"bicycle":
-        {"price":19.95, "color":"red"},
-        "book":[
-          {"price":8.95, "category":"reference", "title":"Sayings of the Century", "author":"Nigel Rees"},
-          {"price":12.99, "category":"fiction", "title":"Sword of Honour", "author":"Evelyn Waugh"},
-          {"price":8.99, "category":"fiction", "isbn":"0-553-21311-3", "title":"Moby Dick", "author":"Herman Melville"},
-          {"price":22.99, "category":"fiction", "isbn":"0-395-19395-8", "title":"The Lord of the Rings", "author":"J. R. R. Tolkien"}
-        ]
-      }
-    }
-    HERE_DOC
+JsonPath.on(json, '$..author')
+# => ["Nigel Rees", "Evelyn Waugh", "Herman Melville", "Tolkien"]
+~~~~~
 
-    JsonPath.new('$..price').on(object)
-    # => [19.95, 8.95, 12.99, 8.99, 22.99]
+Of course the full JsonPath syntax is supported, such as array slices
+
+~~~~~ {ruby}
+JsonPath.new('$..book[::2]').on(json)
+# => [
+#      {"price"=>8.95, "category"=>"reference", "author"=>"Nigel Rees", "title"=>"Sayings of the Century"},
+#      {"price"=>8.99, "category"=>"fiction", "author"=>"Herman Melville", "title"=>"Moby Dick", "isbn"=>"0-553-21311-3"}
+#    ]
+~~~~~
+
+...and evals.
+
+~~~~~ {ruby}
+JsonPath.new('$..price[?(@ < 20)]').on(json)
+# => [8.95, 8.99]
+~~~~~
 
-    JsonPath.on(object, '$..author')
-    # => ["Nigel Rees", "Evelyn Waugh", "Herman Melville", "J. R. R. Tolkien"]
+There is a convenience method, `#first` that gives you the first element for a JSON object and path.
 
-    JsonPath.new('$..book[::2]').on(object)
-    # => [{"price"=>8.95, "category"=>"reference", "author"=>"Nigel Rees", "title"=>"Sayings of the Century"}, {"price"=>8.99, "category"=>"fiction", "author"=>"Herman Melville", "title"=>"Moby Dick", "isbn"=>"0-553-21311-3"}]
+~~~~~ {ruby}
+JsonPath.new('$..color').first(object)
+# => "red"
+~~~~~
 
-    JsonPath.new('$..color').first(object)
-    # => "red"
+As well, we can directly create an `Enumerable` at any time using `#[]`. 
 
-    # Lazy enumeration - only needs to find the first two matches
-    JsonPath.new('$..price').enum_on(object).each do |match|
-      break price if price < 15.0
-    end
-    # => 8.95
+~~~~~ {ruby}
+enum = JsonPath.new('$..color')[object]
+# => #<JsonPath::Enumerable:...>
+enum.first
+# => "red"
+enum.any?{ |c| c == 'red' }
+# => true
 ~~~~~
 
 You can optionally prevent eval from being called on sub-expressions by passing in :allow_eval => false to the constructor.
 
-If you'd like to do substitution in a json object, do this:
+### Manipulation
+
+If you'd like to do substitution in a json object, you can use `#gsub` or `#gsub!` to modify the object in place.
 
 ~~~~~ {ruby}
-    JsonPath.for({'test' => 'time'}).gsub('$..test') {|v| v << v}
+JsonPath.for('{"candy":"lollipop"}').gsub('$..candy') {|v| "big turks" }.to_hash
 ~~~~~
 
 The result will be
 
 ~~~~~ {ruby}
-    {'test' => 'timetime'}
+{'candy' => 'big turks'}
+~~~~~
+
+If you'd like to remove all nil keys, you can use `#compact` and `#compact!`. To remove all keys under a certain path, use `#delete` or `#delete!`. You can even chain these methods together as follows:
+
+~~~~~ {ruby}
+json = '{"candy":"lollipop","noncandy":null,"other":"things"}'
+o = JsonPath.for(json).
+  gsub('$..candy') {|v| "big turks" }.
+  compact.
+  delete('$..other').
+  to_hash
+# => {"candy" => "big turks"}
 ~~~~~

data/Rakefile

@@ -16,3 +16,5 @@ task :test do
   require 'jsonpath'
   Dir['./test/**/test_*.rb'].each { |test| require test }
 end
+
+task :default => :test

data/lib/jsonpath.rb

@@ -1,10 +1,13 @@
 require 'strscan'
+require 'multi_json'
 require 'jsonpath/proxy'
 require 'jsonpath/enumerable'
 require 'jsonpath/version'
 
 class JsonPath
 
+  PATH_ALL = '$..*'
+
   attr_reader :path
 
   def initialize(path, opts = nil)
@@ -49,23 +52,29 @@ class JsonPath
     end
   end
 
-  def on(object)
-    enum_on(object).to_a
+  def on(obj_or_str)
+    enum_on(obj_or_str).to_a
+  end
+
+  def first(obj_or_str, *args)
+    enum_on(obj_or_str).first(*args)
   end
 
-  def first(object)
-    enum_on(object).first
+  def enum_on(obj_or_str, mode = nil)
+    JsonPath::Enumerable.new(self, self.class.process_object(obj_or_str), mode, @opts)
   end
+  alias_method :[], :enum_on
 
-  def enum_on(object)
-    JsonPath::Enumerable.new(self, object, @opts)
+  def self.on(obj_or_str, path, opts = nil)
+    self.new(path, opts).on(process_object(obj_or_str))
   end
 
-  def self.on(object, path, opts = nil)
-    self.new(path, opts).on(object)
+  def self.for(obj_or_str)
+    Proxy.new(process_object(obj_or_str))
   end
 
-  def self.for(obj)
-    Proxy.new(obj)
+  private
+  def self.process_object(obj_or_str)
+    obj_or_str.is_a?(String) ? MultiJson.decode(obj_or_str) : obj_or_str
   end
 end

data/lib/jsonpath/enumerable.rb

@@ -4,14 +4,14 @@ class JsonPath
     attr_reader :allow_eval
     alias_method :allow_eval?, :allow_eval
 
-    def initialize(path, object, options = nil)
-      @path, @object, @options = path.path, object, options
+    def initialize(path, object, mode, options = nil)
+      @path, @object, @mode, @options = path.path, object, mode, options
       @allow_eval = @options && @options.key?(:allow_eval) ? @options[:allow_eval] : true
-      @mode = @options && @options[:mode]
     end
 
     def each(context = @object, key = nil, pos = 0, &blk)
       node = key ? context[key] : context
+      @_current_node = node
       return yield_value(blk, context, key) if pos == @path.size
       case expr = @path[pos]
       when '*', '..'
@@ -29,14 +29,21 @@ class JsonPath
               each(node, k, pos + 1, &blk) if node.key?(k)
             end
           when ??
-            (node.is_a?(Hash) ? node.keys : (0..node.size)).each do |e|
-              subenum = ::JsonPath.new(sub_path[2, sub_path.size - 3]).on(node[e])
-              each(node, e, pos + 1, &blk) if subenum.any?{|n| true}
+            raise "Cannot use ?(...) unless eval is enabled" unless allow_eval?
+            case node
+            when Hash, Array
+              (node.is_a?(Hash) ? node.keys : (0..node.size)).each do |e|
+                each(node, e, pos + 1) { |n|
+                  @_current_node = n
+                  yield n if process_function_or_literal(sub_path[1, sub_path.size - 1])
+                }
+              end
+            else
+              yield node if process_function_or_literal(sub_path[1, sub_path.size - 1])
             end
           else
             if node.is_a?(Array)
-              @obj = node
-              array_args = sub_path.gsub('@','@obj').split(':')
+              array_args = sub_path.split(':')
               start_idx = process_function_or_literal(array_args[0], 0)
               next unless start_idx
               start_idx %= node.size
@@ -67,10 +74,13 @@ class JsonPath
 
     private
     def yield_value(blk, context, key)
-      @substitute_with = nil
       case @mode
       when nil
         blk.call(key ? context[key] : context)
+      when :compact
+        context.delete(key) if key && context[key].nil?
+      when :delete
+        context.delete(key) if key
       when :substitute
         if key
           context[key] = blk.call(context[key])
@@ -80,11 +90,14 @@ class JsonPath
       end
     end
 
-    def process_function_or_literal(exp, default)
+    def process_function_or_literal(exp, default = nil)
       if exp.nil?
         default
       elsif exp[0] == ?(
-        allow_eval? ? eval(exp) : nil
+        #p @_current_node
+        #p exp.gsub(/@/, '@_current_node')
+        #p eval(exp.gsub(/@/, '@_current_node'))
+        allow_eval? ? @_current_node && eval(exp.gsub(/@/, '@_current_node')) : nil
       elsif exp.empty?
         default
       else

data/lib/jsonpath/proxy.rb

@@ -1,25 +1,54 @@
 class JsonPath
   class Proxy
+    attr_reader :obj
+    alias_method :to_hash, :obj
+
     def initialize(obj)
       @obj = obj
     end
 
     def gsub(path, replacement = nil, &replacement_block)
-      _gsub(deep_copy, path, replacement ? proc{replacement} : replacement_block)
+      _gsub(_deep_copy, path, replacement ? proc{replacement} : replacement_block)
     end
 
     def gsub!(path, replacement = nil, &replacement_block)
       _gsub(@obj, path, replacement ? proc{replacement} : replacement_block)
     end
 
+    def delete(path = JsonPath::PATH_ALL)
+      _delete(_deep_copy, path)
+    end
+
+    def delete!(path = JsonPath::PATH_ALL)
+      _delete(@obj, path)
+    end
+
+    def compact(path = JsonPath::PATH_ALL)
+      _compact(_deep_copy, path)
+    end
+
+    def compact!(path = JsonPath::PATH_ALL)
+      _compact(@obj, path)
+    end
+
     private
-    def deep_copy
+    def _deep_copy
       Marshal::load(Marshal::dump(@obj))
     end
 
     def _gsub(obj, path, replacement)
-      JsonPath.new(path, :mode => :substitute).enum_on(obj).each(&replacement)
-      obj
+      JsonPath.new(path)[obj, :substitute].each(&replacement)
+      Proxy.new(obj)
+    end
+
+    def _delete(obj, path)
+      JsonPath.new(path)[obj, :delete].each
+      Proxy.new(obj)
+    end
+
+    def _compact(obj, path)
+      JsonPath.new(path)[obj, :compact].each
+      Proxy.new(obj)
     end
   end
 end

data/lib/jsonpath/version.rb

@@ -1,3 +1,3 @@
 class JsonPath
-  VERSION = '0.4.2' unless const_defined?(:VERSION)
+  VERSION = '0.5.0'
 end

data/test/test_jsonpath.rb

@@ -46,7 +46,12 @@ class TestJsonpath < MiniTest::Unit::TestCase
     assert_equal [@object['store']['book'][0], @object['store']['book'][2]], JsonPath.new("$..book[?(@['price'] < 10)]").on(@object)
     assert_equal [@object['store']['book'][0], @object['store']['book'][2]], JsonPath.new("$..book[?(@['price'] == 9)]").on(@object)
     assert_equal [@object['store']['book'][3]], JsonPath.new("$..book[?(@['price'] > 20)]").on(@object)
-    assert_equal [@object['store']['book'][2], @object['store']['book'][3]], JsonPath.new("$..book[?(@.isbn)]").on(@object)
+  end
+
+  if RUBY_VERSION[/^1\.9/]
+    def test_recognize_filters_on_val
+      assert_equal [@object['store']['book'][1]['price'], @object['store']['book'][3]['price'], @object['store']['bicycle']['price']], JsonPath.new("$..price[?(@ > 10)]").on(@object)
+    end
   end
 
   def test_no_eval
@@ -87,7 +92,7 @@ class TestJsonpath < MiniTest::Unit::TestCase
     @object2['store']['book'][1]['price'] += 10
     @object2['store']['book'][2]['price'] += 10
     @object2['store']['book'][3]['price'] += 10
-    assert_equal @object2, JsonPath.for(@object).gsub('$..price') { |p| p + 10 }
+    assert_equal @object2, JsonPath.for(@object).gsub('$..price') { |p| p + 10 }.to_hash
   end
 
   def test_gsub!
@@ -105,6 +110,18 @@ class TestJsonpath < MiniTest::Unit::TestCase
     assert_equal h, @object
   end
 
+  def test_compact
+    h = {'hi' => 'there', 'you' => nil}
+    JsonPath.for(h).compact!
+    assert_equal({'hi' => 'there'}, h)
+  end
+
+  def test_delete
+    h = {'hi' => 'there', 'you' => nil}
+    JsonPath.for(h).delete!('*.hi')
+    assert_equal({'you' => nil}, h)
+  end
+
   def example_object
     { "store"=> {
       "book" => [

metadata

@@ -1,123 +1,94 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jsonpath
-version: !ruby/object:Gem::Version 
-  hash: 11
+version: !ruby/object:Gem::Version
+  version: 0.5.0
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 2
-  version: 0.4.2
 platform: ruby
-authors: 
+authors:
 - Joshua Hull
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-26 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: multi_json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70241925955780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: code_stats
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70241925955780
+- !ruby/object:Gem::Dependency
+  name: code_stats
+  requirement: &70241925955060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70241925955060
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70241925954420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70241925954420
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70241925953660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 2
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.2.0
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: phocus
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70241925953660
+- !ruby/object:Gem::Dependency
+  name: phocus
+  requirement: &70241925953100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70241925953100
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70241926010900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 0
-        - 10
+      - !ruby/object:Gem::Version
         version: 1.0.10
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: *70241926010900
 description: Ruby implementation of http://goessner.net/articles/JsonPath/.
 email: joshbuddy@gmail.com
-executables: 
+executables:
 - jsonpath
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - .gemtest
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -129,39 +100,30 @@ files:
 - lib/jsonpath/version.rb
 - test/test_jsonpath.rb
 - test/test_jsonpath_bin.rb
-has_rdoc: true
 homepage: http://github.com/joshbuddy/jsonpath
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: jsonpath
-rubygems_version: 1.6.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Ruby implementation of http://goessner.net/articles/JsonPath/
 test_files: []
-
+has_rdoc: