json_p3 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d20426353cc6a3b8f7be130f6b5d3dd8ff37dcad13ac2b81a7a421f70d0462c
-  data.tar.gz: c93805a6ca467e830881176da0b9203bf3cfce7d85690749621bf3609de43e1c
+  metadata.gz: afd5de1be45132d6071616dc7aa21425dc3d9beaed525315f017b343b434a42f
+  data.tar.gz: 19f0fc51ac0f8680e47808beda7f206ea9d911b33ebebaccb5803cd7bcd012c0
 SHA512:
-  metadata.gz: 329b8946de0220d55a7d1358bfd3062bced99420247b14d95ec023ab7fbb22a336534d227ebbf37766890f2c2c68bf5dc482504e10860b12845830930c560d5f
-  data.tar.gz: d248901e8c95aaa4ca7336d56439542cb4c6208c94993a6324e48b9dcbf95c00ed84040f36d697c99fe8b629e48c58f5c01bd0d55a6e8eac2ffa2af23ce06779
+  metadata.gz: 9c6458e2fc86fa09988edbc032ad434cca4125f1d6a368e2f8e37e79e65b80fb404d12a3ec9dfb42ef007dbfc2977a4492814c9a8d689900921e2cfa885b6c11
+  data.tar.gz: 54580931a9a37165dcbb10f8a240c8142a8de013cbc9e76776f59a5f60b43743f98db65daae7d85968d61a6eda1983df26f9ae8d8aaf1571b3a45106236a8ed1

data/.rubocop.yml

@@ -23,7 +23,7 @@ Metrics/CyclomaticComplexity:
   Max: 15
 
 Metrics/MethodLength:
-  Max: 35
+  Max: 50
 
 Metrics/PerceivedComplexity:
   Max: 20

data/.ruby-version

