smart_container 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 238540cd0bdf9e1753b190d639cf1b0de8876ec5fbe5c5b152235543177079e5
-  data.tar.gz: aab0620b71b507954e40a3b6e92aee2928432624c3db32b8fdde2a2c7c09a347
+  metadata.gz: 8724a62bc6365606a5b796bac2899c5ddba96c179548878f12e324291b6862a3
+  data.tar.gz: 769c81de665be07979bbeb8026398ff6cf6e8885159cbe6ab1aff52d07a64095
 SHA512:
-  metadata.gz: 21c636030e9b8911c7af18af53d4450676fdf7ca14d3438354bf6da7b0c3375441ee06099fb06774cef311930e418e3d9b95c1b1528826b6f291cef82140195c
-  data.tar.gz: 9e45275d4c8cea45fc87590650f67b1b677ce44a3b1e3524206e7ebf6ec3dc8f29d6cd3e1e5a0c409a6a5f21cfc268ae65c9c82e51a59dac9154f41fd8dc289f
+  metadata.gz: b1f138811f9b345b2f735b4f90e06d44ef83b955358e78b786becb9e2d73144de113cbfc0b08d765c245a7c1a4889bba8f5c3ed63219f28fa312554f8834d1ae
+  data.tar.gz: 69da3a3c4ac8b5d34243a617dff6614654a9c116ef7270f7f313127dafe973a2d102143df21fcad222bb9d94499606f983835b74e711a9c823934c58c8bc42a2

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.2.0] - 202-01-05
+### Changed
+- (Private API (`SmartCore::Container::RegistryBuilder`)) improved semantics:
+  - `build_state` is renamed to `initialise`;
+  - `build_definitions` is renamed to `define`;
+- (Public API) Support for memoized dependencies (all dependencies are memoized by default)
+  ```ruby
+  class MyContainer < SmartCore::Container
+    namespace(:some_naespace) do
+      # memoized by default
+      register(:random_number) { rand(1000) }
+      # explicit memoization
+      register(:random_number, memoized: true) { rand(1000) }
+
+      # register non-memoizable dependency
+      register(:random_number, memoized: false) { rand(1000) }
+    end
+  end
+  ```
+
 ## [0.1.0] - 2020-01-02
 
 - Release :)

data/Gemfile.lock

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

data/README.md

@@ -22,6 +22,39 @@ require 'smart_core/container'
 
 ---
 
