smart_container 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 919cbfa847aa6931a64cf70c07269a0883ac0b5f47e9b84243854b0ea626f49e
-  data.tar.gz: b9fcfbf5060a973bf1aa8e81d8a78cbdabf243e585dea583e64904e698c094dc
+  metadata.gz: bb1bc1e5f80263730638b0b0387105364777f87e957b5f673c27c219f206273d
+  data.tar.gz: 0d1a505edb3b4456ab44ecfe52071b1cb5555f51680d3a48de68fb12bd11dcad
 SHA512:
-  metadata.gz: 282c7f32da7c8029518b72f94b1047ed71046db44b0e18c9eef2557158bbf3ad97bb5ed658af9a836105964175fa2fd5a5b6ddb0568700b39ed471e7b6ec4c28
-  data.tar.gz: bfabb455faa37954f0700d2f910e6de93ed4194bb9bb63d45918af7e81de92a5f07f3edf503c922a363d682d6a227cad64a5e5f4c53b355db0b8018757397bb4
+  metadata.gz: 3959674748c1dcc2564bd6edc9ee0acdc3770b0bd260d50c7a1bba5906fee6725ff577e90a2b36b0a81910c423020431810b2a052f42c65826bfc8dcabe7dc22
+  data.tar.gz: f01f97eda299d91b22f730de1eba90e546f9f4de0362218bc0b8f86d8800acd6abf3d2214e223c0246f5c1d4b4742b71c7223ada409a3665765c088c88ab207e

data/.travis.yml

@@ -1,6 +1,7 @@
 ---
 language: ruby
 cache: bundler
+os: linux
 before_install:
 - gem install bundler -v 2.1.2
 script:
@@ -10,19 +11,11 @@ jobs:
   fast_finish: true
   include:
   - rvm: 2.4.9
-    os: [linux, osx]
   - rvm: 2.5.7
-    os: [linux, osx]
   - rvm: 2.6.5
-    os: [linux, osx]
   - rvm: 2.7.0
-    os: [linux, osx]
   - rvm: ruby-head
-    os: [linux, osx]
   - rvm: jruby-head
-    os: [linux, osx]
   allow_failures:
   - rvm: ruby-head
-    os: [linux, osx]
   - rvm: jruby-head
-    os: [linux, osx]

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.4.0] - 2020-01-06
+### Added
+- `#keys(all_variants: false)` - return a list of dependency keys
+  (`all_variants: true` is mean "including namespace kaeys");
+- `#each_dependency(yield_all: false) { |key, value| }` - iterate over conteiner's dependencies
+  (`yield_all: true` will include nested containers to iteration process);
+### Fixed
+- `SmartCore::Container::ResolvingError` class has incorrect message attribute name;
+
 ## [0.3.0] - 2020-01-05
 ### Changed
 - Dependency resolving is not memoized by default (previously: totally memoized 😱);

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_container (0.3.0)
+    smart_container (0.4.0)
       smart_engine (~> 0.2)
 
 GEM

data/README.md

@@ -24,6 +24,8 @@ require 'smart_core/container'
 
 ## Synopsis (demo)
 
+- container class creation:
+
 ```ruby
 class Container < SmartCore::Container
   namespace(:database) do # support for namespaces
@@ -41,16 +43,60 @@ class Container < SmartCore::Container
   # dependencies are not memoized by default (memoize: false)
   register(:random) { rand(1000) }
 end
+```
 
+- container instantiation and dependency resolving:
+
+```ruby
 container = Container.new # create container instance
+```
 
+```ruby
 container['database.resolver'] # => #<SomeDatabaseResolver:0x00007f0f0f1d6332>
 container['database.cache.redis'] # => #<RedisClient:0x00007f0f0f1d0158>
 container['logger'] # => #<Logger:0x00007f5f0f2f0158>
 
+container.resolve('logger') # #resolve(path) is an alias for #[](path)
+
 # non-memoized dependency
 container['random'] # => 352
 container['random'] # => 57
+
+# trying to resolve a namespace as dependency
+container['database'] # => SmartCore::Container::ResolvingError
+
+# but you can fetch any depenendency type (internal containers and values) via #fetch
+container.fetch('database') # => SmartCore::Container (nested container)
+container.fetch('database.resolver') # => #<SomeDatabaseResolver:0x00007f0f0f1d6332>
+```
+
+- container keys (dependency names):
+
+```ruby
+# get dependnecy keys (only dependencies)
+container.keys
+# => result:
+[
+  'database.resolver',
+  'database.cache.memcached',
+  'database.cache.redis',
+  'logger',
+  'random'
+]
+```
+```ruby
+# get all keys (namespaces and dependencies)
+container.keys(all_variants: true)
+# => result:
+[
+  'database', # namespace
+  'database.resolver',
+  'database.cache', # namespace
+  'database.cache.memcached',
+  'database.cache.redis',
+  'logger',
+  'random'
+]
 ```
 
 ---

