jsi 0.7.0 → 0.8.0

data/lib/jsi/ptr.rb

@@ -16,12 +16,17 @@ module JSI
       class ResolutionError < Error
       end
 
+      POS_INT_RE = /\A[1-9]\d*\z/
+      private_constant :POS_INT_RE
+
       # instantiates a pointer or returns the given pointer
       # @param ary_ptr [#to_ary, JSI::Ptr] an array of tokens, or a pointer
       # @return [JSI::Ptr]
       def self.ary_ptr(ary_ptr)
         if ary_ptr.is_a?(Ptr)
           ary_ptr
+        elsif ary_ptr == Util::EMPTY_ARY
+          EMPTY
         else
           new(ary_ptr)
         end
@@ -42,7 +47,7 @@ module JSI
       # @param tokens any number of tokens
       # @return [JSI::Ptr]
       def self.[](*tokens)
-        new(tokens)
+        tokens.empty? ? EMPTY : new(tokens.freeze)
       end
 
       # parse a URI-escaped fragment and instantiate as a JSI::Ptr
@@ -55,6 +60,12 @@ module JSI
       #     JSI::Ptr.from_fragment('/foo%20bar')
       #     => JSI::Ptr["foo bar"]
       #
+      # Note: A fragment does not include a leading '#'. The string "#/foo" is a URI containing the
+      # fragment "/foo", which should be parsed by `Addressable::URI` before passing to this method, e.g.:
+      #
+      #     JSI::Ptr.from_fragment(Addressable::URI.parse("#/foo").fragment)
+      #     => JSI::Ptr["foo"]
+      #
       # @param fragment [String] a fragment containing a pointer
       # @return [JSI::Ptr]
       # @raise [JSI::Ptr::PointerSyntaxError] when the fragment does not contain a pointer with
@@ -75,13 +86,17 @@ module JSI
       # @return [JSI::Ptr]
       # @raise [JSI::Ptr::PointerSyntaxError] when the pointer_string does not have valid pointer syntax
       def self.from_pointer(pointer_string)
-        tokens = pointer_string.split('/', -1).map! do |piece|
-          piece.gsub('~1', '/').gsub('~0', '~')
-        end
-        if tokens[0] == ''
-          new(tokens[1..-1])
-        elsif tokens.empty?
-          new(tokens)
+        pointer_string = pointer_string.to_str
+        if pointer_string[0] == ?/
+          tokens = pointer_string.split('/', -1).map! do |piece|
+            piece.gsub!('~1', '/')
+            piece.gsub!('~0', '~')
+            piece.freeze
+          end
+          tokens.shift
+          new(tokens.freeze)
+        elsif pointer_string.empty?
+          EMPTY
         else
           raise(PointerSyntaxError, "Invalid pointer syntax in #{pointer_string.inspect}: pointer must begin with /")
         end
@@ -94,7 +109,7 @@ module JSI
         unless tokens.respond_to?(:to_ary)
           raise(TypeError, "tokens must be an array. got: #{tokens.inspect}")
         end
-        @tokens = tokens.to_ary.map(&:freeze).freeze
+        @tokens = Util.deep_to_frozen(tokens.to_ary, not_implemented: proc { |o| o })
       end
 
       attr_reader :tokens
@@ -117,19 +132,19 @@ module JSI
       # the pointer string representation of this pointer
       # @return [String]
       def pointer
-        tokens.map { |t| '/' + t.to_s.gsub('~', '~0').gsub('/', '~1') }.join('')
+        tokens.map { |t| '/' + t.to_s.gsub('~', '~0').gsub('/', '~1') }.join('').freeze
       end
 
       # the fragment string representation of this pointer
       # @return [String]
       def fragment
-        Addressable::URI.escape(pointer)
+        Addressable::URI.escape(pointer).freeze
       end
 
       # a URI consisting of a fragment containing this pointer's fragment string representation
       # @return [Addressable::URI]
       def uri