@@ -0,0 +1 @@
+3.3.6

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.3.2] - 2025-01-29
+
+- Fix normalized string representations of node locations as returned by `JSONPathNode.path`.
+- Fix canonical string representations of instances of `JSONPath`, as returned by `to_s`.
+- Fixed filter queries with multiple bracketed segments. Previously we were failing to tokenize queries like `$[?@[0][0]]`. See [#15](https://github.com/jg-rp/ruby-json-p3/issues/15).
+
+## [0.3.1] - 2024-12-05
+
+- Fix JSON Patch `move` and `copy` operations when using the special JSON Pointer token `-`.
+
 ## [0.3.0] - 2024-11-25
 
 - Implement JSON Pointer and Relative JSON Pointer

data/README.md

@@ -474,6 +474,12 @@ Print memory usage to the terminal.
 bundle exec ruby performance/memory_profile.rb
 ```
 
-### TruffleRuby
+### Notes to self
+
+#### Build
+
+`bundle exec rake release` and `bundle exec rake build` will look for `gem-private_key.pem` and `gem-public_cert.pem` in `~/.gem`.
+
+#### TruffleRuby
 
 On macOS Sonoma using MacPorts and `rbenv`, `LIBYAML_PREFIX=/opt/local/lib` is needed to install TruffleRuby and when executing any `bundle` command.

data/lib/json_p3/filter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "json"
 require_relative "function"
+require_relative "serialize"
 
 module JSONP3 # rubocop:disable Style/Documentation
   # Base class for all filter expression nodes.
@@ -33,7 +33,7 @@ module JSONP3 # rubocop:disable Style/Documentation
     end
 
     def to_s
-      @expression.to_s
+      to_canonical_string(@expression, Precedence::LOWEST)
     end
 
     def ==(other)
@@ -47,6 +47,39 @@ module JSONP3 # rubocop:disable Style/Documentation
     def hash
       [@expression, @token].hash
     end
+
+    private
+
+    class Precedence
+      LOWEST = 1
+      LOGICAL_OR = 3
+      LOGICAL_AND = 4
+      PREFIX = 7
+    end
+
+    def to_canonical_string(expression, parent_precedence)
+      if expression.instance_of? LogicalAndExpression
+        left = to_canonical_string(expression.left, Precedence::LOGICAL_AND)
+        right = to_canonical_string(expression.right, Precedence::LOGICAL_AND)
+        expr = "#{left} && #{right}"
+        return parent_precedence >= Precedence::LOGICAL_AND ? "(#{expr})" : expr
+      end
+
+      if expression.instance_of? LogicalOrExpression
+        left = to_canonical_string(expression.left, Precedence::LOGICAL_OR)
+        right = to_canonical_string(expression.right, Precedence::LOGICAL_OR)
+        expr = "#{left} || #{right}"
+        return parent_precedence >= Precedence::LOGICAL_OR ? "(#{expr})" : expr
+      end
+
+      if expression.instance_of? LogicalNotExpression
+        operand = to_canonical_string(expression.expression, Precedence::PREFIX)
+        expr = "!#{operand}"
+        return parent_precedence > Precedence::PREFIX ? `(#{expr})` : expr
+      end
+
+      expression.to_s
+    end
   end
 
   # Base class for expression literals.
@@ -85,7 +118,7 @@ module JSONP3 # rubocop:disable Style/Documentation
   # A double or single quoted string literal.
   class StringLiteral < FilterExpressionLiteral
     def to_s
-      JSON.generate(@value)
+      JSONP3.canonical_string(@value)
     end
   end
 

data/lib/json_p3/lexer.rb

@@ -209,7 +209,7 @@ module JSONP3 # rubocop:disable Style/Documentation
         case c
         when "]"
           emit(:token_rbracket, "]")
-          return @filter_depth.positive? ? :lex_inside_filter : :lex_segment
+          return :lex_segment
         when ""
           error "unclosed bracketed selection"
           return nil

data/lib/json_p3/node.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "serialize"
+
 module JSONP3
   # A JSON-like value and its location.
   class JSONPathNode
@@ -19,7 +21,7 @@ module JSONP3
     # Return the normalized path to this node.
     # @return [String] the normalized path.
     def path
-      segments = @location.flatten.map { |i| i.is_a?(String) ? "['#{i}']" : "[#{i}]" }
+      segments = @location.flatten.map { |i| i.is_a?(String) ? "[#{JSONP3.canonical_string(i)}]" : "[#{i}]" }
       "$#{segments.join}"
     end
 

data/lib/json_p3/parser.rb

@@ -116,7 +116,7 @@ module JSONP3
       end
     end
 
-    def parse_bracketed_selection(stream) # rubocop:disable Metrics/MethodLength
+    def parse_bracketed_selection(stream)
       stream.expect(:token_lbracket)
       segment_token = stream.next
 
@@ -245,7 +245,7 @@ module JSONP3
       FilterSelector.new(@env, token, FilterExpression.new(token, expression))
     end
 
-    def parse_filter_expression(stream, precedence = Precedence::LOWEST) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
+    def parse_filter_expression(stream, precedence = Precedence::LOWEST) # rubocop:disable Metrics/CyclomaticComplexity
       left = case stream.peek.type
              when :token_double_quote_string, :token_single_quote_string
                token = stream.next
@@ -313,7 +313,7 @@ module JSONP3
       end
     end
 
-    def parse_function_expression(stream) # rubocop:disable Metrics/MethodLength
+    def parse_function_expression(stream)
       token = stream.next
       args = [] # : Array[Expression]
 

data/lib/json_p3/patch.rb

@@ -220,7 +220,11 @@ module JSONP3
 
       # Write the source value to the destination.
       if dest_parent.is_a?(Array)
-        dest_parent[dest_target.to_i] = source_obj
+        if dest_target == "-"
+          dest_parent << source_obj
+        else
+          dest_parent[dest_target.to_i] = source_obj
+        end
       elsif dest_parent.is_a?(Hash)
         dest_parent[dest_target] = source_obj
       end
@@ -267,7 +271,11 @@ module JSONP3
 
       # Write the source value to the destination.
       if dest_parent.is_a?(Array)
-        dest_parent.insert(dest_target.to_i, deep_copy(source_obj))
+        if dest_target == "-"
+          dest_parent << source_obj
+        else
+          dest_parent.insert(dest_target.to_i, deep_copy(source_obj))
+        end
       elsif dest_parent.is_a?(Hash)
         dest_parent[dest_target] = deep_copy(source_obj)
       else

data/lib/json_p3/selector.rb

@@ -46,7 +46,7 @@ module JSONP3
     end
 
     def to_s
-      @name.inspect
+      JSONP3.canonical_string(@name)
     end
 
     def ==(other)

data/lib/json_p3/serialize.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "json"
+
+module JSONP3 # rubocop:disable Style/Documentation
+  TRANS = { "\\\"" => "\"", "'" => "\\'" }.freeze
+
+  # Return _value_ formatted as a canonical string literal.
+  # @param value [String]
+  def self.canonical_string(value)
+    "'#{(JSON.dump(value)[1..-2] || raise).gsub(/('|\\")/, TRANS)}'"
+  end
+end

data/lib/json_p3/unescape.rb

