json_p3 0.4.0 → 1.0.0

data/lib/json_p3/patch.rb

@@ -1,329 +1,14 @@
 # frozen_string_literal: true
 
 require "English"
-require_relative "errors"
 
 module JSONP3
-  # Base class for all JSON Patch operations
-  class Op
-    # Return the name of the patch operation.
-    def name
-      raise "JSON Patch operations must implement #name"
-    end
-
-    # Apply the patch operation to _value_.
-    def apply(_value, _index)
-      raise "JSON Patch operations must implement apply(value, index)"
-    end
-
-    # Return a JSON-like representation of this patch operation.
-    def to_h
-      raise "JSON Patch operations must implement #to_h"
-    end
-  end
-
-  # The JSON Patch _add_ operation.
-  class OpAdd < Op
-    # @param pointer [JSONPointer]
-    # @param value [JSON-like value]
-    def initialize(pointer, value)
-      super()
-      @pointer = pointer
-      @value = value
-    end
-
-    def name
-      "add"
-    end
-
-    def apply(value, index)
-      parent, obj = @pointer.resolve_with_parent(value)
-      return @value if parent == JSONP3::JSONPointer::UNDEFINED && @pointer.tokens.empty?
-
-      if parent == JSONP3::JSONPointer::UNDEFINED
-        raise JSONPatchError,
-              "no such property or item '#{@pointer.parent}' (#{name}:#{index})"
-      end
-
-      target = @pointer.tokens.last
-      if parent.is_a?(Array)
-        if obj == JSONP3::JSONPointer::UNDEFINED
-          raise JSONPatchError, "index out of range (#{name}:#{index})" unless target == "-"
-
-          parent << @value
-        else
-          parent.insert(target.to_i, @value)
-        end
-      elsif parent.is_a?(Hash)
-        parent[target] = @value
-      else
-        raise JSONPatchError, "unexpected operation on #{parent.class} (#{name}:#{index})"
-      end
-
-      value
-    end
-
-    def to_h
-      { "op" => name, "path" => @pointer.to_s, "value" => @value }
-    end
-  end
-
-  # The JSON Patch _remove_ operation.
-  class OpRemove < Op
-    # @param pointer [JSONPointer]
-    def initialize(pointer)
-      super()
-      @pointer = pointer
-    end
-
-    def name
-      "remove"
-    end
-
-    def apply(value, index)
-      parent, obj = @pointer.resolve_with_parent(value)
-
-      if parent == JSONP3::JSONPointer::UNDEFINED && @pointer.tokens.empty?
-        raise JSONPatchError,
-              "can't remove root (#{name}:#{index})"
-      end
-
-      if parent == JSONP3::JSONPointer::UNDEFINED
-        raise JSONPatchError,
-              "no such property or item '#{@pointer.parent}' (#{name}:#{index})"
-      end
-
-      target = @pointer.tokens.last
-      if target == JSONP3::JSONPointer::UNDEFINED
-        raise JSONPatchError,
-              "unexpected operation (#{name}:#{index})"
-      end
-
-      if parent.is_a?(Array)
-        raise JSONPatchError, "no item to remove (#{name}:#{index})" if obj == JSONP3::JSONPointer::UNDEFINED
-
-        parent.delete_at(target.to_i)
-      elsif parent.is_a?(Hash)
-        raise JSONPatchError, "no property to remove (#{name}:#{index})" if obj == JSONP3::JSONPointer::UNDEFINED
-
-        parent.delete(target)
-      else
-        raise JSONPatchError, "unexpected operation on #{parent.class} (#{name}:#{index})"
-      end
-
-      value
-    end
-
-    def to_h
-      { "op" => name, "path" => @pointer.to_s }
-    end
-  end
-
-  # The JSON Patch _replace_ operation.
-  class OpReplace < Op
-    # @param pointer [JSONPointer]
-    # @param value [JSON-like value]
-    def initialize(pointer, value)
-      super()
-      @pointer = pointer
-      @value = value
-    end
-
-    def name
-      "replace"
-    end
-
-    def apply(value, index)
-      parent, obj = @pointer.resolve_with_parent(value)
-      return @value if parent == JSONP3::JSONPointer::UNDEFINED && @pointer.tokens.empty?
-
-      if parent == JSONP3::JSONPointer::UNDEFINED
-        raise JSONPatchError,
-              "no such property or item '#{@pointer.parent}' (#{name}:#{index})"
-      end
-
-      target = @pointer.tokens.last
-      if target == JSONP3::JSONPointer::UNDEFINED
-        raise JSONPatchError,
-              "unexpected operation (#{name}:#{index})"
-      end
-
-      if parent.is_a?(Array)
-        raise JSONPatchError, "no item to replace (#{name}:#{index})" if obj == JSONP3::JSONPointer::UNDEFINED
-
-        parent[target.to_i] = @value
-      elsif parent.is_a?(Hash)
-        raise JSONPatchError, "no property to replace (#{name}:#{index})" if obj == JSONP3::JSONPointer::UNDEFINED
-
-        parent[target] = @value
-      else
-        raise JSONPatchError, "unexpected operation on #{parent.class} (#{name}:#{index})"
-      end
-
-      value
-    end
-
-    def to_h
-      { "op" => name, "path" => @pointer.to_s, "value" => @value }
-    end
-  end
-
-  # The JSON Patch _move_ operation.
-  class OpMove < Op
-    # @param from [JSONPointer]
-    # @param pointer [JSONPointer]
-    def initialize(from, pointer)
-      super()
-      @from = from
-      @pointer = pointer
-    end
-
-    def name
-      "move"
-    end
-
-    def apply(value, index)
-      if @pointer.relative_to?(@from)
-        raise JSONPatchError,
-              "can't move object to one of its children (#{name}:#{index})"
-      end
-
-      # Grab the source value.
-      source_parent, source_obj = @from.resolve_with_parent(value)
-      if source_obj == JSONP3::JSONPointer::UNDEFINED
-        raise JSONPatchError,
-              "source object does not exist (#{name}:#{index})"
-      end
-
-      source_target = @from.tokens.last
-      if source_target == JSONP3::JSONPointer::UNDEFINED
-        raise JSONPatchError,
-              "unexpected operation (#{name}:#{index})"
-      end
-
-      # Delete the target value from the source location.
-      if source_parent.is_a?(Array)
-        source_parent.delete_at(source_target.to_i)
-      elsif source_parent.is_a?(Hash)
-        source_parent.delete(source_target)
-      end
-
-      # Find the parent of the destination pointer.
-      dest_parent, _dest_obj = @pointer.resolve_with_parent(value)
-      return source_obj if dest_parent == JSONP3::JSONPointer::UNDEFINED
-
-      dest_target = @pointer.tokens.last
-      if dest_target == JSONP3::JSONPointer::UNDEFINED
-        raise JSONPatchError,
-              "unexpected operation (#{name}:#{index})"
-      end
-
-      # Write the source value to the destination.
-      if dest_parent.is_a?(Array)
-        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
-
-      value
-    end
-
-    def to_h
-      { "op" => name, "from" => @from.to_s, "path" => @pointer.to_s }
-    end
-  end
-
-  # The JSON Patch _copy_ operation.
-  class OpCopy < Op
-    # @param from [JSONPointer]
-    # @param pointer [JSONPointer]
-    def initialize(from, pointer)
-      super()
-      @from = from
-      @pointer = pointer
-    end
-
-    def name
-      "copy"
-    end
-
-    def apply(value, index)
-      # Grab the source value.
-      _source_parent, source_obj = @from.resolve_with_parent(value)
-      if source_obj == JSONP3::JSONPointer::UNDEFINED
-        raise JSONPatchError,
-              "source object does not exist (#{name}:#{index})"
-      end
-
-      # Find the parent of the destination pointer.
-      dest_parent, _dest_obj = @pointer.resolve_with_parent(value)
-      return deep_copy(source_obj) if dest_parent == JSONP3::JSONPointer::UNDEFINED
-
-      dest_target = @pointer.tokens.last
-      if dest_target == JSONP3::JSONPointer::UNDEFINED
-        raise JSONPatchError,
-              "unexpected operation (#{name}:#{index})"
-      end
-
-      # Write the source value to the destination.
-      if dest_parent.is_a?(Array)
-        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
-        raise JSONPatchError, "unexpected operation on #{dest_parent.class} (#{name}:#{index})"
-      end
-
-      value
-    end
-
-    def to_h
-      { "op" => name, "from" => @from.to_s, "path" => @pointer.to_s }
-    end
-
-    private
-
-    def deep_copy(obj)
-      Marshal.load(Marshal.dump(obj))
-    end
-  end
-
-  # The JSON Patch _test_ operation.
-  class OpTest < Op
-    # @param pointer [JSONPointer]
-    # @param value [JSON-like value]
-    def initialize(pointer, value)
-      super()
-      @pointer = pointer
-      @value = value
-    end
-
-    def name
-      "test"
-    end
-
-    def apply(value, index)
-      obj = @pointer.resolve(value)
-      raise JSONPatchTestFailure, "test failed (#{name}:#{index})" if obj != @value
-
-      value
-    end
-
-    def to_h
-      { "op" => name, "path" => @pointer.to_s, "value" => @value }
+  # A JSON Patch containing zero or more patch operations.
+  class Patch
+    def self.apply!(ops, value)
+      new(ops).apply!(value)
     end
