jsonpath 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 86c7a2524bbfbf973b55437a09068d62ae594a05
-  data.tar.gz: 8653a33163faa160f9eef04155e3906ff6419343
+SHA256:
+  metadata.gz: d45aa52a5d4a9500f243abaa6ff69131a7e5a8653ffacd1ff0787946774d12f3
+  data.tar.gz: bd0903ab08210ac2e5a44a56f548104c1924f2d9a9db9d5006a51db86aafc648
 SHA512:
-  metadata.gz: ca8350260d52a9c24fc1782393975e74a14639c6152a6d4e450efde8e980882aefd0009ed1c6063cd24be2d36e5f64c16e81e361a42c075b35494c613b1c57d2
-  data.tar.gz: aa60fa92da9e3ba857f3914ebb902a473bada3f53a4486997d04a7d37530c942fbe93b13e3ac4cd4e39253ae2b57cdc8191afd4875ab1d9a34e678afb41ae2dc
+  metadata.gz: 96a161911383f2c7870bd5450020aaaaceb1ea4305672f5a08493016e4fdcc5fb346001b3e8a377c16588c7bcd5adf9b0be1ef51d18b483404619324600501bb
+  data.tar.gz: 2c824f8916a742f0e5a9201c858c683bf2df7e9c7d5e38f7b7206fc8f511f69741afb3378993f3ed7e8f396148a14596ce7b9e78f0a739d2aeafc15591a0b585

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-07-07 21:29:45 +0200 using RuboCop version 0.57.2.
+# 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
@@ -18,31 +18,32 @@ Lint/IneffectiveAccessModifier:
   Exclude:
     - 'lib/jsonpath.rb'
 
-# Offense count: 16
+# Offense count: 17
 Metrics/AbcSize:
-  Max: 54
+  Max: 60
 
 # Offense count: 2
 # Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 33
+  Max: 37
 
 # Offense count: 1
 # Configuration parameters: CountBlocks.
 Metrics/BlockNesting:
   Max: 4
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 578
+  Max: 739
 
-# Offense count: 6
+# Offense count: 7
 Metrics/CyclomaticComplexity:
-  Max: 18
+  Max: 20
 
-# Offense count: 24
-# Configuration parameters: CountComments.
+# Offense count: 26
+# Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 52
 
@@ -53,9 +54,16 @@ Metrics/ParameterLists:
 
 # Offense count: 6
 Metrics/PerceivedComplexity:
-  Max: 20
+  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:
@@ -69,11 +77,12 @@ Style/Documentation:
     - 'lib/jsonpath/enumerable.rb'
     - 'lib/jsonpath/proxy.rb'
 
-# Offense count: 1
+# Offense count: 3
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
     - 'lib/jsonpath/enumerable.rb'
+    - 'lib/jsonpath/parser.rb'
 
 # Offense count: 2
 # Cop supports --auto-correct.
@@ -81,16 +90,22 @@ Style/IfUnlessModifier:
   Exclude:
     - 'lib/jsonpath/enumerable.rb'
 
-# Offense count: 2
+# Offense count: 1
+Style/MultipleComparison:
+  Exclude:
+    - 'lib/jsonpath/parser.rb'
+
+# Offense count: 3
 # Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, EnforcedStyle.
+# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
 # SupportedStyles: predicate, comparison
 Style/NumericPredicate:
   Exclude:
     - 'spec/**/*'
     - 'lib/jsonpath/enumerable.rb'
+    - 'lib/jsonpath/parser.rb'
 
-# Offense count: 2
+# Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, AllowInnerSlashes.
 # SupportedStyles: slashes, percent_r, mixed
@@ -98,15 +113,15 @@ Style/RegexpLiteral:
   Exclude:
     - 'lib/jsonpath/parser.rb'
 
-# Offense count: 3
+# Offense count: 4
 # Cop supports --auto-correct.
 Style/RescueModifier:
   Exclude:
     - 'lib/jsonpath/enumerable.rb'
     - 'lib/jsonpath/parser.rb'
 
