smart_core 0.6.0 → 0.7.0

data/lib/smart_core/container/registry.rb

@@ -1,227 +1,250 @@
 # frozen_string_literal: true
 
-class SmartCore::Container
-  # @api private
-  # @since 0.5.0
-  class Registry
-    # @since 0.5.0
-    include Enumerable
-
-    # @return [void]
-    #
-    # @api private
-    # @since 0.5.0
-    def initialize
-      @access_lock = Mutex.new
-      @registry = {}
-    end
+# @api private
+# @since 0.7.0
+# rubocop:disable Metrics/ClassLength
+class SmartCore::Container::Registry
+  # @since 0.7.0
+  include Enumerable
+
+  # @return [Hash<Symbol,SmartCore::Container::Entity>]
+  #
+  # @api private
+  # @since 0.7.0
+  attr_reader :registry
 
-    # @return [void]
-    #
-    # @api private
-    # @since 0.5.0
-    def freeze
-      thread_safe { freeze_state }
-    end
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def initialize
+    @registry = {}
+    @access_lock = SmartCore::Container::ArbitaryLock.new
+  end
 
-    # @return [void]
-    #
-    # @api private
-    # @since 0.5.0
-    def frozen?
-      thread_safe { state_frozen? }
-    end
+  # @param entity_path [String, Symbol]
+  # @return [SmartCore::Container::Entity]
+  #
+  # @api private
+  # @since 0.7.0
+  def resolve(entity_path)
+    thread_safe { fetch_entity(entity_path) }
+  end
 
-    # @param dependency_path [String, Symbol]
-    # @return [SmartCore::Container::Namespace, SmartCore::Container::Dependnecy]
-    #
-    # @api private
-    # @since 0.5.0
-    def resolve(dependency_path)
-      thread_safe { fetch_dependency(dependency_path) }
-    end
+  # @param name [String, Symbol]
+  # @param dependency_definition [Block]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def register_dependency(name, &dependency_definition)
+    thread_safe { add_dependency(name, dependency_definition) }
+  end
 
-    # @param name [String, Symbol]
-    # @param options [Hash<Symbol,Any>]
-    # @param dependency_definition [Block]
-    # @return [void]
-    #
-    # @todo option list
-    #
-    # @api private
-    # @since 0.5.0
-    def register(name, **options, &dependency_definition)
-      thread_safe do
-        raise(
-          SmartCore::Container::FrozenRegistryError,
-          'Can not modify frozen registry'
-        ) if state_frozen?
-
-        append_dependency(name, dependency_definition, **options)
-      end
-    end
+  # @param name [String, Symbol]
+  # @param dependencies_definition [Block]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def register_namespace(name, &dependencies_definition)
+    thread_safe { add_namespace(name, dependencies_definition) }
+  end
 
-    # @param name [String, Symbol]
-    # @param dependency_definitions [Block]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.5.0
-    def namespace(name, &dependency_definitions)
-      thread_safe do
-        raise(
-          SmartCore::Container::FrozenRegistryError,
-          'Can not modify frozen registry'
-        ) if state_frozen?
-
-        append_namespace(name, dependency_definitions)
-      end
-    end
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def freeze!
+    thread_safe { freeze_state }
+  end
 
-    # @param block [Block]
-    # @return [Enumerable]
-    #
-    # @api private
-    # @since 0.5.0
-    def each(&block)
-      thread_safe { block_given? ? registry.each_value(&block) : registry.each_value }
-    end
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.7.0
+  def frozen?
+    thread_safe { state_frozen? }
+  end
 
-    # @return [Hash<Symbol,Any>]
-    #
-    # @api private
-    # @since 0.5.0
-    def to_h
-      # TODO: implement :)
-    end
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.7.0
+  def each(&block)
+    thread_safe { enumerate(&block) }
+  end
 
-    private
-
-    # @return [Mutex]
-    #
-    # @api private
-    # @since 0.5.0
-    attr_reader :access_lock
-
-    # @return [Hash<Symbol,SmartCore::Container::Entity>]
-    #
-    # @api private
-    # @since 0.5.0
-    attr_reader :registry
-
-    # @return [Boolean]
-    #
-    # @api private
-    # @since 0.5.0
-    def state_frozen?
-      registry.frozen?
-    end
+  # @return [Hash<String|Symbol,SmartCore::Container::Entities::Base|Any>]
+  #
+  # @api private
+  # @since 0.7.0
+  def hash_tree(resolve_dependencies: false)
+    thread_safe { build_hash_tree(resolve_dependencies: resolve_dependencies) }
+  end
+  alias_method :to_h, :hash_tree
+  alias_method :to_hash, :hash_tree
 
-    # @return [void]
-    #
-    # @api private
-    # @since 0.5.0
-    def freeze_state
-      registry.freeze
-    end
+  private
 
