smart_core 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19dd6183688e0576100f7178ad66764ca76d1461c459eaeb239815c1b75a2d30
-  data.tar.gz: 34419b8bac8cc0e409c823282320fadf14f562225a5c4dd62545c4270b298919
+  metadata.gz: 3ca3b0d1486eb3331a2d09f642d63c5557fa56aba7927eba276f5cdf1ea27ccb
+  data.tar.gz: ea3f79d0fa9471d4bf3ebe4558c3bbd7bb508b925d1265a6ac749a1a2a15bcf5
 SHA512:
-  metadata.gz: '06718cef684bec320e3fa67d83e9486df6c991571fcabe6fad48a2a7063f554499e46a7c231bc37edb8dcb2325daf9004ae293f3e736e85f73a6eb6c791d7a74'
-  data.tar.gz: d13ec368c4bed72a132f1de1963c322383e8ad7d5168c3da188a13b649f7ec1cc27da080cc917b0c5c30c344436847229dd7bf92b429d6cd499dc77557274070
+  metadata.gz: ff087931c4a69cfeedabbaf8ab7b96645a47c3ceec7ad78ec0475f2d6229faf45a20aae9d17febf12e23b4090edcae34056f6c9f386be22a1fd2515ebe5f3aaf
+  data.tar.gz: 6cea80b530a0e742c67b58de15c23d06b0de7cc92337920ec19d6849b765a1fe61f7d0b7a9d2b4653ed36c199143c5d9401cf07710b1fef0c966bbb0c64497e5

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.8.0] - 2019-11-14
+### Added
+- [**SmartCore::Container**]
+  - support for `dot-notation`;
+
+### Changed
+- [**SmartCore::Container**]
+  - new `#resolve`: now supports only the dot-notated invokation style;
+  - old `#resolve` renamed to `#fetch`;
+  - added `#[](dependency_path)` - an alias for `#resolve`;
+
 ## [0.7.0] - 2019-11-10
 ### Changed
 - `SmartCore::Operation::Custom` result type is renamed to `SmartCore::Operation::Callback`;

data/README.md

@@ -38,7 +38,7 @@ require 'smart_core'
 - Schema Structure Validator (`SmartCore::Schema`);
 - Saga (`SmartCore::Saga`);
 - External Type System (`SmartCore::Types`);
-- Step-like execution behavior for `SmartCore::Operation` (`.step`);
+- Step-like execution behavior for `SmartCore::Operation` (`.step`, `SmartCore::Railway`);
 - Automatic result instantiation and handling for `SmartCore::Operation`;
 
 ---

data/Rakefile

@@ -6,6 +6,7 @@ require 'rubocop'
 require 'rubocop-rspec'
 require 'rubocop-performance'
 require 'rubocop/rake_task'
+require 'rubocop-rake'
 
 RuboCop::RakeTask.new(:rubocop) do |t|
   config_path = File.expand_path(File.join('.rubocop.yml'), __dir__)
@@ -13,6 +14,7 @@ RuboCop::RakeTask.new(:rubocop) do |t|
   t.options = ['--config', config_path]
   t.requires << 'rubocop-rspec'
   t.requires << 'rubocop-performance'
+  t.requires << 'rubocop-rake'
 end
 
 RSpec::Core::RakeTask.new(:rspec)

data/lib/smart_core/container.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # @api public
-# @since 0.1.0
+# @since 0.7.0
 class SmartCore::Container
   require_relative 'container/errors'
   require_relative 'container/arbitary_lock'
@@ -14,13 +14,19 @@ class SmartCore::Container
   require_relative 'container/dependency_resolver'
   require_relative 'container/mixin'
 
-  # @since 0.1.0
+  # @since 0.7.0
   include DefinitionDSL
 
+  # @return [SmartCore::Container::Registry]
+  #
+  # @api private
+  # @since 0.7.0
+  attr_reader :registry
+
   # @return [void]
   #
   # @api public
-  # @since 0.1.0
+  # @since 0.7.0
   def initialize
     build_registry!
     @access_lock = ArbitaryLock.new
@@ -31,7 +37,7 @@ class SmartCore::Container
   # @return [void]
   #
   # @api public
-  # @sicne 0.1.0
+  # @sicne 0.7.0
   def register(dependency_name, &dependency_definition)
     thread_safe { registry.register_dependency(dependency_name, &dependency_definition) }
   end
