smart_container 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6670714cdeb503df6debb42135ee26283aef48a012fcf2469487668390a675f3
-  data.tar.gz: ba0ad291f05bdebb5d5af7fc46554c30c0748753243e04ac6277abf74886acb6
+  metadata.gz: fbae5c2d40dc40e3114d685c1f13d6cbfb7003a1c8fda862ef5dbcfa432cf5cd
+  data.tar.gz: dd288fa47167c0da4e2aae656478170d0dd78b142eef52a351c461ddbc92bf29
 SHA512:
-  metadata.gz: 29b1566aaff6a6227ed13a03a0b65110ce319c4b08bccc50b8c346793cb258174ee611fa19e3950e339049ab50b5819fc31ae6164b2e6d715c8a51d72a29a44f
-  data.tar.gz: cd38836e86ef48c860e58e55af5a30b8f3babdb7724658f96dee7a42ee953a122667688b29bdbb50aeccb94fc4026c1dc17d922524f21a32b20ab67ad7f3ca58
+  metadata.gz: 27129a91c84f8aad432c5462c2d3a921284b2b8e3b1fb4b0a215295f6f88d94063946cc24f2d065f6da9ba6e64baf421f2a192b68fa63ebda879a81715e2c88f
+  data.tar.gz: 5e6839adcfe1e3c31513b622fc3e46aab37ab3ec35a992c8a3b9c7ff029c976dbf331619d3df20da7ffe3d712a8839f04ac83f3055f9e2426869e9b9ecf556f6

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.8.1] - 2020-07-09
+### Changed
+- *Core*
+  - refactored `SmartCore::Container::Entities::NamespaceBuilder` and `SmartCore::Container::Entities::DependencyBuilder`
+    (from stateful-based logic on instances to stateless-based logic on modules);
+
+### Fixed
+- Subscription to the nested dependency changement doesn't work
+  (incomplete nested dependency path in watcher notification);
+
 ## [0.8.0] - 2020-07-08
 ### Added
 - An ability to observe dependency re-registrations:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_container (0.8.0)
+    smart_container (0.8.1)
       smart_engine (~> 0.5)
 
 GEM

data/README.md

