oso-oso 0.2.2

data/lib/oso/polar/ffi.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+module Oso
+  module Polar
+    module FFI
+      LIB = ::FFI::Platform::LIBPREFIX + 'polar.' + ::FFI::Platform::LIBSUFFIX
+      LIB_PATH = File.expand_path(File.join(__dir__, "../../../ext/oso-oso/lib/#{LIB}"))
+
+      # Wrapper classes defined upfront to fix Ruby loading issues. Actual
+      # implementations live in the sibling `ffi/` directory and are `require`d
+      # at the bottom of this file.
+
+      # Wrapper class for Polar FFI pointer + operations.
+      class Polar < ::FFI::AutoPointer
+        def self.release(ptr)
+          Rust.free(ptr) unless ptr.null?
+        end
+      end
+      # Wrapper class for Query FFI pointer + operations.
+      class Query < ::FFI::AutoPointer
+        def self.release(ptr)
+          Rust.free(ptr) unless ptr.null?
+        end
+      end
+      # Wrapper class for QueryEvent FFI pointer + operations.
+      class QueryEvent < ::FFI::AutoPointer
+        def self.release(ptr)
+          Rust.free(ptr) unless ptr.null?
+        end
+      end
+      # Wrapper class for Error FFI pointer + operations.
+      class Error < ::FFI::AutoPointer
+        def self.release(ptr)
+          Rust.free(ptr)
+        end
+      end
+    end
+    private_constant :FFI
+  end
+end
+
+require 'oso/polar/ffi/polar'
+require 'oso/polar/ffi/query'
+require 'oso/polar/ffi/query_event'
+require 'oso/polar/ffi/error'

