smart_core 0.6.0 → 0.7.0

data/lib/smart_core/container/dependency_compatability/registry.rb

@@ -1,36 +1,35 @@
 # frozen_string_literal: true
 
-module SmartCore::Container::DependencyCompatability
-  # @api private
-  # @since 0.5.0
-  class Registry < Abstract
-    class << self
-      # @param registry [SmartCore::Container::Regsitry]
-      # @param dependency_name [String]
-      # @return [Boolean]
-      #
-      # @api private
-      # @since 0.5.0
-      def potential_namespace_overlap?(registry, dependency_name)
-        registry.any? do |registered_dependency|
-          next unless registered_dependency.is_a?(SmartCore::Container::Namespace)
-          # NOTE: registered_dependency is a namespace
-          registered_dependency.external_name == dependency_name
-        end
+# @api private
+# @since 0.7.0
+module SmartCore::Container::DependencyCompatability::Registry
+  class << self
+    # @since 0.7.0
+    include SmartCore::Container::DependencyCompatability::General
+
+    # @param registry [SmartCore::Container::Registry]
+    # @param dependency_name [String, Symbol]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.7.0
+    def potential_namespace_overlap?(registry, dependency_name)
+      registry.any? do |(entity_name, entity)|
+        next unless entity.is_a?(SmartCore::Container::Entities::Namespace)
+        entity.namespace_name == dependency_name
       end
+    end
 
-      # @param registry [SmartCore::Container::Regsitry]
-      # @param namespace_name [String]
-      # @return [Boolean]
-      #
-      # @api private
-      # @since 0.5.0
-      def potential_dependency_overlap?(registry, namespace_name)
-        registry.any? do |registered_dependency|
-          next unless registered_dependency.is_a?(SmartCore::Container::Dependency)
-          # NOTE: registered_dependency is a dependency/memoized dependency
-          registered_dependency.external_name == namespace_name
-        end
+    # @param registry [SmartCore::Container::Registry]
+    # @param namespace_name [String, Symbol]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.7.0
+    def potential_dependency_overlap?(registry, namespace_name)
+      registry.any? do |(entity_name, entity)|
+        next unless entity.is_a?(SmartCore::Container::Entities::Dependency)
+        entity.dependency_name == namespace_name
       end
     end
   end

data/lib/smart_core/container/dependency_resolver.rb

@@ -1,16 +1,21 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.5.0
+# @since 0.7.0
 module SmartCore::Container::DependencyResolver
   class << self
     # @param registry [SmartCore::Container::Registry]
-    # @return [Any]
+    # @param dependency_path [String, Symbol]
+    # @return [SmartCore::Container, Any]
+    #
+    # @see SmartCore::Container::Registry#resolve
+    # @see SmartCore::Container::Entities::Namespace#resolve
+    # @see SmartCore::Container::Entities::Dependency#resolve
     #
     # @api private
-    # @since 0.5.0
+    # @since 0.7.0
     def resolve(registry, dependency_path)
-      registry.resolve(dependency_path).call
+      registry.resolve(dependency_path).resolve
     end
   end
 end

data/lib/smart_core/container/entities.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.7.0
+module SmartCore::Container::Entities
+  require_relative 'entities/base'
+  require_relative 'entities/dependency'
+  require_relative 'entities/dependency_builder'
+  require_relative 'entities/namespace'
+  require_relative 'entities/namespace_builder'
+end

data/lib/smart_core/container/{entity.rb → entities/base.rb}

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.5.0
-class SmartCore::Container::Entity
+# @since 0.7.0
+class SmartCore::Container::Entities::Base
   # @return [String]
   #
   # @api private
-  # @since 0.5.0
+  # @since 0.7.0
   attr_reader :external_name
 
   # @param external_name [String]
   # @return [void]
   #
   # @api private
-  # @since 0.5.0
+  # @since 0.7.0
   def initialize(external_name)
     @external_name = external_name
   end
 
-  # @return [void]
+  # @return [Any]
   #
   # @api private
-  # @since 0.5.0
-  def call; end
+  # @since 0.7.0
+  def resolve; end
 end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.7.0