@@ -41,7 +47,7 @@ class SmartCore::Container
   # @return [void]
   #
   # @api public
-  # @since 0.1.0
+  # @since 0.7.0
   def namespace(namespace_name, &dependencies_definition)
     thread_safe { registry.register_namespace(namespace_name, &dependencies_definition) }
   end
@@ -50,15 +56,26 @@ class SmartCore::Container
   # @return [Any]
   #
   # @api public
-  # @since 0.1.0
+  # @since 0.7.0
+  # @version 0.8.0
   def resolve(dependency_path)
-    thread_safe { DependencyResolver.resolve(registry, dependency_path) }
+    thread_safe { DependencyResolver.resolve(self, dependency_path) }
+  end
+  alias_method :[], :resolve
+
+  # @param dependency_path [String, Symbol]
+  # @return [Any]
+  #
+  # @api public
+  # @since 0.8.0
+  def fetch(dependency_path)
+    thread_safe { DependencyResolver.fetch(self, dependency_path) }
   end
 
   # @return [void]
   #
   # @api public
-  # @since 0.1.0
+  # @since 0.7.0
   def freeze!
     thread_safe { registry.freeze! }
   end
@@ -66,7 +83,7 @@ class SmartCore::Container
   # @return [Boolean]
   #
   # @api public
-  # @since 0.1.0
+  # @since 0.7.0
   def frozen?
     thread_safe { registry.frozen? }
   end
@@ -74,15 +91,16 @@ class SmartCore::Container
   # @return [void]
   #
   # @api public
-  # @since 0.1.0
+  # @since 0.7.0
   def reload!
     thread_safe { build_registry! }
   end
 
+  # @option resolve_dependencies [Boolean]
   # @return [Hash<String|Symbol,SmartCore::Container::Entities::Base|Any>]
   #
   # @api public
-  # @since 0.1.0
+  # @since 0.7.0
   def hash_tree(resolve_dependencies: false)
     thread_safe { registry.hash_tree(resolve_dependencies: resolve_dependencies) }
   end
@@ -91,16 +109,10 @@ class SmartCore::Container
 
   private
 
-  # @return [SmartCore::Container::Registry]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :registry
-
   # @return [void]
   #
   # @api private
-  # @since 0.1.0
+  # @since 0.7.0
   def build_registry!
     @registry = RegistryBuilder.build(self)
   end
@@ -109,7 +121,7 @@ class SmartCore::Container
   # @return [Any]
   #
   # @api private
-  # @since 0.1.0
+  # @since 0.7.0
   def thread_safe(&block)
     @access_lock.thread_safe(&block)
   end

data/lib/smart_core/container/dependency_resolver.rb

@@ -3,19 +3,64 @@
 # @api private
 # @since 0.7.0
 module SmartCore::Container::DependencyResolver
+  require_relative 'dependency_resolver/route'
+
   class << self
-    # @param registry [SmartCore::Container::Registry]
+    # @param container [SmartCore::Container]
+    # @param dependency_path [String, Symbol]
+    # @return [SmartCore::Container, Any]
+    #
+    # @see SmartCore::Container::Registry#resolve
+    # @see SmartCore::Container::Entities::Namespace#reveal
+    # @see SmartCore::Container::Entities::Dependency#reveal
+    #
+    # @api private
+    # @since 0.8.0
+    def fetch(container, dependency_path)
+      container.registry.resolve(dependency_path).reveal
+    end
+
+    # @param container [SmartCore::Container]
     # @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
+    # @see SmartCore::Container::Entities::Namespace#reveal
+    # @see SmartCore::Container::Entities::Dependency#reveal
+    #
+    # @raise [SmartCore::Container::ResolvingError]
     #
     # @api private
     # @since 0.7.0
