smart_injection 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f48169147897c8ce8f66b9f89612932e7f4928dfbd841a71333952e36fa2d8e
-  data.tar.gz: d8516b07187415d826c6370f3b03c7200c3c8df59cc04cba455aa815beda0f1e
+  metadata.gz: a205772dafa117f100cd5c63816db14f1c2c39dc294dfc9d92abd77eec24f3b9
+  data.tar.gz: ba602f4127dcccb4579550a2884f84dc35623f3a9f9fef5cce4881c40b5bfe85
 SHA512:
-  metadata.gz: 6258aebce545dafba8aaef29d7f137f322e097c60d7003d2dfd3bdc8d111845493f52909918c71bc233abc54c5c5c3b55dd7fd4b83d753f238bdf6a92c8c3704
-  data.tar.gz: 3f27d11d72af45e20fd2fbf393765be6414a2bb5e91b9dff4a797c13870fd36752702cc03cb9fd7e13acbea3632b2712e967ddf6e6bab6ef22c24e52bd70fad3
+  metadata.gz: 34094f99543b3643f706f9fe21c0a9d5b9d30e47bbc1f06104a1a83f282149194cc97fe690c5f73bd4f2ba0fcbd1c7c66d48a528b34df2f0880d0b69b9017e30
+  data.tar.gz: 01dcae384d39e0ff46dc299bd55cfb94571b18462c924767d9b2ce8268c9d318d8352386909209c7d0e2387f9867c7fc3e7d70509a8529546605fad0c372046c

data/CHANGELOG.md

@@ -1,2 +1,6 @@
 # Changelog
 All notable changes to this project will be documented in this file.
+
+# [0.1.0] - 2020-07-09
+
+- Release :)

data/Gemfile.lock

@@ -1,34 +1,41 @@
 PATH
   remote: .
   specs:
-    smart_injection (0.0.0)
+    smart_injection (0.0.0.alpha2)
+      smart_container (~> 0.8, >= 0.8.1)
+      smart_engine (~> 0.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.1)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    armitage-rubocop (0.85.0)
-      rubocop (= 0.85.0)
+    armitage-rubocop (0.85.1)
+      rubocop (= 0.85.1)
       rubocop-performance (= 1.6.1)
-      rubocop-rails (= 2.5.2)
+      rubocop-rails (= 2.6.0)
       rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 1.39.0)
+      rubocop-rspec (= 1.40.0)
     ast (2.4.1)
+    coderay (1.1.3)
     concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     docile (1.3.2)
     i18n (1.8.3)
       concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
     minitest (5.14.1)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    rack (2.2.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (1.7.1)
@@ -46,7 +53,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.85.0)
+    rubocop (0.85.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
@@ -55,28 +62,31 @@ GEM
       rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
+    rubocop-ast (0.1.0)
       parser (>= 2.7.0.1)
     rubocop-performance (1.6.1)
       rubocop (>= 0.71.0)
-    rubocop-rails (2.5.2)
-      activesupport
+    rubocop-rails (2.6.0)
+      activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.72.0)
+      rubocop (>= 0.82.0)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (1.39.0)
+    rubocop-rspec (1.40.0)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)
+    smart_container (0.8.1)
+      smart_engine (~> 0.5)
+    smart_engine (0.7.0)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.3.1)
 
 PLATFORMS
   ruby
@@ -84,6 +94,7 @@ PLATFORMS
 DEPENDENCIES
   armitage-rubocop (~> 0.85)
   bundler (~> 2.1)
+  pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.9)
   simplecov (~> 0.18)

data/README.md

@@ -2,6 +2,26 @@
 
 Dependency injection principles and idioms realized in scope of Ruby.
 
