smart_initializer 0.1.0.alpha2 → 0.3.0

data/lib/smart_core/initializer/dsl/inheritance.rb

@@ -13,6 +13,7 @@ module SmartCore::Initializer::DSL::Inheritance
     def inherit(base:, child:)
       child.__params__.concat(base.__params__)
       child.__options__.concat(base.__options__)
+      child.__init_extensions__.concat(base.__init_extensions__)
     end
   end
 end

data/lib/smart_core/initializer/errors.rb

@@ -32,4 +32,48 @@ module SmartCore::Initializer
   # @api public
   # @since 0.1.0
   NoTypeAliasError = Class.new(Error)
+
+  # @api public
+  # @since 0.1.0
+  PluginError = Class.new(Error)
+
+  # @api public
+  # @since 0.1.0
+  UnresolvedPluginDependencyError = Class.new(PluginError)
+
+  # @api public
+  # @since 0.1.0
+  AlreadyRegisteredPluginError = Class.new(PluginError)
+
+  # @api public
+  # @since 0.1.0
+  UnregisteredPluginError = Class.new(PluginError)
+
+  # @api public
+  # @since 0.1.0
+  TypeSystemError = Class.new(Error)
+
+  # @api public
+  # @since 0.1.0
+  TypeAliasNotFoundError = Class.new(TypeSystemError)
+
+  # @api public
+  # @since 0.1.0
+  IncorrectTypeSystemInteropError = Class.new(TypeSystemError)
+
+  # @api public
+  # @since 0.1.0
+  IncorrectTypeObjectError = Class.new(TypeSystemError)
+
+  # @api public
+  # @since 0.1.0
+  UnsupportedTypeSystemError = Class.new(TypeSystemError)
+
+  # @api public
+  # @since 0.1.0
+  UnsupportedTypeOperationError = Class.new(TypeSystemError)
+
+  # @api public
+  # @since 0.1.0
+  TypeCastingUnsupportedError = Class.new(UnsupportedTypeOperationError)
 end

data/lib/smart_core/initializer/extensions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module SmartCore::Initializer::Extensions
+  require_relative 'extensions/abstract'
+  require_relative 'extensions/ext_init'
+  require_relative 'extensions/list'
+end

data/lib/smart_core/initializer/extensions/abstract.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Initializer::Extensions::Abstract
+  # @!method dup
+  #   @return [SmartCore::Initializer::Extensions::Abstract]
+end

data/lib/smart_core/initializer/extensions/ext_init.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Initializer::Extensions::ExtInit < SmartCore::Initializer::Extensions::Abstract
+  # @param extender [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(extender)
+    @extender = extender
+  end
+
+  # @param instance [Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def call(instance)
+    extender.call(instance)
+  end
+
+  private
+
+  # @return [Proc]
+  #
+  # @api private
+  # @since0 0.1.0
+  attr_reader :extender
+end

data/lib/smart_core/initializer/extensions/list.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Initializer::Extensions::List
+  # @since 0.1.0
+  include Enumerable
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize
+    @extensions = []
+    @lock = SmartCore::Engine::Lock.new
+  end
+
+  # @param extension [SmartCore::Initializer::Extensions::Abstract]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def add(extension)
+    thread_safe { extensions << extension }
+  end
+  alias_method :<<, :add
+
+  # @param list [SmartCore::Initializer::Extensions::List]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def concat(list)
+    thread_safe do
+      list.each { |extension| add(extension.dup) }
+    end
+  end
+
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.1.0
+  def each(&block)
+    thread_safe do
+      block_given? ? extensions.each(&block) : extensions.each
+    end
+  end
+
+  # @return [Integer]
+  #
+  # @api private
+  # @since 0.1.0
+  def size
+    thread_safe { extensions.size }
+  end
+
+  private
+
+  # @return [Array<SmartCore::Initializer::Extensions::Abstract>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :extensions
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def thread_safe(&block)
+    @lock.synchronize(&block)
+  end
+end

