jsi 0.4.0 → 0.6.0

data/lib/jsi/schema.rb

@@ -6,6 +6,18 @@ module JSI
   # the content of an instance which is a JSI::Schema (referred to in this context as schema_content) is
   # expected to be a Hash (JSON object) or a Boolean.
   module Schema
+    autoload :Application, 'jsi/schema/application'
+    autoload :Validation, 'jsi/schema/validation'
+    autoload :Issue, 'jsi/schema/issue'
+
+    autoload :SchemaAncestorNode, 'jsi/schema/schema_ancestor_node'
+
+    autoload :Ref, 'jsi/schema/ref'
+
+    autoload :Draft04, 'jsi/schema/draft04'
+    autoload :Draft06, 'jsi/schema/draft06'
+    autoload :Draft07, 'jsi/schema/draft07'
+
     class Error < StandardError
     end
 
@@ -13,6 +25,109 @@ module JSI
     class NotASchemaError < Error
     end
 
+    # an exception raised when we are unable to resolve a schema reference
+    class ReferenceError < StandardError
+    end
+
+    # extends any schema which uses the keyword '$id' to identify its canonical URI
+    module BigMoneyId
+      # the contents of a $id keyword whose value is a string, or nil
+      # @return [#to_str, nil]
+      def id
+        if schema_content.respond_to?(:to_hash) && schema_content['$id'].respond_to?(:to_str)
+          schema_content['$id']
+        else
+          nil
+        end
+      end
+    end
+
+    # extends any schema which uses the keyword 'id' to identify its canonical URI
+    module OldId
+      # the contents of an `id` keyword whose value is a string, or nil
+      # @return [#to_str, nil]
+      def id
+        if schema_content.respond_to?(:to_hash) && schema_content['id'].respond_to?(:to_str)
+          schema_content['id']
+        else
+          nil
+        end
+      end
+    end
+
+    # extends any schema which defines an anchor as a URI fragment in the schema id
+    module IdWithAnchor
+      # a URI for the schema's id, unless the id defines an anchor in its
+      # fragment. nil if the schema defines no id.
+      # @return [Addressable::URI, nil]
+      def id_without_fragment
+        if id
+          id_uri = Addressable::URI.parse(id)
+          if id_uri.merge(fragment: nil).empty?
+            # fragment-only id is just an anchor
+            # e.g. #foo
+            nil
+          elsif id_uri.fragment == nil
+            # no fragment
+            # e.g. http://localhost:1234/bar
+            id_uri
+          elsif id_uri.fragment == ''
+            # empty fragment
+            # e.g. http://json-schema.org/draft-07/schema#
+            id_uri.merge(fragment: nil)
+          elsif jsi_schema_base_uri && jsi_schema_base_uri.join(id_uri).merge(fragment: nil) == jsi_schema_base_uri
+            # the id, resolved against the base uri, consists of the base uri plus an anchor fragment.
+            # so there's no non-fragment id.
+            # e.g. base uri is http://localhost:1234/bar
+            #        and id is http://localhost:1234/bar#foo
+            nil
+          else
+            # e.g. http://localhost:1234/bar#foo
+            id_uri.merge(fragment: nil)
+          end
+        else
+          nil
+        end
+      end
+
+      # an anchor defined by a non-empty fragment in the id uri
+      # @return [String]
+      def anchor
+        if id
+          id_uri = Addressable::URI.parse(id)
+          if id_uri.fragment == ''
+            nil
+          else
+            id_uri.fragment
+          end
+        else
+          nil
+        end
+      end
+    end
+
+    # @private
+    module IntegerAllows0Fraction
+      # is `value` an integer?
+      # @private
+      # @param value
+      # @return [Boolean]
+      def internal_integer?(value)
+        value.is_a?(Integer) || (value.is_a?(Numeric) && value % 1.0 == 0.0)
+      end
+    end
+
+    # @private
+    module IntegerDisallows0Fraction
+      # is `value` an integer?
+      # @private
+      # @param value
+      # @return [Boolean]
+      def internal_integer?(value)
+        value.is_a?(Integer)
+      end
+    end
+
     # JSI::Schema::DescribesSchema: a schema which describes another schema. this module
     # extends a JSI::Schema instance and indicates that JSIs which instantiate the schema
     # are themselves also schemas.
