jsi 0.6.0 → 0.7.0

data/lib/jsi/base.rb

@@ -14,24 +14,17 @@ module JSI
   #
   # the JSI::Base class itself is not intended to be instantiated.
   class Base
-    include PathedNode
+    autoload :ArrayNode, 'jsi/base/node'
+    autoload :HashNode, 'jsi/base/node'
+
     include Schema::SchemaAncestorNode
     include Util::Memoize
 
-    # not every JSI::Base is necessarily an Enumerable, but it's better to include Enumerable on
-    # the class than to conditionally extend the instance.
-    include Enumerable
-
-    # an exception raised when #[] is invoked on an instance which is not an array or hash
+    # an exception raised when {Base#[]} is invoked on an instance which is not an array or hash
     class CannotSubscriptError < StandardError
     end
 
     class << self
-      # @private @deprecated
-      def new_jsi(instance, **kw, &b)
-        new(instance, **kw, &b)
-      end
-
       # @private
       # is the constant JSI::SchemaClasses::<self.schema_classes_const_name> defined?
       # (if so, we will prefer to use something more human-readable than that ugly mess.)
@@ -84,8 +77,9 @@ module JSI
       def schema_classes_const_name
         if respond_to?(:jsi_class_schemas)
           schema_names = jsi_class_schemas.map do |schema|
-            if schema.jsi_schema_module.name
-              schema.jsi_schema_module.name
+            named_ancestor_schema, tokens = schema.jsi_schema_module.send(:named_ancestor_schema_tokens)
+            if named_ancestor_schema
+              [named_ancestor_schema.jsi_schema_module.name, *tokens].join('_')
             elsif schema.schema_uri
               schema.schema_uri.to_s
             else
@@ -119,78 +113,44 @@ module JSI
       end
     end
 
-    # NOINSTANCE is a magic value passed to #initialize when instantiating a JSI
-    # from a document and pointer.
+    # initializes a JSI whose instance is in the given document at the given pointer.
     #
-    # @private
-    NOINSTANCE = Object.new
-    [:inspect, :to_s].each(&(-> (s, m) { NOINSTANCE.define_singleton_method(m) { s } }.curry.("#{JSI::Base}::NOINSTANCE")))
-    NOINSTANCE.freeze
-
-    # initializes this JSI from the given instance - instance is most commonly
-    # a parsed JSON document consisting of Hash, Array, or sometimes a basic
-    # type, but this is in no way enforced and a JSI may wrap any object.
+    # this is a private api - users should look elsewhere to instantiate JSIs, in particular:
+    #
+    # - {JSI.new_schema} and {Schema::DescribesSchema#new_schema} to instantiate schemas
+    # - {Schema#new_jsi} to instantiate schema instances
     #
-    # @param instance [Object] the JSON Schema instance to be represented as a JSI
-    # @param jsi_document [Object] for internal use. the instance may be specified as a
-    #   node in the `jsi_document` param, pointed to by `jsi_ptr`. the param `instance`
-    #   MUST be `NOINSTANCE` to use the jsi_document + jsi_ptr form. `jsi_document` MUST
-    #   NOT be passed if `instance` is anything other than `NOINSTANCE`.
-    # @param jsi_ptr [JSI::Ptr] for internal use. a pointer specifying
-    #   the path of this instance in the `jsi_document` param. `jsi_ptr` must be passed
-    #   iff `jsi_document` is passed, i.e. when `instance` is `NOINSTANCE`
-    # @param jsi_root_node [JSI::Base] for internal use, specifies the JSI at the root of the document
+    # @api private
+    # @param jsi_document [Object] the document containing the instance
+    # @param jsi_ptr [JSI::Ptr] a pointer pointing to the JSI's instance in the document
+    # @param jsi_root_node [JSI::Base] the JSI of the root of the document containing this JSI
     # @param jsi_schema_base_uri [Addressable::URI] see {SchemaSet#new_jsi} param uri