+class SmartCore::Container::Entities::Dependency < SmartCore::Container::Entities::Base
+  # @return [String]
+  #
+  # @api private
+  # @sicne 0.7.0
+  alias_method :dependency_name, :external_name
+
+  # @param dependency_name [String]
+  # @param dependency_definition [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def initialize(dependency_name, dependency_definition)
+    super(dependency_name)
+    @dependency_definition = dependency_definition
+  end
+
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.7.0
+  def resolve
+    dependency_definition.call
+  end
+
+  private
+
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.7.0
+  attr_reader :dependency_definition
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.7.0
+class SmartCore::Container::Entities::DependencyBuilder
+  class << self
+    # @param dependency_name [String]
+    # @param dependency_definition [Proc]
+    # @return [SmartCore::Container::Entities::Dependency]
+    #
+    # @api private
+    # @since 0.7.0
+    def build(dependency_name, dependency_definition)
+      new(dependency_name, dependency_definition).build
+    end
+  end
+
+  # @param dependency_name [String]
+  # @param dependency_definition [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def initialize(dependency_name, dependency_definition)
+    @dependency_name = dependency_name
+    @dependency_definition = dependency_definition
+  end
+
+  # @return [SmartCore::Container::Entities::Dependency]
+  #
+  # @api private
+  # @since 0.7.0
+  def build
+    SmartCore::Container::Entities::Dependency.new(dependency_name, dependency_definition)
+  end
+
+  private
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.7.0
+  attr_reader :dependency_name
+
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.7.0
+  attr_reader :dependency_definition
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.7.0
+class SmartCore::Container::Entities::Namespace < SmartCore::Container::Entities::Base
+  # @return [String]
+  #
+  # @api private
+  # @since 0.7.0
+  alias_method :namespace_name, :external_name
+
+  # @param namespace_name [String]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def initialize(namespace_name)
+    super(namespace_name)
+    @container_klass = Class.new(SmartCore::Container)
+    @container_instance = nil
+    @lock = SmartCore::Container::ArbitaryLock.new
+  end
+
+  # @return [SmartCore::Container]
+  #
+  # @api private
+  # @since 0.7.0
+  def resolve
+    thread_safe { container_instance }
+  end
+
+  # @param dependencies_definition [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def append_definitions(dependencies_definition)
+    thread_safe { container_klass.instance_eval(&dependencies_definition) }
+  end
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def freeze!
+    thread_safe { container_instance.freeze! }
+  end
+
+  private
+
+  # @return [Class<SmartCore::Container>]
+  #
+  # @api private
+  # @since 0.7.0
+  attr_reader :container_klass
+
+  # @return [SmartCore::Container]
+  #
+  # @api private
+  # @since 0.7.0
+  def container_instance
+    @container_instance ||= container_klass.new
+  end
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.7.0
+  def thread_safe(&block)
+    @lock.thread_safe(&block)
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.7.0
+class SmartCore::Container::Entities::NamespaceBuilder
+  class << self
+    # @param namespace_name [String]
+    # @return [SmartCore::Container::Entities::Namespace]
+    #
+    # @api private
+    # @since 0.7.0
+    def build(namespace_name)
+      new(namespace_name).build
+    end
+  end
+
+  # @param namespace_name [String]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def initialize(namespace_name)
+    @namespace_name = namespace_name
+  end
+
+  # @return [SmartCore::Container::Entities::Namespace]
+  #
+  # @api private
+  # @since 0.7.0
+  def build
+    SmartCore::Container::Entities::Namespace.new(namespace_name)
+  end
+
+  private
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.7.0
+  attr_reader :namespace_name
+end

data/lib/smart_core/container/errors.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class SmartCore::Container
+  # @api public
+  # @since 0.7.0
+  Error = Class.new(SmartCore::Error)
+
+  # @api public
+  # @since 0.7.0
+  ArgumentError = Class.new(SmartCore::ArgumentError)
+
+  # @api public
+  # @since 0.7.0
+  IncompatibleEntityNameError = Class.new(ArgumentError)
+
+  # @see SmartCore::Container::Registry
+  #
+  # @api public
+  # @since 0.7.0
+  FrozenRegistryError = Class.new(SmartCore::FrozenError)
+
+  # @see SmartCore::Container::Registry
+  #
+  # @api public
+  # @since 0.7.0
+  NonexistentEntityError = Class.new(Error)
+
+  # @see SmartCore::Container::DependencyCompatability::General
+  # @see SmartCore::Container::DependencyCompatability::Definition
+  # @see SmartCore::Container::DependencyCompatability::Registry
+  #
+  # @api public
+  # @since 0.7.0
+  DependencyOverNamespaceOverlapError = Class.new(Error)
+
+  # @see SmartCore::Container::DependencyCompatability::General
+  # @see SmartCore::Container::DependencyCompatability::Definition
+  # @see SmartCore::Container::DependencyCompatability::Registry
+  #
+  # @api public
+  # @since 0.7.0
+  NamespaceOverDependencyOverlapError = Class.new(Error)
+end