-        Addressable::URI.new(fragment: fragment)
+        Addressable::URI.new(fragment: fragment).freeze
       end
 
       # whether this pointer is empty, i.e. it has no tokens
@@ -149,29 +164,33 @@ module JSI
         if root?
           raise(Ptr::Error, "cannot access parent of root pointer: #{pretty_inspect.chomp}")
         end
-        Ptr.new(tokens[0...-1])
+        tokens.size == 1 ? EMPTY : Ptr.new(tokens[0...-1].freeze)
       end
 
-      # whether this pointer contains the other_ptr - that is, whether this pointer is an ancestor
-      # of `other_ptr`, a descendent pointer. `contains?` is inclusive; a pointer does contain itself.
+      # whether this pointer is an ancestor of `other_ptr`, a descendent pointer.
+      # `ancestor_of?` is inclusive; a pointer is an ancestor of itself.
+      #
       # @return [Boolean]
-      def contains?(other_ptr)
+      def ancestor_of?(other_ptr)
         tokens == other_ptr.tokens[0...tokens.size]
       end
 
+      # @deprecated
+      def contains?(other_ptr)
+        ancestor_of?(other_ptr)
+      end
+
       # part of this pointer relative to the given ancestor_ptr
       # @return [JSI::Ptr]
       # @raise [JSI::Ptr::Error] if the given ancestor_ptr is not an ancestor of this pointer
       def relative_to(ancestor_ptr)
-        unless ancestor_ptr.contains?(self)
+        return self if ancestor_ptr.empty?
+        unless ancestor_ptr.ancestor_of?(self)
           raise(Error, "ancestor_ptr #{ancestor_ptr.inspect} is not ancestor of #{inspect}")
         end
-        Ptr.new(tokens[ancestor_ptr.tokens.size..-1])
+        ancestor_ptr.tokens.size == tokens.size ? EMPTY : Ptr.new(tokens[ancestor_ptr.tokens.size..-1].freeze)
       end
 
-      # @deprecated after v0.6
-      alias_method :ptr_relative_to, :relative_to
-
       # a pointer with the tokens of this one plus the given `ptr`'s.
       # @param ptr [JSI::Ptr, #to_ary]
       # @return [JSI::Ptr]
@@ -183,7 +202,7 @@ module JSI
         else
           raise(TypeError, "ptr must be a #{Ptr} or Array of tokens; got: #{ptr.inspect}")
         end
-        Ptr.new(tokens + ptr_tokens)
+        ptr_tokens.empty? ? self : Ptr.new((tokens + ptr_tokens).freeze)
       end
 
       # a pointer consisting of the first `n` of our tokens
@@ -191,10 +210,10 @@ module JSI
       # @return [JSI::Ptr]
       # @raise [ArgumentError] if n is not between 0 and the size of our tokens
       def take(n)
-        unless (0..tokens.size).include?(n)
+        unless n.is_a?(Integer) && n >= 0 && n <= tokens.size
           raise(ArgumentError, "n not in range (0..#{tokens.size}): #{n.inspect}")
         end
-        Ptr.new(tokens.take(n))
+        n == tokens.size ? self : Ptr.new(tokens.take(n).freeze)
       end
 
       # appends the given token to this pointer's tokens and returns the result
@@ -202,7 +221,7 @@ module JSI
       # @param token [Object]
       # @return [JSI::Ptr] pointer to a child node of this pointer with the given token
       def [](token)
-        Ptr.new(tokens + [token])
+        Ptr.new(tokens.dup.push(token).freeze)
       end
 
       # takes a document and a block. the block is yielded the content of the given document at this
@@ -227,7 +246,7 @@ module JSI
           Util.modified_copy(document, &block)
         else
           car = tokens[0]
-          cdr = Ptr.new(tokens[1..-1])
+          cdr = tokens.size == 1 ? EMPTY : Ptr.new(tokens[1..-1].freeze)
           token, document_child = node_subscript_token_child(document, car)
           modified_document_child = cdr.modified_document_copy(document_child, &block)
           if modified_document_child.object_id == document_child.object_id
