smart_initializer 0.1.0.alpha2 → 0.3.0

data/lib/smart_core/initializer/type_system.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.1.0
+module SmartCore::Initializer::TypeSystem
+  require_relative 'type_system/interop'
+  require_relative 'type_system/registry'
+  require_relative 'type_system/smart_types'
+  require_relative 'type_system/registry_interface'
+
+  # @since 0.1.0
+  extend SmartCore::Initializer::TypeSystem::RegistryInterface
+
+  # @since 0.1.0
+  register(:smart_types, SmartCore::Initializer::TypeSystem::SmartTypes)
+end

data/lib/smart_core/initializer/type_system/interop.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# @abstract
+# @api private
+# @since 0.1.0
+class SmartCore::Initializer::TypeSystem::Interop
+  require_relative 'interop/operation'
+  require_relative 'interop/abstract_factory'
+  require_relative 'interop/aliasing'
+
+  # @since 0.1.0
+  include SmartCore::Initializer::TypeSystem::Interop::Aliasing
+
+  class << self
+    # @param type_object [Any]
+    # @return [SmartCore::Initializer::TypeSystem::Interop]
+    #
+    # @api private
+    # @since 0.1.0
+    def create(type_object)
+      self::AbstractFactory.create(type_object)
+    end
+
+    # @return [SmartCore::Initialiezr::TypeSystem::Interop]
+    #
+    # @api private
+    # @since 0.1.0
+    def generic_type_object
+      self::AbstractFactory.generic_type_object
+    end
+
+    # @param type_object [Any]
+    # @return [void]
+    #
+    # @raise [SmartCore::Initializer::IncorrectTypeObjectError]
+    #
+    # @api private
+    # @since 0.1.0
+    def prevent_incompatible_type!(type_object)
+      self::AbstractFactory.prevent_incompatible_type!(type_object)
+    end
+  end
+
+  # @param valid_op [SmartCore::Initializer::TypeSystem::Interop::Operation]
+  # @param validate_op [SmartCore::Initializer::TypeSystem::Interop::Operation]
+  # @param cast_op [SmartCore::Initializer::TypeSystem::Interop::Operation]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(valid_op, validate_op, cast_op)
+    @valid_op = valid_op
+    @validate_op = validate_op
+    @cast_op = cast_op
+  end
+
+  # @param value [Any]
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.1.0
+  def valid?(value)
+    valid_op.call(value)
+  end
+
+  # @param value [Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def validate!(value)
+    validate_op.call(value)
+  end
+
+  # @param value [Any]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def cast(value)
+    cast_op.call(value)
+  end
+
+  private
+
+  # @return [SmartCore::Initializer::TypeSystem::Interop::Operation]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :valid_op
+
+  # @return [SmartCore::Initializer::TypeSystem::Interop::Operation]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :validate_op
+
+  # @return [SmartCore::Initializer::TypeSystem::Interop::Operation]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :cast_op
+end

data/lib/smart_core/initializer/type_system/interop/abstract_factory.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# @abstract
+# @api private
+# @since 0.1.0
+class SmartCore::Initializer::TypeSystem::Interop::AbstractFactory
+  class << self
+    # @param type [Any]
+    # @return [SmartCore::Initializer::TypeSystem::Interop]
+    #
+    # @api private
+    # @since 0.1.0
+    def create(type)
+      prevent_incompatible_type!(type)
+
+      valid_op = build_valid_operation(type)
+      validate_op = build_validate_operation(type)
+      cast_op = build_cast_operation(type)
+
+      build_interop(valid_op, validate_op, cast_op)
+    end
+
+    # @return [Any]
+    #
+    # @api private
+    # @since 0.1.0
+    def generic_type_object; end
+
+    # @param type [Any]
+    # @return [void]
+    #
+    # @raise [SmartCore::Initializer::IncorrectTypeObjectError]
+    #
+    # @api private
+    # @since 0.1.0
+    def prevent_incompatible_type!(type); end
+
+    private
+
+    # @param type [Any]
+    # @return [SmartCore::Initializer::TypeSystem::Interop::Operation]
+    #
+    # @api private
+    # @since 0.1.0
+    def build_valid_operation(type); end
+
+    # @param type [Any]
+    # @return [SmartCore::Initializer::TypeSystem::Interop::Operation]
+    #
+    # @api private
+    # @since 0.1.0
+    def build_validate_operation(type); end
+
+    # @param type [Any]
+    # @return [SmartCore::Initializer::TypeSystem::Interop::Operation]
+    #
+    # @api private
+    # @since 0.1.0
+    def build_cast_operation(type); end
+
+    # @param valid_op [SmartCore::Initializer::TypeSystem::Interop::Operation]
+    # @param validate_op [SmartCore::Initializer::TypeSystem::Interop::Operation]
+    # @param cast_op [SmartCore::Initializer::TypeSystem::Interop::Operation]
+    # @return [SmartCore::Initializer::TypeSystem::Interop]
+    #
+    # @api private
+    # @since 0.1.0
+    def build_interop(valid_op, validate_op, cast_op); end
+  end
+end