data/lib/smart_core/container.rb

@@ -20,6 +20,9 @@ module SmartCore
     require_relative 'container/dependency_resolver'
     require_relative 'container/mixin'
 
+    # @since 0.4.0
+    include ::Enumerable
+
     # @since 0.1.0
     include DefinitionDSL
 
@@ -102,6 +105,33 @@ module SmartCore
       thread_safe { build_registry! }
     end
 
+    # @option all_variants [Boolean]
+    # @return [Array<String>]
+    #
+    # @api public
+    # @since 0.4.0
+    def keys(all_variants: SmartCore::Container::Registry::DEFAULT_KEY_EXTRACTION_BEHAVIOUR)
+      thread_safe { registry.keys(all_variants: all_variants) }
+    end
+
+    # @option yield_all [Boolean]
+    # @param block [Block]
+    # @yield [dependency_name, dependency_value]
+    # @yield_param dependency_name [String]
+    # @yield_param dependency_value [Any, SmartCore::Container]
+    # @return [Enumerable]
+    #
+    # @api public
+    # @since 0.4.0
+    def each_dependency(
+      yield_all: SmartCore::Container::Registry::DEFAULT_ITERATION_YIELD_BEHAVIOUR,
+      &block
+    )
+      thread_safe { registry.each_dependency(yield_all: yield_all, &block) }
+    end
+    alias_method :each, :each_dependency
+    alias_method :each_pair, :each_dependency
+
     # @option resolve_dependencies [Boolean]
     # @return [Hash<String|Symbol,SmartCore::Container::Entities::Base|Any>]
     #

data/lib/smart_core/container/dependency_resolver.rb

@@ -5,6 +5,12 @@
 module SmartCore::Container::DependencyResolver
   require_relative 'dependency_resolver/route'
 
+  # @return [String]
+  #
+  # @api private
+  # @since 0.4.0
+  PATH_PART_SEPARATOR = '.'
+
   class << self
     # @param container [SmartCore::Container]
     # @param dependency_path [String, Symbol]