@@ -246,33 +265,36 @@ module JSI
       # a string representation of this pointer
       # @return [String]
       def inspect
-        "#{self.class.name}[#{tokens.map(&:inspect).join(", ")}]"
+        -"#{self.class.name}[#{tokens.map(&:inspect).join(", ")}]"
       end
 
-      alias_method :to_s, :inspect
+      def to_s
+        inspect
+      end
 
-      # pointers are equal if the tokens are equal
+      # see {Util::Private::FingerprintHash}
+      # @api private
       def jsi_fingerprint
-        {class: Ptr, tokens: tokens}
+        {class: Ptr, tokens: tokens}.freeze
       end
-      include Util::FingerprintHash
+      include Util::FingerprintHash::Immutable
+
+      EMPTY = new(Util::EMPTY_ARY)
 
       private
 
       def node_subscript_token_child(value, token, *a, **kw)
         if value.respond_to?(:to_ary)
-          if token.is_a?(String) && token =~ /\A\d|[1-9]\d+\z/
+          if token.is_a?(String) && (token == '0' || token =~ POS_INT_RE)
             token = token.to_i
           elsif token == '-'
             # per rfc6901, - refers "to the (nonexistent) member after the last array element" and is
             # expected to raise an error condition.
             raise(ResolutionError, "Invalid resolution: #{token.inspect} refers to a nonexistent element in array #{value.inspect}")
           end
-          unless token.is_a?(Integer)
-            raise(ResolutionError, "Invalid resolution: #{token.inspect} is not an integer and cannot be resolved in array #{value.inspect}")
-          end
-          unless (0...(value.respond_to?(:size) ? value : value.to_ary).size).include?(token)
-            raise(ResolutionError, "Invalid resolution: #{token.inspect} is not a valid index of #{value.inspect}")
+          size = (value.respond_to?(:size) ? value : value.to_ary).size
+          unless token.is_a?(Integer) && token >= 0 && token < size
+            raise(ResolutionError, "Invalid resolution: #{token.inspect} is not a valid array index of #{value.inspect}")
           end
 
           ary = (value.respond_to?(:[]) ? value : value.to_ary)

data/lib/jsi/schema/application/child_application/draft04.rb

@@ -2,7 +2,6 @@
 
 module JSI
   module Schema::Application::ChildApplication::Draft04
-    include Schema::Application::ChildApplication
     include Schema::Application::ChildApplication::Items
     include Schema::Application::ChildApplication::Properties
 

data/lib/jsi/schema/application/child_application/draft06.rb

@@ -2,7 +2,6 @@
 
 module JSI
   module Schema::Application::ChildApplication::Draft06
-    include Schema::Application::ChildApplication
     include Schema::Application::ChildApplication::Items
     include Schema::Application::ChildApplication::Contains
     include Schema::Application::ChildApplication::Properties

data/lib/jsi/schema/application/child_application/draft07.rb

@@ -2,7 +2,6 @@
 
 module JSI
   module Schema::Application::ChildApplication::Draft07
-    include Schema::Application::ChildApplication
     include Schema::Application::ChildApplication::Items
     include Schema::Application::ChildApplication::Contains
     include Schema::Application::ChildApplication::Properties

data/lib/jsi/schema/application/child_application.rb

@@ -9,30 +9,5 @@ module JSI
     autoload :Items, 'jsi/schema/application/child_application/items'
     autoload :Contains, 'jsi/schema/application/child_application/contains'
     autoload :Properties, 'jsi/schema/application/child_application/properties'