-    def resolve(registry, dependency_path)
-      registry.resolve(dependency_path).resolve
+    # @version 0.8.0
+    def resolve(container, dependency_path)
+      entity = container
+
+      Route.build(dependency_path).each do |cursor|
+        entity = entity.registry.resolve(cursor.current_path)
+        if cursor.last? && entity.is_a?(SmartCore::Container::Entities::Namespace)
+          # rubocop:enable Metrics/LineLength
+          raise(SmartCore::Container::ResolvingError.new(<<~MESSAGE, path_part: cursor.current_path))
+            Trying to resolve a namespace as a dependency
+          MESSAGE
+          # rubocop:disable Metrics/LineLength
+        end
+        if !cursor.last? && entity.is_a?(SmartCore::Container::Entities::Dependency)
+          # rubocop:enable Metrics/LineLength
+          raise(SmartCore::Container::ResolvingError.new(<<~MESSAGE, path_part: cursor.current_path))
+            Trying to resolve nonexistent dependency
+          MESSAGE
+          # rubocop:disable Metrics/LineLength
+        end
+        entity = entity.reveal
+      end
+
+      entity
+    rescue SmartCore::Container::ResolvingError => error
+      full_dependency_path = Route.build_path(dependency_path, error.path_part)
+      raise(SmartCore::Container::ResolvingError.new(<<~MESSAGE, path_part: full_dependency_path))
+        #{error.message} (incorrect path: "#{full_dependency_path}")
+      MESSAGE
     end
   end
 end

data/lib/smart_core/container/dependency_resolver/route.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.8.0
+class SmartCore::Container::DependencyResolver::Route
+  require_relative 'route/cursor'
+
+  # @since 0.8.0
+  include Enumerable
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.8.0
+  PATH_PART_SEPARATOR = '.'
+
+  class << self
+    # @param path [String, Symbol]
+    # @return [SmartCore::Container::DependencyResolver::Route]
+    #
+    # @api private
+    # @since 0.8.0
+    def build(path)
+      new(SmartCore::Container::KeyGuard.indifferently_accessable_key(path))
+    end
+
+    # @return [Array<String>]
+    #
+    # @api private
+    # @since 0.8.0
+    def build_path(*path_parts)
+      path_parts.join(PATH_PART_SEPARATOR)
+    end
+  end
+
+  # @return [Integer]
+  #
+  # @api private
+  # @since 0.8.0
+  attr_reader :size
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.8.0
+  attr_reader :path
+
+  # @param path [String]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.8.0
+  def initialize(path)
+    @path = path
+    @path_parts = path.split(PATH_PART_SEPARATOR).freeze
+    @size = @path_parts.size
+  end
+
+  # @param block [Block]
+  # @yield cursor [SmartCore::Container::DependencyResolver::Route::Cursor]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.8.0
+  def each(&block)
+    enumerator = Enumerator.new do |yielder|
+      path_parts.each_with_index do |path_part, path_part_index|
+        cursor = Cursor.new(path_part, path_part_index, self)
+        yielder.yield(cursor)
+      end
+    end
+
+    block_given? ? enumerator.each(&block) : enumerator
+  end
+
+  private
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.8.0
+  attr_reader :path_parts
+end

data/lib/smart_core/container/dependency_resolver/route/cursor.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.8.0
+class SmartCore::Container::DependencyResolver::Route::Cursor
+  # @return [String]
+  #
+  # @api private
+  # @since 0.8.0
+  attr_reader :path_part
+  alias_method :current_path, :path_part
+
+  # @param path_part [String]
+  # @param path_part_index [Integer]
+  # @param route [SmartCore::Container::DependencyResolver::Route]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.8.0
+  def initialize(path_part, path_part_index, route)
+    @path_part = path_part
+    @path_part_index = path_part_index
+    @route = route
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.8.0
+  def last?
+    route.size <= (path_part_index + 1)
+  end
+
+  private
+
+  # @return [Integer]
+  #
+  # @api private
+  # @since 0.8.0
+  attr_reader :path_part_index
+
+  # @return [SmartCore::Container::DependencyResolver::Route]
+  #
+  # @api private
+  # @since 0.8.0
+  attr_reader :route
+end

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

@@ -21,6 +21,6 @@ class SmartCore::Container::Entities::Base
   # @return [Any]
   #
   # @api private
-  # @since 0.7.0
-  def resolve; end
+  # @since 0.8.0
+  def reveal; end
 end

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

@@ -6,7 +6,7 @@ class SmartCore::Container::Entities::Dependency < SmartCore::Container::Entitie
   # @return [String]
   #
   # @api private
-  # @sicne 0.7.0
+  # @since 0.7.0
   alias_method :dependency_name, :external_name
 
   # @param dependency_name [String]
@@ -23,8 +23,8 @@ class SmartCore::Container::Entities::Dependency < SmartCore::Container::Entitie
   # @return [Any]
   #
   # @api private