@@ -20,233 +135,471 @@ module JSI
     # examples of a schema which describes a schema include the draft JSON Schema metaschemas and
     # the OpenAPI schema definition which describes "A deterministic version of a JSON Schema object."
     module DescribesSchema
+      # instantiates the given schema content as a JSI Schema.
+      #
+      # the schema is instantiated after recursively converting any symbol hash keys in the structure
+      # to strings. note that this is in contrast to {JSI::Schema#new_jsi}, which does not alter its
+      # given instance.
+      #
+      # the schema will be registered with the `JSI.schema_registry`.
+      #
+      # @param schema_content [#to_hash, Boolean] an object to be instantiated as a schema
+      # @param uri [nil, #to_str, Addressable::URI] the URI of the schema document.
+      #   relative URIs within the document are resolved using this uri as their base.
+      #   the result schema will be registered with this URI in the {JSI.schema_registry}.
+      # @return [JSI::Base, JSI::Schema] a JSI whose instance is the given schema_content and whose schemas
+      #   are inplace applicators matched from self to the schema being instantiated.
+      def new_schema(schema_content,
+          uri: nil
+      )
+        schema_jsi = new_jsi(Util.deep_stringify_symbol_keys(schema_content),
+          uri: uri,
+        )
+        JSI.schema_registry.register(schema_jsi)
+        schema_jsi
+      end
+
+      # instantiates a given schema object as a JSI Schema and returns its JSI Schema Module.
+      #
+      # shortcut to chain {#new_schema} + {Schema#jsi_schema_module}.
+      #
+      # @param (see #new_schema)
+      # @return [Module, JSI::SchemaModule] the JSI Schema Module of the schema
+      def new_schema_module(schema_content, **kw)
+        new_schema(schema_content, **kw).jsi_schema_module
+      end
     end
 
     class << self
-      # @return [JSI::Schema] the default metaschema
+      # an application-wide default metaschema set by {default_metaschema=}, used by {JSI.new_schema}
+      #
+      # @return [nil, #new_schema]
       def default_metaschema
-        JSI::JSONSchemaOrgDraft06.schema
+        return @default_metaschema if instance_variable_defined?(:@default_metaschema)
+        return JSONSchemaOrgDraft07
       end
 
-      # @return [Array<JSI::Schema>] supported metaschemas
-      def supported_metaschemas
-        [
-          JSI::JSONSchemaOrgDraft04.schema,
-          JSI::JSONSchemaOrgDraft06.schema,
-        ]
+      # sets an application-wide default metaschema used by {JSI.new_schema}
+      #
+      # @param default_metaschema [#new_schema] the default metaschema. this may be a metaschema or a
+      #   metaschema's schema module (e.g. `JSI::JSONSchemaOrgDraft07`).
+      def default_metaschema=(default_metaschema)
+        unless default_metaschema.respond_to?(:new_schema)
+          raise(TypeError, "given default_metaschema does not respond to #new_schema")
+        end
+        @default_metaschema = default_metaschema
       end
 
-      # instantiates a given schema object as a JSI::Schema.
+      # instantiates a given schema object as a JSI Schema.
       #
-      # schemas are instantiated according to their '$schema' property if specified. otherwise their schema
-      # will be the {JSI::Schema.default_metaschema}.
+      # the metaschema to use to instantiate the schema must be indicated.
+      #
+      # - if the schema object has a `$schema` property, that URI is resolved using the {JSI.schema_registry},
+      #   and that metaschema is used.
+      # - if no `$schema` property is present, the `default_metaschema` param is used, if the caller
+      #   specifies it.
+      # - if no `default_metaschema` param is specified, the application-wide default
+      #   {JSI::Schema.default_metaschema JSI::Schema.default_metaschema} is used,
+      #   if the application has set it.
+      #
+      # an ArgumentError is raised if none of these indicate a metaschema to use.
+      #
+      # note that if you are instantiating a schema known to have no `$schema` property, an alternative to
+      # passing the `default_metaschema` param is to use `.new_schema` on the metaschema or its module, e.g.
+      # `JSI::JSONSchemaOrgDraft07.new_schema(my_schema_object)`
       #
       # if the given schema_object is a JSI::Base but not already a JSI::Schema, an error