-
-    # a set of child applicator subschemas of this schema which apply to the child of the given instance
-    # on the given token.
-    #
-    # @param token [Object] the array index or object property name for the child instance
-    # @param instance [Object] the instance to check any child applicators against
-    # @return [JSI::SchemaSet] child applicator subschemas of this schema for the given token
-    #   of the instance
-    def child_applicator_schemas(token, instance)
-      SchemaSet.new(each_child_applicator_schema(token, instance))
-    end
-
-    # yields each child applicator subschema (from properties, items, etc.) which applies to the child of
-    # the given instance on the given token.
-    #
-    # @param (see #child_applicator_schemas)
-    # @yield [JSI::Schema]
-    # @return [nil, Enumerator] an Enumerator if invoked without a block; otherwise nil
-    def each_child_applicator_schema(token, instance, &block)
-      return to_enum(__method__, token, instance) unless block
-
-      internal_child_applicate_keywords(token, instance, &block)
-
-      nil
-    end
   end
 end

data/lib/jsi/schema/application/inplace_application/draft04.rb

@@ -2,7 +2,6 @@
 
 module JSI
   module Schema::Application::InplaceApplication::Draft04
-    include Schema::Application::InplaceApplication
     include Schema::Application::InplaceApplication::Ref
     include Schema::Application::InplaceApplication::Dependencies
     include Schema::Application::InplaceApplication::SomeOf

data/lib/jsi/schema/application/inplace_application/draft06.rb

@@ -2,7 +2,6 @@
 
 module JSI
   module Schema::Application::InplaceApplication::Draft06
-    include Schema::Application::InplaceApplication
     include Schema::Application::InplaceApplication::Ref
     include Schema::Application::InplaceApplication::Dependencies
     include Schema::Application::InplaceApplication::SomeOf

data/lib/jsi/schema/application/inplace_application/draft07.rb

@@ -2,7 +2,6 @@
 
 module JSI
   module Schema::Application::InplaceApplication::Draft07
-    include Schema::Application::InplaceApplication
     include Schema::Application::InplaceApplication::Ref
     include Schema::Application::InplaceApplication::Dependencies
     include Schema::Application::InplaceApplication::IfThenElse

data/lib/jsi/schema/application/inplace_application/ref.rb

@@ -5,7 +5,7 @@ module JSI
     # @private
     def internal_applicate_ref(instance, visited_refs, throw_done: false, &block)
       if keyword?('$ref') && schema_content['$ref'].respond_to?(:to_str)
-        ref = jsi_memoize(:ref) { Schema::Ref.new(schema_content['$ref'], self) }
+        ref = schema_ref('$ref')
         unless visited_refs.include?(ref)
           ref.deref_schema.each_inplace_applicator_schema(instance, visited_refs: visited_refs + [ref], &block)
           if throw_done

data/lib/jsi/schema/application/inplace_application/someof.rb

@@ -27,7 +27,7 @@ module JSI
         oneOf_idxs = schema_content['oneOf'].each_index
         subschema_idx_valid = Hash.new { |h, i| h[i] = subschema(['oneOf', i]).instance_valid?(instance) }
         # count up to 2 `oneOf` subschemas which `instance` validates against
-        nvalid = oneOf_idxs.inject(0) { |n, i| n > 1 ? n : subschema_idx_valid[i] ? n + 1 : n }
+        nvalid = oneOf_idxs.inject(0) { |n, i| n <= 1 && subschema_idx_valid[i] ? n + 1 : n }
         if nvalid == 1
           applicator_idxs = oneOf_idxs.select { |i| subschema_idx_valid[i] }
         else

data/lib/jsi/schema/application/inplace_application.rb

@@ -10,32 +10,5 @@ module JSI
     autoload :SomeOf, 'jsi/schema/application/inplace_application/someof'
     autoload :IfThenElse, 'jsi/schema/application/inplace_application/ifthenelse'
     autoload :Dependencies, 'jsi/schema/application/inplace_application/dependencies'