+## Synopsis (demo)
+
+```ruby
+class Container < SmartCore::Container
+  namespace(:database) do # support for namespaces
+    register(:resolver) { SomeDatabaseResolver.new } # dependency registration
+
+    namespace(:cache) do # support for nested naespaces
+      register(:memcached) { MemcachedClient.new }
+      register(:redis) { RedisClient.new }
+    end
+  end
+
+  # root dependencies
+  register(:logger) { Logger.new(STDOUT) }
+
+  # do not memoize registered object
+  register(:random, memoize: false) { rand(1000) }
+end
+
+container = Container.new # create container instance
+
+container['database.resolver'] # => #<SomeDatabaseResolver:0x00007f0f0f1d6332>
+container['database.cache.redis'] # => #<RedisClient:0x00007f0f0f1d0158>
+container['logger'] # => #<Logger:0x00007f5f0f2f0158>
+
+# non-memoized dependency
+container['random'] # => 352
+container['random'] # => 57
+```
+
+---
+
 ## Contributing
 
 - Fork it ( https://github.com/smart-rb/smart_container/fork )

data/lib/smart_core/container/definition_dsl.rb

@@ -63,17 +63,19 @@ class SmartCore::Container
       end
 
       # @param dependency_name [String, Symbol]
+      # @option memoize [Boolean]
       # @param dependency_definition [Block]
       # @return [void]
       #
       # @api public
       # @since 0.1.0
-      def register(dependency_name, &dependency_definition)
+      # @version 0.2.0
+      def register(dependency_name, memoize: true, &dependency_definition)
         @__container_definition_lock__.thread_safe do
           DependencyCompatability::Definition.prevent_namespace_overlap!(self, dependency_name)
 
           __container_definition_commands__ << Commands::Definition::Register.new(
-            dependency_name, dependency_definition
+            dependency_name, dependency_definition, memoize
           )
         end
       end

data/lib/smart_core/container/definition_dsl/commands/definition/compose.rb

@@ -27,7 +27,7 @@ module SmartCore::Container::DefinitionDSL::Commands::Definition
     # @api private
     # @since 0.1.0
     def call(registry)
-      SmartCore::Container::RegistryBuilder.build_definitions(container_klass, registry)
+      SmartCore::Container::RegistryBuilder.define(container_klass, registry)
     end
 
     # @return [SmartCore::Container::DefinitionDSL::Commands::Definition::Compose]

data/lib/smart_core/container/definition_dsl/commands/definition/register.rb

@@ -15,14 +15,17 @@ module SmartCore::Container::DefinitionDSL::Commands::Definition
 
     # @param dependency_name [String, Symbol]
     # @param dependency_definition [Proc]
+    # @param memoize [Boolean]
     # @return [void]
     #
     # @api private
     # @since 0.1.0
-    def initialize(dependency_name, dependency_definition)
+    # @version 0.2.0
+    def initialize(dependency_name, dependency_definition, memoize)
       SmartCore::Container::KeyGuard.indifferently_accessable_key(dependency_name).tap do |name|
         @dependency_name = name
         @dependency_definition = dependency_definition
+        @memoize = memoize
       end
     end
 
@@ -31,16 +34,18 @@ module SmartCore::Container::DefinitionDSL::Commands::Definition
     #
     # @api private
     # @since 0.1.0
+    # @version 0.2.0
     def call(registry)
-      registry.register_dependency(dependency_name, &dependency_definition)
+      registry.register_dependency(dependency_name, memoize, &dependency_definition)
     end
 
     # @return [SmartCore::Container::DefinitionDSL::Commands::Definition::Register]
     #
     # @api private
     # @since 0.1.0
+    # @version 0.2.0
     def dup
-      self.class.new(dependency_name, dependency_definition)
+      self.class.new(dependency_name, dependency_definition, memoize)
     end
 
     private
@@ -50,5 +55,11 @@ module SmartCore::Container::DefinitionDSL::Commands::Definition
     # @api private
     # @since 0.1.0
     attr_reader :dependency_definition
+
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.2.0
+    attr_reader :memoize
   end
 end

data/lib/smart_core/container/definition_dsl/commands/instantiation/compose.rb

@@ -27,7 +27,7 @@ module SmartCore::Container::DefinitionDSL::Commands::Instantiation
     # @api private
     # @since 0.1.0
     def call(registry)
-      SmartCore::Container::RegistryBuilder.build_state(
+      SmartCore::Container::RegistryBuilder.instantiate(
         container_klass, registry, ignored_commands: [
           SmartCore::Container::DefinitionDSL::Commands::Instantiation::FreezeState
         ]

data/lib/smart_core/container/entities.rb

@@ -5,6 +5,7 @@
 module SmartCore::Container::Entities
   require_relative 'entities/base'
   require_relative 'entities/dependency'
+  require_relative 'entities/memoized_dependency'
   require_relative 'entities/dependency_builder'
   require_relative 'entities/namespace'
   require_relative 'entities/namespace_builder'

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

@@ -6,32 +6,38 @@ class SmartCore::Container::Entities::DependencyBuilder
   class << self
     # @param dependency_name [String]
     # @param dependency_definition [Proc]
+    # @param memoize [Boolean]
     # @return [SmartCore::Container::Entities::Dependency]
     #
     # @api private
     # @since 0.1.0
-    def build(dependency_name, dependency_definition)
-      new(dependency_name, dependency_definition).build
+    # @version 0.2.0
+    def build(dependency_name, dependency_definition, memoize)
+      new(dependency_name, dependency_definition, memoize).build
     end
   end
 
   # @param dependency_name [String]
   # @param dependency_definition [Proc]
+  # @param memoize [Boolean]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def initialize(dependency_name, dependency_definition)
+  # @version 0.2.0
+  def initialize(dependency_name, dependency_definition, memoize)
     @dependency_name = dependency_name
     @dependency_definition = dependency_definition
+    @memoize = memoize
   end
 
   # @return [SmartCore::Container::Entities::Dependency]
   #
   # @api private
   # @since 0.1.0
+  # @version 0.2.0
   def build
-    SmartCore::Container::Entities::Dependency.new(dependency_name, dependency_definition)
+    memoize ? build_memoized_dependency : build_original_dependency
   end
 
   private
@@ -47,4 +53,26 @@ class SmartCore::Container::Entities::DependencyBuilder
   # @api private
   # @since 0.1.0
   attr_reader :dependency_definition
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :memoize
+
+  # @return [SmartCore::Container::Entities::Dependency]
+  #
+  # @api private
+  # @since 0.2.0
+  def build_memoized_dependency
+    SmartCore::Container::Entities::MemoizedDependency.new(dependency_name, dependency_definition)
+  end
+
+  # @return [SmartCore::Container::Entities::Dependency]
+  #
+  # @api private
+  # @since 0.2.0
+  def build_original_dependency
+    SmartCore::Container::Entities::Dependency.new(dependency_name, dependency_definition)
+  end
 end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module SmartCore::Container::Entities
+  # @api private
+  # @since 0.2.0
+  class MemoizedDependency < Dependency
+    # @param dependency_name [String]
+    # @param dependency_definition [Proc]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.2.0
+    def initialize(dependency_name, dependency_definition)
+      super(dependency_name, dependency_definition)
+      @lock = SmartCore::Container::ArbitaryLock.new
+    end
+
+    # @return [Any]
+    #
+    # @api private
+    # @since 0.2.0
+    def reveal
+      @lock.thread_safe do
+        unless instance_variable_defined?(:@revealed_dependency)
+          @revealed_dependency = dependency_definition.call
+        else
+          @revealed_dependency
+        end
+      end
+    end
+
+    private
+
+    # @return [Proc]
+    #
+    # @api private
+    # @since 0.2.0
+    attr_reader :dependency_definition
+  end
+end

data/lib/smart_core/container/registry.rb

@@ -32,13 +32,15 @@ class SmartCore::Container::Registry
   end
 
   # @param name [String, Symbol]
+  # @param memoize [Boolean]
   # @param dependency_definition [Block]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def register_dependency(name, &dependency_definition)
-    thread_safe { add_dependency(name, dependency_definition) }
+  # @version 0.2.0
+  def register_dependency(name, memoize = true, &dependency_definition)
+    thread_safe { add_dependency(name, dependency_definition, memoize) }
   end
 
   # @param name [String, Symbol]
@@ -157,13 +159,15 @@ class SmartCore::Container::Registry
 
   # @param dependency_name [String, Symbol]
   # @param dependency_definition [Proc]
+  # @param memoize [Boolean]
   # @return [SmartCore::Container::Entities::Dependency]
   #
   # @raise [SmartCore::Container::DependencyOverNamespaceOverlapError]
   #
   # @api private
   # @since 0.1.0
-  def add_dependency(dependency_name, dependency_definition)
+  # @version 0.2.0
+  def add_dependency(dependency_name, dependency_definition, memoize)
     if state_frozen?
       raise(SmartCore::Container::FrozenRegistryError, 'Can not modify frozen registry!')
     end
@@ -171,7 +175,7 @@ class SmartCore::Container::Registry
     prevent_namespace_overlap!(dependency_name)
 
     dependency_entity = SmartCore::Container::Entities::DependencyBuilder.build(
-      dependency_name, dependency_definition
+      dependency_name, dependency_definition, memoize
     )
 
     dependency_entity.tap { registry[dependency_name] = dependency_entity }

data/lib/smart_core/container/registry_builder.rb

@@ -14,8 +14,8 @@ module SmartCore::Container::RegistryBuilder
     # @since 0.1.0
     def build(container, ignored_definition_commands: [], ignored_instantiation_commands: [])
       SmartCore::Container::Registry.new.tap do |registry|
-        build_definitions(container.class, registry, ignored_commands: ignored_definition_commands)
-        build_state(container.class, registry, ignored_commands: ignored_instantiation_commands)
+        define(container.class, registry, ignored_commands: ignored_definition_commands)
+        instantiate(container.class, registry, ignored_commands: ignored_instantiation_commands)
       end
     end
 
@@ -26,7 +26,7 @@ module SmartCore::Container::RegistryBuilder
     #
     # @api private
     # @since 0.1.0
-    def build_definitions(container_klass, registry, ignored_commands: [])
+    def define(container_klass, registry, ignored_commands: [])
       container_klass.__container_definition_commands__.each do |command|
         next if ignored_commands.include?(command.class)
         command.call(registry)
@@ -40,7 +40,7 @@ module SmartCore::Container::RegistryBuilder
     #
     # @api private
     # @since 0.1.0
-    def build_state(container_klass, registry, ignored_commands: [])
+    def instantiate(container_klass, registry, ignored_commands: [])
       container_klass.__container_instantiation_commands__.each do |command|
         next if ignored_commands.include?(command.class)
         command.call(registry)

data/lib/smart_core/container/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_container
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2020-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_engine
@@ -153,6 +153,7 @@ files:
 - lib/smart_core/container/entities/base.rb
 - lib/smart_core/container/entities/dependency.rb
 - lib/smart_core/container/entities/dependency_builder.rb
+- lib/smart_core/container/entities/memoized_dependency.rb
 - lib/smart_core/container/entities/namespace.rb
 - lib/smart_core/container/entities/namespace_builder.rb
 - lib/smart_core/container/errors.rb