smart_container 0.5.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92746ed446b181dc165a597563edc69b62b41550974023342c4693f2c17dee6a
-  data.tar.gz: 1cf3862c40c1044510a11e09f19df542a8d0b3a255bd0df5593ad9c531b9f10b
+  metadata.gz: 6a45cc16a5fa97c52b28570a75115e21765f771b58e43fc1a0bd90d39b3c8abe
+  data.tar.gz: e956a3ceaa496e4c7e023ac6310b93bc05525959f48619f0c31126d9097f7e83
 SHA512:
-  metadata.gz: ec6db288f98f769d0bbe96dd4d35186d1a199f6e046edf1de83a50c4b76149366c94a7c172a005378be88c8e8503436b9dad7e2518bcbae1de939b2a37204600
-  data.tar.gz: 9124de765215847cb7bd135a19524043652b9f9d7580027106a43cc6fa8f61a3bfd22c982cf07b1f46ea196b6fdae978d0973682a9c24511eb679d7c310b33a7
+  metadata.gz: d4d619d75a98601444c55ff7a278169e6b0937f0356ff19f8fcd41ba9c72d9f25c8ec0a077a90b87d77469605e542a5e5081aec5d9b0bf0c1718019902ad8166
+  data.tar.gz: cb220b711e67c661f7338ff6d49f82048df73861cadc0c1fdc981739d7c64ffec03953d397176c1d9e4e64321cdae078ca624fcb6ac51a8ccb92f4473b92fe83

data/.rubocop.yml

@@ -5,11 +5,16 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.4.9
+  TargetRubyVersion: 3.0.0
+  NewCops: enable
   Include:
     - lib/**/*.rb
     - spec/**/*.rb
     - Gemfile
     - Rakefile
-    - siege.gemspec
+    - smart_container.gemspec
     - bin/console
+
+Lint/EmptyBlock:
+  Exclude:
+    - spec/**/*.rb

data/CHANGELOG.md

@@ -1,6 +1,43 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.9.0] - 2020-01-17
+### Added
+- Support for *Ruby@3*;
+- Updated development dependencies;
+
+### Changed
+- No more TravisCI (todo: migrate to Github Actions);
+- Minimal `smart_engine` version: *0.11.0* (in order to support *Ruby@3*);
+
+## [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)`);

data/Gemfile.lock

@@ -1,83 +1,104 @@
 PATH
   remote: .
   specs:
-    smart_container (0.4.0)
-      smart_engine (~> 0.2)
+    smart_container (0.9.0)
+      smart_engine (~> 0.11)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    armitage-rubocop (0.78.0)
-      rubocop (= 0.78.0)
-      rubocop-performance (= 1.5.2)
-      rubocop-rails (= 2.4.1)
-      rubocop-rake (= 0.5.0)
-      rubocop-rspec (= 1.37.1)
-    ast (2.4.0)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    jaro_winkler (1.5.4)
-    json (2.3.0)
-    method_source (0.9.2)
-    parallel (1.19.1)
-    parser (2.7.0.1)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.0.8)
+    activesupport (6.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    armitage-rubocop (1.7.0.1)
+      rubocop (= 1.7.0)
+      rubocop-performance (= 1.9.1)
+      rubocop-rails (= 2.9.1)
+      rubocop-rake (= 0.5.1)
+      rubocop-rspec (= 2.1.0)
+    ast (2.4.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.1)
-    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)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.78.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.7.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rails (2.4.1)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.72.0)
-    rubocop-rake (0.5.0)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (1.37.1)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    simplecov (0.17.1)
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       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_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    smart_engine (0.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
-  armitage-rubocop (~> 0.78)
-  bundler (~> 2.1)
-  pry (~> 0.12)
+  armitage-rubocop (~> 1.7)
+  bundler (~> 2.2)
+  pry (~> 0.13)
   rake (~> 13.0)
-  rspec (~> 3.9)
-  simplecov (~> 0.17)
+  rspec (~> 3.10)
+  simplecov (~> 0.21)
   smart_container!
 
 BUNDLED WITH
-   2.1.2
+   2.2.3

data/README.md

@@ -1,4 +1,4 @@
-# SmartCore::Container · [![Gem Version](https://badge.fury.io/rb/smart_container.svg)](https://badge.fury.io/rb/smart_container) [![Build Status](https://travis-ci.org/smart-rb/smart_container.svg?branch=master)](https://travis-ci.org/smart-rb/smart_container)
+# SmartCore::Container · [![Gem Version](https://badge.fury.io/rb/smart_container.svg)](https://badge.fury.io/rb/smart_container)
 
 Thread-safe semanticaly-defined IoC/DI Container.
 
@@ -22,9 +22,27 @@ require 'smart_core/container'
 
 ---
 
-## Synopsis (demo)
+## Table of cotnents
+
+- [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)
 
-- container class creation:
+---
+
+## 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,20 +112,24 @@ container.fetch('database') # => SmartCore::Container (nested container)
 container.fetch('database.resolver') # => #<SomeDatabaseResolver:0x00007f0f0f1d6332>
 ```
 
-- runtime-level dependency/namespace registration:
+---
+
+#### runtime-level dependency/namespace registration
 
 ```ruby
 container.namespace(:api) do
-  register(:provider) { GoogleProvider }
+  register(:provider) { GoogleProvider } # without memoization
 end
 
-container.register('game_api') { 'overwatch' }
+container.register('game_api', memoize: true) { 'overwatch' } # with memoization
 
 container['api.provider'] # => GoogleProvider
 container['game_api'] # => 'overwatch'
 ```
 
-- container keys (dependency names):
+---
+
+#### container keys (dependency names):
 
 ```ruby
 # get dependnecy keys (only dependencies)
@@ -112,12 +158,15 @@ 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?
+---
+
+#### 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
@@ -136,13 +185,31 @@ container.dependency?('random', memoized: true) # => false
 container.dependency?('random', memoized: false) # => true
 ```
 
-- state freeze:
+---
+
+#### state freeze
+
+- state freeze (`#freeze!`, `.#frozen?`):
 
 ```ruby
 # documentation is coming;
 ```
 
-- reloading:
+---
+
+#### reloading
+
+- reloading (`#reload!`):
+
+```ruby
+# documentation is coming;
+```
+
+---
+
+#### hash tree
+
+- hash tree (`#hash_tree`, `#hash_tree(resolve_dependencies: true)`):
 
 ```ruby
 # documentation is coming;
@@ -150,6 +217,147 @@ container.dependency?('random', memoized: false) # => true
 
 ---
 
+#### 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
+
+- migrate to Github Actions;
+
+- 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);
+
+- inline temporary dependency switch:
+
+```ruby
+with(logger: Logger.new, db: DB.new) do
+  # logger is a new logger
+  # db is a new db
+end
+
+# out of block: logger is an old logger, db is an old db
+```
+
+---
+
 ## Contributing
 
 - Fork it ( https://github.com/smart-rb/smart_container/fork )