data/lib/smart_core/initializer/type_system/interop/aliasing.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module SmartCore::Initializer::TypeSystem::Interop::Aliasing
+  require_relative 'aliasing/alias_list'
+
+  class << self
+    # @param base_klass [Class]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def included(base_klass)
+      base_klass.extend(ClassMethods)
+      base_klass.singleton_class.prepend(ClassInheritance)
+    end
+  end
+
+  # @api private
+  # @since 0.1.0
+  module ClassInheritance
+    # @param child_klass [Class<SmartCore::Initializer::TypeSystem::Interop>]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def inherited(child_klass)
+      child_klass.instance_variable_set(:@__type_aliases__, AliasList.new(child_klass))
+      super
+    end
+  end
+
+  # @api private
+  # @since 0.1.0
+  module ClassMethods
+    # @return [SmartCore::Initializer::TypeSystem::Interop::Aliasing::AliasList]
+    #
+    # @api private
+    # @since 0.1.0
+    def __type_aliases__
+      @__type_aliases__
+    end
+
+    # @return [Array<String>]
+    #
+    # @api public
+    # @since 0.1.0
+    def type_aliases
+      __type_aliases__.keys
+    end
+
+    # @param alias_name [String, Symbol]
+    # @param type [Any]
+    # @return [void]
+    #
+    # @api public
+    # @since 0.1.0
+    def type_alias(alias_name, type)
+      __type_aliases__.associate(alias_name, type)
+    end
+
+    # @param alias_name [String, Symbol]
+    # @return [Any]
+    #
+    # @api public
+    # @since 0.1.0
+    def type_from_alias(alias_name)
+      __type_aliases__.resolve(alias_name)
+    end
+  end
+end

data/lib/smart_core/initializer/type_system/interop/aliasing/alias_list.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Initializer::TypeSystem::Interop::Aliasing::AliasList
+  # @param interop_klass [Class<SmartCore::Initializer::TypeSystem::Interop>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(interop_klass)
+    @interop_klass = interop_klass
+    @list = {}
+    @lock = SmartCore::Engine::Lock.new
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.1.0
+  def keys
+    thread_safe { registered_aliases }
+  end
+
+  # @return [Hash<String,Any>]
+  #
+  # @api private
+  # @since 0.1.0
+  def to_h
+    thread_safe { transform_to_hash }
+  end
+  alias_method :to_hash, :to_h
+
+  # @param alias_name [String, Symbol]
+  # @param type [Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def associate(alias_name, type)
+    interop_klass.prevent_incompatible_type!(type)
+    thread_safe { set_alias(alias_name, type) }
+  end
+
+  # @param alias_name [String, Symbol]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def resolve(alias_name)
+    thread_safe { get_alias(alias_name) }
+  end
+
+  private
+
+  # @return [Hash<String,Any>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :list
+
+  # @return [Class<SmartCore::Initializer::TypeSystem::Interop>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :interop_klass
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def thread_safe(&block)
+    @lock.synchronize(&block)
+  end
+
+  # @param alias_name [String, Symbol]
+  # @param type [Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def set_alias(alias_name, type)
+    alias_name = normalized_alias(alias_name)
+
+    if list.key?(alias_name)
+      ::Warning.warn(
+        "[#{interop_klass.name}] Shadowing of the already existing \"#{alias_name}\" type alias."
+      )
+    end
+
+    list[alias_name] = type
+  end
+
+  # @param alias_name [String, Symbol]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def get_alias(alias_name)
+    alias_name = normalized_alias(alias_name)
+
+    begin
+      list.fetch(alias_name)
+    rescue ::KeyError
+      raise(SmartCore::Initializer::TypeAliasNotFoundError, <<~ERROR_MESSAGE)
+        Alias with name "#{alias_name}" not found.
+      ERROR_MESSAGE
+    end
+  end
+
+  # @param alias_name [String, Symbol]
+  # @return [String]
+  #
+  # @api private
+  # @since 0.1.0
+  def normalized_alias(alias_name)
+    raise(
+      SmartCore::Initializer::ArgumentError,
+      'Type alias should be a type of string or symbol'
+    ) unless alias_name.is_a?(String) || alias_name.is_a?(Symbol)
+
+    alias_name.to_s
+  end
+
+  # @return [Hash<String,Any>]
+  #
+  # @api private
+  # @since 0.1.0
+  def transform_to_hash
+    list.to_h
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.1.0
+  def registered_aliases
+    list.keys
+  end
+end

