json_p3 0.4.1 → 1.0.0

data/lib/json_p3/errors.rb

@@ -1,57 +1,65 @@
 # frozen_string_literal: true
 
 module JSONP3
-  # An exception raised when a JSONPathEnvironment is misconfigured.
-  class JSONPathEnvironmentError < StandardError; end
+  # Base class for all errors raised from this gem.
+  class Error < StandardError; end
 
-  # Base class for JSONPath exceptions that happen when parsing or evaluating a query.
-  class JSONPathError < StandardError
-    FULL_MESSAGE = ((RUBY_VERSION.split(".")&.map(&:to_i) <=> [3, 2, 0]) || -1) < 1
+  module Path
+    # Base class for all JSONPath errors.
+    class Error < JSONP3::Error
+      FULL_MESSAGE = ((RUBY_VERSION.split(".")&.map(&:to_i) <=> [3, 2, 0]) || -1) < 1
 
-    def initialize(msg, token)
-      super(msg)
-      @token = token
-    end
+      def initialize(msg, token, query)
+        super(msg)
+        @token = token
+        @query = query
+      end
 
-    def detailed_message(highlight: true, **_kwargs)
-      if @token.query.strip.empty?
-        "empty query"
-      else
-        lines = @token.query[...@token.start]&.lines or [""] # pleasing the type checker
-        lineno = lines.length
-        col = lines[-1].length
-        pad = " " * lineno.to_s.length
-        pointer = (" " * col) + ("^" * [@token.value.length, 1].max)
-        <<~ENDOFMESSAGE.strip
-          #{self.class}: #{message}
-          #{pad} -> '#{@token.query}' #{lineno}:#{col}
-          #{pad} |
-          #{lineno} | #{@token.query}
-          #{pad} | #{pointer} #{highlight ? "\e[1m#{message}\e[0m" : message}
-        ENDOFMESSAGE
+      def detailed_message(highlight: true, **_kwargs)
+        if @query.strip.empty?
+          "empty query"
+        else
+          value = JSONP3::Path.get_token_value(@token, @query)
+          lines = @query[...@token[1]]&.lines or [""] # pleasing the type checker
+          lineno = lines.length
+          col = lines.last.length
+          pad = " " * lineno.to_s.length
+          pointer = (" " * col) + ("^" * [value.length, 1].max)
+          <<~ENDOFMESSAGE.strip
+            #{self.class}: #{message}
+            #{pad} -> '#{@query}' #{lineno}:#{col}
+            #{pad} |
+            #{lineno} | #{@query}
+            #{pad} | #{pointer} #{highlight ? "\e[1m#{message}\e[0m" : message}
+          ENDOFMESSAGE
+        end
       end
-    end
 
-    def full_message(highlight: true, order: :top)
-      if FULL_MESSAGE
-        # For Ruby < 3.2.0
-        "#{super}\n#{detailed_message(highlight: highlight, order: order)}"
-      else
-        super
+      def full_message(highlight: true, order: :top)
+        if FULL_MESSAGE
+          # For Ruby < 3.2.0
+          "#{super}\n#{detailed_message(highlight: highlight, order: order)}"
+        else
+          super
+        end
       end
     end
-  end
 
-  class JSONPathSyntaxError < JSONPathError; end
-  class JSONPathTypeError < JSONPathError; end
-  class JSONPathNameError < JSONPathError; end
-  class JSONPathRecursionError < JSONPathError; end
+    class SyntaxError < Error; end
+    class TypeError < Error; end
+    class NameError < Error; end
+    class RecursionError < Error; end
+  end
 
-  class JSONPointerError < StandardError; end
-  class JSONPointerIndexError < JSONPointerError; end
-  class JSONPointerSyntaxError < JSONPointerError; end
-  class JSONPointerTypeError < JSONPointerError; end
+  class Pointer
+    class Error < JSONP3::Error; end
+    class IndexError < Error; end
+    class SyntaxError < Error; end
+    class TypeError < Error; end
+  end
 
-  class JSONPatchError < StandardError; end
-  class JSONPatchTestFailure < JSONPatchError; end
+  class Patch
+    class Error < JSONP3::Error; end
+    class TestFailure < Error; end
+  end
 end

data/lib/json_p3/patch/op.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module JSONP3
+  class Patch
+    # 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
+  end
+end