-    # @param jsi_schema_resource_ancestors [Array<JSI::Base>]
-    def initialize(instance,
-        jsi_document: nil,
-        jsi_ptr: nil,
+    # @param jsi_schema_resource_ancestors [Array<JSI::Base<JSI::Schema>>]
+    def initialize(jsi_document,
+        jsi_ptr: Ptr[],
         jsi_root_node: nil,
         jsi_schema_base_uri: nil,
-        jsi_schema_resource_ancestors: []
+        jsi_schema_resource_ancestors: Util::EMPTY_ARY
     )
-      unless respond_to?(:jsi_schemas)
-        raise(TypeError, "cannot instantiate #{self.class.inspect} which has no method #jsi_schemas. it is recommended to instantiate JSIs from a schema using JSI::Schema#new_jsi.")
-      end
-
-      if instance.is_a?(JSI::Schema)
-        raise(TypeError, "assigning a schema to a #{self.class.inspect} instance is incorrect. received: #{instance.pretty_inspect.chomp}")
-      elsif instance.is_a?(JSI::Base)
-        raise(TypeError, "assigning another JSI::Base instance to a #{self.class.inspect} instance is incorrect. received: #{instance.pretty_inspect.chomp}")
-      end
+      raise(Bug, "no #jsi_schemas") unless respond_to?(:jsi_schemas)
 
       jsi_initialize_memos
 
-      if instance == NOINSTANCE
-        self.jsi_document = jsi_document
-        self.jsi_ptr = jsi_ptr
-        if @jsi_ptr.root?
-          raise(Bug, "jsi_root_node cannot be specified for root JSI") if jsi_root_node
-          @jsi_root_node = self
-        else
-          if !jsi_root_node.is_a?(JSI::Base)
-            raise(TypeError, "jsi_root_node must be a JSI::Base; got: #{jsi_root_node.inspect}")
-          end
-          if !jsi_root_node.jsi_ptr.root?
-            raise(Bug, "jsi_root_node ptr #{jsi_root_node.jsi_ptr.inspect} is not root")
-          end
-          @jsi_root_node = jsi_root_node
-        end
-      else
-        raise(Bug, 'incorrect usage') if jsi_document || jsi_ptr || jsi_root_node
-        @jsi_document = instance
-        @jsi_ptr = Ptr[]
+      self.jsi_document = jsi_document
+      self.jsi_ptr = jsi_ptr
+      if @jsi_ptr.root?
+        raise(Bug, "jsi_root_node specified for root JSI") if jsi_root_node
         @jsi_root_node = self
+      else
+        raise(Bug, "jsi_root_node is not JSI::Base") if !jsi_root_node.is_a?(JSI::Base)
+        raise(Bug, "jsi_root_node ptr is not root") if !jsi_root_node.jsi_ptr.root?
+        @jsi_root_node = jsi_root_node
       end
-
       self.jsi_schema_base_uri = jsi_schema_base_uri
       self.jsi_schema_resource_ancestors = jsi_schema_resource_ancestors
 
-      if self.jsi_instance.respond_to?(:to_hash)
-        extend PathedHashNode
-      end
-      if self.jsi_instance.respond_to?(:to_ary)
-        extend PathedArrayNode
+      if jsi_instance.is_a?(JSI::Base)
+        raise(TypeError, "a JSI::Base instance must not be another JSI::Base. received: #{jsi_instance.pretty_inspect.chomp}")
       end
     end
 
@@ -211,53 +171,53 @@ module JSI
     # @return [JSI::Base]
     attr_reader :jsi_root_node
 
+    # the content of this node in our {#jsi_document} at our {#jsi_ptr}. the same as {#jsi_instance}.
+    def jsi_node_content
+      content = jsi_ptr.evaluate(jsi_document)
+      content
+    end
+
     # the JSON schema instance this JSI represents - the underlying JSON data used to instantiate this JSI
     alias_method :jsi_instance, :jsi_node_content
 
-    # each is overridden by PathedHashNode or PathedArrayNode when appropriate. the base #each
-    # is not actually implemented, along with all the methods of Enumerable.
-    def each(*_)
-      raise NoMethodError, "Enumerable methods and #each not implemented for instance that is not like a hash or array: #{jsi_instance.pretty_inspect.chomp}"
-    end
-
     # yields a JSI of each node at or below this one in this JSI's document.
     #
     # returns an Enumerator if no block is given.
     #
-    # @yield [JSI::Base] each node in the document, starting with self
+    # @yield [JSI::Base] each descendent node, starting with self
     # @return [nil, Enumerator] an Enumerator if invoked without a block; otherwise nil
-    def jsi_each_child_node(&block)
+    def jsi_each_descendent_node(&block)
       return to_enum(__method__) unless block
 
       yield self
       if respond_to?(:to_hash)
         each_key do |k|
-          self[k, as_jsi: true].jsi_each_child_node(&block)
+          self[k, as_jsi: true].jsi_each_descendent_node(&block)
         end
       elsif respond_to?(:to_ary)
         each_index do |i|
-          self[i, as_jsi: true].jsi_each_child_node(&block)
+          self[i, as_jsi: true].jsi_each_descendent_node(&block)
         end
       end
       nil
     end
 
-    # recursively selects child nodes of this JSI, returning a modified copy of self containing only
-    # child nodes for which the given block had a true-ish result.
+    # recursively selects descendent nodes of this JSI, returning a modified copy of self containing only
+    # descendent nodes for which the given block had a true-ish result.
     #
     # this method yields a node before recursively descending to its child nodes, so leaf nodes are yielded
-    # last, after their parents. if a node is not selected, its children are never recursed.
+    # last, after their parents. if a node is not selected, its descendents are never recursed.
     #
-    # @yield [JSI::Base] each child node below self
+    # @yield [JSI::Base] each descendent node below self
     # @return [JSI::Base] modified copy of self containing only the selected nodes
-    def jsi_select_children_node_first(&block)
+    def jsi_select_descendents_node_first(&block)
       jsi_modified_copy do |instance|
         if respond_to?(:to_hash)
           res = instance.class.new
           each_key do |k|
             v = self[k, as_jsi: true]
             if yield(v)
-              res[k] = v.jsi_select_children_node_first(&block).jsi_node_content
+              res[k] = v.jsi_select_descendents_node_first(&block).jsi_node_content
             end
           end
           res
@@ -266,7 +226,7 @@ module JSI
           each_index do |i|
             e = self[i, as_jsi: true]
             if yield(e)
-              res << e.jsi_select_children_node_first(&block).jsi_node_content
+              res << e.jsi_select_descendents_node_first(&block).jsi_node_content
             end
           end
           res
@@ -276,20 +236,23 @@ module JSI
       end
     end
 
-    # recursively selects child nodes of this JSI, returning a modified copy of self containing only
-    # child nodes for which the given block had a true-ish result.
+    # @deprecated after v0.6
+    alias_method :jsi_select_children_node_first, :jsi_select_descendents_node_first
+
+    # recursively selects descendent nodes of this JSI, returning a modified copy of self containing only
+    # descendent nodes for which the given block had a true-ish result.
     #
     # this method recursively descends child nodes before yielding each node, so leaf nodes are yielded
     # before their parents.
     #
-    # @yield [JSI::Base] each child node below self
+    # @yield [JSI::Base] each descendent node below self
     # @return [JSI::Base] modified copy of self containing only the selected nodes
-    def jsi_select_children_leaf_first(&block)
+    def jsi_select_descendents_leaf_first(&block)
       jsi_modified_copy do |instance|
         if respond_to?(:to_hash)
           res = instance.class.new
           each_key do |k|
-            v = self[k, as_jsi: true].jsi_select_children_leaf_first(&block)
+            v = self[k, as_jsi: true].jsi_select_descendents_leaf_first(&block)
             if yield(v)
               res[k] = v.jsi_node_content
             end
@@ -298,7 +261,7 @@ module JSI
         elsif respond_to?(:to_ary)
           res = instance.class.new
           each_index do |i|
-            e = self[i, as_jsi: true].jsi_select_children_leaf_first(&block)
+            e = self[i, as_jsi: true].jsi_select_descendents_leaf_first(&block)
             if yield(e)
               res << e.jsi_node_content
             end
@@ -310,6 +273,9 @@ module JSI
       end
     end
 
+    # @deprecated after v0.6
+    alias_method :jsi_select_children_leaf_first, :jsi_select_descendents_leaf_first
+
     # an array of JSI instances above this one in the document.
     #
     # @return [Array<JSI::Base>]
@@ -327,7 +293,31 @@ module JSI
     #
     # @return [JSI::Base, nil]
     def jsi_parent_node
-      jsi_parent_nodes.first
+      jsi_ptr.root? ? nil : jsi_root_node.jsi_descendent_node(jsi_ptr.parent)
+    end
+
+    # ancestor JSI instances from this node up to the root. this node itself is always its own first ancestor.
+    #
+    # @return [Array<JSI::Base>]
+    def jsi_ancestor_nodes
+      ancestors = []
+      ancestor = jsi_root_node
+      ancestors << ancestor
+
+      jsi_ptr.tokens.each do |token|
+        ancestor = ancestor[token, as_jsi: true]
+        ancestors << ancestor
+      end
+      ancestors.reverse!.freeze
+    end
+
+    # the descendent node at the given pointer
+    #
+    # @param ptr [JSI::Ptr, #to_ary]
+    # @return [JSI::Base]
+    def jsi_descendent_node(ptr)
+      descendent = Ptr.ary_ptr(ptr).evaluate(self, as_jsi: true)
+      descendent
     end
 
     # subscripts to return a child value identified by the given token.
@@ -338,14 +328,14 @@ module JSI
     #
     #   - :auto (default): by default a JSI will be returned when either:
     #
-    #     - the result is a complex value (responds to #to_ary or #to_hash) and is described by some schemas
+    #     - the result is a complex value (responds to #to_ary or #to_hash)
     #     - the result is a schema (including true/false schemas)
     #
     #     a plain value is returned when no schemas are known to describe the instance, or when the value is a
     #     simple type (anything unresponsive to #to_ary / #to_hash).
     #
-    #   - true: the result value will always be returned as a JSI. the #jsi_schemas of the result may be empty
-    #     if no schemas describe the instance.
+    #   - true: the result value will always be returned as a JSI. the {#jsi_schemas} of the result may be
+    #     empty if no schemas describe the instance.
     #   - false: the result value will always be the plain instance.
     #
     #   note that nil is returned (regardless of as_jsi) when there is no value to return because the token
@@ -381,14 +371,18 @@ module JSI
 
         if token_in_range
           jsi_subinstance_as_jsi(value, subinstance_schemas, as_jsi) do
-            jsi_subinstance_memos[token: token, subinstance_schemas: subinstance_schemas]
+            jsi_subinstance_memos[
+              token: token,
+              subinstance_schemas: subinstance_schemas,
+              includes: SchemaClasses.includes_for(value),
+            ]
           end
         else
           if use_default
             defaults = Set.new
             subinstance_schemas.each do |subinstance_schema|
-              if subinstance_schema.respond_to?(:to_hash) && subinstance_schema.key?('default')
-                defaults << subinstance_schema['default']
+              if subinstance_schema.keyword?('default')
+                defaults << subinstance_schema.jsi_node_content['default']
               end
             end
           end
@@ -415,7 +409,7 @@ module JSI
     # @param value [JSI::Base, Object] the value to be assigned
     def []=(token, value)
       unless respond_to?(:to_hash) || respond_to?(:to_ary)
-        raise(NoMethodError, "cannot assign subscript (using token: #{token.inspect}) to instance: #{jsi_instance.pretty_inspect.chomp}")
+        raise(CannotSubscriptError, "cannot assign subscript (using token: #{token.inspect}) to instance: #{jsi_instance.pretty_inspect.chomp}")
       end
       if value.is_a?(Base)
         self[token] = value.jsi_instance
@@ -427,12 +421,12 @@ module JSI
     # the set of JSI schema modules corresponding to the schemas that describe this JSI
     # @return [Set<Module>]
     def jsi_schema_modules
-      jsi_schemas.map(&:jsi_schema_module).to_set.freeze
+      Util.ensure_module_set(jsi_schemas.map(&:jsi_schema_module))
     end
 
     # yields the content of this JSI's instance. the block must result in
-    # a modified copy of the yielded instance (not destructively modifying it)
-    # which will be used to instantiate a new JSI with the modified content.
+    # a modified copy of the yielded instance (not modified in place, which would alter this JSI
+    # as well) which will be used to instantiate and return a new JSI with the modified content.
     #
     # the result may have different schemas which describe it than this JSI's schemas,
     # if conditional applicator schemas apply differently to the modified instance.
@@ -443,17 +437,14 @@ module JSI
     def jsi_modified_copy(&block)
       if @jsi_ptr.root?
         modified_document = @jsi_ptr.modified_document_copy(@jsi_document, &block)
-        self.class.new(Base::NOINSTANCE,
-          jsi_document: modified_document,
-          jsi_ptr: @jsi_ptr,
-          jsi_schema_base_uri: @jsi_schema_base_uri,
-          jsi_schema_resource_ancestors: @jsi_schema_resource_ancestors, # this can only be empty but included for consistency
+        jsi_schemas.new_jsi(modified_document,
+          uri: jsi_schema_base_uri,
         )
       else
         modified_jsi_root_node = @jsi_root_node.jsi_modified_copy do |root|
           @jsi_ptr.modified_document_copy(root, &block)
         end
-        @jsi_ptr.evaluate(modified_jsi_root_node, as_jsi: true)
+        modified_jsi_root_node.jsi_descendent_node(@jsi_ptr)
       end
     end
 
@@ -470,19 +461,21 @@ module JSI
       jsi_schemas.instance_valid?(self)
     end
 
-    # @private
-    def fully_validate(errors_as_objects: false)
-      raise(NotImplementedError, "Base#fully_validate removed: see new validation interface Base#jsi_validate")
-    end
-
-    # @private
-    def validate
-      raise(NotImplementedError, "Base#validate renamed: see Base#jsi_valid?")
-    end
-
-    # @private
-    def validate!
-      raise(NotImplementedError, "Base#validate! removed")
+    # queries this JSI using the [JMESPath Ruby](https://rubygems.org/gems/jmespath) gem.
+    # see [https://jmespath.org/](https://jmespath.org/) to learn the JMESPath query language.
+    #
+    # the JMESPath gem is not a dependency of JSI, so must be installed / added to your Gemfile to use.
+    # e.g. `gem 'jmespath', '~> 1.5'`. note that versions below 1.5 are not compatible with JSI.
+    #
+    # @param expression [String] a [JMESPath](https://jmespath.org/) expression
+    # @param runtime_options passed to [JMESPath.search](https://rubydoc.info/gems/jmespath/JMESPath#search-class_method),
+    #   though no runtime_options are publicly documented or normally used.
+    # @return [Array, Object, nil] query results.
+    #   see [JMESPath.search](https://rubydoc.info/gems/jmespath/JMESPath#search-class_method)
+    def jmespath_search(expression, **runtime_options)
+      Util.require_jmespath
+
+      JMESPath.search(expression, self, **runtime_options)
     end
 
     def dup
@@ -495,6 +488,8 @@ module JSI
       "\#<#{jsi_object_group_text.join(' ')} #{jsi_instance.inspect}>"
     end
 
+    alias_method :to_s, :inspect
+
     # pretty-prints a representation of this JSI to the given printer
     # @return [void]
     def pretty_print(q)
@@ -513,27 +508,14 @@ module JSI
     # @private
     # @return [Array<String>]
     def jsi_object_group_text
-      class_name = self.class.name unless self.class.in_schema_classes
-      class_txt = begin
-        if class_name
-          # ignore ID
-          schema_module_names = jsi_schemas.map { |schema| schema.jsi_schema_module.name }.compact
-          if schema_module_names.empty?
-            class_name
-          else
-            "#{class_name} (#{schema_module_names.join(', ')})"
-          end
-        else
-          schema_names = jsi_schemas.map { |schema| schema.jsi_schema_module.name_from_ancestor || schema.schema_uri }.compact
-          if schema_names.empty?
-            "JSI"
-          else
-            "JSI (#{schema_names.join(', ')})"
-          end
-        end
+      schema_names = jsi_schemas.map { |schema| schema.jsi_schema_module.name_from_ancestor || schema.schema_uri }.compact
+      if schema_names.empty?
+        class_txt = "JSI"
+      else
+        class_txt = "JSI (#{schema_names.join(', ')})"
       end
 
-      if (is_a?(PathedArrayNode) || is_a?(PathedHashNode)) && ![Array, Hash].include?(jsi_node_content.class)
+      if (is_a?(ArrayNode) || is_a?(HashNode)) && ![Array, Hash].include?(jsi_node_content.class)
         if jsi_node_content.respond_to?(:jsi_object_group_text)
           content_txt = jsi_node_content.jsi_object_group_text
         else
@@ -553,7 +535,7 @@ module JSI
     # a jsonifiable representation of the instance
     # @return [Object]
     def as_json(*opt)
-      Typelike.as_json(jsi_instance, *opt)
+      Util.as_json(jsi_instance, *opt)
     end
 
     # an opaque fingerprint of this JSI for {Util::FingerprintHash}.
@@ -574,22 +556,14 @@ module JSI
 
     def jsi_subinstance_schemas_memos
       jsi_memomap(:subinstance_schemas, key_by: -> (i) { i[:token] }) do |token: , instance: , subinstance: |
-        SchemaSet.build do |schemas|
-          jsi_schemas.each do |schema|
-            schema.each_child_applicator_schema(token, instance) do |child_app_schema|
-              child_app_schema.each_inplace_applicator_schema(subinstance) do |child_inpl_app_schema|
-                schemas << child_inpl_app_schema
-              end
-            end
-          end
-        end
+        jsi_schemas.child_applicator_schemas(token, instance).inplace_applicator_schemas(subinstance)
       end
     end
 
     def jsi_subinstance_memos
-      jsi_memomap(:subinstance, key_by: -> (i) { i[:token] }) do |token: , subinstance_schemas: |
-        JSI::SchemaClasses.class_for_schemas(subinstance_schemas).new(Base::NOINSTANCE,
-          jsi_document: @jsi_document,
+      jsi_memomap(:subinstance, key_by: -> (i) { i[:token] }) do |token: , subinstance_schemas: , includes: |
+        jsi_class = JSI::SchemaClasses.class_for_schemas(subinstance_schemas, includes: includes)
+        jsi_class.new(@jsi_document,
           jsi_ptr: @jsi_ptr[token],
           jsi_root_node: @jsi_root_node,
           jsi_schema_base_uri: jsi_resource_ancestor_uri,
@@ -599,12 +573,12 @@ module JSI
     end
 
     def jsi_subinstance_as_jsi(value, subinstance_schemas, as_jsi)
-      value_as_jsi = if [true, false].include?(as_jsi)
-        as_jsi
+      if [true, false].include?(as_jsi)
+        value_as_jsi = as_jsi
       elsif as_jsi == :auto
-        complex_value = subinstance_schemas.any? && (value.respond_to?(:to_hash) || value.respond_to?(:to_ary))
-        schema_value = subinstance_schemas.any? { |subinstance_schema| subinstance_schema.describes_schema? }
-        complex_value || schema_value
+        complex_value = value.respond_to?(:to_hash) || value.respond_to?(:to_ary)
+        schema_value = subinstance_schemas.any?(&:describes_schema?)
+        value_as_jsi = complex_value || schema_value
       else
         raise(ArgumentError, "as_jsi must be one of: :auto, true, false")
       end

data/lib/jsi/jsi_coder.rb

@@ -48,7 +48,7 @@ module JSI
         unless data.respond_to?(:to_ary)
           raise TypeError, "expected array-like column data; got: #{data.class}: #{data.inspect}"
         end
-        data.map { |el| load_object(el) }
+        data.to_ary.map { |el| load_object(el) }
       else
         load_object(data)
       end
@@ -66,7 +66,7 @@ module JSI
           unless object.respond_to?(:to_ary)
             raise(TypeError, "expected array-like attribute; got: #{object.class}: #{object.inspect}")
           end
-          object.map do |el|
+          object.to_ary.map do |el|
             dump_object(el)
           end
         else
@@ -86,7 +86,7 @@ module JSI
     # @param object [JSI::Base, Object]
     # @return [Object]
     def dump_object(object)
-      JSI::Typelike.as_json(object)
+      JSI::Util.as_json(object)
     end
   end
 end

data/lib/jsi/metaschema.rb

@@ -2,6 +2,5 @@
 
 module JSI
   module Metaschema
-    include JSI::Schema::DescribesSchema
   end
 end

data/lib/jsi/metaschema_node/bootstrap_schema.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module JSI
-  # @private
   # internal class to bootstrap a metaschema. represents a schema without the complexity of JSI::Base. the
   # schema is represented but schemas describing the schema are not.
   #
@@ -9,9 +8,11 @@ module JSI
   # Schema#subschema and Schema#resource_root_subschema are the intended mechanisms to instantiate subschemas
   # and resolve references. #[] and #jsi_root_node are not implemented.
   #
-  # metaschema instance modules are attached to generated subclasses of BootstrapSchema by
+  # schema implementation modules are attached to generated subclasses of BootstrapSchema by
   # {SchemaClasses.bootstrap_schema_class}. that subclass is instantiated with a document and
   # pointer, representing a schema.
+  #
+  # @api private
   class MetaschemaNode::BootstrapSchema
     include Util::Memoize
     include Util::FingerprintHash
@@ -22,7 +23,7 @@ module JSI
         if self == MetaschemaNode::BootstrapSchema
           name
         else
-          "#{name || MetaschemaNode::BootstrapSchema.name} (#{metaschema_instance_modules.map(&:inspect).join(', ')})"
+          "#{name || MetaschemaNode::BootstrapSchema.name} (#{schema_implementation_modules.map(&:inspect).join(', ')})"
         end
       end
 
@@ -36,9 +37,7 @@ module JSI
         jsi_ptr: Ptr[],
         jsi_schema_base_uri: nil
     )
-      unless respond_to?(:metaschema_instance_modules)
-        raise(TypeError, "cannot instantiate #{self.class.inspect} which has no method #metaschema_instance_modules")
-      end
+      raise(Bug, "no #schema_implementation_modules") unless respond_to?(:schema_implementation_modules)
 
       jsi_initialize_memos
 
@@ -62,6 +61,8 @@ module JSI
       "\#<#{jsi_object_group_text.join(' ')} #{schema_content.inspect}>"
     end
 
+    alias_method :to_s, :inspect
+
     # pretty-prints a representation of self to the given printer
     # @return [void]
     def pretty_print(q)
@@ -82,7 +83,7 @@ module JSI
     def jsi_object_group_text
       [
         self.class.name || MetaschemaNode::BootstrapSchema.name,
-        "(#{metaschema_instance_modules.map(&:inspect).join(', ')})",
+        "(#{schema_implementation_modules.map(&:inspect).join(', ')})",
         jsi_ptr.uri,
       ]
     end
@@ -93,7 +94,7 @@ module JSI
         class: self.class,
         jsi_ptr: @jsi_ptr,
         jsi_document: @jsi_document,
-        metaschema_instance_modules: metaschema_instance_modules,
+        schema_implementation_modules: schema_implementation_modules,
       }
     end
   end