jsonpath 0.5.8 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0605409a770fbb28dd1352fa92753e7707d0df96
-  data.tar.gz: ed5e1e0c2fc22721d9d9a71ca5ec97f15e07bfe5
+SHA256:
+  metadata.gz: 27b1b5e54ebef03b9cde7f447c1dc6fb8e411b4a28f5039426c87782b250ab1a
+  data.tar.gz: ae08f25885125bde4f301d905b9c6446bf0e922516aabce101a4e90088fd6e68
 SHA512:
-  metadata.gz: d3471d1c6ffdd79d987edf7772c945b2c5c74cd614086cc49e57588d47c6135310fd9ca6660c0e5e711521c9863b189de1067c8656165d46bf266eb2522a9491
-  data.tar.gz: 091adbef8dc29e30172d0016cf67e6035af094426fd405a45fff52e0292b45340f1aab1804b5291f918b0916fe2f02b252cb8fa2d97e2ee13dcd330645ac9cf8
+  metadata.gz: e4e778c37086407f3fb101b23c7f0507c48f0714ad2ae671d14ce52a2397e18f0f7433b8fa0fe651e503285002b4db1b70dad91ae4de1cf51b948f9ec736818b
+  data.tar.gz: b0dac82fcb16862190ae1405680d4779d6b3208d6ad31e25e5b0eb800877ca8bf56bae2789bac11452dfd872593071334205208bcb3a7320e3a8c0b94ba206c9

data/.gitignore