-    # @paramm dependency_path [String, Symbol]
-    # @return [SmartCore::Container::Namespace, SmartCore::Container::Dependency]
-    #
-    # @api private
-    # @since 0.5.0
-    def fetch_dependency(dependency_path)
-      # TODO: rabbit style dependnecy path
-      name = indifferently_accessable_name(dependency_path)
-      registry.fetch(name)
-    rescue KeyError
-      raise(
-        SmartCore::Container::UnexistentDependencyError,
-        "Dependencny with '#{name}' name does not exist!"
-      )
-    end
+  # @return [Mutex]
+  #
+  # @api private
+  # @since 0.7.0
+  attr_reader :lock
 
-    # @param dependency_name [String, Symbol]
-    # @param dependency_definition [Proc]
-    # @param options [Hash<Symbol,Any>]
-    # @return [void]
-    #
-    # @todo option list
-    # @raise [SmartCore::Container::NamespaceOverlapError]
-    #
-    # @api private
-    # @since 0.5.0
-    def append_dependency(dependency_name, dependency_definition, **options)
-      dependency_name = indifferently_accessable_name(dependency_name)
-      prevent_namespace_overlap!(dependency_name)
-      dependency = DependencyBuilder.build(dependency_name, dependency_definition, **options)
-
-      registry[dependency_name] = dependency
-    end
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.7.0
+  def state_frozen?
+    registry.frozen?
+  end
 
-    # @param namespace_name [String, Symbol]
-    # @param dependency_definitions [Proc]
-    # @return [void]
-    #
-    # @raise [SmartCore::Container::DependencyOverlapError]
-    #
-    # @api private
-    # @since 0.5.0
-    def append_namespace(namespace_name, dependency_definitions)
-      namespace_name = indifferently_accessable_name(namespace_name)
-      prevent_dependency_overlap!(namespace_name)
-
-      # rubocop:disable Layout/RescueEnsureAlignment
-      namespace = begin
-        registry.fetch(namespace_name)
-      rescue KeyError
-        registry[namespace_name] = SmartCore::Container::Namespace.new(namespace_name)
+  # @return [Hash<String|Symbol,SmartCore::Container::Entities::Base|Any>]
+  #
+  # @api private
+  # @since 0.7.0
+  def build_hash_tree(resolve_dependencies: false)
+    {}.tap do |tree|
+      enumerate do |(entity_name, entity)|
+        case entity
+        when SmartCore::Container::Entities::Namespace
+          tree[entity_name] = entity.resolve.hash_tree(resolve_dependencies: resolve_dependencies)
+        when SmartCore::Container::Entities::Dependency
+          tree[entity_name] = resolve_dependencies ? entity.resolve : entity
+        end
       end
-      # rubocop:enable Layout/RescueEnsureAlignment
-
-      namespace.append_definitions(dependency_definitions)
     end
+  end
 
-    # @param name [String, Symbol]
-    # @return [void]
-    #
-    # @see [SmartCore::Container::KeyGuard]
-    #
-    # @api private
-    # @since 0.5.0
-    def indifferently_accessable_name(name)
-      SmartCore::Container::KeyGuard.indifferently_accessable_key(name)
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def freeze_state
+    registry.freeze.tap do
+      enumerate do |(entity_name, entity)|
+        entity.freeze! if entity.is_a?(SmartCore::Container::Entities::Namespace)
+      end
     end
+  end
 
-    # @param dependency_name [String]
-    # @retrun [void]
-    #
-    # @api private
-    # @since 0.5.0
-    def prevent_namespace_overlap!(dependency_name)
-      DependencyCompatability::Registry.prevent_namespace_overlap!(
-        self, dependency_name
-      )
+  # @param block
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.7.0
+  def enumerate(&block)
+    block_given? ? registry.each(&block) : registry.each
+  end
+
+  # @paramm entity_path [String, Symbol]
+  # @return [SmartCore::Container::Entity]
+  #
+  # @api private
+  # @since 0.7.0
+  def fetch_entity(entity_path)
+    dependency_name = indifferently_accessable_name(entity_path)
+    registry.fetch(dependency_name)
+  rescue KeyError
+    raise(
+      SmartCore::Container::NonexistentEntityError,
+      "Entity with '#{dependency_name}' name does not exist!"
+    )
+  end
+
+  # @param dependency_name [String, Symbol]
+  # @param dependency_definition [Proc]
+  # @return [SmartCore::Container::Entities::Dependency]
+  #
+  # @raise [SmartCore::Container::DependencyOverNamespaceOverlapError]
+  #
+  # @api private
+  # @since 0.7.0
+  def add_dependency(dependency_name, dependency_definition)
+    if state_frozen?
+      raise(SmartCore::Container::FrozenRegistryError, 'Can not modify frozen registry!')
     end