-      # will be raised. JSI::Base _should_ already extend a given instance with JSI::Schema
-      # when its schema describes a schema (by extending with JSI::Schema::DescribesSchema).
+      # will be raised. schemas which describe schemas must have JSI::Schema in their
+      # Schema#jsi_schema_instance_modules.
       #
       # @param schema_object [#to_hash, Boolean, JSI::Schema] an object to be instantiated as a schema.
-      #   if it's already a schema, it is returned as-is.
+      #   if it's already a JSI::Schema, it is returned as-is.
+      # @param uri (see DescribesSchema#new_schema)
+      # @param default_metaschema [#new_schema] the metaschema to use if the schema_object does not have
+      #   a '$schema' property. this may be a metaschema or a metaschema's schema module
+      #   (e.g. `JSI::JSONSchemaOrgDraft07`).
       # @return [JSI::Schema] a JSI::Schema representing the given schema_object
-      def from_object(schema_object)
+      def new_schema(schema_object, default_metaschema: nil, **kw)
+        default_metaschema_new_schema = -> {
+          default_metaschema ||= JSI::Schema.default_metaschema
+          if default_metaschema.nil?
+            raise(ArgumentError, [
+              "when instantiating a schema with no `$schema` property, you must specify the metaschema.",
+              "you may pass the `default_metaschema` param to this method.",
+              "JSI::Schema.default_metaschema may be set to an application-wide default metaschema.",
+              "you may alternatively use new_schema on the appropriate metaschema or its schema module.",
+              "instantiating schema_object: #{schema_object.pretty_inspect.chomp}",
+            ].join("\n"))
+          end
+          if !default_metaschema.respond_to?(:new_schema)
+            raise(TypeError, "given default_metaschema does not respond to #new_schema: #{default_metaschema.pretty_inspect.chomp}")
+          end
+          default_metaschema.new_schema(schema_object, **kw)
+        }
         if schema_object.is_a?(Schema)
           schema_object
         elsif schema_object.is_a?(JSI::Base)
           raise(NotASchemaError, "the given schema_object is a JSI::Base, but is not a JSI::Schema: #{schema_object.pretty_inspect.chomp}")
         elsif schema_object.respond_to?(:to_hash)
-          schema_object = JSI.deep_stringify_symbol_keys(schema_object)
           if schema_object.key?('$schema') && schema_object['$schema'].respond_to?(:to_str)
-            if schema_object['$schema'] == schema_object['$id'] || schema_object['$schema'] == schema_object['id']
-              MetaschemaNode.new(schema_object)
-            else
-              metaschema = supported_metaschemas.detect { |ms| schema_object['$schema'] == ms['$id'] || schema_object['$schema'] == ms['id'] }
-              unless metaschema
-                raise(NotImplementedError, "metaschema not supported: #{schema_object['$schema']}")
-              end
-              metaschema.new_jsi(schema_object)
+            metaschema = Schema::Ref.new(schema_object['$schema']).deref_schema
+            unless metaschema.describes_schema?
+              raise(Schema::ReferenceError, "given schema_object contains a $schema but the resource it identifies does not describe a schema")
             end
+            metaschema.new_schema(schema_object, **kw)
           else
-            default_metaschema.new_jsi(schema_object)
+            default_metaschema_new_schema.call
           end
         elsif [true, false].include?(schema_object)
-          default_metaschema.new_jsi(schema_object)
+          default_metaschema_new_schema.call
         else
           raise(TypeError, "cannot instantiate Schema from: #{schema_object.pretty_inspect.chomp}")
         end
       end
 