@@ -35,7 +35,7 @@ require 'smart_core/container'
   - [reloading](#reloading)
   - [hash tree](#hash-tree)
   - [explicit class definition](#explicit-class-definition)
-  - [dependency changement observing](#dependency-changement-observing)
+  - [subscribe to dependency changements](#subscribe-to-dependency-changements)
 - [Roadmap](#roadmap)
 
 ---
@@ -257,7 +257,7 @@ AppContainer['db_driver'] # => Sequel (AppContainer dependency)
 
 ---
 
-#### dependency changement observing
+#### subscribe to dependency changements
 
 - features and limitations:
   - you can subscribe only on container instances (on container instance changements);
@@ -292,13 +292,13 @@ end
 ```
 
 ```ruby
-container.register('database.stats') { 'kek' } # => invokes entity_observer and outputs "changed! => 'kek'"
+container.fetch('database').register('stats') = 'kek' # => invokes entity_observer and outputs "changed! => 'kek'"
 container.namespace('database') {} # => invoks namespace_observer and outputs "changed => 'database'"
 
 container.unobserve(observer) # unsubscribe entity_observer from dependency changement observing;
 container.clear_observers # unsubscribe all observers
 
-container.register('database.stats') { 'kek' } # no one to listen this changement... :)
+container.fetch('database').register('stats') = 'pek' # no one to listen this changement... :)
 container.namespace('database') {} # no one to listen this changement... :)
 ```
 
@@ -306,6 +306,17 @@ container.namespace('database') {} # no one to listen this changement... :)
 
 ## Roadmap
 
+- convinient way to rebind registered dependnecies:
+
+```ruby
+# PoC
+
+container['dependency.path'] = 'pek' # simplest instant dependency registration without memoization
+# --- or/and ---
+container.rebind('dependency.path', memoize: true/false) { 'pek' } # bind with dynamic dependency registration
+container.rebind('dependency.path', memoize: true/false, 'pek') # bind with instant dependency registration
+```
+
 - pattern-based pathes in dependency changement observing;
 
 ```ruby

data/lib/smart_core/container.rb

@@ -19,6 +19,7 @@ module SmartCore
     require_relative 'container/registry_builder'
     require_relative 'container/dependency_resolver'
     require_relative 'container/dependency_watcher'
+    require_relative 'container/host'
     require_relative 'container/mixin'
 
     class << self
@@ -45,18 +46,48 @@ module SmartCore
     # @since 0.1.0
     include DefinitionDSL
 
+    # @return [NilClass]
+    #
+    # @api private
+    # @since 0.8.1
+    NO_HOST_CONTAINER = nil
+
+    # @return [NilClass]
+    #
+    # @api private
+    # @since 0.8.1
+    NO_HOST_PATH = nil
+
     # @return [SmartCore::Container::Registry]
     #
     # @api private
     # @since 0.1.0
     attr_reader :registry
 
+    # @return [SmartCore::Container::Host]
+    #
+    # @api private
+    # @since 0.8.1
+    attr_reader :host
+
+    # @return [SmartCore::Container::DependencyWatcher]
+    #
+    # @api private
+    # @since 0.8.0
+    attr_reader :watcher
+
+    # @option host_container [SmartCore::Container, NilClass]
+    # @option host_path [String, NilClass]
     # @return [void]
     #
     # @api public
     # @since 0.1.0
-    def initialize
+    # @version 0.8.1
+    def initialize(host_container: NO_HOST_CONTAINER, host_path: NO_HOST_PATH)
+      @host = SmartCore::Container::Host.build(host_container, host_path)
       build_registry!
+      @watcher = SmartCore::Container::DependencyWatcher.new(self)
+      @host_path = host_path
       @access_lock = ArbitraryLock.new
     end
 
@@ -87,7 +118,7 @@ module SmartCore
     # @version 0.8.0
     def namespace(namespace_name, &dependencies_definition)
       thread_safe do
-        registry.register_namespace(namespace_name, &dependencies_definition)
+        registry.register_namespace(namespace_name, self, &dependencies_definition)
         watcher.notify(namespace_name)
       end
     end
@@ -238,20 +269,13 @@ module SmartCore
 
     private
 
-    # @return [SmartCore::Container::DependencyWatcher]
-    #
-    # @api private
-    # @since 0.8.0
-    attr_reader :watcher
-
     # @return [void]
     #
     # @api private
     # @since 0.1.0
-    # @version 0.8.0
+    # @version 0.8.1
     def build_registry!
       @registry = RegistryBuilder.build(self)
-      @watcher = SmartCore::Container::DependencyWatcher.new(self)
     end
 
     # @param block [Block]

data/lib/smart_core/container/dependency_resolver.rb

@@ -22,8 +22,9 @@ module SmartCore::Container::DependencyResolver
     #
     # @api private
     # @since 0.1.0
+    # @version 0.8.1
     def fetch(container, dependency_path)
-      container.registry.resolve(dependency_path).reveal
+      container.registry.resolve(dependency_path).reveal(container)
     end
 
     # @param container [SmartCore::Container]
@@ -86,12 +87,16 @@ module SmartCore::Container::DependencyResolver
     #
     # @api private
     # @since 0.1.0
+    # @version 0.8.1
     def resolve(container, dependency_path)
       entity = container
+      host_container = container
+
       Route.build(dependency_path).each do |cursor|
         entity = entity.registry.resolve(cursor.current_path)
         prevent_ambiguous_resolving!(cursor, entity)
-        entity = entity.reveal
+        entity = entity.reveal(host_container)
+        host_container = entity.is_a?(SmartCore::Container) ? entity : nil
       end
       entity
     rescue SmartCore::Container::ResolvingError => error
@@ -106,14 +111,17 @@ module SmartCore::Container::DependencyResolver
     #
     # @api private
     # @since 0.5.0
+    # @version 0.8.1
     def extract(container, entity_path)
       resolved_entity = container
       extracted_entity = container
+      host_container = container
 
       Route.build(entity_path).each do |cursor|
         resolved_entity = resolved_entity.registry.resolve(cursor.current_path)
         extracted_entity = resolved_entity
-        resolved_entity = resolved_entity.reveal
+        resolved_entity = resolved_entity.reveal(host_container)
+        host_container = resolved_entity.is_a?(SmartCore::Container) ? resolved_entity : nil
       end
 
       extracted_entity

data/lib/smart_core/container/dependency_watcher.rb

@@ -12,7 +12,7 @@ class SmartCore::Container::DependencyWatcher
   # @since 0.8.0
   def initialize(container)
     @container = container
-    @observers = Hash.new { |k, v| k[v] = [] }
+    @observers = Hash.new { |h, k| h[k] = [] }
     @access_lock = SmartCore::Container::ArbitraryLock.new
   end
 
@@ -72,9 +72,11 @@ class SmartCore::Container::DependencyWatcher
   #
   # @api private
   # @since 0.8.0
+  # @version 0.8.1
   def notify_listeners(entity_path)
     entity_path = indifferently_accessable_path(entity_path)
     observers.fetch(entity_path).each(&:notify!) if observers.key?(entity_path)
+    container.host.notify_about_nested_changement(entity_path)
   end
 
   # @param entity_path [String, Symbol]

data/lib/smart_core/container/entities/dependency.rb

@@ -20,11 +20,13 @@ class SmartCore::Container::Entities::Dependency < SmartCore::Container::Entitie
     @dependency_definition = dependency_definition
   end
 
+  # @param host_container [SmartCore::Container, NilClass]
   # @return [Any]
   #
   # @api private
   # @since 0.1.0
-  def reveal
+  # @version 0.8.1
+  def reveal(host_container = SmartCore::Container::NO_HOST_CONTAINER)
     dependency_definition.call
   end
 

data/lib/smart_core/container/entities/dependency_builder.rb

@@ -2,7 +2,8 @@
 
 # @api private
 # @since 0.1.0
-class SmartCore::Container::Entities::DependencyBuilder
+# @version 0.8.1
+module SmartCore::Container::Entities::DependencyBuilder
   class << self
     # @param dependency_name [String]
     # @param dependency_definition [Proc]
@@ -11,68 +12,35 @@ class SmartCore::Container::Entities::DependencyBuilder
     #
     # @api private
     # @since 0.1.0
-    # @version 0.2.0
+    # @version 0.8.1
     def build(dependency_name, dependency_definition, memoize)
-      new(dependency_name, dependency_definition, memoize).build
+      if memoize
+        build_memoized_dependency(dependency_name, dependency_definition)
+      else
+        build_original_dependency(dependency_name, dependency_definition)
+      end
     end
-  end
-
-  # @param dependency_name [String]
-  # @param dependency_definition [Proc]
-  # @param memoize [Boolean]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.2.0
-  def initialize(dependency_name, dependency_definition, memoize)
-    @dependency_name = dependency_name
-    @dependency_definition = dependency_definition
-    @memoize = memoize
-  end
-
-  # @return [SmartCore::Container::Entities::Dependency]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.2.0
-  def build
-    memoize ? build_memoized_dependency : build_original_dependency
-  end
-
-  private
 
-  # @return [String]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :dependency_name
+    private
 
-  # @return [Proc]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :dependency_definition
-
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.2.0
-  attr_reader :memoize
-
-  # @return [SmartCore::Container::Entities::Dependency]
-  #
-  # @api private
-  # @since 0.2.0
-  def build_memoized_dependency
-    SmartCore::Container::Entities::MemoizedDependency.new(dependency_name, dependency_definition)
-  end
+    # @param dependency_name [String]
+    # @param dependency_definition [Proc]
+    # @return [SmartCore::Container::Entities::Dependency]
+    #
+    # @api private
+    # @since 0.8.1
+    def build_memoized_dependency(dependency_name, dependency_definition)
+      SmartCore::Container::Entities::MemoizedDependency.new(dependency_name, dependency_definition)
+    end
 
-  # @return [SmartCore::Container::Entities::Dependency]
-  #
-  # @api private
-  # @since 0.2.0
-  def build_original_dependency
-    SmartCore::Container::Entities::Dependency.new(dependency_name, dependency_definition)
+    # @param dependency_name [String]
+    # @param dependency_definition [Proc]
+    # @return [SmartCore::Container::Entities::Dependency]
+    #
+    # @api private
+    # @since 0.8.1
+    def build_original_dependency(dependency_name, dependency_definition)
+      SmartCore::Container::Entities::Dependency.new(dependency_name, dependency_definition)
+    end
   end
 end

data/lib/smart_core/container/entities/memoized_dependency.rb

@@ -15,11 +15,13 @@ module SmartCore::Container::Entities
       @lock = SmartCore::Container::ArbitraryLock.new
     end
 
+    # @param host_container [SmartCore::Container, NilClass]
     # @return [Any]
     #
     # @api private
     # @since 0.2.0
-    def reveal
+    # @version 0.8.1
+    def reveal(host_container = SmartCore::Container::NO_HOST_CONTAINER)
       @lock.thread_safe do
         unless instance_variable_defined?(:@revealed_dependency)
           @revealed_dependency = dependency_definition.call

data/lib/smart_core/container/entities/namespace.rb

@@ -9,24 +9,35 @@ class SmartCore::Container::Entities::Namespace < SmartCore::Container::Entities
   # @since 0.1.0
   alias_method :namespace_name, :external_name
 
+  # @return [NilClass, SmartCore::Container]
+  #
+  # @api private
+  # @since 0.8.01
+  attr_reader :host_container
+
   # @param namespace_name [String]
+  # @param host_container [NilClass, SmartCore::Container]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def initialize(namespace_name)
+  # @version 0.8.1
+  def initialize(namespace_name, host_container = SmartCore::Container::NO_HOST_CONTAINER)
     super(namespace_name)
     @container_klass = Class.new(SmartCore::Container)
     @container_instance = nil
+    @host_container = host_container
     @lock = SmartCore::Container::ArbitraryLock.new
   end
 
+  # @param runtime_host_container [SmartCore::Container, NilClass]
   # @return [SmartCore::Container]
   #
   # @api private
   # @since 0.1.0
-  def reveal
-    thread_safe { container_instance }
+  # @version 0.8.1
+  def reveal(runtime_host_container = SmartCore::Container::NO_HOST_CONTAINER)
+    thread_safe { container_instance(runtime_host_container) }
   end
 
   # @param dependencies_definition [Proc]
@@ -54,12 +65,18 @@ class SmartCore::Container::Entities::Namespace < SmartCore::Container::Entities
   # @since 0.1.0
   attr_reader :container_klass
 
+  # @param runtime_host_container [SmartCore::Container, NilClass]
   # @return [SmartCore::Container]
   #
   # @api private
   # @since 0.1.0
-  def container_instance
-    @container_instance ||= container_klass.new
+  # @version 0.8.1
+  def container_instance(runtime_host_container = SmartCore::Container::NO_HOST_CONTAINER)
+    @host_container ||= runtime_host_container
+    @container_instance ||= container_klass.new(
+      host_container: @host_container,
+      host_path: @host_container && namespace_name
+    )
   end
 
   # @param block [Block]

data/lib/smart_core/container/entities/namespace_builder.rb

@@ -2,40 +2,20 @@
 
 # @api private
 # @since 0.1.0
-class SmartCore::Container::Entities::NamespaceBuilder
-  class << self
-    # @param namespace_name [String]
-    # @return [SmartCore::Container::Entities::Namespace]
-    #
-    # @api private
-    # @since 0.1.0
-    def build(namespace_name)
-      new(namespace_name).build
+# @version 0.8.1
+module SmartCore::Container::Entities
+  module NamespaceBuilder
+    class << self
+      # @param namespace_name [String]
+      # @param host_container [SmartContainer, NilClass]
+      # @return [SmartCore::Container::Entities::Namespace]
+      #
+      # @api private
+      # @since 0.1.0
+      # @version 0.8.1
+      def build(namespace_name, host_container = SmartCore::Container::NO_HOST_CONTAINER)
+        SmartCore::Container::Entities::Namespace.new(namespace_name, host_container)
+      end
     end
   end
-
-  # @param namespace_name [String]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  def initialize(namespace_name)
-    @namespace_name = namespace_name
-  end
-
-  # @return [SmartCore::Container::Entities::Namespace]
-  #
-  # @api private
-  # @since 0.1.0
-  def build
-    SmartCore::Container::Entities::Namespace.new(namespace_name)
-  end
-
-  private
-
-  # @return [String]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :namespace_name
 end

data/lib/smart_core/container/host.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.8.1
+class SmartCore::Container::Host
+  class << self
+    # @param container [SmartCore::Container]
+    # @param path [String]
+    # @return [SmartCore::Container::Host]
+    #
+    # @api private
+    # @since 0.8.1
+    def build(container, path) # rubocop:disable Metrics/AbcSize
+      if (container.nil? && !path.nil?) || (!container.nil? && path.nil?)
+        raise(SmartCore::Container::ArgumentError, <<~ERROR_MESSAGE)
+          Host container requires both host container instance and host container path
+          (container: #{container.inspect} / path: #{path.inspect})
+        ERROR_MESSAGE
+      end
+
+      if (!container.nil? && !path.nil?) &&
+         (!container.is_a?(SmartCore::Container) || !path.is_a?(String))
+        raise(SmartCore::Container::ArgumentError, <<~ERROR_MESSAGE)
+          Host container should be a type of SmartCore::Container
+          and host path should be a type of String.
+        ERROR_MESSAGE
+      end
+
+      new(container, path)
+    end
+  end
+
+  # @return [SmartCore::Container]
+  #
+  # @api private
+  # @since 0.8.1
+  attr_reader :container
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.8.1
+  attr_reader :path
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.8.1
+  attr_reader :exists
+  alias_method :exists?, :exists
+  alias_method :present?, :exists
+
+  # @param container [SmartCore::Container]
+  # @param path [String]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.8.1
+  def initialize(container, path)
+    @container = container
+    @path = path
+    @exists = !!container
+  end
+
+  # @param nested_entity_path [String]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.8.1
+  def notify_about_nested_changement(nested_entity_path)
+    return unless exists?
+    host_path = "#{path}" \
+                "#{SmartCore::Container::DependencyResolver::PATH_PART_SEPARATOR}" \
+                "#{nested_entity_path}"
+    container.watcher.notify(host_path)
+  end
+end

data/lib/smart_core/container/registry.rb

@@ -62,13 +62,19 @@ class SmartCore::Container::Registry
   end
 
   # @param name [String, Symbol]
+  # @param host_container [NilClasss, SmartCore::Container]
   # @param dependencies_definition [Block]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def register_namespace(name, &dependencies_definition)
-    thread_safe { add_namespace(name, dependencies_definition) }
+  # @version 0.8.1
+  def register_namespace(
+    name,
+    host_container = SmartCore::Container::NO_HOST_CONTAINER,
+    &dependencies_definition
+  )
+    thread_safe { add_namespace(name, host_container, dependencies_definition) }
   end
 
   # @return [void]
@@ -223,6 +229,7 @@ class SmartCore::Container::Registry
   end
 
   # @param namespace_name [String, Symbol]
+  # @param host_container [NilClass, SmartCore::Container]
   # @param dependencies_definition [Proc]
   # @return [SmartCore::Container::Entities::Namespace]
   #
@@ -230,11 +237,13 @@ class SmartCore::Container::Registry
   #
   # @api private
   # @since 0.1.0
-  def add_namespace(namespace_name, dependencies_definition)
+  # @version 0.8.1
+  def add_namespace(namespace_name, host_container, dependencies_definition)
     if state_frozen?
       raise(SmartCore::Container::FrozenRegistryError, 'Can not modify frozen registry!')
     end
     namespace_name = indifferently_accessable_name(namespace_name)
+    dependencies_definition ||= proc {}
     prevent_dependency_overlap!(namespace_name)
 
     # rubocop:disable Layout/RescueEnsureAlignment
@@ -242,7 +251,7 @@ class SmartCore::Container::Registry
       fetch_entity(namespace_name)
     rescue SmartCore::Container::FetchError
       registry[namespace_name] = SmartCore::Container::Entities::NamespaceBuilder.build(
-        namespace_name
+        namespace_name, host_container
       )
     end
     # rubocop:enable Layout/RescueEnsureAlignment

data/lib/smart_core/container/version.rb

@@ -4,7 +4,7 @@ module SmartCore
   class Container
     # @api public
     # @since 0.1.0
-    # @version 0.8.0
-    VERSION = '0.8.0'
+    # @version 0.8.1
+    VERSION = '0.8.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_container
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_engine
@@ -159,6 +159,7 @@ files:
 - lib/smart_core/container/entities/namespace.rb
 - lib/smart_core/container/entities/namespace_builder.rb
 - lib/smart_core/container/errors.rb
+- lib/smart_core/container/host.rb
 - lib/smart_core/container/key_guard.rb
 - lib/smart_core/container/mixin.rb
 - lib/smart_core/container/registry.rb