+    dependency_name = indifferently_accessable_name(dependency_name)
+    prevent_namespace_overlap!(dependency_name)
+
+    dependency_entity = SmartCore::Container::Entities::DependencyBuilder.build(
+      dependency_name, dependency_definition
+    )
 
-    # @param namespace_name [String]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.5.0
-    def prevent_dependency_overlap!(namespace_name)
-      DependencyCompatability::Registry.prevent_dependency_overlap!(
-        self, namespace_name
+    dependency_entity.tap { registry[dependency_name] = dependency_entity }
+  end
+
+  # @param namespace_name [String, Symbol]
+  # @param dependencies_definition [Proc]
+  # @return [SmartCore::Container::Entities::Namespace]
+  #
+  # @raise [SmartCore::Container::NamespaceOverDependencyOverlapError]
+  #
+  # @api private
+  # @since 0.7.0
+  def add_namespace(namespace_name, dependencies_definition)
+    if state_frozen?
+      raise(SmartCore::Container::FrozenRegistryError, 'Can not modify frozen registry!')
+    end
+    namespace_name = indifferently_accessable_name(namespace_name)
+    prevent_dependency_overlap!(namespace_name)
+
+    # rubocop:disable Layout/RescueEnsureAlignment
+    namespace_entity = begin
+      fetch_entity(namespace_name)
+    rescue SmartCore::Container::NonexistentEntityError
+      registry[namespace_name] = SmartCore::Container::Entities::NamespaceBuilder.build(
+        namespace_name
       )
     end
+    # rubocop:enable Layout/RescueEnsureAlignment
 
-    # @param block [Proc]
-    # @return [Any]
-    #
-    # @api private
-    # @since 0.5.0
-    def thread_safe(&block)
-      @access_lock.synchronize(&block)
-    end
+    namespace_entity.tap { namespace_entity.append_definitions(dependencies_definition) }
+  end
+
+  # @param name [String, Symbol]
+  # @return [void]
+  #
+  # @see [SmartCore::Container::KeyGuard]
+  #
+  # @api private
+  # @since 0.7.0
+  def indifferently_accessable_name(name)
+    SmartCore::Container::KeyGuard.indifferently_accessable_key(name)
+  end
+
+  # @param dependency_name [String]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def prevent_namespace_overlap!(dependency_name)
+    SmartCore::Container::DependencyCompatability::Registry.prevent_namespace_overlap!(
+      self, dependency_name
+    )
+  end
+
+  # @param namespace_name [String]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def prevent_dependency_overlap!(namespace_name)
+    SmartCore::Container::DependencyCompatability::Registry.prevent_dependency_overlap!(
+      self, namespace_name
+    )
+  end
+
+  # @param block [Proc]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.7.0
+  def thread_safe(&block)
+    @access_lock.thread_safe(&block)
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/smart_core/container/registry_builder.rb

@@ -1,18 +1,51 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.5.0
+# @since 0.7.0
 module SmartCore::Container::RegistryBuilder
+  # rubocop:disable Metrics/LineLength
   class << self
-    # @param commands [SmartCore::Container::CommandSet]
+    # @parma container [SmartCore::Container]
+    # @option ignored_definition_commands [Array<Class::SmartCore::Container::DefinitionDSL::Commands::Base>>]
+    # @option ignored_instantiation_commands [Array<Class::SmartCore::Container::DefinitionDSL::Commands::Base>>]
     # @return [SmartCore::Container::Registry]
     #
     # @api private
-    # @since 0.5.0
-    def build(commands)
+    # @since 0.7.0
+    def build(container, ignored_definition_commands: [], ignored_instantiation_commands: [])
       SmartCore::Container::Registry.new.tap do |registry|
-        commands.each { |command| command.call(registry) }
+        build_definitions(container.class, registry, ignored_commands: ignored_definition_commands)
+        build_state(container.class, registry, ignored_commands: ignored_instantiation_commands)
+      end
+    end
+
+    # @param container_klass [Class<SmartCore::Container>]
+    # @param registry [SmartCore::Container::Registry]
+    # @option ignored_commands [Array<Class<SmartCore::Container::DefinitionDSL::Commands::Base>>]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.7.0
+    def build_definitions(container_klass, registry, ignored_commands: [])
+      container_klass.__container_definition_commands__.each do |command|
+        next if ignored_commands.include?(command.class)
+        command.call(registry)
+      end
+    end
+
+    # @param container_klass [Class<SmartCore::Container>]
+    # @param registry [SmartCore::Container::Registry]
+    # @option ignored_commands [Array<Class<SmartCore::Container::DefinitionDSL::Commands::Base>>]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.7.0
+    def build_state(container_klass, registry, ignored_commands: [])
+      container_klass.__container_instantiation_commands__.each do |command|
+        next if ignored_commands.include?(command.class)
+        command.call(registry)
       end
     end
   end
+  # rubocop:enable Metrics/LineLength
 end