-      alias_method :new, :from_object
-    end
+      # @deprecated
+      alias_method :new, :new_schema
 
-    # @return [String, nil] an absolute id for the schema, with a json pointer fragment. nil if
-    #   no parent of this schema defines an id.
-    def schema_id
-      return @schema_id if instance_variable_defined?(:@schema_id)
-      @schema_id = begin
-        # start from self and ascend parents looking for an 'id' property.
-        # append a fragment to that id (appending to an existing fragment if there
-        # is one) consisting of the path from that parent to our schema_node.
-        node_for_id = self
-        path_from_id_node = []
-        done = false
+      # @deprecated
+      alias_method :from_object, :new_schema
 
-        while !done
-          node_content_for_id = node_for_id.node_content
-          if node_for_id.is_a?(JSI::Schema) && node_content_for_id.respond_to?(:to_hash)
-            parent_id = node_content_for_id.key?('$id') && node_content_for_id['$id'].respond_to?(:to_str) ? node_content_for_id['$id'].to_str :
-              node_content_for_id.key?('id') && node_content_for_id['id'].respond_to?(:to_str) ? node_content_for_id['id'].to_str : nil
-          end
+      # ensure the given object is a JSI Schema
+      #
+      # @param schema [Object] the thing the caller wishes to ensure is a Schema
+      # @param msg [#to_s, #to_ary] lines of the error message preceding the pretty-printed schema param
+      #   if the schema param is not a schema
+      # @raise [NotASchemaError] if the schema param is not a schema
+      # @return [Schema] the given schema
+      def ensure_schema(schema, msg: "indicated object is not a schema:", reinstantiate_as: nil)
+        if schema.is_a?(Schema)
+          schema
+        else
+          if reinstantiate_as
+            # TODO warn; behavior is undefined and I hate this implementation
+
+            result_schema_schemas = schema.jsi_schemas + reinstantiate_as
+
+            result_schema_class = JSI::SchemaClasses.class_for_schemas(result_schema_schemas)
 
-          if parent_id || node_for_id.node_ptr.root?
-            done = true
+            result_schema_class.new(Base::NOINSTANCE,
+              jsi_document: schema.jsi_document,
+              jsi_ptr: schema.jsi_ptr,
+              jsi_root_node: schema.jsi_root_node,
+              jsi_schema_base_uri: schema.jsi_schema_base_uri,
+              jsi_schema_resource_ancestors: schema.jsi_schema_resource_ancestors,
+            )
           else
-            path_from_id_node.unshift(node_for_id.node_ptr.reference_tokens.last)
-            node_for_id = node_for_id.parent_node
+            raise(NotASchemaError, [
+              *msg,
+              schema.pretty_inspect.chomp,
+            ].join("\n"))
           end
         end
-        if parent_id
-          parent_auri = Addressable::URI.parse(parent_id)
-          if parent_auri.fragment
-            # add onto the fragment
-            parent_id_path = JSI::JSON::Pointer.from_fragment(parent_auri.fragment).reference_tokens
-            path_from_id_node = parent_id_path + path_from_id_node
-            parent_auri.fragment = nil
-          #else: no fragment so parent_id good as is
-          end
+      end
+    end
 
-          schema_id = parent_auri.merge(fragment: JSI::JSON::Pointer.new(path_from_id_node).fragment).to_s
+    # the underlying JSON data used to instantiate this JSI::Schema.
+    # this is an alias for PathedNode#jsi_node_content, named for clarity in the context of working with
+    # a schema.
+    def schema_content
+      jsi_node_content
+    end
 
-          schema_id
+    # the URI of this schema, calculated from our `#id`, resolved against our `#jsi_schema_base_uri`
+    # @return [Addressable::URI, nil]
+    def schema_absolute_uri
+      if respond_to?(:id_without_fragment) && id_without_fragment
+        if jsi_schema_base_uri
+          Addressable::URI.parse(jsi_schema_base_uri).join(id_without_fragment)
+        elsif id_without_fragment.absolute?
+          id_without_fragment
         else