@@ -3,3 +3,8 @@ Gemfile.lock
 coverage/*
 doc/*
 .yardoc
+.DS_Store
+.idea
+vendor
+.tags
+*.gem

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,127 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-01-25 09:23:04 +0100 using RuboCop version 0.63.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 15
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/jsonpath.rb'
+    - 'lib/jsonpath/parser.rb'
+
+# Offense count: 1
+Lint/IneffectiveAccessModifier:
+  Exclude:
+    - 'lib/jsonpath.rb'
+
+# Offense count: 17
+Metrics/AbcSize:
+  Max: 60
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 37
+
+# Offense count: 1
+# Configuration parameters: CountBlocks.
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 739
+
+# Offense count: 7
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+# Offense count: 26
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 52
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 6
+Metrics/PerceivedComplexity:
+  Max: 21
+
+# Offense count: 1
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: io, id, to, by, on, in, at, ip, db
+Naming/UncommunicativeMethodParamName:
+  Exclude:
+    - 'lib/jsonpath/parser.rb'
+
+# Offense count: 15
+# Configuration parameters: AllowedChars.
+Style/AsciiComments:
+  Exclude:
+    - 'lib/jsonpath/parser.rb'
+
+# Offense count: 2
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/jsonpath/enumerable.rb'
+    - 'lib/jsonpath/proxy.rb'
+
+# Offense count: 3
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/jsonpath/enumerable.rb'
+    - 'lib/jsonpath/parser.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/jsonpath/enumerable.rb'
+
+# Offense count: 1
+Style/MultipleComparison:
+  Exclude:
+    - 'lib/jsonpath/parser.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/jsonpath/enumerable.rb'
+    - 'lib/jsonpath/parser.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'lib/jsonpath/parser.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/RescueModifier:
+  Exclude:
+    - 'lib/jsonpath/enumerable.rb'
+    - 'lib/jsonpath/parser.rb'
+
+# Offense count: 89
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 296

data/.travis.yml

@@ -1,5 +1,8 @@
+language: ruby
 rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - jruby
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
+  - jruby-head
+  - truffleruby-head

data/Gemfile

@@ -1,2 +1,6 @@
-source "http://rubygems.org"
-gemspec
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+gemspec
+gem 'rubocop', require: true, group: :test
+gem 'simplecov', require: false, group: :test

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Joshua Lin & Gergely Brautigam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -4,8 +4,8 @@ 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.
+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
 
@@ -15,14 +15,14 @@ There is stand-alone usage through the binary `jsonpath`
 
     jsonpath [expression] (file|string)
 
-    If you omit the second argument, it will read stdin, assuming one valid JSON object
-    per line. Expression must be a valid jsonpath expression.
+    If you omit the second argument, it will read stdin, assuming one valid JSON
+    object per line. Expression must be a valid jsonpath expression.
 
 ### Library
 
 To use JsonPath as a library simply include and get goin'!
 
-~~~~~ {ruby}
+```ruby
 require 'jsonpath'
 
 json = <<-HERE_DOC
@@ -38,90 +38,212 @@ json = <<-HERE_DOC
   }
 }
 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.
+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}
+```ruby
 path = JsonPath.new('$..price')
-~~~~~
+```
 
 Now that we have a path, let's apply it to the object above.
 
-~~~~~ {ruby}
+```ruby
 path.on(json)
 # => [19.95, 8.95, 12.99, 8.99, 22.99]
-~~~~~
+```
 
-Or on some other object ...
+Or reuse it later on some other object (thread safe) ...
 
-~~~~~ {ruby}
+```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.
+You can also just combine this into one mega-call with the convenient
+`JsonPath.on` method.
 
-~~~~~ {ruby}
+```ruby
 JsonPath.on(json, '$..author')
 # => ["Nigel Rees", "Evelyn Waugh", "Herman Melville", "Tolkien"]
-~~~~~
+```
 
 Of course the full JsonPath syntax is supported, such as array slices
 
-~~~~~ {ruby}
+```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"}
+#      {"price" => 8.95, "category" => "reference", "title" => "Sayings of the Century", "author" => "Nigel Rees"},
+#      {"price" => 8.99, "category" => "fiction", "isbn" => "0-553-21311-3", "title" => "Moby Dick", "author" => "Herman Melville","color" => "blue"},
 #    ]
-~~~~~
+```
 
-...and evals.
+...and evals, including those with conditional operators
 
-~~~~~ {ruby}
-JsonPath.new('$..price[?(@ < 20)]').on(json)
+```ruby
+JsonPath.new("$..price[?(@ < 10)]").on(json)
 # => [8.95, 8.99]
-~~~~~
 
-There is a convenience method, `#first` that gives you the first element for a JSON object and path.
+JsonPath.new("$..book[?(@['price'] == 8.95 || @['price'] == 8.99)].title").on(json)
+# => ["Sayings of the Century", "Moby Dick"]
 
-~~~~~ {ruby}
-JsonPath.new('$..color').first(object)
+JsonPath.new("$..book[?(@['price'] == 8.95 && @['price'] == 8.99)].title").on(json)
+# => []
+```
+
+There is a convenience method, `#first` that gives you the first element for a
+JSON object and path.
+
+```ruby
+JsonPath.new('$..color').first(json)
 # => "red"
-~~~~~
+```
 
 As well, we can directly create an `Enumerable` at any time using `#[]`. 
 
-~~~~~ {ruby}
-enum = JsonPath.new('$..color')[object]
+```ruby
+enum = JsonPath.new('$..color')[json]
 # => #<JsonPath::Enumerable:...>
 enum.first
 # => "red"
 enum.any?{ |c| c == 'red' }
 # => true
-~~~~~
+```
+
+For more usage examples and variations on paths, please visit the tests. There
+are some more complex ones as well.
+
+### Querying ruby data structures
+
+If you have ruby hashes with symbolized keys as input, you
+can use `:use_symbols` to make JsonPath work fine on them too:
+
+```ruby
+book = { title: "Sayings of the Century" }
+
+JsonPath.new('$.title').on(book)
+# => []
+
+JsonPath.new('$.title', use_symbols: true).on(book)
+# => ["Sayings of the Century"]
+```
+
+JsonPath also recognizes objects responding to `dig` (introduced
+in ruby 2.3), and therefore works out of the box with Struct,
+OpenStruct, and other Hash-like structures:
+
+```ruby
+book_class = Struct.new(:title)
+book = book_class.new("Sayings of the Century")
+
+JsonPath.new('$.title').on(book)
+# => ["Sayings of the Century"]
+```
+
+JsonPath is able to query pure ruby objects and uses `__send__`
+on them. The option is enabled by default in JsonPath 1.x, but
+we encourage to enable it explicitly:
+
+```ruby
+book_class = Class.new{ attr_accessor :title }
+book = book_class.new
+book.title = "Sayings of the Century"
+
+JsonPath.new('$.title', allow_send: true).on(book)
+# => ["Sayings of the Century"]
+```
+
+### Other available options
+
+By default, JsonPath does not return null values on unexisting paths.
+This can be changed using the `:default_path_leaf_to_null` option
 
-You can optionally prevent eval from being called on sub-expressions by passing in :allow_eval => false to the constructor.
+```ruby
+JsonPath.new('$..book[*].isbn').on(json)
+# => ["0-553-21311-3", "0-395-19395-8"]
+
+JsonPath.new('$..book[*].isbn', default_path_leaf_to_null: true).on(json)
+# => [nil, nil, "0-553-21311-3", "0-395-19395-8"]
+```
+
+When JsonPath returns a Hash, you can ask to symbolize its keys
+using the `:symbolize_keys` option
+
+```ruby
+JsonPath.new('$..book[0]').on(json)
+# => [{"category" => "reference", ...}]
+
+JsonPath.new('$..book[0]', symbolize_keys: true).on(json)
+# => [{category: "reference", ...}]
+```
+
+### Selecting Values
+
+It's possible to select results once a query has been defined after the query. For
+example given this JSON data:
+
+```bash
+{
+    "store": {
+        "book": [
+            {
+                "category": "reference",
+                "author": "Nigel Rees",
+                "title": "Sayings of the Century",
+                "price": 8.95
+            },
+            {
+                "category": "fiction",
+                "author": "Evelyn Waugh",
+                "title": "Sword of Honour",
+                "price": 12.99
+            }
+        ]
+}
+```
+
+... and this query:
+
+```ruby
+"$.store.book[*](category,author)"
+```
+
+... the result can be filtered as such:
+
+```bash
+[
+   {
+      "category" : "reference",
+      "author" : "Nigel Rees"
+   },
+   {
+      "category" : "fiction",
+      "author" : "Evelyn Waugh"
+   }
+]
+```
 
 ### Manipulation
 
-If you'd like to do substitution in a json object, you can use `#gsub` or `#gsub!` to modify the object in place.
+If you'd like to do substitution in a json object, you can use `#gsub`
+or `#gsub!` to modify the object in place.
 
-~~~~~ {ruby}
+```ruby
 JsonPath.for('{"candy":"lollipop"}').gsub('$..candy') {|v| "big turks" }.to_hash
-~~~~~
+```
 
 The result will be
 
-~~~~~ {ruby}
+```ruby
 {'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:
+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}
+```ruby
 json = '{"candy":"lollipop","noncandy":null,"other":"things"}'
 o = JsonPath.for(json).
   gsub('$..candy') {|v| "big turks" }.
@@ -129,4 +251,15 @@ o = JsonPath.for(json).
   delete('$..other').
   to_hash
 # => {"candy" => "big turks"}
-~~~~~
+```
+
+# Contributions
+
+Please feel free to submit an Issue or a Pull Request any time you feel like
+you would like to contribute. Thank you!
+
+## Running an individual test
+
+```ruby
+ruby -Ilib:../lib test/test_jsonpath.rb --name test_wildcard_on_intermediary_element_v6
+```

data/Rakefile

@@ -1,12 +1,23 @@
+# frozen_string_literal: true
+
+desc 'run rubocop'
+task(:rubocop) do
+  require 'rubocop'
+  cli = RuboCop::CLI.new
+  cli.run
+end
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/test/'
+end
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
 task :test do
-  $: << 'lib'
-  require 'minitest/autorun'
-  require 'phocus'
-  require 'jsonpath'
+  $LOAD_PATH << 'lib'
   Dir['./test/**/test_*.rb'].each { |test| require test }
 end
 