-  end
 
-  # A JSON Patch containing zero or more patch operations.
-  class JSONPatch
     # @param ops [Array<Op | Hash<String, untyped>>?]
     def initialize(ops = nil)
       @ops = []
@@ -384,8 +69,8 @@ module JSONP3
     end
 
     # Apply this patch to JSON-like value _value_.
-    def apply(value)
-      @ops.each_with_index { |op, i| value = op.apply(value, i) }
+    def apply!(value)
+      @ops.each_with_index { |op, i| value = op.apply!(value, i) }
       value
     end
 
@@ -418,22 +103,22 @@ module JSONP3
         when "test"
           test(op_pointer(obj, "path", "test", i), op_value(obj, "value", "test", i))
         else
-          raise JSONPatchError,
+          raise Patch::Error,
                 "expected 'op' to be one of 'add', 'remove', 'replace', 'move', 'copy' or 'test' (#{obj["op"]}:#{i})"
         end
       end
     end
 
     def op_pointer(obj, key, op, index)
-      raise JSONPatchError, "missing property '#{key}' (#{op}:#{index})" unless obj.key?(key)
+      raise Patch::Error, "missing property '#{key}' (#{op}:#{index})" unless obj.key?(key)
 
-      JSONP3::JSONPointer.new(obj[key])
-    rescue JSONPointerError
-      raise JSONPatchError, "#{$ERROR_INFO} (#{op}:#{index})"
+      JSONP3::Pointer.new(obj[key])
+    rescue Pointer::Error
+      raise Patch::Error, "#{$ERROR_INFO} (#{op}:#{index})"
     end
 
     def op_value(obj, key, op, index)