+          # TODO warn / schema_error
           nil
         end
       end
     end
 
-    # @return [Module] a module representing this schema. see {JSI::SchemaClasses.module_for_schema}.
+    # a nonrelative URI which refers to this schema.
+    # nil if no parent of this schema defines an id.
+    # see {#schema_uris} for all URIs known to refer to this schema.
+    # @return [Addressable::URI, nil]
+    def schema_uri
+      schema_uris.first
+    end
+
+    # nonrelative URIs (that is, absolute, but possibly with a fragment) which refer to this schema
+    # @return [Array<Addressable::URI>]
+    def schema_uris
+      jsi_memoize(:schema_uris) do
+        each_schema_uri.to_a
+      end
+    end
+
+    # see {#schema_uris}
+    # @yield [Addressable::URI]
+    # @return [Enumerator, nil]
+    def each_schema_uri
+      return to_enum(__method__) unless block_given?
+
+      yield schema_absolute_uri if schema_absolute_uri
+
+      parent_schemas = jsi_subschema_resource_ancestors.reverse_each.select do |resource|
+        resource.is_a?(Schema) && resource.schema_absolute_uri
+      end
+
+      anchored = self.anchor
+      parent_schemas.each do |parent_schema|
+        if anchored
+          if parent_schema.jsi_anchor_subschema(anchor) == self
+            yield parent_schema.schema_absolute_uri.merge(fragment: anchor)
+          else
+            anchored = false
+          end
+        end
+
+        relative_ptr = self.jsi_ptr.ptr_relative_to(parent_schema.jsi_ptr)
+        yield parent_schema.schema_absolute_uri.merge(fragment: relative_ptr.fragment)
+      end
+
+      nil
+    end
+
+    # a module which extends all instances of this schema. this may be opened by the application to add
+    # methods to schema instances.
+    #
+    # this module includes accessor methods for object property names this schema
+    # describes (see {#described_object_property_names}). these accessors wrap {Base#[]} and {Base#[]=}.
+    #
+    # some functionality is also defined on the module itself (its singleton class, not for its instances):
+    #
+    # - the module is extended with {JSI::SchemaModule}, which defines .new_jsi to instantiate instances
+    #   of this schema (see {#new_jsi}).
+    # - properties described by this schema's metaschema are defined as methods to get subschemas' schema
+    #   modules, so for example `schema.jsi_schema_module.items` returns the same module
+    #   as `schema.items.jsi_schema_module`.
+    # - method .schema which returns this schema.
+    #
+    # @return [Module]
     def jsi_schema_module
       JSI::SchemaClasses.module_for_schema(self)
     end
 
-    # @return [Class < JSI::Base] a JSI class for this one schema
+    # Evaluates the given block in the context of this schema's JSI schema module.
+    # Any arguments passed to this method will be passed to the block.
+    # shortcut to invoke [Module#module_exec](https://ruby-doc.org/core/Module.html#method-i-module_exec)
+    # on our {#jsi_schema_module}.
+    #
+    # @return the result of evaluating the block
+    def jsi_schema_module_exec(*a, **kw, &block)
+      jsi_schema_module.module_exec(*a, **kw, &block)
+    end
+
+    # @private @deprecated
     def jsi_schema_class
-      JSI.class_for_schemas(Set[self])
+      JSI::SchemaClasses.class_for_schemas(SchemaSet[self])
     end
 
-    # instantiates the given other_instance as a JSI::Base class for schemas matched from this schema to the
-    # other_instance.
-    #
-    # any parameters are passed to JSI::Base#initialize, but none are normally used.
+    # instantiates the given instance as a JSI::Base class for schemas matched from this schema to the
+    # instance.
     #