-task :default => :test
+task default: %i[test rubocop]

data/bin/jsonpath

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'jsonpath'
 require 'multi_json'
@@ -15,7 +16,7 @@ usage unless ARGV[0]
 
 jsonpath = JsonPath.new(ARGV[0])
 case ARGV[1]
-when nil #stdin
+when nil # stdin
   puts MultiJson.encode(jsonpath.on(MultiJson.decode(STDIN.read)))
 when String
   puts MultiJson.encode(jsonpath.on(MultiJson.decode(File.exist?(ARGV[1]) ? File.read(ARGV[1]) : ARGV[1])))

data/jsonpath.gemspec

@@ -1,32 +1,27 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 require File.join(File.dirname(__FILE__), 'lib', 'jsonpath', 'version')
 
 Gem::Specification.new do |s|
   s.name = 'jsonpath'
   s.version = JsonPath::VERSION
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Joshua Hull"]
-  s.summary = "Ruby implementation of http://goessner.net/articles/JsonPath/"
-  s.description = "Ruby implementation of http://goessner.net/articles/JsonPath/."
-  s.email = %q{joshbuddy@gmail.com}
+  s.required_ruby_version = '>= 2.5'
+  s.authors = ['Joshua Hull', 'Gergely Brautigam']
+  s.summary = 'Ruby implementation of http://goessner.net/articles/JsonPath/'
+  s.description = 'Ruby implementation of http://goessner.net/articles/JsonPath/.'
+  s.email = ['joshbuddy@gmail.com', 'skarlso777@gmail.com']
   s.extra_rdoc_files = ['README.md']
   s.files = `git ls-files`.split("\n")
