smart_injection 0.0.0 → 0.1.0

data/lib/smart_core/injection/injector/container_set.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Injection::Injector::ContainerSet
+  require_relative 'container_set/adding_listener'
+
+  # @since 0.1.0
+  include Enumerable
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize
+    @containers = [] # NOTE: we use Array cuz we need an ordered set
+    @adding_listeners = []
+    @access_lock = SmartCore::Engine::Lock.new
+  end
+
+  # @param container [SmartCore::Container]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def add(container)
+    thread_safe { append_container(container) }
+  end
+  alias_method :<<, :add
+
+  # @param listener [Block]
+  # @yield [container]
+  # @yieldparam container [SmartCore::Container]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def listen_addings(&listener)
+    thread_safe { add_adding_listener(listener) }
+  end
+
+  # @param block [Block]
+  # @yield [container]
+  # @yieldparam container [SmartCore::Container]
+  # @return [Enumerator]
+  #
+  # @api private
+  # @since 0.1.0
+  def each(&block)
+    thread_safe { block_given? ? containers.each(&block) : containers.each }
+  end
+
+  # @param block [Block]
+  # @yield [container]
+  # @yieldparam container [SmartCore::Container]
+  # @return [Enumerator]
+  #
+  # @api private
+  # @since 0.1.0
+  def reverse_each(&block)
+    thread_safe { block_given? ? containers.reverse_each(&block) : containers.reverse_each }
+  end
+
+  # @return [Array<SmartCore::Container>]
+  #
+  # @api private
+  # @since 0.1.0
+  def list
+    thread_safe { containers.dup }
+  end
+
+  private
+
+  # @return [Array<SmartCore::Container>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :containers
+
+  # @return [Array<SmartCore::Injection::Injector::ContainerSet::AddingListener>]
+  attr_reader :adding_listeners
+
+  # @param listener [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def add_adding_listener(listener)
+    adding_listeners << SmartCore::Injection::Injector::ContainerSet::AddingListener.new(listener)
+  end
+
+  # @param container [SmartCore::Container]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def append_container(container)
+    # NOTE:
+    #   - #concant is used to prevent container duplications in ordered set;
+    #   - @containers should have an ordered unified container list;
+    containers.concat([container])
+    adding_listeners.each { |listener| listener.notify(container) }
+  end
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def thread_safe(&block)
+    @access_lock.synchronize(&block)
+  end
+end

data/lib/smart_core/injection/injector/container_set/adding_listener.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Injection::Injector::ContainerSet::AddingListener
+  # @param listener [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(listener)
+    @listener = listener
+  end
+
+  # @param cotnainer [SmartCore::Container]
+  #
+  # @api private
+  # @since 0.1.0
+  def notify(container)
+    listener.call(container)
+  end
+
+  private
+
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :listener
+end

data/lib/smart_core/injection/injector/injection_settings.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Injection::Injector::InjectionSettings
+  require_relative 'injection_settings/incompatability_control'
+
+  # @return [Hash<String|Symbol,String>]
+  #
+  # @api private
+  # @since 0.1.0
+  DEFAULT_IMPORTS = {}.freeze
+
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.1.0
+  DEFAULT_ACCESS = :public
+
+  # @return [Array<Symbol>]
+  #
+  # @api private
+  # @since 0.1.0
+  ACCESS_MARKS = %i[public protected private].freeze
+
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.1.0
+  DEFAULT_BINDING_STRATEGY = :dynamic
+
+  # @return [Array<Symbol>]
+  #
+  # @api private
+  # @since 0.1.0
+  BINDING_STRATEGIES = %i[static dynamic].freeze
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.1.0
+  DEFAULT_MEMOIZE = false
+
+  # @return [NilClass]
+  #
+  # @api private
+  # @since 0.1.0
+  EMPTY_CONTAINER_DESTINATION = nil
+
+  # @return [Hash<String|Symbol,String>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :imports
+
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :access
+
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :bind
+
+  # @return [NilClass, <SmartCore::Container>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :from
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :memoize
+
+  # @return [SmartCore::Injection::Injector::ContainerSet]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :container_set
+
+  # @return [Class, Module]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :injectable
+
+  # @param injectable [Class, Module]
+  # @param container_set [SmartCore::Injection::Injector::ContainerSet]
+  # @param import [Hash<String|Symbol,String>]
+  # @option memoize [Boolean]
+  # @option access [Symbol]
+  # @option bind [Symbol]
+  # @option from [NilClass, SmartCore::Container]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(
+    injectable,
+    container_set,
+    imports,
+    memoize: DEFAULT_MEMOIZE,
+    access: DEFAULT_ACCESS,
+    bind: DEFAULT_BINDING_STRATEGY,
+    from: EMPTY_CONTAINER_DESTINATION
+  )
+    IncompatabilityControl.prevent_incompatabilities!(
+      injectable,
+      imports,
+      memoize,
+      access,
+      bind,
+      from
+    )
+
+    @injectable = injectable
+    @container_set = container_set
+    @imports = imports
+    @memoize = memoize
+    @access = access
+    @bind = bind
+    @from = from
+  end
+
+  # @return [Class, Module]
+  #
+  # @api private
+  # @since 0.1.0
+  def instance_level_injectable
+    injectable
+  end
+
+  # @return [Class]
+  #
+  # @api private
+  # @since 0.1.0
+  def class_level_injectable
+    class << injectable; self; end
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.1.0
+  def bind_dynamic?
+    bind == :dynamic
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.1.0
+  def bind_static?
+    bind == :static
+  end
+
+  # @param block [Block]
+  # @yield [import_key, import_path]
+  # @yieldparam import_key [String, Symbol]
+  # @yieldparam import_path [String]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.1.0
+  def each_import(&block)
+    block_given? ? imports.each_pair(&block) : imports.each_pair
+  end
+end