data/lib/json_p3/patch/op_add.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module JSONP3
+  class Patch
+    # 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::Pointer::UNDEFINED && @pointer.tokens.empty?
+
+        if parent == JSONP3::Pointer::UNDEFINED
+          raise JSONP3::Patch::Error,
+                "no such property or item '#{@pointer.parent}' (#{name}:#{index})"
+        end
+
+        target = @pointer.tokens.last
+        if parent.is_a?(Array)
+          if obj == JSONP3::Pointer::UNDEFINED
+            raise JSONP3::Patch::Error, "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 JSONP3::Patch::Error, "unexpected operation on #{parent.class} (#{name}:#{index})"
+        end
+
+        value
+      end
+
+      def to_h
+        { "op" => name, "path" => @pointer.to_s, "value" => @value }
+      end
+    end
+  end
+end

data/lib/json_p3/patch/op_copy.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module JSONP3
+  class Patch
+    # 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::Pointer::UNDEFINED
+          raise JSONP3::Patch::Error,
+                "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::Pointer::UNDEFINED
+
+        dest_target = @pointer.tokens.last
+        if dest_target == JSONP3::Pointer::UNDEFINED
+          raise JSONP3::Patch::Error,
+                "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 JSONP3::Patch::Error, "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
+  end
+end

data/lib/json_p3/patch/op_move.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module JSONP3
+  class Patch
+    # 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 JSONP3::Patch::Error,
+                "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::Pointer::UNDEFINED
+          raise JSONP3::Patch::Error,
+                "source object does not exist (#{name}:#{index})"
+        end
+
+        source_target = @from.tokens.last
+        if source_target == JSONP3::Pointer::UNDEFINED
+          raise JSONP3::Patch::Error,
+                "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::Pointer::UNDEFINED
+
+        dest_target = @pointer.tokens.last
+        if dest_target == JSONP3::Pointer::UNDEFINED
+          raise JSONP3::Patch::Error,
+                "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
+  end
+end

data/lib/json_p3/patch/op_remove.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module JSONP3
+  class Patch
+    # 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::Pointer::UNDEFINED && @pointer.tokens.empty?
+          raise JSONP3::Patch::Error,
+                "can't remove root (#{name}:#{index})"
+        end
+
+        if parent == JSONP3::Pointer::UNDEFINED
+          raise JSONP3::Patch::Error,
+                "no such property or item '#{@pointer.parent}' (#{name}:#{index})"
+        end
+
+        target = @pointer.tokens.last
+        if target == JSONP3::Pointer::UNDEFINED
+          raise JSONP3::Patch::Error,
+                "unexpected operation (#{name}:#{index})"
+        end
+
+        if parent.is_a?(Array)
+          raise JSONP3::Patch::Error, "no item to remove (#{name}:#{index})" if obj == JSONP3::Pointer::UNDEFINED
+
+          parent.delete_at(target.to_i)
+        elsif parent.is_a?(Hash)
+          raise JSONP3::Patch::Error, "no property to remove (#{name}:#{index})" if obj == JSONP3::Pointer::UNDEFINED
+
+          parent.delete(target)
+        else
+          raise JSONP3::Patch::Error, "unexpected operation on #{parent.class} (#{name}:#{index})"
+        end
+
+        value
+      end
+
+      def to_h
+        { "op" => name, "path" => @pointer.to_s }
+      end
+    end
+  end
+end

data/lib/json_p3/patch/op_replace.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module JSONP3
+  class Patch
+    # 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::Pointer::UNDEFINED && @pointer.tokens.empty?
+
+        if parent == JSONP3::Pointer::UNDEFINED
+          raise JSONP3::Patch::Error,
+                "no such property or item '#{@pointer.parent}' (#{name}:#{index})"
+        end
+
+        target = @pointer.tokens.last
+        if target == JSONP3::Pointer::UNDEFINED
+          raise JSONP3::Patch::Error,
+                "unexpected operation (#{name}:#{index})"
+        end
+
+        if parent.is_a?(Array)
+          raise JSONP3::Patch::Error, "no item to replace (#{name}:#{index})" if obj == JSONP3::Pointer::UNDEFINED
+
+          parent[target.to_i] = @value
+        elsif parent.is_a?(Hash)
+          raise JSONP3::Patch::Error, "no property to replace (#{name}:#{index})" if obj == JSONP3::Pointer::UNDEFINED
+
+          parent[target] = @value
+        else
+          raise JSONP3::Patch::Error, "unexpected operation on #{parent.class} (#{name}:#{index})"
+        end
+
+        value
+      end
+
+      def to_h
+        { "op" => name, "path" => @pointer.to_s, "value" => @value }
+      end
+    end
+  end
+end

data/lib/json_p3/patch/op_test.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module JSONP3
+  class Patch
+    # 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 JSONP3::Patch::TestFailure, "test failed (#{name}:#{index})" if obj != @value
+
+        value
+      end
+
+      def to_h
+        { "op" => name, "path" => @pointer.to_s, "value" => @value }
+      end
+    end
+  end
+end