@@ -6,7 +6,7 @@ module JSONP3 # rubocop:disable Style/Documentation
   # @param quote [String] one of '"' or "'".
   # @param token [Token]
   # @return [String] A new string without escape sequences.
-  def self.unescape_string(value, quote, token) # rubocop:disable Metrics/MethodLength
+  def self.unescape_string(value, quote, token)
     unescaped = String.new(encoding: "UTF-8")
     index = 0
     length = value.length

data/lib/json_p3/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JSONP3
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

data/sig/json_p3.rbs

@@ -126,7 +126,7 @@ module JSONP3
 
     def initialize: (Token token) -> void
 
-    # Evaluate the filter expressin in the given context.
+    # Evaluate the filter expression in the given context.
     def evaluate: (FilterContext _context) -> untyped
   end
 
@@ -147,6 +147,10 @@ module JSONP3
     alias eql? ==
 
     def hash: () -> Integer
+            
+    private
+
+    def to_canonical_string: (Expression expression, Integer parent_precedence) -> String
   end
 
   # Base class for expression literals.
@@ -394,7 +398,7 @@ module JSONP3
   # @return [Array<Token>]
   def self.tokenize: (String query) -> Array[Token]
 
-  # JSONPath query expreession lexical scanner.
+  # JSONPath query expression lexical scanner.
   #
   # @see tokenize
   class Lexer
@@ -428,7 +432,7 @@ module JSONP3
     # Generate a new token with the given type.
     # @param token_type [Symbol] one of the constants defined on the _Token_ class.
     # @param value [String | nil] a the token's value, if it is known, otherwise the
-    #   value will be sliced from @query. This is a performance optimisation.
+    #   value will be sliced from @query. This is a performance optimization.
     def emit: (token_t token_type, ?untyped value) -> void
 
     def next: () -> String
@@ -488,7 +492,7 @@ module JSONP3
 
     # @param value [JSON-like] the value at this node.
     # @param location [Array<String | Integer | Array<String | Integer>>] the sequence of
-    #   names and/or indicies leading to _value_ in _root_.
+    #   names and/or indices leading to _value_ in _root_.
     # @param root [JSON-like] the root value containing _value_ at _location_.
     def initialize: (untyped value, Array[location_element] location, untyped root) -> void
 
@@ -498,7 +502,7 @@ module JSONP3
 
     # Return a new node that is a child of this node.
     # @param value the JSON-like value at the new node.
-    # @param key [Integer, String] the array index or hash key assiciated with _value_.
+    # @param key [Integer, String] the array index or hash key associated with _value_.
     def new_child: (untyped value, String | Integer key) -> JSONPathNode
 
     def to_s: () -> ::String
@@ -926,7 +930,7 @@ module JSONP3
   # @param value [String]
   # @param quote [String] one of '"' or "'".
   # @param token [Token]
-  # @return [String] A new string without escape seqeuences.
+  # @return [String] A new string without escape sequences.
   def self.unescape_string: (String value, String quote, Token token) -> String
 
   def self.decode_hex_char: (untyped value, untyped index, Token token) -> ::Array[untyped]
@@ -938,6 +942,8 @@ module JSONP3
   def self.low_surrogate?: (untyped code_point) -> untyped
 
   def self.code_point_to_string: (untyped code_point, Token token) -> untyped
+
+  def self.canonical_string: (untyped String) -> ::String
 end
 
 module JSONP3
@@ -1162,7 +1168,7 @@ module JSONP3
   class OpRemove < Op
     @pointer: JSONPointer
 
-    # @param papointerth [JSONPointer]
+    # @param pointer [JSONPointer]
     def initialize: (JSONPointer pointer) -> void
 
     def name: () -> "remove"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_p3
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - James Prior
@@ -36,7 +36,7 @@ cert_chain:
   6dM18fnfBc3yA4KI7AO8UAmRkTscMYV6f/K4YZR6ZYCNWRpY7rkg+arhf05aoSQf
   vn9bO1bzwdnG
   -----END CERTIFICATE-----
-date: 2024-11-25 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies: []
 description: JSONPath following RFC 9535
 email:
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".ruby-version"
 - ".yardopts"
 - CHANGELOG.md
 - LICENCE
@@ -73,6 +74,7 @@ files:
 - lib/json_p3/pointer.rb
 - lib/json_p3/segment.rb
 - lib/json_p3/selector.rb
+- lib/json_p3/serialize.rb
 - lib/json_p3/token.rb
 - lib/json_p3/unescape.rb
 - lib/json_p3/version.rb
@@ -106,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: 'JSONPath: Query Expressions for JSON in Ruby'