+---
+
+## Major Features
+
+- `method-injection` strategy
+- `soon:` constructor injection strategy;
+- `soon:` property injection strategy;
+- realized as a mixin;
+- instance-method dependency injection;
+- class-method dependency injection;
+- multiple IoC-container registration;
+- static and dynamic bindings;
+- support for memoization with run-time dependency-switchable re-memoization;
+- an ability to import dependencies from the list of IoC-containers
+- an ability to import from the pre-configured default IoC-container(s);
+- an ability to import from any manually passed IoC-container;
+- privacy control of injected dependency (public/private/protected);
+
+---
+
 ## Installation
 
 ```ruby
@@ -20,6 +40,71 @@ require 'smart_core/injection'
 
 ---
 
+## Synopsis
+
+Create some containers:
+
+```ruby
+AppContainer = SmartCore::Container.define do
+  namespace(:data_storage) do
+    register(:main) { Sequel::Model.db }
+    register(:cache) { Redis.new }
+  end
+end
+
+ServiceContainer = SmartCore::Container.define do
+  namespace(:rands) do
+    register(:alphanum) { -> { SeureRandom.alphanumeric } }
+    register(:hex) { -> { SecureRandom.hex } }
+  end
+end
+
+GlobalContainer = SmartCore::Container.define do
+  namespace(:phone_clients) do
+    register(:nexmo) { Nexmo.new }
+    register(:twilio) { Twilio.new }
+  end
+end
+```
+
+And work with dependency injection:
+
+```ruby
+class MiniService
+  include SmartCore::Injection
+
+  register_container(AppContainer)
+  register_container(ServiceContainer)
+
+  # --- or ---
+  include SmartCore::Injection(AppContainer, ServiceContainer)
+
+  # --- or ---
+  include SmartCore::Injection
+  register_container(AppContainer, ServiceContainer)
+
+  # import dependencies to an instance
+  import({ db: 'data_storage.main' }, bind: :dynamic, access: :private)
+  import({ rnd: 'rands.alphanum' }, bind: :static, memoize: true)
+
+  # import dependencies to a class
+  import_static({ cache: 'data_storage.cache', hexer: 'rands.hex' }, bind: :static)
+
+  # import from a non-registered container
+  import({ phone_client: 'phone_clients.nexmo' }, from: GlobalContainer)
+
+  def call
+    db # => returns data_storage.main
+    rnd # => returns rands.alphanum
+    self.class.cache # => returns data_storage.cache
+    self.class.hexer # => returns rands.hexer
+    phone_client # => returns phone_clients.nexmo
+  end
+end
+```
+
+---
+
 ## Contributing
 
 - Fork it ( https://github.com/smart-rb/smart_injection )

data/lib/smart_core/injection.rb

@@ -1,11 +1,44 @@
 # frozen_string_literal: true
 
+require 'smart_core/container'
+require 'set'
+
 # @api public
 # @since 0.1.0
 module SmartCore
+  # TODO: обязательно учесть наследование
+
+  class << self
+    # @param containers [Array<SmartCore::Container>]
+    # @return [Module]
+    #
+    # @api public
+    # @since 0.1.0
+    # rubocop:disable Naming/MethodName
+    def Injection(*containers)
+      ::SmartCore::Injection::Injector::Modulizer.with_containers(containers)
+    end
+    # rubocop:enable Naming/MethodName
+  end
+
   # @api public
   # @since 0.1.0
   module Injection
     require_relative 'injection/version'
+    require_relative 'injection/errors'
+    require_relative 'injection/injector'
+    require_relative 'injection/locator'
+    require_relative 'injection/dsl'
+
+    class << self
+      # @param base_klass [Class, Module]
+      # @return [void]
+      #
+      # @api private
+      # @since 0.1.0
+      def included(base_klass)
+        ::SmartCore::Injection::Injector::Modulizer.inject_to(base_klass)
+      end
+    end
   end
 end

data/lib/smart_core/injection/dsl.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.1.0
+module SmartCore::Injection::DSL
+  class << self
+    # @param base_klass [Class, Module]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def included(base_klass)
+      base_klass.instance_variable_set(
+        :@__smart_injection_injector__,
+        SmartCore::Injection::Injector.new(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]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def inherited(child_klass)
+      child_klass.instance_variable_set(
+        :@__smart_injection_injector__,
+        __smart_injection_injector__.duplicate_for(child_klass)
+      )
+      child_klass.singleton_class.prepend(ClassInheritance)
+      super
+    end
+  end
+
+  # @api private
+  # @since 0.1.0
+  module ClassMethods
+    # @param imports [Hash<String|Symbol,String>]
+    # @option memoize [Boolean]
+    # @option access [Symbol]
+    # @option bind [Symbol]
+    # @option from [NilClass, SmartCore::Container]
+    # @return [void]
+    #
+    # @api public
+    # @sincd 0.1.0
+    def import(
+      imports,
+      memoize: SmartCore::Injection::Injector::InjectionSettings::DEFAULT_MEMOIZE,
+      access: SmartCore::Injection::Injector::InjectionSettings::DEFAULT_ACCESS,
+      bind: SmartCore::Injection::Injector::InjectionSettings::DEFAULT_BINDING_STRATEGY,
+      from: SmartCore::Injection::Injector::InjectionSettings::EMPTY_CONTAINER_DESTINATION
+    )
+      __smart_injection_injector__.inject(imports, memoize, access, bind, from)
+    end
+
+    # @param imports [Hash<String|Symbol,String>]
+    # @option memoize [Boolean]
+    # @option access [Symbol]
+    # @option bind [Symbol]
+    # @option from [NilClass, SmartCore::Container]
+    # @return [void]
+    #
+    # @api public
+    # @sincd 0.1.0
+    def import_static(
+      imports,
+      memoize: SmartCore::Injection::Injector::InjectionSettings::DEFAULT_MEMOIZE,
+      access: SmartCore::Injection::Injector::InjectionSettings::DEFAULT_ACCESS,
+      bind: SmartCore::Injection::Injector::InjectionSettings::DEFAULT_BINDING_STRATEGY,
+      from: SmartCore::Injection::Injector::InjectionSettings::EMPTY_CONTAINER_DESTINATION
+    )
+      __smart_injection_injector__.inject_static(imports, memoize, access, bind, from)
+    end
+
+    # @param containers [Array<SmartCore::Container>]
+    # @return [void]
+    #
+    # @api public
+    # @since 0.1.0
+    def register_container(*containers)
+      __smart_injection_injector__.register_container(*containers)
+    end
+
+    # @return [Array<SmartCore::Container>]
+    #
+    # @api public
+    # @since 0.1.0
+    def linked_containers
+      __smart_injection_injector__.associated_containers
+    end
+
+    # @return [SmartCore::Injection::Injector]
+    #
+    # @api private
+    # @since 0.1.0
+    def __smart_injection_injector__
+      @__smart_injection_injector__
+    end
+  end
+end

data/lib/smart_core/injection/errors.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SmartCore::Injection
+  # @api public
+  # @since 0.1.0
+  Error = Class.new(SmartCore::Error)
+
+  # @api public
+  # @since 0.1.0
+  ArgumentError = Class.new(SmartCore::ArgumentError)
+
+  # @api public
+  # @since 0.1.0
+  NoRegisteredContainersError = Class.new(Error)
+end

data/lib/smart_core/injection/injector.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Injection::Injector
+  require_relative 'injector/container_set'
+  require_relative 'injector/injection_settings'
+  require_relative 'injector/modulizer'
+  require_relative 'injector/strategies'
+
+  # @param injectable [Class, Module]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(injectable)
+    @injectable = injectable
+    @linked_containers = SmartCore::Injection::Injector::ContainerSet.new
+    @access_lock = SmartCore::Engine::Lock.new
+  end
+
+  # @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 inject(imports, memoize, access, bind, from)
+    thread_safe { inject_instance_method(imports, memoize, access, bind, from) }
+  end
+
+  # @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 inject_static(imports, memoize, access, bind, from)
+    thread_safe { inject_class_method(imports, memoize, access, bind, from) }
+  end
+
+  # @param containers [Array<SmartCore::Container>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def register_container(*containers)
+    thread_safe { link_container(containers) }
+  end
+
+  # @return [Array<SmartCore::Container>]
+  #
+  # @api private
+  # @since 0.1.0
+  def associated_containers
+    thread_safe { linked_containers.list }
+  end
+
+  # @param another_injectable [Class, Module]
+  # @return [SmartCore::Injection::Injector]
+  #
+  # @api private
+  # @since 0.1.0
+  def duplicate_for(another_injectable)
+    thread_safe { create_duplicate(another_injectable) }
+  end
+
+  private
+
+  # @return [Class, Module]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :injectable
+
+  # @return [Array<SmartCore::Container>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :linked_containers
+
+  # @param another_injectable [Class, Module]
+  # @return [SmartCore::Injection::Injector]
+  #
+  # @api private
+  # @since 0.1.0
+  def create_duplicate(another_injectable)
+    self.class.new(another_injectable).tap do |duplicate|
+      linked_containers.each do |container|
+        duplicate.register_container(container)
+      end
+    end
+  end
+
+  # @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 inject_instance_method(imports, memoize, access, bind, from)
+    SmartCore::Injection::Injector::Strategies::MethodInjection.inject_instance_method(
+      SmartCore::Injection::Injector::InjectionSettings.new(
+        injectable,
+        linked_containers,
+        imports,
+        memoize: memoize,
+        access: access,
+        bind: bind,
+        from: from
+      )
+    )
+  end
+
+  # @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 inject_class_method(imports, memoize, access, bind, from)
+    SmartCore::Injection::Injector::Strategies::MethodInjection.inject_class_method(
+      SmartCore::Injection::Injector::InjectionSettings.new(
+        injectable,
+        linked_containers,
+        imports,
+        memoize: memoize,
+        access: access,
+        bind: bind,
+        from: from
+      )
+    )
+  end
+
+  # @param containers [Array<SmartCore::Container>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def link_container(containers)
+    containers.each do |container|
+      linked_containers.add(container)
+    end
+  end
+
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def thread_safe(&block)
+    @access_lock.synchronize(&block)
+  end
+end