-# Offense count: 71
+# Offense count: 89
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 175
+  Max: 296

data/lib/jsonpath.rb

@@ -33,10 +33,12 @@ class JsonPath
         nil
       elsif token = scanner.scan(/[><=] \d+/)
         @path.last << token
-      # TODO: If there are characters that it can't match in the previous legs, this will throw
-      # a RuntimeError: can't modify frozen String error.
       elsif token = scanner.scan(/./)
-        @path.last << token
+        begin
+          @path.last << token
+        rescue RuntimeError
+          raise ArgumentError, "character '#{token}' not supported in query"
+        end
       end
     end
   end
@@ -69,7 +71,7 @@ class JsonPath
     a = enum_on(obj_or_str).to_a
     if opts[:symbolize_keys]
       a.map! do |e|
-        e.inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo }
+        e.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; }
       end
     end
     a

data/lib/jsonpath/enumerable.rb

@@ -15,6 +15,7 @@ class JsonPath
       node = key ? context[key] : context
       @_current_node = node
       return yield_value(blk, context, key) if pos == @path.size
+
       case expr = @path[pos]
       when '*', '..', '@'
         each(context, key, pos + 1, &blk)
@@ -47,6 +48,7 @@ class JsonPath
           handle_question_mark(sub_path, node, pos, &blk)
         else
           next if node.is_a?(Array) && node.empty?
+
           array_args = sub_path.split(':')
           if array_args[0] == '*'
             start_idx = 0
@@ -58,6 +60,7 @@ class JsonPath
           else
             start_idx = process_function_or_literal(array_args[0], 0)
             next unless start_idx
+
             end_idx = array_args[1] && ensure_exclusive_end_index(process_function_or_literal(array_args[1], -1)) || -1
             next unless end_idx
             next if start_idx == end_idx && start_idx >= node.size
@@ -66,6 +69,7 @@ class JsonPath
           end_idx %= node.size
           step = process_function_or_literal(array_args[2], 1)
           next unless step
+
           if @mode == :delete
             (start_idx..end_idx).step(step) { |i| node[i] = nil }
             node.compact!

data/lib/jsonpath/parser.rb

@@ -14,39 +14,39 @@ class JsonPath
     # parse will parse an expression in the following way.
     # Split the expression up into an array of legs for && and || operators.
     # Parse this array into a map for which the keys are the parsed legs
-    # of the split. This map is then used to replace the expression with their
+    #  of the split. This map is then used to replace the expression with their
     # corresponding boolean or numeric value. This might look something like this:
     # ((false || false) && (false || true))
-    # Once this string is assembled... we proceed to evaluate from left to right.
-    # The above string is broken down like this:
+    #  Once this string is assembled... we proceed to evaluate from left to right.
+    #  The above string is broken down like this:
     # (false && (false || true))
     # (false && true)
-    # false
+    #  false
     def parse(exp)
       exps = exp.split(/(&&)|(\|\|)/)
       construct_expression_map(exps)
-      @_expr_map.each {|k, v| exp.sub!(k, "#{v}")}
+      @_expr_map.each { |k, v| exp.sub!(k, v.to_s) }
       raise ArgumentError, "unmatched parenthesis in expression: #{exp}" unless check_parenthesis_count(exp)
-      while (exp.include?("("))
-        exp = parse_parentheses(exp)
-      end
+
+      exp = parse_parentheses(exp) while exp.include?('(')
       bool_or_exp(exp)
     end
 
     # Construct a map for which the keys are the expressions
-    # and the values are the corresponding parsed results.
+    #  and the values are the corresponding parsed results.
     # Exp.:
     # {"(@['author'] =~ /herman|lukyanenko/i)"=>0}
     # {"@['isTrue']"=>true}
     def construct_expression_map(exps)
-      exps.each_with_index do |item, index|
+      exps.each_with_index do |item, _index|
         next if item == '&&' || item == '||'