-      raise JSONPatchError, "missing property '#{key}' (#{op}:#{index})" unless obj.key?(key)
+      raise Patch::Error, "missing property '#{key}' (#{op}:#{index})" unless obj.key?(key)
 
       obj[key]
     end
@@ -441,9 +126,9 @@ module JSONP3
     def ensure_pointer(pointer, op, index)
       return pointer unless pointer.is_a?(String)
 
-      JSONP3::JSONPointer.new(pointer)
-    rescue JSONPointerError
-      raise JSONPatchError, "#{$ERROR_INFO} (#{op}:#{index})"
+      JSONP3::Pointer.new(pointer)
+    rescue Pointer::Error
+      raise Patch::Error, "#{$ERROR_INFO} (#{op}:#{index})"
     end
   end
 end

data/lib/json_p3/path/environment.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require_relative "lexer"
+require_relative "parser"
+require_relative "query"
+require_relative "function"
+require_relative "function_extensions/length"
+require_relative "function_extensions/value"
+require_relative "function_extensions/count"
+require_relative "function_extensions/match"
+require_relative "function_extensions/search"
+
+module JSONP3
+  module Path
+    # JSONPath configuration
+    #
+    # Configure an environment by inheriting from `Environment` and setting one
+    # or more constants and/or overriding {setup_function_extensions}.
+    class Environment
+      # The maximum integer allowed when selecting array items by index.
+      MAX_INT_INDEX = (2**53) - 1
+
+      # The minimum integer allowed when selecting array items by index.
+      MIN_INT_INDEX = -(2**53) + 1
+
+      # The maximum number of arrays and hashes the descendent segment will traverse
+      # before raising a {JSONPathRecursionError}.
+      MAX_RECURSION_DEPTH = 100
+
+      # One of the available implementations of the _name selector_.
+      #
+      # - {NameSelector} (the default) will select values from hashes using string keys.
+      # - {SymbolNameSelector} will select values from hashes using string or symbol keys.
+      #
+      # Implement your own name selector by inheriting from {NameSelector} and overriding
+      # `#resolve`.
+      NAME_SELECTOR = NameSelector
+
+      # An implementation of the _index selector_. The default implementation will
+      # select values from arrays only. Implement your own by inheriting from
+      # {IndexSelector} and overriding `#resolve`.
+      INDEX_SELECTOR = IndexSelector
+
+      attr_accessor :function_extensions
+
+      def initialize
+        @function_extensions = {}
+        setup_function_extensions
+      end
+
+      # Prepare JSONPath expression _query_ for repeated application.
+      # @param query [String]
+      # @return [Query]
+      def compile(query)
+        tokens = JSONP3::Path.tokenize(query)
+        Query.new(self, Parser.new(self, query, tokens).parse)
+      end
+
+      # Apply JSONPath expression _query_ to _value_.
+      # @param query [String] the JSONPath expression
+      # @param value [JSON-like data] the target JSON "document"
+      # @return [Array<JSONPath>]
+      def find(query, value)
+        compile(query).find(value)
+      end
+
+      # Apply JSONPath expression _query_ to _value_.
+      # @param query [String] the JSONPath expression
+      # @param value [JSON-like data] the target JSON "document"
+      # @return [Enumerable<JSONPath>]
+      def find_enum(query, value)
+        compile(query).find_enum(value)
+      end
+
+      # Apply JSONPath expression _query_ to _value_ an return the first
+      # available node.
+      # @param query [String] the JSONPath expression
+      # @param value [JSON-like data] the target JSON "document"
+      # @return [JSONPathNode | nil]
+      def match(path, value)
+        find_enum(path, value).first
+      end
+
+      # Apply JSONPath expression _query_ to _value_ an return `true` if there's at
+      # least one node, or nil if there were no matches.
+      # @param query [String] the JSONPath expression
+      # @param value [JSON-like data] the target JSON "document"
+      # @return [bool]
+      def match?(path, value)
+        !find_enum(path, value).first.nil?
+      end
+
+      # Apply JSONPath expression _query_ to _value_ an return the first
+      # available node, or nil if there were no matches.
+      # @param query [String] the JSONPath expression
+      # @param value [JSON-like data] the target JSON "document"
+      # @return [JSONPathNode | nil]
+      def first(path, value)
+        find_enum(path, value).first
+      end
+
+      # Override this function to configure JSONPath function extensions.
+      # By default, only the standard functions described in RFC 9535 are enabled.
+      def setup_function_extensions
+        @function_extensions["length"] = Length.new
+        @function_extensions["count"] = Count.new
+        @function_extensions["value"] = Value.new
+        @function_extensions["match"] = Match.new
+        @function_extensions["search"] = Search.new
+      end
+    end
+  end
+end