data/lib/oso/polar/ffi/error.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Oso
+  module Polar
+    module FFI
+      # Wrapper class for Error FFI pointer + operations.
+      class Error < ::FFI::AutoPointer
+        def to_s
+          @to_s ||= read_string.force_encoding('UTF-8')
+        end
+
+        Rust = Module.new do
+          extend ::FFI::Library
+          ffi_lib FFI::LIB_PATH
+
+          attach_function :get, :polar_get_error, [], Error
+          attach_function :free, :string_free, [Error], :int32
+        end
+        private_constant :Rust
+
+        # Check for an FFI error and convert it into a Ruby exception.
+        #
+        # @return [::Oso::Polar::Error] if there's an FFI error.
+        # @return [::Oso::Polar::FFIErrorNotFound] if there isn't one.
+        def self.get # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          error = Rust.get
+          return ::Oso::Polar::FFIErrorNotFound if error.null?
+
+          error = JSON.parse(error.to_s)
+          msg = error['formatted']
+          kind, body = error['kind'].first
+          subkind, details = body.first
+          case kind
+          when 'Parse'
+            parse_error(subkind, msg: msg, details: details)
+          when 'Runtime'
+            runtime_error(subkind, msg: msg, details: details)
+          when 'Operational'
+            operational_error(subkind, msg: msg, details: details)
+          when 'Parameter'
+            api_error(subkind, msg: msg, details: details)
+          end
+        end
+
+        # Map FFI parse errors into Ruby exceptions.
+        #
+        # @param kind [String]
+        # @param msg [String]
+        # @param details [Hash<String, Object>]
+        # @return [::Oso::Polar::ParseError] the object converted into the expected format.
+        private_class_method def self.parse_error(kind, msg:, details:) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+          case kind
+          when 'ExtraToken'
+            ::Oso::Polar::ParseError::ExtraToken.new(msg, details: details)
+          when 'IntegerOverflow'
+            ::Oso::Polar::ParseError::IntegerOverflow.new(msg, details: details)
+          when 'InvalidToken'
+            ::Oso::Polar::ParseError::InvalidToken.new(msg, details: details)
+          when 'InvalidTokenCharacter'
+            ::Oso::Polar::ParseError::InvalidTokenCharacter.new(msg, details: details)
+          when 'UnrecognizedEOF'
+            ::Oso::Polar::ParseError::UnrecognizedEOF.new(msg, details: details)
+          when 'UnrecognizedToken'
+            ::Oso::Polar::ParseError::UnrecognizedToken.new(msg, details: details)
+          else
+            ::Oso::Polar::ParseError.new(msg, details: details)
+          end
+        end
+
+        # Map FFI runtime errors into Ruby exceptions.
+        #
+        # @param kind [String]
+        # @param msg [String]
+        # @param details [Hash<String, Object>]
+        # @return [::Oso::Polar::PolarRuntimeError] the object converted into the expected format.
+        private_class_method def self.runtime_error(kind, msg:, details:) # rubocop:disable Metrics/MethodLength
+          case kind
+          when 'Serialization'
+            ::Oso::Polar::SerializationError.new(msg, details: details)
+          when 'Unsupported'
+            ::Oso::Polar::UnsupportedError.new(msg, details: details)
+          when 'TypeError'
+            ::Oso::Polar::PolarTypeError.new(msg, details: details)
+          when 'StackOverflow'
+            ::Oso::Polar::StackOverflowError.new(msg, details: details)
+          else
+            ::Oso::Polar::PolarRuntimeError.new(msg, details: details)
+          end
+        end
+
+        # Map FFI operational errors into Ruby exceptions.
+        #
+        # @param kind [String]
+        # @param msg [String]
+        # @param details [Hash<String, Object>]
+        # @return [::Oso::Polar::OperationalError] the object converted into the expected format.
+        private_class_method def self.operational_error(kind, msg:, details:)
+          case kind
+          when 'Unknown' # Rust panics.
+            ::Oso::Polar::UnknownError.new(msg, details: details)
+          else
+            ::Oso::Polar::OperationalError.new(msg, details: details)
+          end
+        end
+
+        # Map FFI API errors into Ruby exceptions.
+        #
+        # @param kind [String]
+        # @param msg [String]
+        # @param details [Hash<String, Object>]
+        # @return [::Oso::Polar::ApiError] the object converted into the expected format.
+        private_class_method def self.api_error(kind, msg:, details:)
+          case kind
+          when 'Parameter'
+            ::Oso::Polar::ParameterError.new(msg, details: details)
+          else
+            ::Oso::Polar::ApiError.new(msg, details: details)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oso/polar/ffi/polar.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Oso
+  module Polar
+    module FFI
+      # Wrapper class for Polar FFI pointer + operations.
+      class Polar < ::FFI::AutoPointer
+        Rust = Module.new do
+          extend ::FFI::Library
+          ffi_lib FFI::LIB_PATH
+
+          attach_function :new, :polar_new, [], FFI::Polar
+          attach_function :load_str, :polar_load, [FFI::Polar, :string, :string], :int32
+          attach_function :next_inline_query, :polar_next_inline_query, [FFI::Polar], FFI::Query
+          attach_function :new_id, :polar_get_external_id, [FFI::Polar], :uint64
+          attach_function :new_query_from_str, :polar_new_query, [FFI::Polar, :string], FFI::Query
+          attach_function :new_query_from_term, :polar_new_query_from_term, [FFI::Polar, :string], FFI::Query
+          attach_function :new_query_from_repl, :polar_query_from_repl, [FFI::Polar], FFI::Query
+          attach_function :register_constant, :polar_register_constant, [FFI::Polar, :string, :string], :int32
+          attach_function :free, :polar_free, [FFI::Polar], :int32
+        end
+        private_constant :Rust
+
+        # @return [FFI::Polar]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def self.create
+          polar = Rust.new
+          raise FFI::Error.get if polar.null?
+
+          polar
+        end
+
+        # @param src [String]
+        # @param filename [String]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def load_str(src, filename: nil)
+          raise FFI::Error.get if Rust.load_str(self, src, filename).zero?
+        end
+
+        # @return [FFI::Query] if there are remaining inline queries.
+        # @return [nil] if there are no remaining inline queries.
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def next_inline_query
+          query = Rust.next_inline_query(self)
+          query.null? ? nil : query
+        end
+
+        # @return [Integer]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def new_id
+          id = Rust.new_id(self)
+          # TODO(gj): I don't think this error check is correct. If getting a new ID fails on the
+          # Rust side, it'll probably surface as a panic (e.g., the KB lock is poisoned).
+          raise FFI::Error.get if id.zero?
+
+          id
+        end
+
+        # @param str [String] Query string.
+        # @return [FFI::Query]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def new_query_from_str(str)
+          query = Rust.new_query_from_str(self, str)
+          raise FFI::Error.get if query.null?
+
+          query
+        end
+
+        # @param term [Hash<String, Object>]
+        # @return [FFI::Query]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def new_query_from_term(term)
+          query = Rust.new_query_from_term(self, JSON.dump(term))
+          raise FFI::Error.get if query.null?
+
+          query
+        end
+
+        # @return [FFI::Query]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def new_query_from_repl
+          query = Rust.new_query_from_repl(self)
+          raise FFI::Error.get if query.null?
+
+          query
+        end
+
+        # @param name [String]
+        # @param value [Hash<String, Object>]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def register_constant(name, value:)
+          raise FFI::Error.get if Rust.register_constant(self, name, JSON.dump(value)).zero?
+        end
+      end
+    end
+  end
+end