data/lib/smart_core/initializer/functionality.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.3.0
+module SmartCore::Initializer::Functionality
+  # @return [NilClass]
+  #
+  # @api private
+  # @since 0.3.0
+  INITIAL_TYPE_SYSTEM = nil
+
+  class << self
+    # @option type_system [String, Symbol, NilClass]
+    # @return [Module]
+    #
+    # @api private
+    # @since 0.3.0
+    def includable_module(type_system: INITIAL_TYPE_SYSTEM)
+      Module.new.tap do |extension|
+        extension.singleton_class.define_method(:included) do |base_klass|
+          base_klass.include(::SmartCore::Initializer)
+          base_klass.__initializer_settings__.type_system = type_system
+        end
+      end
+    end
+
+    # @param base_klass [Class]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def seed_to(base_klass)
+      base_klass.extend(SmartCore::Initializer::DSL)
+    end
+  end
+end

data/lib/smart_core/initializer/instance_attribute_accessing.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.3.0
+module SmartCore::Initializer::InstanceAttributeAccessing
+  # @return [Hash<Symbol,Any>]
+  #
+  # @api public
+  # @since 0.3.0
+  def __params__
+    __collect_params__
+  end
+
+  # @return [Hash<Symbol,Any>]
+  #
+  # @api public
+  # @since 0.3.0
+  def __options__
+    __collect_options__
+  end
+
+  # @return [Hash<Symbol,Any>]
+  #
+  # @api public
+  # @since 0.3.0
+  def __attributes__
+    __collect_params__.merge(__collect_options__)
+  end
+
+  private
+
+  # @return [Hash<Symbol,Any>]
+  #
+  # @api private
+  # @since 0.3.0
+  def __collect_params__
+    self.class.__params__.each_with_object({}) do |param, memo|
+      memo[param.name] = instance_variable_get("@#{param.name}")
+    end
+  end
+
+  # @return [Hash<Symbol,Any>]
+  #
+  # @api private
+  # @since 0.3.0
+  def __collect_options__
+    self.class.__options__.each_with_object({}) do |option, memo|
+      memo[option.name] = instance_variable_get("@#{option.name}")
+    end
+  end
+end

data/lib/smart_core/initializer/plugins.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module SmartCore::Initializer::Plugins
+  require_relative 'plugins/abstract'
+  require_relative 'plugins/registry'
+  require_relative 'plugins/registry_interface.rb'
+  require_relative 'plugins/access_mixin'
+  require_relative 'plugins/thy_types'
+
+  # @since 0.1.0
+  extend SmartCore::Initializer::Plugins::RegistryInterface
+
+  # @since 0.1.0
+  register_plugin('thy_types', SmartCore::Initializer::Plugins::ThyTypes)
+end

data/lib/smart_core/initializer/plugins/abstract.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Initializer::Plugins::Abstract
+  class << self
+    # @param child_klass [Class]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def inherited(child_klass)
+      child_klass.instance_variable_set(:@__loaded__, false)
+      child_klass.instance_variable_set(:@__lock__, Mutex.new)
+      super
+    end
+
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def load!
+      __thread_safe__ do
+        unless @__loaded__
+          @__loaded__ = true
+          install!
+        end
+      end
+    end
+
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.1.0
+    def loaded?
+      __thread_safe__ { @__loaded__ }
+    end
+
+    private
+
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def install!; end
+
+    # @return [Any]
+    #
+    # @api private
+    # @since 0.1.0
+    def __thread_safe__
+      @__lock__.synchronize { yield }
+    end
+  end
+end