-    # @return [JSI::Base] a JSI whose instance is the given instance and whose schemas are matched from this
-    #   schema.
-    def new_jsi(other_instance, *a, &b)
-      JSI.class_for_schemas(match_to_instance(other_instance)).new(other_instance, *a, &b)
+    # @param instance [Object] the JSON Schema instance to be represented as a JSI
+    # @param uri (see SchemaSet#new_jsi)
+    # @return [JSI::Base subclass] a JSI whose instance is the given instance and whose schemas are matched
+    #   from this schema.
+    def new_jsi(instance,
+        **kw
+    )
+      SchemaSet[self].new_jsi(instance, **kw)
     end
 
-    # @return [Boolean] does this schema itself describe a schema?
+    # does this schema itself describe a schema?
+    # @return [Boolean]
     def describes_schema?
-      is_a?(JSI::Schema::DescribesSchema)
+      jsi_schema_instance_modules.any? { |m| m <= JSI::Schema }
+    end
+
+    # modules to apply to instances described by this schema. these modules are included
+    # on this schema's {#jsi_schema_module}
+    # @return [Set<Module>]
+    def jsi_schema_instance_modules
+      return @jsi_schema_instance_modules if instance_variable_defined?(:@jsi_schema_instance_modules)
+      return Set[].freeze
+    end
+
+    # see {#jsi_schema_instance_modules}
+    #
+    # @return [void]
+    def jsi_schema_instance_modules=(jsi_schema_instance_modules)
+      @jsi_schema_instance_modules = Util.ensure_module_set(jsi_schema_instance_modules)
     end
 
-    # checks this schema for applicators ($ref, allOf, etc.) which should be applied to the given instance.
-    # returns these as a Set of {JSI::Schema}s.
+    # a resource containing this schema.
     #
-    # the returned set will contain this schema itself, unless this schema contains a $ref keyword.
+    # if any parent, or this schema itself, is a schema with an absolute uri (see #schema_absolute_uri),
+    # the resource root is the closest schema with an absolute uri.
     #
-    # @param other_instance [Object] the instance to check any applicators against
-    # @return [Set<JSI::Schema>] matched applicator schemas
-    def match_to_instance(other_instance)
-      node_ptr.schema_match_ptrs_to_instance(node_document, other_instance).map do |ptr|
-        ptr.evaluate(document_root_node).tap { |subschema| jsi_ensure_subschema_is_schema(subschema, ptr) }
-      end.to_set
+    # if no parent schema has an absolute uri, the schema_resource_root is the root of the document
+    # (our #jsi_root_node). in this case, the resource root may or may not be a schema itself.
+    #
+    # @return [JSI::Base] resource containing this schema
+    def schema_resource_root
+      jsi_subschema_resource_ancestors.reverse_each.detect(&:schema_resource_root?) || jsi_root_node
+    end
+
+    # is this schema the root of a schema resource?
+    # @return [Boolean]
+    def schema_resource_root?
+      jsi_ptr.root? || !!schema_absolute_uri
     end
 
-    # returns a set of subschemas of this schema for the given property name, from keywords
-    #   `properties`, `patternProperties`, and `additionalProperties`.
+    # a subschema of this Schema
     #
-    # @param property_name [String] the property name for which to find subschemas
-    # @return [Set<JSI::Schema>] subschemas of this schema for the given property_name
-    def subschemas_for_property_name(property_name)
-      jsi_memoize(:subschemas_for_property_name, property_name) do |property_name|
-        node_ptr.schema_subschema_ptrs_for_property_name(node_document, property_name).map do |ptr|
-          ptr.evaluate(document_root_node).tap { |subschema| jsi_ensure_subschema_is_schema(subschema, ptr) }
-        end.to_set
+    # @param subptr [JSI::Ptr, #to_ary] a relative pointer, or array of tokens, pointing to the subschema
+    # @return [JSI::Schema] the subschema at the location indicated by subptr. self if subptr is empty.
+    def subschema(subptr)
+      subschema_map[Ptr.ary_ptr(subptr)]
+    end
+
+    private
+
+    def subschema_map
+      jsi_memomap(:subschema) do |subptr|
+        if is_a?(MetaschemaNode::BootstrapSchema)
+          self.class.new(
+            jsi_document,
+            jsi_ptr: jsi_ptr + subptr,
+            jsi_schema_base_uri: jsi_resource_ancestor_uri,
+          )
+        else
+          Schema.ensure_schema(subptr.evaluate(self, as_jsi: true), msg: [
+            "subschema is not a schema at pointer: #{subptr.pointer}"
+          ])
+        end
       end
     end
 
