janeway-jsonpath 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33fc9254c0443121404ced6b9e60c15133111299b8f7052f012fe45d7ad4d281
-  data.tar.gz: c5a9eea01a8a332343b47328c64991a52fc50292969247433650914c8af727bd
+  metadata.gz: 9b4502d1b125c833d8a142b6cbecc1fa01f30aefcfe5f06b8526037c70e0d071
+  data.tar.gz: 28b8f3e14cb83b7941d50ac8a4da408e1ff9cdb72cd206fc5dba2e1cc481da97
 SHA512:
-  metadata.gz: 0c101d0e02380fc56bd4abc83b5012965e3281aabc3bcce10e7f55c6cff61ba5b825f0d582f95c076234e01d59f07a8db19e6b8984c85e923c780d6f362adc2c
-  data.tar.gz: e2a762c773653c01415dee8f988b95be53d45da8bb3d1ed6f20817eb333fce00b3c960f9268a2212c929a27582d4c0cdb8e480e3948b2e193974f452b32e526f
+  metadata.gz: 4fe6e4fe0daec50df309251916bda911a4eada27274dd817d5b03b90aeaa3fdaae9a7918cd467644df100b3dc3aa192eaffa8d7a25ceed452a47ca35ad059223
+  data.tar.gz: eeb8197665932f9ad24c582ced1331c2b8cded6fc7d978477b1fc96f5bff268b68d4461e5a7220e7717a0da252c6b85c429f72b27596ac4ac68cb32bb40f6de0

data/README.md

@@ -29,7 +29,7 @@ Install the gem from the command-line:
 or add it to your Gemfile:
 
 ```
-    gem 'janeway-jsonpath', '~> 0.4.0'
+    gem 'janeway-jsonpath', '~> 0.6'
 ```
 
 ### Usage

data/lib/janeway/ast/child_segment.rb

@@ -15,6 +15,7 @@ module Janeway
     #    $[name1, [1:10]]
     class ChildSegment < Janeway::AST::Expression
       extend Forwardable
+
       def_delegators :@value, :size, :first, :last, :each, :map, :empty?
 
       # Subsequent expression that modifies the result of this selector list.

data/lib/janeway/ast/expression.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'helpers'
 require_relative 'error'
 
@@ -37,7 +38,7 @@ module Janeway
       # @param msg [String]
       # @return [String]
       def indented(level, msg)
-        format('%s%s', (INDENT * level), msg)
+        format('%s%s', INDENT * level, msg)
       end
 
       # @param level [Integer]

data/lib/janeway/enumerator.rb

@@ -56,7 +56,7 @@ module Janeway
     # Assign the given value at every query match.
     # @param replacement [Object]
     # @return [void]
-    def replace(replacement = :no_replacement_value_was_given, &block)
+    def replace(replacement = :no_replacement_value_was_given, &_)
       if replacement != :no_replacement_value_was_given && block_given?
         raise Janeway::Error.new('#replace needs either replacement value or block, not both', @query)
       end
@@ -118,6 +118,15 @@ module Janeway
       end
     end
 
+    # Return the normalized path of every query match.
+    #
+    # @see https://www.rfc-editor.org/rfc/rfc9535.html#name-normalized-paths
+    #
+    # @return [Array<String>] normalized paths, eg. [ "$['key'][0]"] ]
+    def find_paths
+      map { |_, _, _, path| path }
+    end
+
     private
 
     # Find the 'parent' of the object pointed to by the query. For singular query only.
@@ -149,7 +158,7 @@ module Janeway
     # @param path [String] jsonpath singular query to parent
     # @yieldparam [Hash] parent object
     # @yieldparam [String] hash key
-    def insert_into_hash(hash, key, value, path, &block)
+    def insert_into_hash(hash, key, value, path, &_)
       unless key.is_a?(String) || key.is_a?(Symbol)
         raise Error.new("cannot use #{key.inspect} as hash key", @query.to_s)
       end
@@ -172,7 +181,7 @@ module Janeway
     # @param path [String] jsonpath singular query to parent
     # @yieldparam [Array] parent object
     # @yieldparam [Integer] array index
-    def insert_into_array(array, index, value, path, &block)
+    def insert_into_array(array, index, value, path)
       raise Error.new("cannot use #{index.inspect} as array index", @query.to_s) unless index.is_a?(Integer)
 
       if index < array.size

data/lib/janeway/interpreter.rb

@@ -50,10 +50,6 @@ module Janeway
     # @param input [Array, Hash] object to be searched
     # @return [Object]
     def interpret(input)
-      unless input.is_a?(Hash) || input.is_a?(Array)
-        return [] # can't query on any other types, but need to check because a string is also valid json
-      end
-
       @root.interpret(nil, nil, input, [])
     rescue StandardError => e
       # Error during interpretation. Convert it to a Janeway::Error and include the query in the message

data/lib/janeway/interpreters/descendant_segment_interpreter.rb

@@ -37,7 +37,7 @@ module Janeway
         end
         # basic types are ignored, they will be added by one of the above
 
-        results.flatten(1).compact
+        results.flatten(1)
       end
     end
   end

data/lib/janeway/interpreters/index_selector_delete_if.rb

@@ -28,8 +28,10 @@ module Janeway
 
         index = selector.value
         result = input.fetch(index) # raises IndexError if no such index
+        index += input.size if index.negative? # yield positive index for the normalize path
         return unless @yield_proc.call(input[index], input, path + [index])
 