data/lib/oso/polar/ffi/query.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Oso
+  module Polar
+    module FFI
+      # Wrapper class for Query FFI pointer + operations.
+      class Query < ::FFI::AutoPointer
+        Rust = Module.new do
+          extend ::FFI::Library
+          ffi_lib FFI::LIB_PATH
+
+          attach_function :debug_command, :polar_debug_command, [FFI::Query, :string], :int32
+          attach_function :call_result, :polar_call_result, [FFI::Query, :uint64, :string], :int32
+          attach_function :question_result, :polar_question_result, [FFI::Query, :uint64, :int32], :int32
+          attach_function :next_event, :polar_next_query_event, [FFI::Query], FFI::QueryEvent
+          attach_function :free, :query_free, [FFI::Query], :int32
+        end
+        private_constant :Rust
+
+        # @param cmd [String]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def debug_command(cmd)
+          res = Rust.debug_command(self, cmd)
+          raise FFI::Error.get if res.zero?
+        end
+
+        # @param result [String]
+        # @param call_id [Integer]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def call_result(result, call_id:)
+          res = Rust.call_result(self, call_id, result)
+          raise FFI::Error.get if res.zero?
+        end
+
+        # @param result [Boolean]
+        # @param call_id [Integer]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def question_result(result, call_id:)
+          result = result ? 1 : 0
+          res = Rust.question_result(self, call_id, result)
+          raise FFI::Error.get if res.zero?
+        end
+
+        # @return [::Oso::Polar::QueryEvent]
+        # @raise [FFI::Error] if the FFI call returns an error.
+        def next_event
+          event = Rust.next_event(self)
+          raise FFI::Error.get if event.null?
+
+          ::Oso::Polar::QueryEvent.new(JSON.parse(event.to_s))
+        end
+      end
+    end
+  end
+end

data/lib/oso/polar/ffi/query_event.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Oso
+  module Polar
+    module FFI
+      # Wrapper class for QueryEvent FFI pointer + operations.
+      class QueryEvent < ::FFI::AutoPointer
+        # @return [String]
+        def to_s
+          @to_s ||= read_string.force_encoding('UTF-8')
+        end
+
+        Rust = Module.new do
+          extend ::FFI::Library
+          ffi_lib FFI::LIB_PATH
+
+          attach_function :free, :string_free, [FFI::QueryEvent], :int32
+        end
+        private_constant :Rust
+      end
+    end
+  end
+end

data/lib/oso/polar/polar.rb