-    # returns a set of subschemas of this schema for the given array index, from keywords
-    #   `items` and `additionalItems`.
+    public
+
+    # a schema in the same schema resource as this one (see #schema_resource_root) at the given
+    # pointer relative to the root of the schema resource.
     #
-    # @param index [Integer] the array index for which to find subschemas
-    # @return [Set<JSI::Schema>] subschemas of this schema for the given array index
-    def subschemas_for_index(index)
-      jsi_memoize(:subschemas_for_index, index) do |index|
-        node_ptr.schema_subschema_ptrs_for_index(node_document, index).map do |ptr|
-          ptr.evaluate(document_root_node).tap { |subschema| jsi_ensure_subschema_is_schema(subschema, ptr) }
-        end.to_set
+    # @param ptr [JSI::Ptr, #to_ary] a pointer to a schema from our schema resource root
+    # @return [JSI::Schema] the schema pointed to by ptr
+    def resource_root_subschema(ptr)
+      resource_root_subschema_map[Ptr.ary_ptr(ptr)]
+    end
+
+    private
+
+    def resource_root_subschema_map
+      jsi_memomap(:resource_root_subschema_map) do |ptr|
+        schema = self
+        if schema.is_a?(MetaschemaNode::BootstrapSchema)
+          # BootstrapSchema does not track jsi_schema_resource_ancestors used by #schema_resource_root;
+          # resource_root_subschema is always relative to the document root.
+          # BootstrapSchema also does not implement jsi_root_node or #[]. we instantiate the ptr directly
+          # rather than as a subschema from the root.
+          schema.class.new(
+            schema.jsi_document,
+            jsi_ptr: ptr,
+            jsi_schema_base_uri: nil,
+          )
+        else
+          resource_root = schema.schema_resource_root
+          Schema.ensure_schema(ptr.evaluate(resource_root, as_jsi: true),
+            msg: [
+              "subschema is not a schema at pointer: #{ptr.pointer}"
+            ],
+            reinstantiate_as: schema.jsi_schemas.select(&:describes_schema?)
+          )
+        end
       end
     end
 
-    # @return [Set] any object property names this schema indicates may be present on its instances.
-    #   this includes any keys of this schema's "properties" object and any entries of this schema's
-    #   array of "required" property keys.
+    public
+
+    # any object property names this schema indicates may be present on its instances.
+    # this includes any keys of this schema's "properties" object and any entries of this schema's
+    # array of "required" property keys.
+    # @return [Set]
     def described_object_property_names
       jsi_memoize(:described_object_property_names) do
         Set.new.tap do |property_names|
-          if node_content.respond_to?(:to_hash) && node_content['properties'].respond_to?(:to_hash)
-            property_names.merge(node_content['properties'].keys)
+          if schema_content.respond_to?(:to_hash) && schema_content['properties'].respond_to?(:to_hash)
+            property_names.merge(schema_content['properties'].keys)
           end
-          if node_content.respond_to?(:to_hash) && node_content['required'].respond_to?(:to_ary)
-            property_names.merge(node_content['required'].to_ary)
+          if schema_content.respond_to?(:to_hash) && schema_content['required'].respond_to?(:to_ary)
+            property_names.merge(schema_content['required'].to_ary)
           end
-        end
+        end.freeze
       end
     end
 