@@ -84,10 +90,9 @@ module SmartCore::Container::DependencyResolver
     # @api private
     # @since 0.1.0
     def process_resolving_error(dependency_path, 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
+      full_dependency_path = Route.build_path(error.path_part)
+      message = "#{error.message} (incorrect path: \"#{full_dependency_path}\")"
+      raise(SmartCore::Container::ResolvingError.new(message, path_part: full_dependency_path))
     end
   end
 end

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

@@ -2,18 +2,13 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.4.0
 class SmartCore::Container::DependencyResolver::Route
   require_relative 'route/cursor'
 
   # @since 0.1.0
   include Enumerable
 
-  # @return [String]
-  #
-  # @api private
-  # @since 0.1.0
-  PATH_PART_SEPARATOR = '.'
-
   class << self
     # @param path [String, Symbol]
     # @return [SmartCore::Container::DependencyResolver::Route]
@@ -28,8 +23,9 @@ class SmartCore::Container::DependencyResolver::Route
     #
     # @api private
     # @since 0.1.0
+    # @version 0.4.0
     def build_path(*path_parts)
-      path_parts.join(PATH_PART_SEPARATOR)
+      path_parts.join(SmartCore::Container::DependencyResolver::PATH_PART_SEPARATOR)
     end
   end
 
@@ -50,9 +46,10 @@ class SmartCore::Container::DependencyResolver::Route
   #
   # @api private
   # @since 0.1.0
+  # @version 0.4.0
   def initialize(path)
     @path = path
-    @path_parts = path.split(PATH_PART_SEPARATOR).freeze
+    @path_parts = path.split(SmartCore::Container::DependencyResolver::PATH_PART_SEPARATOR).freeze
     @size = @path_parts.size
   end
 

data/lib/smart_core/container/errors.rb

@@ -57,7 +57,8 @@ class SmartCore::Container
     #
     # @api private
     # @since 0.1.0
-    def initialize(messegae = nil, path_part:)
+    # @version 0.4.0
+    def initialize(message = nil, path_part:)
       @path_part = path_part
       super(message)
     end

data/lib/smart_core/container/registry.rb

@@ -13,6 +13,18 @@ class SmartCore::Container::Registry
   # @since 0.3.0
   DEFAULT_MEMOIZATION_BEHAVIOR = false
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.4.0
+  DEFAULT_ITERATION_YIELD_BEHAVIOUR = false
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.4.0
+  DEFAULT_KEY_EXTRACTION_BEHAVIOUR = false
+
   # @return [Hash<Symbol,SmartCore::Container::Entity>]
   #
   # @api private
@@ -84,6 +96,30 @@ class SmartCore::Container::Registry
     thread_safe { enumerate(&block) }
   end
 
+  # @param root_dependency_name [NilClass, String]
+  # @option yield_all [Boolean]
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.4.0
+  def each_dependency(
+    root_dependency_name = nil,
+    yield_all: DEFAULT_ITERATION_YIELD_BEHAVIOUR,
+    &block
+  )
+    thread_safe { iterate(root_dependency_name, yield_all: yield_all, &block) }
+  end
+
+  # @option all_variants [Boolean]
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.4.0
+  def keys(all_variants: DEFAULT_KEY_EXTRACTION_BEHAVIOUR)
+    thread_safe { extract_keys(all_variants: all_variants) }
+  end
+
   # @return [Hash<String|Symbol,SmartCore::Container::Entities::Base|Any>]
   #
   # @api private
@@ -158,9 +194,8 @@ class SmartCore::Container::Registry
     dependency_name = indifferently_accessable_name(entity_path)
     registry.fetch(dependency_name)
   rescue KeyError
-    raise(SmartCore::Container::ResolvingError.new(<<~MESSAGE, path_part: dependency_name))
-      Entity with \"#{dependency_name}\" name does not exist
-    MESSAGE
+    error_message = "Entity with \"#{dependency_name}\" name does not exist"
+    raise(SmartCore::Container::ResolvingError.new(error_message, path_part: dependency_name))
   end
 
   # @param dependency_name [String, Symbol]
@@ -215,6 +250,58 @@ class SmartCore::Container::Registry
     namespace_entity.tap { namespace_entity.append_definitions(dependencies_definition) }
   end
 
+  # @param root_dependency_name [String, NilClass]
+  # @param block [Block]
+  # @option yield_all [Boolean]
+  # @yield [dependency_name, dependency]
+  # @yield_param dependency_name [String]
+  # @yield_param dependency [Any]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.4.0
+  def iterate(root_dependency_name = nil, yield_all: DEFAULT_ITERATION_YIELD_BEHAVIOUR, &block)
+    enumerator = Enumerator.new do |yielder|
+      registry.each_pair do |dependency_name, dependency|
+        final_dependency_name =
+          if root_dependency_name
+            "#{root_dependency_name}" \
+            "#{SmartCore::Container::DependencyResolver::PATH_PART_SEPARATOR}" \
+            "#{dependency_name}"
+          else
+            dependency_name
+          end
+
+        case dependency
+        when SmartCore::Container::Entities::Dependency
+          yielder.yield(final_dependency_name, dependency.reveal)
+        when SmartCore::Container::Entities::Namespace
+          yielder.yield(final_dependency_name, dependency.reveal) if yield_all
+          dependency.reveal.registry.each_dependency(
+            final_dependency_name,
+            yield_all: yield_all,
+            &block
+          )
+        end
+      end
+    end
+
+    block_given? ? enumerator.each(&block) : enumerator.each
+  end
+
+  # @option all_variants [Boolean]
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.4.0
+  def extract_keys(all_variants: DEFAULT_KEY_EXTRACTION_BEHAVIOUR)
+    Set.new.tap do |dependency_names|
+      iterate(yield_all: all_variants) do |dependency_name, _dependency|
+        dependency_names << dependency_name
+      end
+    end.to_a
+  end
+
   # @param name [String, Symbol]
   # @return [void]
   #

data/lib/smart_core/container/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_container
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_engine