-  # @since 0.7.0
-  def resolve
+  # @since 0.8.0
+  def reveal
     dependency_definition.call
   end
 

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

@@ -24,8 +24,8 @@ class SmartCore::Container::Entities::Namespace < SmartCore::Container::Entities
   # @return [SmartCore::Container]
   #
   # @api private
-  # @since 0.7.0
-  def resolve
+  # @since 0.8.0
+  def reveal
     thread_safe { container_instance }
   end
 

data/lib/smart_core/container/errors.rb

@@ -19,11 +19,9 @@ class SmartCore::Container
   # @since 0.7.0
   FrozenRegistryError = Class.new(SmartCore::FrozenError)
 
-  # @see SmartCore::Container::Registry
-  #
   # @api public
-  # @since 0.7.0
-  NonexistentEntityError = Class.new(Error)
+  # @since 0.8.0
+  FetchError = Class.new(Error)
 
   # @see SmartCore::Container::DependencyCompatability::General
   # @see SmartCore::Container::DependencyCompatability::Definition
@@ -40,4 +38,28 @@ class SmartCore::Container
   # @api public
   # @since 0.7.0
   NamespaceOverDependencyOverlapError = Class.new(Error)
+
+  # @see SmartCore::Container::DependencyResolver
+  # @see SmartCore::Container::Registry
+  #
+  # @api public
+  # @since 0.8.0
+  class ResolvingError < FetchError
+    # @return [String]
+    #
+    # @api private
+    # @since 0.8.0
+    attr_reader :path_part
+
+    # @param message [String]
+    # @param path_part [String]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.8.0
+    def initialize(messegae = nil, path_part:)
+      @path_part = path_part
+      super(message)
+    end
+  end
 end

data/lib/smart_core/container/mixin.rb

@@ -55,9 +55,7 @@ module SmartCore::Container::Mixin
     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
+        @__smart_core_container_klass__.instance_eval { freeze_state! } if freeze_state
       end
     end
 

data/lib/smart_core/container/registry.rb

@@ -111,9 +111,9 @@ class SmartCore::Container::Registry
       enumerate do |(entity_name, entity)|
         case entity
         when SmartCore::Container::Entities::Namespace
-          tree[entity_name] = entity.resolve.hash_tree(resolve_dependencies: resolve_dependencies)
+          tree[entity_name] = entity.reveal.hash_tree(resolve_dependencies: resolve_dependencies)
         when SmartCore::Container::Entities::Dependency
-          tree[entity_name] = resolve_dependencies ? entity.resolve : entity
+          tree[entity_name] = resolve_dependencies ? entity.reveal : entity
         end
       end
     end
@@ -145,14 +145,14 @@ class SmartCore::Container::Registry
   #
   # @api private
   # @since 0.7.0
+  # @version 0.8.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!"
-    )
+    raise(SmartCore::Container::ResolvingError.new(<<~MESSAGE, path_part: dependency_name))
+      Entity with \"#{dependency_name}\" name does not exist
+    MESSAGE
   end
 
   # @param dependency_name [String, Symbol]
@@ -195,7 +195,7 @@ class SmartCore::Container::Registry
     # rubocop:disable Layout/RescueEnsureAlignment
     namespace_entity = begin
       fetch_entity(namespace_name)
-    rescue SmartCore::Container::NonexistentEntityError
+    rescue SmartCore::Container::FetchError
       registry[namespace_name] = SmartCore::Container::Entities::NamespaceBuilder.build(
         namespace_name
       )

data/lib/smart_core/version.rb

@@ -5,5 +5,5 @@ module SmartCore
   #
   # @api public
   # @since 0.1.0
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_core
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-10 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -131,6 +131,8 @@ files:
 - lib/smart_core/container/dependency_compatability/general.rb
 - lib/smart_core/container/dependency_compatability/registry.rb
 - lib/smart_core/container/dependency_resolver.rb
+- lib/smart_core/container/dependency_resolver/route.rb
+- lib/smart_core/container/dependency_resolver/route/cursor.rb
 - lib/smart_core/container/entities.rb
 - lib/smart_core/container/entities/base.rb
 - lib/smart_core/container/entities/dependency.rb
@@ -210,7 +212,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: "(in active development) A set of common abstractions"