+        index += input.size if index.negative?
         input.delete_at(index) # returns nil if deleted value is nil, or if no value was deleted
         [result]
       rescue IndexError

data/lib/janeway/interpreters/index_selector_interpreter.rb

@@ -31,7 +31,9 @@ module Janeway
         result = input.fetch(selector.value) # raises IndexError if no such index
         return [result] unless @next
 
-        @next.interpret(result, input, root, path + [selector.value])
+        index = selector.value
+        index += input.size if index.negative?
+        @next.interpret(result, input, root, path + [index])
       rescue IndexError
         []
       end

data/lib/janeway/lexer.rb

@@ -72,6 +72,7 @@ module Janeway
     end
 
     def start_tokenization
+      raise err('JSONPath query is empty') if @source.empty?
       if WHITESPACE.include?(@source[0]) || WHITESPACE.include?(@source[-1])
         raise err('JSONPath query may not start or end with whitespace')
       end
@@ -470,6 +471,7 @@ module Janeway
     end
 
     # Lex a member name that is found within dot notation.
+    # This name is not delimited and allows a subset of the characters that can appear in a delimited string.
     #
     # Recognize keywords and given them the correct type.
     # @see https://www.rfc-editor.org/rfc/rfc9535.html#section-2.5.1.1-3
@@ -477,6 +479,10 @@ module Janeway
     # @param ignore_keywords [Boolean]
     # @return [Token]
     def lex_member_name_shorthand(ignore_keywords: false)
+      # Abort if name is preceded by child_start.  Catches non-delimited identifiers in brackets,
+      # eg.  $["key"] is allowed, but $[key] is not
+      raise err('Identifier within brackets must be surrounded by quotes') if @tokens.last&.type == :child_start
+
       consume while name_char?(lookahead)
       identifier = source[lexeme_start_p..(next_p - 1)]
       type =

data/lib/janeway/normalized_path.rb

@@ -46,11 +46,18 @@ module Janeway
     def self.escape_char(char)
       # Character ranges defined by https://www.rfc-editor.org/rfc/rfc9535.html#section-2.7-8
       case char.ord
-      when 0x20..0x26, 0x28..0x5B, 0x5D..0xD7FF, 0xE000..0x10FFFF # normal-unescaped range
-        char # unescaped
-      when 0x62, 0x66, 0x6E, 0x72, 0x74, 0x27, 0x5C # normal-escapable range
-        # backspace, form feed, line feed, carriage return, horizontal tab, apostrophe, backslash
-        "\\#{char}" # escaped
+      # normal-unescaped range
+      when 0x20..0x26, 0x28..0x5B, 0x5D..0xD7FF, 0xE000..0x10FFFF then char # unescaped
+
+      # normal-escapable range
+      when 0x08 then '\\b' # backspace
+      when 0x0C then '\\f' # form feed
+      when 0x0A then '\\n' # line feed / newline
+      when 0x0D then '\\r' # carriage return
+      when 0x09 then '\\t' # horizontal tab
+      when 0x27 then '\\\'' # apostrophe
+      when 0x5C then '\\\\' # backslash
+
       else # normal-hexchar range
         hex_encode_char(char)
       end

data/lib/janeway/query.rb

@@ -90,9 +90,7 @@ module Janeway
     #
     # @return [AST::Selector]
     def pop
-      unless singular_query?
-        raise Janeway::Error.new('not allowed to pop from a non-singular query', to_s)
-      end
+      raise Janeway::Error.new('not allowed to pop from a non-singular query', to_s) unless singular_query?
 
       # Sever the link to the last selector
       nodes = node_list

data/lib/janeway/version.rb

@@ -2,5 +2,5 @@
 
 module Janeway
   # Version for janeway-jsonpath gem
-  VERSION = '0.6.0'
+  VERSION = '1.0.0'
 end

data/lib/janeway.rb

@@ -54,8 +54,8 @@ module Janeway
     Janeway::Parser.parse(query)
   end
 
-  # Transform a jsonpath singular query into an array of values suitable for
-  # providing to Hash#dig or Array#dig.
+  # Transform a jsonpath singular query into an array of hash keys and/or array
+  # indexes suitable for providing to Hash#dig or Array#dig.
   #
   # Only singular queries are allowed, meaning queries that contain only name
   # selectors (ie. hash keys) and index selectors (array indexes.)
@@ -67,6 +67,19 @@ module Janeway
   # @param jsonpath [String] jsonpath query
   # @return [Array<String, Integer>]
   def self.path_to_diggable(jsonpath)
-    raise NotImplementedError
+    raise Janeway::Error.new('Query has nothing to dig', jsonpath) if jsonpath == '$'
+
+    # Parse query and determine whether it can be converted
+    query = parse(jsonpath)
+    unless query.singular_query?
+      raise Janeway::Error.new('Only a singular query can be converted to dig parameters', jsonpath)
+    end
+
+    # Convert query to a list of name and index selectors
+    nodes = query.node_list
+    nodes.shift # discard the root identifier
+
+    # Extract values from selectors
+    nodes.map(&:value)
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: janeway-jsonpath
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Fraser Hanson
 bindir: bin
 cert_chain: []
-date: 2025-02-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: |+
   JSONPath is a query language for selecting and extracting values from a JSON text.
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: jsonpath parser which implements the finalized IETF standard of Goessner
   JSONPath