-
-    # a set of inplace applicator schemas of this schema (from $ref, allOf, etc.) which apply to the
-    # given instance.
-    #
-    # the returned set will contain this schema itself, unless this schema contains a $ref keyword.
-    #
-    # @param instance [Object] the instance to check any applicators against
-    # @return [JSI::SchemaSet] matched applicator schemas
-    def inplace_applicator_schemas(instance)
-      SchemaSet.new(each_inplace_applicator_schema(instance))
-    end
-
-    # yields each inplace applicator schema which applies to the given instance.
-    #
-    # @param instance (see #inplace_applicator_schemas)
-    # @param visited_refs [Enumerable<JSI::Schema::Ref>]
-    # @yield [JSI::Schema]
-    # @return [nil, Enumerator] an Enumerator if invoked without a block; otherwise nil
-    def each_inplace_applicator_schema(instance, visited_refs: [], &block)
-      return to_enum(__method__, instance, visited_refs: visited_refs) unless block
-
-      catch(:jsi_application_done) do
-        internal_inplace_applicate_keywords(instance, visited_refs, &block)
-      end
-
-      nil
-    end
   end
 end

data/lib/jsi/schema/draft04.rb

@@ -3,7 +3,6 @@
 module JSI
   module Schema
     module Draft04
-      include Schema
       include OldId
       include IdWithAnchor
       include IntegerDisallows0Fraction

data/lib/jsi/schema/draft06.rb

@@ -3,7 +3,6 @@
 module JSI
   module Schema
     module Draft06
-      include Schema
       include BigMoneyId
       include IdWithAnchor
       include IntegerAllows0Fraction

data/lib/jsi/schema/draft07.rb

@@ -3,7 +3,6 @@
 module JSI
   module Schema
     module Draft07
-      include Schema
       include BigMoneyId
       include IdWithAnchor
       include IntegerAllows0Fraction

data/lib/jsi/schema/ref.rb

@@ -1,30 +1,45 @@
 # frozen_string_literal: true
 
 module JSI
-  # JSI::Schema::Ref is a reference to another schema (the result of #deref_schema), resolved using a ref URI
-  # from a ref schema (the ref URI typically the contents of the ref_schema's "$ref" keyword)
+  # A JSI::Schema::Ref is a reference to a schema identified by a URI, typically from
+  # a `$ref` keyword of a schema.
   class Schema::Ref
-    # @param ref [String] a reference URI
-    # @param ref_schema [JSI::Schema] a schema from which the reference originated
-    def initialize(ref, ref_schema = nil)
+    # @param ref [String] A reference URI - typically the `$ref` value of the ref_schema
+    # @param ref_schema [JSI::Schema] A schema from which the reference originated.
+    #
+    #   If the ref URI consists of only a fragment, it is resolved from the `ref_schema`'s
+    #   {Schema#schema_resource_root}. Otherwise the resource is found in the `ref_schema`'s
+    #   {SchemaAncestorNode#jsi_schema_registry #jsi_schema_registry} (and any fragment is resolved from there).
+    # @param schema_registry [SchemaRegistry] The registry in which the resource this ref refers to will be found.
+    #   This should only be specified in the absence of a `ref_schema`.
+    #   If neither is specified, {JSI.schema_registry} is used.
+    def initialize(ref, ref_schema: nil, schema_registry: nil)
       raise(ArgumentError, "ref is not a string") unless ref.respond_to?(:to_str)
       @ref = ref
-      @ref_uri = Addressable::URI.parse(ref)
+      @ref_uri = Util.uri(ref)
       @ref_schema = ref_schema ? Schema.ensure_schema(ref_schema) : nil
+      @schema_registry = schema_registry || (ref_schema ? ref_schema.jsi_schema_registry : JSI.schema_registry)
+      @deref_schema = nil
     end
 
+    # @return [String]
     attr_reader :ref
 
+    # @return [Addressable::URI]
     attr_reader :ref_uri
 
+    # @return [Schema, nil]
     attr_reader :ref_schema
 
+    # @return [SchemaRegistry, nil]
+    attr_reader(:schema_registry)
+
     # finds the schema this ref points to
     # @return [JSI::Schema]
     # @raise [JSI::Schema::NotASchemaError] when the thing this ref points to is not a schema
     # @raise [JSI::Schema::ReferenceError] when this reference cannot be resolved
     def deref_schema
