smart_container 0.4.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb1bc1e5f80263730638b0b0387105364777f87e957b5f673c27c219f206273d
-  data.tar.gz: 0d1a505edb3b4456ab44ecfe52071b1cb5555f51680d3a48de68fb12bd11dcad
+  metadata.gz: fbae5c2d40dc40e3114d685c1f13d6cbfb7003a1c8fda862ef5dbcfa432cf5cd
+  data.tar.gz: dd288fa47167c0da4e2aae656478170d0dd78b142eef52a351c461ddbc92bf29
 SHA512:
-  metadata.gz: 3959674748c1dcc2564bd6edc9ee0acdc3770b0bd260d50c7a1bba5906fee6725ff577e90a2b36b0a81910c423020431810b2a052f42c65826bfc8dcabe7dc22
-  data.tar.gz: f01f97eda299d91b22f730de1eba90e546f9f4de0362218bc0b8f86d8800acd6abf3d2214e223c0246f5c1d4b4742b71c7223ada409a3665765c088c88ab207e
+  metadata.gz: 27129a91c84f8aad432c5462c2d3a921284b2b8e3b1fb4b0a215295f6f88d94063946cc24f2d065f6da9ba6e64baf421f2a192b68fa63ebda879a81715e2c88f
+  data.tar.gz: 5e6839adcfe1e3c31513b622fc3e46aab37ab3ec35a992c8a3b9c7ff029c976dbf331619d3df20da7ffe3d712a8839f04ac83f3055f9e2426869e9b9ecf556f6

data/.rubocop.yml

@@ -5,11 +5,11 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.4.9
+  TargetRubyVersion: 2.7.1
   Include:
     - lib/**/*.rb
     - spec/**/*.rb
     - Gemfile
     - Rakefile
-    - siege.gemspec
+    - smart_container.gemspec
     - bin/console

data/.travis.yml

@@ -2,18 +2,19 @@
 language: ruby
 cache: bundler
 os: linux
+dist: xenial
 before_install:
-- gem install bundler -v 2.1.2
+- gem install bundler
 script:
 - bundle exec rake rubocop
 - bundle exec rake rspec
 jobs:
   fast_finish: true
   include:
-  - rvm: 2.4.9
-  - rvm: 2.5.7
-  - rvm: 2.6.5
-  - rvm: 2.7.0
+  - rvm: 2.4.10
+  - rvm: 2.5.8
+  - rvm: 2.6.6
+  - rvm: 2.7.1
   - rvm: ruby-head
   - rvm: jruby-head
   allow_failures:

data/CHANGELOG.md

@@ -1,6 +1,38 @@
 # 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:
+  - `#observe(path, &observer) # => observer object` - listen specific dependency path;
+  - `#unobserve(observer)` - unsubscribe concrete observer object;
+  - `#clear_observers(path = nil)` - unsubscribe specific listenr or all listeners (`nil` parameter);
+
+## [0.7.0] - 2020-06-20
+### Added
+- `SmartCore::Container.define {}` - an ability to avoid explicit class definition that allows
+  to create container instances from an anonymous container class imidietly
+
+## [0.6.0] - 2020-01-12
+### Added
+- Missing memoization flag `:memoize` for runtime-based dependency registration:
+  - `memoize: false` by default;
+  - signature: `SmartCore::Container#register(dependency_name, memoize: false, &dependency)`
+
+## [0.5.0] - 2020-01-07
+### Added
+- Key predicates (`#key?(key)`, `#dependency?(path, memoized: nil/true/false)`, `#namespace?(path)`);
+
 ## [0.4.0] - 2020-01-06
 ### Added
 - `#keys(all_variants: false)` - return a list of dependency keys

data/Gemfile.lock

@@ -1,83 +1,98 @@
 PATH
   remote: .
   specs:
-    smart_container (0.4.0)
-      smart_engine (~> 0.2)
+    smart_container (0.8.1)
+      smart_engine (~> 0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    armitage-rubocop (0.78.0)
-      rubocop (= 0.78.0)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    armitage-rubocop (0.81.0)
+      rubocop (= 0.81.0)
       rubocop-performance (= 1.5.2)
-      rubocop-rails (= 2.4.1)
-      rubocop-rake (= 0.5.0)
-      rubocop-rspec (= 1.37.1)
+      rubocop-rails (= 2.5.2)
+      rubocop-rake (= 0.5.1)
+      rubocop-rspec (= 1.38.1)
     ast (2.4.0)
     coderay (1.1.2)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
     docile (1.3.2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    json (2.3.0)
-    method_source (0.9.2)
+    method_source (1.0.0)
+    minitest (5.14.0)
     parallel (1.19.1)
-    parser (2.7.0.1)
+    parser (2.7.1.0)
       ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.0.8)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.2)
     rainbow (3.0.0)
     rake (13.0.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
     rspec-core (3.9.1)
       rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.78.0)
+    rubocop (0.81.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
-    rubocop-rails (2.4.1)
+    rubocop-rails (2.5.2)
+      activesupport
       rack (>= 1.1)
       rubocop (>= 0.72.0)
-    rubocop-rake (0.5.0)
+    rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (1.37.1)
+    rubocop-rspec (1.38.1)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
-    simplecov (0.17.1)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    smart_engine (0.2.0)
-    unicode-display_width (1.6.0)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    smart_engine (0.7.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  armitage-rubocop (~> 0.78)
+  armitage-rubocop (~> 0.81)
   bundler (~> 2.1)
-  pry (~> 0.12)
+  pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.9)
-  simplecov (~> 0.17)
+  simplecov (~> 0.18)
   smart_container!
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -22,9 +22,27 @@ require 'smart_core/container'
 
 ---
 
-## Synopsis (demo)
+## Table of cotnents
 
-- container class creation:
+- [Functionality](#functionality)
+  - [container class creation](#container-class-creation)
+  - [mixin](#mixin)
+  - [container instantiation and dependency resolving](#container-instantiation-and-dependency-resolving)
+  - [runtime-level dependency/namespace registration](#runtime-level-dependencynamespace-registration)
+  - [container keys (dependency names)](#container-keys-dependency-names)
+  - [key predicates](#key-predicates)
+  - [state freeze](#state-freeze)
+  - [reloading](#reloading)
+  - [hash tree](#hash-tree)
+  - [explicit class definition](#explicit-class-definition)
+  - [subscribe to dependency changements](#subscribe-to-dependency-changements)
+- [Roadmap](#roadmap)
+
+---
+
+## Functionality
+
+#### container class creation
 
 ```ruby
 class Container < SmartCore::Container
@@ -45,7 +63,31 @@ class Container < SmartCore::Container
 end
 ```
 
-- container instantiation and dependency resolving:
+---
+
+#### mixin
+
+```ruby
+# full documentaiton is coming;
+
+class Application
+  include SmartCore::Container::Mixin
+
+  dependencies do
+    namespace(:database) do
+      register(:cache) { MemcachedClient.new }
+    end
+  end
+end
+
+# access:
+Application.container
+Application.new.container # NOTE: the same instance as Application.container
+```
+
+---
+
+#### container instantiation and dependency resolving
 
 ```ruby
 container = Container.new # create container instance
@@ -70,7 +112,24 @@ container.fetch('database') # => SmartCore::Container (nested container)
 container.fetch('database.resolver') # => #<SomeDatabaseResolver:0x00007f0f0f1d6332>
 ```
 
-- container keys (dependency names):
+---
+
+#### runtime-level dependency/namespace registration
+
+```ruby
+container.namespace(:api) do
+  register(:provider) { GoogleProvider } # without memoization
+end
+
+container.register('game_api', memoize: true) { 'overwatch' } # with memoization
+
+container['api.provider'] # => GoogleProvider
+container['game_api'] # => 'overwatch'
+```
+
+---
+
+#### container keys (dependency names):
 
 ```ruby
 # get dependnecy keys (only dependencies)
@@ -101,6 +160,191 @@ container.keys(all_variants: true)
 
 ---
 
+#### key predicates
+
+- `key?(key)` - has dependency or namespace?
+- `namespace?(path)` - has namespace?
+- `dependency?(path)` - has dependency?
+- `dependency?(path, memoized: true)` - has memoized dependency?
+- `dependency?(path, memoized: false)` - has non-memoized dependency?
+
+```ruby
+container.key?('database') # => true
+container.key?('database.cache.memcached') # => true
+
+container.dependency?('database') # => false
+container.dependency?('database.resolver') # => true
+
+container.namespace?('database') # => true
+container.namespace?('database.resolver') # => false
+
+container.dependency?('database.resolver', memoized: true) # => true
+container.dependency?('database.resolver', memoized: false) # => false
+
+container.dependency?('random', memoized: true) # => false
+container.dependency?('random', memoized: false) # => true
+```
+
+---
+
+#### state freeze
+
+- state freeze (`#freeze!`, `.#frozen?`):
+
+```ruby
+# documentation is coming;
+```
+
+---
+
+#### reloading
+
+- reloading (`#reload!`):
+
+```ruby
+# documentation is coming;
+```
+
+---
+
+#### hash tree
+
+- hash tree (`#hash_tree`, `#hash_tree(resolve_dependencies: true)`):
+
+```ruby
+# documentation is coming;
+```
+
+---
+
+#### explicit class definition
+
+- `SmartCore::Container.define` - avoid explicit class definition (allows to create container instance from an anonymous container class immidietly):
+
+```ruby
+# - create from empty container class -
+
+AppContainer = SmartCore::Container.define do
+  namespace :database do
+    register(:logger) { Logger.new }
+  end
+end # => an instance of Class<SmartCore::Container>
+
+AppContainer.resolve('database.logger') # => #<Logger:0x00007f5f0f2f0158>
+AppContainer['database.logger'] # => #<Logger:0x00007f5f0f2f0158>
+```
+
+```ruby
+# - create from another container class with a custom sub-definitions -
+
+class BasicContainer < SmartCore::Container
+  namespace(:api) do
+    register(:client) { Kickbox.new }
+  end
+end
+
+AppContainer = BasicContainer.define do
+  register(:db_driver) { Sequel }
+end
+# --- or ---
+AppContainer = SmartCore::Container.define(BasicContainer) do
+  register(:db_driver) { Sequel }
+end
+
+AppContainer['api.client'] # => #<Kickbox:0x00007f5f0f2f0158> (BasicContainer dependency)
+AppContainer['db_driver'] # => Sequel (AppContainer dependency)
+```
+
+---
+
+#### subscribe to dependency changements
+
+- features and limitations:
+  - you can subscribe only on container instances (on container instance changements);
+  - at this moment only the full entity path patterns are supported (pattern-based pathes are not supported yet);
+  - you can subscribe on namespace changements (when the full namespace is re-registered) and dependency changement (when some dependency has been changed);
+  - `#observe(path, &observer) => observer` - subscribe a custom block to dependency changement events (your proc will be invoked with `|path, container|` attributes);
+  - `#unobserve(observer)` - unsubscribe concrete observer from dependency observing (returns `true` (unsubscribed) or `false` (nothing to unsubscribe));
+  - `#clear_observers(entity_path = nil)` - unsubscribe all observers from concrete path or from all pathes (`nil` parameters);
+- aliases:
+  - `#observe` => `#subscribe`;
+  - `#unobserve` => `#unsubscribe`;
+  - `#clear_observers` => `#clear_listeners`;
+
+```ruby
+container = SmartCore::Container.define do
+  namespace(:database) do
+    register(:stats) { 'stat_db' }
+  end
+end
+```
+
+```ruby
+# observe entity change
+entity_observer = container.observe('database.stats') do |dependency_path, container|
+  puts "changed => '#{container[dependency_path]}'"
+end
+
+# observe namespace change
+namespace_observer = container.observe('database') do |namespace_path, container|
+  puts "changed => '#{namespace_path}'"
+end
+```
+
+```ruby
+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.fetch('database').register('stats') = 'pek' # no one to listen this changement... :)
+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
+container.observe('path.*') { puts 'kek!' } # subscribe to all changements in `path` namespace;
+```
+
+- support for instant dependency registration:
+
+```ruby
+# common (dynamic) way:
+register('dependency_name') { dependency_value }
+
+# instant way:
+register('dependency_name', dependency_value)
+```
+
+- support for memoization ignorance during dependency resolving:
+
+```ruby
+resolve('logger', :allocate) # Draft
+```
+
+- container composition;
+
+- support for fallback block in `.resolve` operation (similar to `Hash#fetch` works);
+
+---
+
 ## Contributing
 
 - Fork it ( https://github.com/smart-rb/smart_container/fork )