data/lib/smart_core/initializer/plugins/access_mixin.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module SmartCore::Initializer::Plugins::AccessMixin
+  # @param plugin_name [Symbol, String]
+  # @return [void]
+  #
+  # @see SmartCore::Initializer::Plugins
+  #
+  # @api public
+  # @since 0.1.0
+  def plugin(plugin_name)
+    SmartCore::Initializer::Plugins.load(plugin_name)
+  end
+
+  # @return [Array<String>]
+  #
+  # @see SmartCore::Initializer::Plugins
+  #
+  # @api public
+  # @since 0.1.0
+  def plugins
+    SmartCore::Initializer::Plugins.names
+  end
+
+  # @return [Hash<String,Class<SmartCore::Initializer::Plugins::Abstract>>]
+  #
+  # @api private
+  # @since 0.1.0
+  def loaded_plugins
+    SmartCore::Initializer::Plugins.loaded_plugins
+  end
+  alias_method :enabled_plugins, :loaded_plugins
+
+  # @param plugin_name [String, Symbol]
+  # @param plugin_klass [Class<SmartCore::Initializer::Plugins::Abstract>]
+  # @return [void]
+  #
+  # @see SmartCore::Initializer::Plugins
+  #
+  # @api public
+  # @since 0.1.0
+  def register_plugin(plugin_name, plugin_klass)
+    SmartCore::Initializer::Plugins.register_plugin(plugin_name, plugin_klass)
+  end
+end

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

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Initializer::Plugins::Registry
+  # @since 0.1.0
+  include Enumerable
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize
+    @plugin_set = {}
+    @access_lock = Mutex.new
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [SmartCore::Initializer::Plugins::Abstract]
+  #
+  # @api private
+  # @since 0.1.0
+  def [](plugin_name)
+    thread_safe { fetch(plugin_name) }
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @param plugin_module [SmartCore::Initializer::Plugins::Abstract]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def register(plugin_name, plugin_module)
+    thread_safe { apply(plugin_name, plugin_module) }
+  end
+  alias_method :[]=, :register
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.1.0
+  def names
+    thread_safe { plugin_names }
+  end
+
+  # @return [Hash<String,Class<SmartCore::Initializer::Plugins::Abstract>>]
+  #
+  # @api private
+  # @since 0.1.0
+  def loaded
+    thread_safe { loaded_plugins }
+  end
+
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.1.0
+  def each(&block)
+    thread_safe { iterate(&block) }
+  end
+
+  private
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :plugin_set
+
+  # @return [Mutex]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :access_lock
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def thread_safe
+    access_lock.synchronize { yield if block_given? }
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.1.0
+  def plugin_names
+    plugin_set.keys
+  end
+
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.1.0
+  def iterate(&block)
+    block_given? ? plugin_set.each_pair(&block) : plugin_set.each_pair
+  end
+
+  # @param plugin_name [String]
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.1.0
+  def registered?(plugin_name)
+    plugin_set.key?(plugin_name)
+  end
+
+  # @return [Array<SmartCore::Initializer::Plugins::Abstract>]
+  #
+  # @api private
+  # @since 0.1.0
+  def loaded_plugins
+    plugin_set.select { |_plugin_name, plugin_module| plugin_module.loaded? }
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @param plugin_module [SmartCore::Initializer::Plugins::Abstract]
+  # @return [void]
+  #
+  # @raise [SmartCore::Initializer::AlreadyRegisteredPluginError]
+  #
+  # @api private
+  # @since 0.1.0
+  def apply(plugin_name, plugin_module)
+    plugin_name = indifferently_accessible_plugin_name(plugin_name)
+
+    if registered?(plugin_name)
+      raise(SmartCore::Initializer::AlreadyRegisteredPluginError, <<~ERROR_MESSAGE)
+        #{plugin_name} plugin already exists
+      ERROR_MESSAGE
+    end
+
+    plugin_set[plugin_name] = plugin_module
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [SmartCore::Initializer::Plugins::Abstract]
+  #
+  # @raise [SmartCore::Initializer::UnregisteredPluginError]
+  #
+  # @api private
+  # @since 0.1.0
+  def fetch(plugin_name)
+    plugin_name = indifferently_accessible_plugin_name(plugin_name)
+
+    unless registered?(plugin_name)
+      raise(SmartCore::Initializer::UnregisteredPluginError, <<~ERROR_MESSAGE)
+        #{plugin_name} plugin is not registered
+      ERROR_MESSAGE
+    end
+
+    plugin_set[plugin_name]
+  end
+
+  # @param key [Symbol, String]
+  # @return [String]
+  #
+  # @api private
+  # @since 0.1.0
+  def indifferently_accessible_plugin_name(plugin_name)
+    plugin_name.to_s
+  end
+end