-    # @return [Array] array of schema validation errors for
-    #   the given instance against this schema
+    # validates the given instance against this schema
+    #
+    # @param instance [Object] the instance to validate against this schema
+    # @return [JSI::Validation::Result]
+    def instance_validate(instance)
+      if instance.is_a?(JSI::PathedNode)
+        instance_ptr = instance.jsi_ptr
+        instance_document = instance.jsi_document
+      else
+        instance_ptr = Ptr[]
+        instance_document = instance
+      end
+      internal_validate_instance(instance_ptr, instance_document)
+    end
+
+    # whether the given instance is valid against this schema
+    # @param instance [Object] the instance to validate against this schema
+    # @return [Boolean]
+    def instance_valid?(instance)
+      if instance.is_a?(JSI::PathedNode)
+        instance = instance.jsi_node_content
+      end
+      internal_validate_instance(Ptr[], instance, validate_only: true).valid?
+    end
+
+    # @private
     def fully_validate_instance(other_instance, errors_as_objects: false)
-      ::JSON::Validator.fully_validate(JSI::Typelike.as_json(node_document), JSI::Typelike.as_json(other_instance), fragment: node_ptr.fragment, errors_as_objects: errors_as_objects)
+      raise(NotImplementedError, "Schema#fully_validate_instance removed: see new validation interface Schema#instance_validate")
     end
 
-    # @return [true, false] whether the given instance validates against this schema
+    # @private
     def validate_instance(other_instance)
-      ::JSON::Validator.validate(JSI::Typelike.as_json(node_document), JSI::Typelike.as_json(other_instance), fragment: node_ptr.fragment)
+      raise(NotImplementedError, "Schema#validate_instance renamed: see Schema#instance_valid?")
     end
 
-    # @return [true] if this method does not raise, it returns true to
-    #   indicate the instance is valid against this schema
-    # @raise [::JSON::Schema::ValidationError] raises if the instance has
-    #   validation errors against this schema
+    # @private
     def validate_instance!(other_instance)
-      ::JSON::Validator.validate!(JSI::Typelike.as_json(node_document), JSI::Typelike.as_json(other_instance), fragment: node_ptr.fragment)
+      raise(NotImplementedError, "Schema#validate_instance! removed")
     end
 
-    # @return [Array] array of schema validation errors for
-    #   this schema, validated against its metaschema. a default metaschema
-    #   is assumed if the schema does not specify a $schema.
+    # @private
     def fully_validate_schema(errors_as_objects: false)
-      ::JSON::Validator.fully_validate(JSI::Typelike.as_json(node_document), [], fragment: node_ptr.fragment, validate_schema: true, list: true, errors_as_objects: errors_as_objects)
+      raise(NotImplementedError, "Schema#fully_validate_schema removed: use validation interface Base#jsi_validate on the schema")
     end
 
-    # @return [true, false] whether this schema validates against its metaschema
+    # @private
     def validate_schema
-      ::JSON::Validator.validate(JSI::Typelike.as_json(node_document), [], fragment: node_ptr.fragment, validate_schema: true, list: true)
+      raise(NotImplementedError, "Schema#validate_schema removed: use validation interface Base#jsi_valid? on the schema")
     end
 
-    # @return [true] if this method does not raise, it returns true to
-    #   indicate this schema is valid against its metaschema
-    # @raise [::JSON::Schema::ValidationError] raises if this schema has
-    #   validation errors against its metaschema
+    # @private
     def validate_schema!
-      ::JSON::Validator.validate!(JSI::Typelike.as_json(node_document), [], fragment: node_ptr.fragment, validate_schema: true, list: true)
+      raise(NotImplementedError, "Schema#validate_schema! removed")
     end
 
-    private
-    def jsi_ensure_subschema_is_schema(subschema, ptr)
-      unless subschema.is_a?(JSI::Schema)
-        raise(NotASchemaError, "subschema not a schema at ptr #{ptr.inspect}: #{subschema.pretty_inspect.chomp}")
+    # schema resources which are ancestors of any subschemas below this schema.
+    # this may include this schema if this is a schema resource root.
+    # @private
+    # @return [Array<JSI::Schema>]
+    def jsi_subschema_resource_ancestors
+      if schema_resource_root?
+        jsi_schema_resource_ancestors + [self]
+      else
+        jsi_schema_resource_ancestors
       end
     end
   end