data/lib/smart_core/initializer/type_system/interop/operation.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# @abstract
+# @api private
+# @since 0.1.0
+class SmartCore::Initializer::TypeSystem::Interop::Operation
+  # @param type [Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(type)
+    @type = type
+  end
+
+  # @param value [Any]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def call(value); end
+
+  private
+
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :type
+end

data/lib/smart_core/initializer/type_system/registry.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Initializer::TypeSystem::Registry
+  # @since 0.1.0
+  include Enumerable
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize
+    @systems = {}
+    @lock = SmartCore::Engine::Lock.new
+  end
+
+  # @param system_identifier [String, Symbol]
+  # @param interop_klass [Class<SmartCore::Initializer::TypeSystem::Interop>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def register(system_identifier, interop_klass)
+    thread_safe { apply(system_identifier, interop_klass) }
+  end
+
+  # @param system_identifier [String, Symbol]
+  # @return [Class<SmartCore::Initializer::TypeSystem::Interop>]
+  #
+  # @api private
+  # @since 0.1.0
+  def resolve(system_identifier)
+    thread_safe { fetch(system_identifier) }
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.1.0
+  def names
+    thread_safe { system_names }
+  end
+
+  # @return [Array<Class<SmartCore::Initializer::TypeSystem::Interop>>]
+  #
+  # @api private
+  # @since 0.1.0
+  def interops
+    thread_safe { system_interops }
+  end
+
+  # @param block [Block]
+  # @yield [system_name, system_interop]
+  #   @yieldparam system_name [String]
+  #   @yieldparam system_interop [Class<SmartCore::Initializer::TypeSystem::Interop>]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.1.0
+  def each(&block)
+    thread_safe { iterate(&block) }
+  end
+
+  # @return [Hash<String,Class<SmartCore::Initializer::TypeSystem::Interop>]
+  #
+  # @api private
+  # @since 0.1.0
+  def to_h
+    thread_safe { systems.dup }
+  end
+  alias_method :to_hash, :to_h
+
+  private
+
+  # @return [Hash<String,Class<SmartCore::Initializer::TypeSystem::Interop>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :systems
+
+  # @return [Array<String>]
+  #
+  # @pai private
+  # @since 0.1.0
+  def system_names
+    systems.keys
+  end
+
+  # @return [Array<Class<SmartCore::Initializer::TypeSystem::Interop>>]
+  #
+  # @api private
+  # @since 0.1.0
+  def system_interops
+    systems.values
+  end
+
+  # @param block [Block]
+  # @yield [system_name, system_interop]
+  #   @yieldparam system_name [String]
+  #   @yieldparam system_interop [Class<SmartCore::Initializer::TypeSystem::Interop>]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.1.0
+  def iterate(&block)
+    block_given? ? systems.each_pair(&block) : systems.each_pair
+  end
+
+  # @param system_identifier [String, Symbol]
+  # @param interop_klass [Class<SmartCore::Initializer::TypeSystem::Interop>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def apply(system_identifier, interop_klass)
+    prevent_incorrect_system_interop!(interop_klass)
+    identifier = indifferently_accessible_identifier(system_identifier)
+    systems[identifier] = interop_klass
+  end
+
+  # @param system_identifier [String, Symbol]
+  # @return [Class<SmartCore::Initializer::TypeSystem::Interop>]
+  #
+  # @raise [SmartCore::Initializer::UnsupportedTypeSystemError]
+  #
+  # @api private
+  # @since 0.1.0
+  def fetch(system_identifier)
+    identifier = indifferently_accessible_identifier(system_identifier)
+
+    begin
+      systems.fetch(identifier)
+    rescue ::KeyError
+      raise(SmartCore::Initializer::UnsupportedTypeSystemError, <<~ERROR_MESSAGE)
+        "#{identifier}" type system is not supported.
+      ERROR_MESSAGE
+    end
+  end
+
+  # @param interop_klass [Class<SMartCore::Initializer::TypeSystem::Interop>]
+  # @return [void]
+  #
+  # @raise [SmartCore::Initializer::IncorrectTypeSystemInteropError]
+  #
+  # @api private
+  # @since 0.1.0
+  def prevent_incorrect_system_interop!(interop_klass)
+    unless interop_klass.is_a?(Class) && interop_klass < SmartCore::Initializer::TypeSystem::Interop
+      raise(
+        SmartCore::Initializer::IncorrectTypeSystemInteropError,
+        'Incorrect type system interop class.'
+      )
+    end
+  end
+
+  # @param system_identifier [String, Symbol]
+  # @return [String]
+  #
+  # @api private
+  # @since 0.1.0
+  def indifferently_accessible_identifier(system_identifier)
+    system_identifier.to_s.clone.tap(&:freeze)
+  end
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def thread_safe(&block)
+    @lock.synchronize(&block)
+  end
+end