-      return @deref_schema if instance_variable_defined?(:@deref_schema)
+      return @deref_schema if @deref_schema
 
       schema_resource_root = nil
       check_schema_resource_root = -> {
@@ -36,7 +51,7 @@ module JSI
         end
       }
 
-      ref_uri_nofrag = ref_uri.merge(fragment: nil)
+      ref_uri_nofrag = ref_uri.merge(fragment: nil).freeze
 
       if ref_uri_nofrag.empty?
         unless ref_schema
@@ -49,7 +64,7 @@ module JSI
         # the URI only consists of a fragment (or is empty).
         # for a fragment pointer, resolve using Schema#resource_root_subschema on the ref_schema.
         # for a fragment anchor, bootstrap does not support anchors; otherwise use the ref_schema's schema_resource_root.
-        schema_resource_root = ref_schema.is_a?(MetaschemaNode::BootstrapSchema) ? nil : ref_schema.schema_resource_root
+        schema_resource_root = ref_schema.is_a?(MetaSchemaNode::BootstrapSchema) ? nil : ref_schema.schema_resource_root
         resolve_fragment_ptr = ref_schema.method(:resource_root_subschema)
       else
         # find the schema_resource_root from the non-fragment URI. we will resolve any fragment, either pointer or anchor, from there.
@@ -57,19 +72,26 @@ module JSI
         if ref_uri_nofrag.absolute?
           ref_abs_uri = ref_uri_nofrag
         elsif ref_schema && ref_schema.jsi_resource_ancestor_uri
-          ref_abs_uri = ref_schema.jsi_resource_ancestor_uri.join(ref_uri_nofrag)
+          ref_abs_uri = ref_schema.jsi_resource_ancestor_uri.join(ref_uri_nofrag).freeze
         else
           ref_abs_uri = nil
         end
         if ref_abs_uri
-          schema_resource_root = JSI.schema_registry.find(ref_abs_uri)
+          unless schema_registry
+            raise(Schema::ReferenceError, [
+              "could not resolve remote ref with no schema_registry specified",
+              "ref URI: #{ref_uri.to_s}",
+              ("from: #{ref_schema.pretty_inspect.chomp}" if ref_schema),
+            ].compact.join("\n"))
+          end
+          schema_resource_root = schema_registry.find(ref_abs_uri)
         end
 
         unless schema_resource_root
           # HAX for how google does refs and ids
           if ref_schema && ref_schema.jsi_document.respond_to?(:to_hash) && ref_schema.jsi_document['schemas'].respond_to?(:to_hash)
-            ref_schema.jsi_document['schemas'].each_key do |k|
-              if Addressable::URI.parse(ref_schema.jsi_document['schemas'][k]['id']) == ref_uri_nofrag
+            ref_schema.jsi_document['schemas'].each do |k, v|
+              if Addressable::URI.parse(v['id']) == ref_uri_nofrag
                 schema_resource_root = ref_schema.resource_root_subschema(['schemas', k])
               end
             end
@@ -136,10 +158,12 @@ module JSI
 
     # @return [String]
     def inspect
-      %Q(\#<#{self.class.name} #{ref}>)
+      -%Q(\#<#{self.class.name} #{ref}>)
     end
 
-    alias_method :to_s, :inspect
+    def to_s
+      inspect
+    end
 
     # pretty-prints a representation of self to the given printer
     # @return [void]
@@ -151,10 +175,12 @@ module JSI
       q.text '>'
     end
 
-    # @private
+    # see {Util::Private::FingerprintHash}
+    # @api private
     def jsi_fingerprint
-      {class: self.class, ref: ref, ref_schema: ref_schema}
+      {class: self.class, ref: ref, ref_schema: ref_schema}.freeze
     end
-    include Util::FingerprintHash
+
+    include(Util::FingerprintHash::Immutable)
   end
 end