data/lib/smart_core/injection/injector/injection_settings/incompatability_control.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module SmartCore::Injection::Injector::InjectionSettings::IncompatabilityControl
+  class << self
+    # @param injectable [Class, Module]
+    # @param imports [Hash<String|Symbol,String>]
+    # @param memoize [Boolean]
+    # @param access [Symbol]
+    # @param bind [Symbol]
+    # @param from [NilClass, SmartCore::Container]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def prevent_incompatabilities!(injectable, imports, memoize, access, bind, from)
+      prevent_injectable_incompatabilities!(injectable)
+      prevent_imports_incompatabilites!(imports)
+      prevent_memoize_incompatabilites(memoize)
+      prevent_access_incompatabilites(access)
+      prevent_bind_incompatabilites(bind)
+      prevent_from_incompatabilites(from)
+    end
+
+    private
+
+    # @param injectable [Class, Module]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def prevent_injectable_incompatabilities!(injectable)
+      unless injectable.is_a?(Class) || injectable.is_a?(Module)
+        raise(SmartCore::Injection::ArgumentError, <<~ERROR_MESSAGE)
+        ERROR_MESSAGE
+      end
+    end
+
+    # @param imports [Hash<String|Symbol,String>]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def prevent_imports_incompatabilites!(imports)
+      unless imports.is_a?(::Hash)
+        raise(SmartCore::Injection::ArgumentError, <<~ERROR_MESSAGE)
+          Incorrect import list (should be a type of Hash)
+        ERROR_MESSAGE
+      end
+
+      unless imports.keys.all? { |key| key.is_a?(String) || key.is_a?(Symbol) }
+        raise(SmartCore::Injection::ArgumentError, <<~ERROR_MESSAGE)
+          Some method aliases are incorret (they should be a type of String or Symbol)
+        ERROR_MESSAGE
+      end
+
+      unless imports.values.all? { |value| value.is_a?(String) }
+        raise(SmartCore::Injection::ArgumentError, <<~ERROR_MESSAGE)
+          Some injection pathes are incorrect (they should be a type of String)
+        ERROR_MESSAGE
+      end
+    end
+
+    # @param memoize [Boolean]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def prevent_memoize_incompatabilites(memoize)
+      unless memoize.is_a?(::TrueClass) || memoize.is_a?(::FalseClass)
+        raise(SmartCore::Injection::ArgumentError, <<~ERROR_MESSAGE)
+        ERROR_MESSAGE
+      end
+    end
+
+    # @param access [Symbol]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def prevent_access_incompatabilites(access)
+      unless SmartCore::Injection::Injector::InjectionSettings::ACCESS_MARKS.include?(access)
+        raise(SmartCore::Injection::ArgumentError, <<~ERROR_MESSAGE)
+        ERROR_MESSAGE
+      end
+    end
+
+    # @param bind [Symbol]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def prevent_bind_incompatabilites(bind)
+      unless SmartCore::Injection::Injector::InjectionSettings::BINDING_STRATEGIES.include?(bind)
+        raise(SmartCore::Injection::ArgumentError, <<~ERROR_MESSAGE)
+        ERROR_MESSAGE
+      end
+    end
+
+    # @param from [NilClass, SmartCore::Container]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def prevent_from_incompatabilites(from)
+      unless from.is_a?(NilClass) || from.is_a?(SmartCore::Container)
+        raise(SmartCore::Injection::ArgumentError, <<~ERROR_MESSAGE)
+        ERROR_MESSAGE
+      end
+    end
+  end
+end

data/lib/smart_core/injection/injector/modulizer.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module SmartCore::Injection::Injector::Modulizer
+  class << self
+    # @param containers [Array<SmartCore::Container>]
+    # @return [Module]
+    #
+    # @api private
+    # @since 0.1.0
+    def with_containers(containers)
+      prevent_inconsistency!(containers)
+      build_container_injectable_module(containers)
+    end
+
+    # @param base_klass [Class, Module]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def inject_to(base_klass)
+      base_klass.include(::SmartCore::Injection::DSL)
+    end
+
+    private
+
+    # @param containers [Array<SmartCore::Container>]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def prevent_inconsistency!(containers)
+      unless containers.is_a?(Array) && containers.all? { |cont| cont.is_a?(SmartCore::Container) }
+        raise(SmartCore::Injection::ArgumentError, <<~ERROR_MESSAGE)
+          Injectable containers should be a type of SmartCore::Container
+        ERROR_MESSAGE
+      end
+    end
+
+    # @param containers [Array<SmartCore::Container>]
+    # @return [Module]
+    #
+    # @api private
+    # @since 0.1.0
+    def build_container_injectable_module(containers)
+      Module.new do
+        define_singleton_method :included do |base_klass|
+          base_klass.include(::SmartCore::Injection::DSL)
+          base_klass.register_container(*containers)
+        end
+      end
+    end
+  end
+end