@@ -0,0 +1,381 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'set'
+
+module Oso
+  module Polar
+    # Create and manage an instance of the Polar runtime.
+    class Polar # rubocop:disable Metrics/ClassLength
+      def initialize
+        @ffi_instance = FFI::Polar.create
+        @calls = {}
+        @classes = {}
+        @constructors = {}
+        @instances = {}
+        @load_queue = Set.new
+      end
+
+      # Enqueue a Polar policy file for loading into the KB.
+      #
+      # @param name [String]
+      # @raise [PolarFileExtensionError] if provided filename has invalid extension.
+      # @raise [PolarFileNotFoundError] if provided filename does not exist.
+      def load_file(name)
+        raise PolarFileExtensionError unless ['.pol', '.polar'].include? File.extname(name)
+        raise PolarFileNotFoundError, name unless File.file?(name)
+
+        load_queue << name
+      end
+
+      # Load a Polar string into the KB.
+      #
+      # @param str [String] Polar string to load.
+      # @param filename [String] Name of Polar source file.
+      # @raise [NullByteInPolarFileError] if str includes a non-terminating null byte.
+      # @raise [InlineQueryFailedError] on the first failed inline query.
+      # @raise [Error] if any of the FFI calls raise one.
+      def load_str(str, filename: nil) # rubocop:disable Metrics/MethodLength
+        raise NullByteInPolarFileError if str.chomp("\0").include?("\0")
+
+        ffi_instance.load_str(str, filename: filename)
+        loop do
+          next_query = ffi_instance.next_inline_query
+          break if next_query.nil?
+
+          begin
+            Query.new(next_query, polar: self).results.next
+          rescue StopIteration
+            raise InlineQueryFailedError
+          end
+        end
+      end
+
+      # Replace the current Polar instance but retain all registered classes and
+      # constructors.
+      def clear
+        @ffi_instance = FFI::Polar.create
+      end
+
+      # Query for a predicate.
+      #
+      # @param name [String]
+      # @param args [Array<Object>]
+      # @raise [Error] if the FFI call raises one.
+      def query_pred(name, args:)
+        clear_query_state
+        load_queued_files
+        pred = Predicate.new(name, args: args)
+        query_ffi_instance = ffi_instance.new_query_from_term(to_polar_term(pred))
+        Query.new(query_ffi_instance, polar: self).results
+      end
+
+      # Start a REPL session.
+      #
+      # @raise [Error] if the FFI call raises one.
+      def repl # rubocop:disable Metrics/MethodLength
+        clear_query_state
+        load_queued_files
+        loop do
+          query = Query.new(ffi_instance.new_query_from_repl, polar: self)
+          results = query.results.to_a
+          if results.empty?
+            puts 'False'
+          else
+            results.each do |result|
+              puts result
+            end
+          end
+        end
+      end
+
+      # Get a unique ID from Polar.
+      #
+      # @return [Integer]
+      # @raise [Error] if the FFI call raises one.
+      def new_id
+        ffi_instance.new_id
+      end
+
+      # Register a Ruby class with Polar.
+      #
+      # @param cls [Class]
+      # @param name [String]
+      # @param from_polar [Proc]
+      # @raise [InvalidConstructorError] if provided an invalid 'from_polar' constructor.
+      def register_class(cls, name: nil, from_polar: nil) # rubocop:disable Naming/MethodParameterName
+        # TODO(gj): should this take 3 args: cls (Class), constructor_cls
+        # (Option<Class>) that defaults to cls, and constructor_method
+        # (Option<Symbol>) that defaults to :new?
+        name = cls.name if name.nil?
+        raise DuplicateClassAliasError, name: name, old: get_class(name), new: cls if classes.key? name
+
+        classes[name] = cls
+        if from_polar.nil?
+          constructors[name] = :new
+        elsif from_polar.respond_to? :call
+          constructors[name] = from_polar
+        else
+          raise InvalidConstructorError
+        end
+
+        register_constant(name, value: cls)
+      end
+
+      def register_constant(name, value:)
+        ffi_instance.register_constant(name, value: to_polar_term(value))
+      end
+
+      # Register a Ruby method call, wrapping the call result in a generator if
+      # it isn't already one.
+      #
+      # @param method [#to_sym]
+      # @param call_id [Integer]
+      # @param instance [Hash]
+      # @param args [Array<Hash>]
+      # @raise [InvalidCallError] if the method doesn't exist on the instance or
+      #   the args passed to the method are invalid.
+      def register_call(method, call_id:, instance:, args:)
+        return if calls.key?(call_id)
+
+        args = args.map { |a| to_ruby(a) }
+        if instance["value"].has_key? "ExternalInstance"
+          instance_id = instance["value"]["ExternalInstance"]["instance_id"]
+          instance = get_instance(instance_id)
+        else
+          instance = to_ruby(instance)
+        end
+        result = instance.__send__(method, *args)
+        result = [result].to_enum unless result.is_a? Enumerator # Call must be a generator.
+        calls[call_id] = result.lazy
+      rescue ArgumentError, NoMethodError
+        raise InvalidCallError
+      end
+
+      # Retrieve the next result from a registered call and pass it to {#to_polar_term}.
+      #
+      # @param id [Integer]
+      # @return [Hash]
+      # @raise [StopIteration] if the call has been exhausted.
+      def next_call_result(id)
+        to_polar_term(calls[id].next)
+      end
+
+      # Construct and cache a Ruby instance.
+      #
+      # @param cls_name [String]
+      # @param fields [Hash<String, Hash>]
+      # @param id [Integer]
+      # @raise [PolarRuntimeError] if instance construction fails.
+      def make_instance(cls_name, fields:, id:) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        constructor = get_constructor(cls_name)
+        fields = Hash[fields.map { |k, v| [k.to_sym, to_ruby(v)] }]
+        instance = if constructor == :new
+                     if fields.empty?
+                       get_class(cls_name).__send__(:new)
+                     else
+                       get_class(cls_name).__send__(:new, **fields)
+                     end
+                   elsif fields.empty?
+                     constructor.call
+                   else
+                     constructor.call(**fields)
+                   end
+        cache_instance(instance, id: id)
+      rescue StandardError => e
+        raise PolarRuntimeError, "Error constructing instance of #{cls_name}: #{e}"
+      end
+
+      # Check if an instance has been cached.
+      #
+      # @param id [Integer]
+      # @return [Boolean]
+      def instance?(id)
+        instances.key? id
+      end
+
+      # Fetch a Ruby instance from the {#instances} cache.
+      #
+      # @param id [Integer]
+      # @return [Object]
+      # @raise [UnregisteredInstanceError] if the ID has not been registered.
+      def get_instance(id)
+        raise UnregisteredInstanceError, id unless instance? id
+
+        instances[id]
+      end
+
+      # Check if the left class is more specific than the right class for the
+      # given instance.
+      #
+      # @param instance_id [Integer]
+      # @param left_tag [String]
+      # @param right_tag [String]
+      # @return [Boolean]
+      def subspecializer?(instance_id, left_tag:, right_tag:)
+        mro = get_instance(instance_id).class.ancestors
+        mro.index(get_class(left_tag)) < mro.index(get_class(right_tag))
+      rescue StandardError
+        false
+      end
+
+      # Check if instance is an instance of class.
+      #
+      # @param instance_id [Integer]
+      # @param class_tag [String]
+      # @return [Boolean]
+      def isa?(instance_id, class_tag:)
+        instance = get_instance(instance_id)
+        cls = get_class(class_tag)
+        instance.is_a? cls
+      rescue PolarRuntimeError
+        false
+      end
+
+      # Check if two instances unify
+      #
+      # @param left_instance_id [Integer]
+      # @param right_instance_id [Integer]
+      # @return [Boolean]
+      def unify?(left_instance_id, right_instance_id)
+        left_instance = get_instance(left_instance_id)
+        right_instance = get_instance(right_instance_id)
+        left_instance == right_instance
+      rescue PolarRuntimeError
+        false
+      end
+
+      # Turn a Ruby value into a Polar term that's ready to be sent across the
+      # FFI boundary.
+      #
+      # @param value [Object]
+      # @return [Hash<String, Object>]
+      def to_polar_term(value) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        value = case true # rubocop:disable Lint/LiteralAsCondition
+                when value.instance_of?(TrueClass) || value.instance_of?(FalseClass)
+                  { 'Boolean' => value }
+                when value.instance_of?(Integer)
+                  { 'Number' => { 'Integer' => value } }
+                when value.instance_of?(Float)
+                  { 'Number' => { 'Float' => value } }
+                when value.instance_of?(String)
+                  { 'String' => value }
+                when value.instance_of?(Array)
+                  { 'List' => value.map { |el| to_polar_term(el) } }
+                when value.instance_of?(Hash)
+                  { 'Dictionary' => { 'fields' => value.transform_values { |v| to_polar_term(v) } } }
+                when value.instance_of?(Predicate)
+                  { 'Call' => { 'name' => value.name, 'args' => value.args.map { |el| to_polar_term(el) } } }
+                when value.instance_of?(Variable)
+                  # This is supported so that we can query for unbound variables
+                  { 'Variable' => value }
+                else
+                  { 'ExternalInstance' => { 'instance_id' => cache_instance(value) } }
+                end
+        { 'value' => value }
+      end
+
+      # Turn a Polar term passed across the FFI boundary into a Ruby value.
+      #
+      # @param data [Hash<String, Object>]
+      # @option data [Integer] :id
+      # @option data [Integer] :offset Character offset of the term in its source string.
+      # @option data [Hash<String, Object>] :value
+      # @return [Object]
+      # @raise [UnexpectedPolarTypeError] if type cannot be converted to Ruby.
+      def to_ruby(data) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        tag, value = data['value'].first
+        case tag
+        when 'String', 'Boolean'
+          value
+        when 'Number'
+          value.values.first
+        when 'List'
+          value.map { |el| to_ruby(el) }
+        when 'Dictionary'
+          value['fields'].transform_values { |v| to_ruby(v) }
+        when 'ExternalInstance'
+          get_instance(value['instance_id'])
+        when 'Call'
+          Predicate.new(value['name'], args: value['args'].map { |a| to_ruby(a) })
+        else
+          raise UnexpectedPolarTypeError, tag
+        end
+      end
+
+      # Load all queued files, flushing the {#load_queue}.
+      def load_queued_files
+        load_queue.reject! do |filename|
+          File.open(filename) { |file| load_str(file.read, filename: filename) }
+          true
+        end
+      end
+
+      private
+
+      # @return [Hash<Integer, Enumerator>]
+      attr_reader :calls
+      # @return [Hash<String, Class>]
+      attr_reader :classes
+      # @return [Hash<String, Object>]
+      attr_reader :constructors
+      # @return [FFI::Polar]
+      attr_reader :ffi_instance
+      # @return [Hash<Integer, Object>]
+      attr_reader :instances
+      # @return [Array<String>]
+      attr_reader :load_queue
+
+      # Clear the instance and call caches.
+      def clear_query_state
+        calls.clear
+        instances.clear
+      end
+
+      # Query for a Polar string.
+      #
+      # @param str [String]
+      # @return [Enumerator]
+      def query_str(str)
+        clear_query_state
+        load_queued_files
+        query_ffi_instance = ffi_instance.new_query_from_str(str)
+        Query.new(query_ffi_instance, polar: self).results
+      end
+
+      # Cache a Ruby instance, fetching a {#new_id} if one isn't provided.
+      #
+      # @param instance [Object]
+      # @param id [Integer]
+      # @return [Integer]
+      def cache_instance(instance, id: nil)
+        id = new_id if id.nil?
+        instances[id] = instance
+        id
+      end
+
+      # Fetch a Ruby class from the {#classes} cache.
+      #
+      # @param name [String]
+      # @return [Class]
+      # @raise [UnregisteredClassError] if the class has not been registered.
+      def get_class(name)
+        raise UnregisteredClassError, name unless classes.key? name
+
+        classes[name]
+      end
+
+      # Fetch a constructor from the {#constructors} cache.
+      #
+      # @param name [String]
+      # @return [Symbol] if constructor is the default of `:new`.
+      # @return [Proc] if a custom constructor was registered.
+      # @raise [UnregisteredConstructorError] if the constructor has not been registered.
+      def get_constructor(name)
+        raise MissingConstructorError, name unless constructors.key? name
+
+        constructors[name]
+      end
+    end
+  end
+end