-  s.homepage = %q{http://github.com/joshbuddy/jsonpath}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.test_files = `git ls-files`.split("\n").select{|f| f =~ /^spec/}
-  s.rubyforge_project = 'jsonpath'
-  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.homepage = 'https://github.com/joshbuddy/jsonpath'
+  s.test_files = `git ls-files`.split("\n").select { |f| f =~ /^spec/ }
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.licenses    = ['MIT']
 
   # dependencies
   s.add_runtime_dependency 'multi_json'
+  s.add_development_dependency 'bundler'
   s.add_development_dependency 'code_stats'
-  s.add_development_dependency 'rake'
   s.add_development_dependency 'minitest', '~> 2.2.0'
   s.add_development_dependency 'phocus'
-  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
 end
-

data/lib/jsonpath/dig.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class JsonPath
+  module Dig
+
+    # Similar to what Hash#dig or Array#dig
+    def dig(context, *keys)
+      keys.inject(context){|memo,k|
+        dig_one(memo, k)
+      }
+    end
+
+    # Returns a hash mapping each key from keys
+    # to its dig value on context.
+    def dig_as_hash(context, keys)
+      keys.each_with_object({}) do |k, memo|
+        memo[k] = dig_one(context, k)
+      end
+    end
+
+    # Dig the value of k on context.
+    def dig_one(context, k)
+      case context
+      when Hash
+        context[@options[:use_symbols] ? k.to_sym : k]
+      when Array
+        context[k.to_i]
+      else
+        if context.respond_to?(:dig)
+          context.dig(k)
+        elsif @options[:allow_send]
+          context.__send__(k)
+        end
+      end
+    end
+
+    # Yields the block if context has a diggable
+    # value for k
+    def yield_if_diggable(context, k, &blk)
+      case context
+      when Array
+        nil
+      when Hash
+        k = @options[:use_symbols] ? k.to_sym : k
+        return yield if context.key?(k) || @options[:default_path_leaf_to_null]
+      else
+        if context.respond_to?(:dig)
+          digged = dig_one(context, k)
+          yield if !digged.nil? || @options[:default_path_leaf_to_null]
+        elsif @options[:allow_send] && context.respond_to?(k.to_s) && !Object.respond_to?(k.to_s)
+          yield
+        end
+      end
+    end
+
+  end
+end