+
         item = item.strip.gsub(/\)*$/, '').gsub(/^\(*/, '')
         @_expr_map[item] = parse_exp(item)
       end
     end
 
-    # using a scanner break down the individual expressions and determine if
+    #  using a scanner break down the individual expressions and determine if
     # there is a match in the JSON for it or not.
     def parse_exp(exp)
       exp = exp.sub(/@/, '').gsub(/^\(/, '').gsub(/\)$/, '').tr('"', '\'').strip
@@ -100,34 +100,33 @@ class JsonPath
       return nil unless hash.is_a? Hash
       return nil unless hash.key?(keys.first)
       return hash.fetch(keys.first) if keys.size == 1
+
       prev = keys.shift
       dig(keys, hash.fetch(prev))
     end
 
-    # This will break down a parenthesis from the left to the right
-    # and replace the given expression with it's returned value.
+    #  This will break down a parenthesis from the left to the right
+    #  and replace the given expression with it's returned value.
     # It does this in order to make it easy to eliminate groups
     # one-by-one.
     def parse_parentheses(str)
       opening_index = 0
       closing_index = 0
 
-      (0..str.length-1).step(1) do |i|
-        if str[i] == '('
-          opening_index = i
-        end
+      (0..str.length - 1).step(1) do |i|
+        opening_index = i if str[i] == '('
         if str[i] == ')'
           closing_index = i
           break
         end
       end
 
-      to_parse = str[opening_index+1..closing_index-1]
+      to_parse = str[opening_index + 1..closing_index - 1]
 
-      # handle cases like (true && true || false && true) in
+      #  handle cases like (true && true || false && true) in
       # one giant parenthesis.
       top = to_parse.split(/(&&)|(\|\|)/)
-      top = top.map{|t| t.strip}
+      top = top.map(&:strip)
       res = bool_or_exp(top.shift)
       top.each_with_index do |item, index|
         case item
@@ -138,42 +137,44 @@ class JsonPath
         end
       end
 
-      # if we are at the last item, the opening index will be 0
+      #  if we are at the last item, the opening index will be 0
       # and the closing index will be the last index. To avoid
       # off-by-one errors we simply return the result at that point.
-      if closing_index+1 >= str.length && opening_index == 0
-        return "#{res}"
+      if closing_index + 1 >= str.length && opening_index == 0
+        return res.to_s
       else
-        return "#{str[0..opening_index-1]}#{res}#{str[closing_index+1..str.length]}"
+        return "#{str[0..opening_index - 1]}#{res}#{str[closing_index + 1..str.length]}"
       end
     end
 
-    # This is convoluted and I should probably refactor it somehow.
-    # The map that is created will contain strings since essentially I'm
+    #  This is convoluted and I should probably refactor it somehow.
+    #  The map that is created will contain strings since essentially I'm
     # constructing a string like `true || true && false`.
     # With eval the need for this would disappear but never the less, here
-    # it is. The fact is that the results can be either boolean, or a number
+    #  it is. The fact is that the results can be either boolean, or a number
     # in case there is only indexing happening like give me the 3rd item... or
     # it also can be nil in case of regexes or things that aren't found.
     # Hence, I have to be clever here to see what kind of variable I need to
     # provide back.
     def bool_or_exp(b)
-      if "#{b}" == 'true'
+      if b.to_s == 'true'
         return true
-      elsif "#{b}" == 'false'
+      elsif b.to_s == 'false'
         return false
-      elsif "#{b}" == ""
+      elsif b.to_s == ''
         return nil
       end
+
       b = Float(b) rescue b
       b
     end
 
     # this simply makes sure that we aren't getting into the whole
-    # parenthesis parsing business without knowing that every parenthesis
+    #  parenthesis parsing business without knowing that every parenthesis
     # has its pair.
     def check_parenthesis_count(exp)
-      return true unless exp.include?("(")
+      return true unless exp.include?('(')
+
       depth = 0
       exp.chars.each do |c|
         if c == '('

data/lib/jsonpath/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class JsonPath
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/test/test_jsonpath.rb

@@ -228,18 +228,15 @@ class TestJsonpath < MiniTest::Unit::TestCase
             'delete_me' => [
               'no' => 'do not'
             ]
-          }
-        },
+          } },
         { 'category' => 'fiction',
           'author' => 'Evelyn Waugh',
           'title' => 'Sword of Honour',
-          'price' => 13
-        },
+          'price' => 13 },
         { 'category' => 'fiction',
           'author' => 'Aasdf',
           'title' => 'Aaasdf2',
-          'price' => 1
-        }
+          'price' => 1 }
       ]
     } }
     json_deleted = { 'store' => {
@@ -249,18 +246,15 @@ class TestJsonpath < MiniTest::Unit::TestCase
           'title' => 'Sayings of the Century',
           'price' => 9,
           'tags' => %w[asdf asdf2],
-          'this' => {}
-        },
+          'this' => {} },
         { 'category' => 'fiction',
           'author' => 'Evelyn Waugh',
           'title' => 'Sword of Honour',
-          'price' => 13
-        },
+          'price' => 13 },
         { 'category' => 'fiction',
           'author' => 'Aasdf',
           'title' => 'Aaasdf2',
-          'price' => 1
-        }
+          'price' => 1 }
       ]
     } }
     assert_equal(json_deleted, JsonPath.for(json).delete('$..store.book..delete_me').obj)