data/lib/smart_core/container/key_guard.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
 # @api priavate
-# @since 0.5.0
+# @since 0.7.0
 module SmartCore::Container::KeyGuard
   class << self
     # @param key [Symbol, String]
     # @return [void]
     #
-    # @raise [SmartCore::Container::ArgumentError]
+    # @raise [SmartCore::Container::IncompatibleEntityNameError]
     #
     # @api private
-    # @since 0.5.0
+    # @since 0.7.0
     def prevent_incomparabilities!(key)
       raise(
-        SmartCore::Container::ArgumentError,
+        SmartCore::Container::IncompatibleEntityNameError,
         'Namespace/Dependency name should be a symbol or a string'
       ) unless key.is_a?(String) || key.is_a?(Symbol)
     end
@@ -22,7 +22,7 @@ module SmartCore::Container::KeyGuard
     # @return [String]
     #
     # @api private
-    # @since 0.5.0
+    # @since 0.7.0
     def indifferently_accessable_key(key)
       prevent_incomparabilities!(key)
       key.to_s

data/lib/smart_core/container/mixin.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
 # @api public
-# @since 0.5.0
+# @since 0.7.0
 module SmartCore::Container::Mixin
   class << self
     # @param base_klass [Class]
     # @return [void]
     #
     # @api private
-    # @since 0.5.0
+    # @since 0.7.0
     def included(base_klass)
       # rubocop:disable Metrics/LineLength
-      base_klass.instance_variable_set(:@__smart_core_container_access_lock__, Mutex.new)
-      base_klass.instance_variable_set(:@__smart_core_container_definition_lock__, Mutex.new)
+      base_klass.instance_variable_set(:@__smart_core_container_access_lock__, SmartCore::Container::ArbitaryLock.new)
       base_klass.instance_variable_set(:@__smart_core_container_klass__, Class.new(SmartCore::Container))
       base_klass.instance_variable_set(:@__smart_core_container__, nil)
       # rubocop:enable Metrics/LineLength
@@ -24,57 +23,62 @@ module SmartCore::Container::Mixin
   end
 
   # @api private
-  # @since 0.5.0
+  # @since 0.7.0
   module ClassInheritance
     # @param child_klass [CLass]
     # @return [void]
     #
     # @api private
-    # @since 0.5.0
+    # @since 0.7.0
     def inherited(child_klass)
       inherited_container_klass = Class.new(@__smart_core_container_klass__)
 
-      child_klass.instance_variable_set(:@__smart_core_container_access_lock__, Mutex.new)
-      child_klass.instance_variable_set(:@__smart_core_container_definition_lock__, Mutex.new)
+      # rubocop:disable Metrics/LineLength
+      child_klass.instance_variable_set(:@__smart_core_container_access_lock__, SmartCore::Container::ArbitaryLock.new)
       child_klass.instance_variable_set(:@__smart_core_container_klass__, inherited_container_klass)
       child_klass.instance_variable_set(:@__smart_core_container__, nil)
+      # rubocop:disable Metrics/LineLength
 
       super
     end
   end
 
   # @api private
-  # @since 0.5.0
+  # @since 0.7.0
   module ClassMethods
+    # @param freeze_state [Boolean]
     # @param block [Proc]
     # @return [void]
     #
     # @api public
-    # @since 0.5.0
-    def dependencies(&block)
-      @__smart_core_container_definition_lock__.synchronize do
+    # @since 0.7.0
+    def dependencies(freeze_state: false, &block)
+      @__smart_core_container_access_lock__.thread_safe do
         @__smart_core_container_klass__.instance_eval(&block) if block_given?
+        @__smart_core_container_klass__.instance_eval do
+          freeze_state!
+        end if freeze_state
       end
     end
 
     # @return [SmartCore::Container]
     #
     # @api public
-    # @since 0.5.0
+    # @since 0.7.0
     def container
-      @__smart_core_container_definition_lock__.synchronize do
+      @__smart_core_container_access_lock__.thread_safe do
         @__smart_core_container__ ||= @__smart_core_container_klass__.new
       end
     end
   end
 
   # @api private
-  # @since 0.5.0
+  # @since 0.7.0
   module InstanceMethods
     # @return [SmartCore::Container]
     #
     # @api public
-    # @since 0.5.0
+    # @since 0.7.0
     def container
       self.class.container
     end