@@ -605,19 +599,19 @@ class TestJsonpath < MiniTest::Unit::TestCase
     json = {
       channels: [
         {
-          name: "King's Speech",
+          name: "King's Speech"
         }
       ]
     }.to_json
 
-    assert_equal [{"name" => "King\'s Speech"}], JsonPath.on(json, "$..channels[?(@.name == 'King\'s Speech')]")
+    assert_equal [{ 'name' => "King\'s Speech" }], JsonPath.on(json, "$..channels[?(@.name == 'King\'s Speech')]")
   end
 
   def test_curly_brackets
     data = {
       '{data}' => 'data'
     }
-    assert_equal ['data'], JsonPath.new("$.{data}").on(data)
+    assert_equal ['data'], JsonPath.new('$.{data}').on(data)
   end
 
   def test_symbolize
@@ -660,7 +654,7 @@ class TestJsonpath < MiniTest::Unit::TestCase
       }
     }
     '
-    assert_equal [{: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"}], JsonPath.new('$..book[::2]').on(data, {symbolize_keys: true})
+    assert_equal [{ 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' }], JsonPath.new('$..book[::2]').on(data, symbolize_keys: true)
   end
 
   def test_changed
@@ -724,10 +718,22 @@ class TestJsonpath < MiniTest::Unit::TestCase
 
   def test_complex_nested_grouping_unmatched_parent
     path = "$..book[?((@['author'] == 'Evelyn Waugh' || @['author'] == 'Herman Melville' && (@['price'] == 33 || @['price'] == 9))]"
-    err = assert_raises(ArgumentError, "should have raised an exception") { JsonPath.new(path).on(@object)}
+    err = assert_raises(ArgumentError, 'should have raised an exception') { JsonPath.new(path).on(@object) }
     assert_match(/unmatched parenthesis in expression: \(\(false \|\| false && \(false \|\| true\)\)/, err.message)
   end
 
+  def test_runtime_error_frozen_string
+    skip('in ruby version below 2.2.0 this error is not raised') if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.0')
+    json = '
+    {
+      "test": "something"
+    }
+    '.to_json
+    assert_raises(ArgumentError, "RuntimeError: character '|' not supported in query") do
+      JsonPath.on(json, '$.description|title')
+    end
+  end
+
   def test_delete_more_items
     a = { 'itemList' =>
       [{ 'alfa' => 'beta1' },

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonpath
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Joshua Hull
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-20 00:00:00.000000000 Z
+date: 2019-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: jsonpath
-rubygems_version: 2.6.13
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Ruby implementation of http://goessner.net/articles/JsonPath/