dry-container 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dc623285b4e64816e0bea0c4668ab012291e234
-  data.tar.gz: 8fa2abd26fa7064d7765cc7cc27a75e01190888b
+  metadata.gz: 746334a72c7c6dbc33c55a831bc0b6be199d5307
+  data.tar.gz: 2c86a308642567d9dbc2d91330fd86f5f5dcd7e2
 SHA512:
-  metadata.gz: c2dfecb1010dc1a4325ca8dd6842d157a127427895802fe133b41c6bb7ff2605a059be69a78a7d5bd7a0c11e96202d2ad7f42c39a0017cedb29b5c6d68fe8d31
-  data.tar.gz: 006d27b613370ba76c9d0301286cf7038c8141afe7d3f4c5f835245c1e68ae76aff2b6a70e82c0b5452ad79e6623b166e5b0e2880c147afdf8b495ce9c6a81c2
+  metadata.gz: bfd4c3abb602f546e0abdf5e4ff39cdd8abb20ef16b8eea97896fdf6b8fed34324556b9150883c351cd8736493e9d2defb5159a2a5c47223403689e94a0e9d95
+  data.tar.gz: fd568448c7ccbb98bb0049b66878b6eccddca1d3db95c47cf3ffea365f5bd6f514eaed861b142a9e77151c9dab04f15566b9e401a5ca58a69a60f9edbb1af3f5

data/.rubocop.yml

@@ -10,3 +10,11 @@ Style/Documentation:
 Lint/HandleExceptions:
   Exclude:
     - rakelib/*.rake
+
+Lint/NestedMethodDefinition:
+  Exclude:
+    - lib/dry/container/mixin.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/dry/container/mixin.rb

data/.rubocop_todo.yml

@@ -1,11 +1,6 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-06-10 01:03:27 +0100 using RuboCop version 0.26.0.
+# on 2015-06-16 19:51:19 +0100 using RuboCop version 0.32.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 14

data/.travis.yml

@@ -20,3 +20,5 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
+notifications:
+  email: false

data/LICENSE

@@ -18,4 +18,3 @@ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-s

data/README.md

@@ -4,7 +4,7 @@
 <a href="https://travis-ci.org/dryrb/dry-container" target="_blank">![Build Status](https://travis-ci.org/dryrb/dry-container.svg?branch=master)</a>
 <a href="http://inch-ci.org/github/dryrb/dry-container" target="_blank">![Inline docs](http://inch-ci.org/github/dryrb/dry-container.svg?branch=master&style=flat)</a>
 
-A simple IoC container implemented in Ruby
+A simple, configurable container implemented in Ruby
 
 ## Synopsis
 
@@ -69,6 +69,36 @@ container.register(:item, :my_item)
 container.resolve(:item)
 # => :my_item
 ```
+### Using a custom registry/resolver
+
+You can configure how items are registered and resolved from the container:
+
+```ruby
+Dry::Container.configure do |config|
+  config.registry = ->(container, key, item, options) { container[key] = item }
+  config.resolver = ->(key) { container[key] }
+end
+
+class Container
+  extend Dry::Container::Mixin
+
+  configure do |config|
+    config.registry = ->(container, key, item, options) { container[key] = item }
+    config.resolver = ->(key) { container[key] }
+  end
+end
+
+class ContainerObject
+  include Dry::Container::Mixin
+
+  configure do |config|
+    config.registry = ->(container, key, item, options) { container[key] = item }
+    config.resolver = ->(key) { container[key] }
+  end
+end
+```
+
+This allows you to customise the behaviour of Dry::Container, for example, the default registry (Dry::Container::Registry) will raise a Dry::Container::Error exception if you try to register under a key that is already used, you may want to just overwrite the existing value in that scenario, configuration allows you to do so.
 
 ## License
 

data/dry-container.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'thread_safe'
+  spec.add_runtime_dependency 'dry-configurable', '0.1.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/lib/dry/container.rb

@@ -1,6 +1,9 @@
 require 'thread_safe'
+require 'dry/configurable'
 require 'dry/container/error'
 require 'dry/container/item'
+require 'dry/container/registry'
+require 'dry/container/resolver'
 require 'dry/container/mixin'
 require 'dry/container/version'
 

data/lib/dry/container/mixin.rb

@@ -26,13 +26,37 @@ module Dry
     module Mixin
       # @private
       def self.extended(base)
-        base.instance_variable_set(:@_mutex, Mutex.new)
+        base.class_eval do
+          extend ::Dry::Configurable
+
+          setting :registry, Registry.new
+          setting :resolver, Resolver.new
+
+          @_container = ThreadSafe::Cache.new
+
+          class << self
+            attr_reader :_container
+          end
+        end
       end
       # @private
       def self.included(base)
-        base.send(:define_method, :initialize) do |*args, &block|
-          @_mutex = Mutex.new
-          super(*args, &block)
+        base.class_eval do
+          extend ::Dry::Configurable
+
+          setting :registry, Registry.new
+          setting :resolver, Resolver.new
+
+          attr_reader :_container
+
+          def initialize(*args, &block)
+            @_container = ThreadSafe::Cache.new
+            super(*args, &block)
+          end
+
+          def config
+            self.class.config
+          end
         end
       end
       # Register an item with the container to be resolved later
@@ -42,15 +66,11 @@ module Dry
       # @param [Mixed] contents
       #   The item to register with the container (if no block given)
       # @param [Hash] options
-      # @option options [Symbol] :call
-      #   Whether the item should be called when resolved
+      #   Options to pass to the registry when registering the item
       # @yield
       #   If a block is given, contents will be ignored and the block
       #   will be registered instead
       #
-      # @raise [Dry::Conainer::Error]
-      #   If an item is already registered with the given key
-      #
       # @return [Dry::Container] self
       #
       # @api public
@@ -62,11 +82,7 @@ module Dry
           item = contents
         end
 
-        if _container.key?(key)
-          fail Error, "There is already an item registered with the key #{key.inspect}"
-        else
-          _container[key] = Item.new(item, options)
-        end
+        config.registry.call(_container, key, item, options)
 
         self
       end
@@ -75,18 +91,11 @@ module Dry
       # @param [Mixed] key
       #   The key for the item you wish to resolve
       #
-      # @raise [Dry::Conainer::Error]
-      #   If the given key is not registered with the container
-      #
       # @return [Mixed]
       #
       # @api public
       def resolve(key)
-        item = _container.fetch(key) do
-          fail Error, "Nothing registered with the key #{key.inspect}"
-        end
-
-        item.call
+        config.resolver.call(_container, key)
       end
       # Resolve an item from the container
       #
@@ -99,13 +108,6 @@ module Dry
       def [](key)
         resolve(key)
       end
-
-      private
-
-      # @private
-      def _container
-        @_mutex.synchronize { @_container ||= ThreadSafe::Cache.new }
-      end
     end
   end
 end

data/lib/dry/container/registry.rb

@@ -0,0 +1,40 @@
+module Dry
+  class Container
+    # Default registry for registering items with the container
+    #
+    # @api public
+    class Registry
+      # @private
+      def initialize
+        @_mutex = Mutex.new
+      end
+      # Register an item with the container to be resolved later
+      #
+      # @param [ThreadSafe::Hash] container
+      #   The container
+      # @param [Mixed] key
+      #   The key to register the container item with (used to resolve)
+      # @param [Mixed] item
+      #   The item to register with the container
+      # @param [Hash] options
+      # @option options [Symbol] :call
+      #   Whether the item should be called when resolved
+      #
+      # @raise [Dry::Conainer::Error]
+      #   If an item is already registered with the given key
+      #
+      # @return [Mixed]
+      #
+      # @api public
+      def call(container, key, item, options)
+        @_mutex.synchronize do
+          if container.key?(key)
+            fail Error, "There is already an item registered with the key #{key.inspect}"
+          else
+            container[key] = Item.new(item, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/container/resolver.rb

@@ -0,0 +1,29 @@
+module Dry
+  class Container
+    # Default resolver for resolving items from container
+    #
+    # @api public
+    class Resolver
+      # Resolve an item from the container
+      #
+      # @param [ThreadSafe::Hash] container
+      #   The container
+      # @param [Mixed] key
+      #   The key for the item you wish to resolve
+      #
+      # @raise [Dry::Conainer::Error]
+      #   If the given key is not registered with the container
+      #
+      # @return [Mixed]
+      #
+      # @api public
+      def call(container, key)
+        item = container.fetch(key) do
+          fail Error, "Nothing registered with the key #{key.inspect}"
+        end
+
+        item.call
+      end
+    end
+  end
+end

data/lib/dry/container/version.rb

@@ -1,6 +1,6 @@
 module Dry
   class Container
     # @api public
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/spec/integration/container_spec.rb

@@ -1,5 +1,6 @@
 RSpec.describe Dry::Container do
-  let(:container) { Dry::Container.new }
+  let(:klass) { Dry::Container }
+  let(:container) { klass.new }
 
   it_behaves_like 'a container'
 end

data/spec/integration/mixin_spec.rb

@@ -1,16 +1,18 @@
 RSpec.describe Dry::Container::Mixin do
   describe 'extended' do
-    let(:container) do
+    let(:klass) do
       Class.new { extend Dry::Container::Mixin }
     end
+    let(:container) { klass }
 
     it_behaves_like 'a container'
   end
 
   describe 'included' do
-    let(:container) do
-      Class.new { include Dry::Container::Mixin }.new
+    let(:klass) do
+      Class.new { include Dry::Container::Mixin }
     end
+    let(:container) { klass.new }
 
     it_behaves_like 'a container'
   end

data/spec/support/shared_examples/container.rb

@@ -1,76 +1,153 @@
 shared_examples 'a container' do
-  describe 'registering a block' do
-    context 'without options' do
-      it 'registers and resolves an object' do
-        container.register(:item) { 'item' }
+  describe 'configuration' do
+    describe 'registry' do
+      describe 'default' do
+        it { expect(klass.config.registry).to be_a(Dry::Container::Registry) }
+      end
+
+      describe 'custom' do
+        let(:custom_registry) { double('Registry') }
+        let(:key) { :key }
+        let(:item) { :item }
+        let(:options) { {} }
+
+        before do
+          klass.configure do |config|
+            config.registry = custom_registry
+          end
+
+          allow(custom_registry).to receive(:call)
+        end
 
-        expect(container.resolve(:item)).to eq('item')
+        after do
+          # HACK: Have to reset the configuration so that it doesn't
+          # interfere with other specs
+          klass.configure do |config|
+            config.registry = Dry::Container::Registry.new
+          end
+        end
+
+        subject! { container.register(key, item, options) }
+
+        it do
+          expect(custom_registry).to have_received(:call).with(
+            container._container,
+            key,
+            item,
+            options
+          )
+        end
       end
     end
 
-    context 'with option call: false' do
-      it 'registers and resolves a proc' do
-        container.register(:item, call: false) { 'item' }
+    describe 'resolver' do
+      describe 'default' do
+        it { expect(klass.config.resolver).to be_a(Dry::Container::Resolver) }
+      end
 
-        expect(container.resolve(:item).call).to eq('item')
-        expect(container[:item].call).to eq('item')
+      describe 'custom' do
+        let(:custom_resolver) { double('Resolver') }
+        let(:item) { double('Item') }
+        let(:key) { :key }
+
+        before do
+          klass.configure do |config|
+            config.resolver = custom_resolver
+          end
+
+          allow(custom_resolver).to receive(:call).and_return(item)
+        end
+
+        after do
+          # HACK: Have to reset the configuration so that it doesn't
+          # interfere with other specs
+          klass.configure do |config|
+            config.resolver = Dry::Container::Resolver.new
+          end
+        end
+
+        subject! { container.resolve(key) }
+
+        it { expect(custom_resolver).to have_received(:call).with(container._container, key) }
+        it { is_expected.to eq(item) }
       end
     end
   end
 
-  describe 'registering a proc' do
-    context 'without options' do
-      it 'registers and resolves an object' do
-        container.register(:item, proc { 'item' })
+  context 'with default configuration' do
+    describe 'registering a block' do
+      context 'without options' do
+        it 'registers and resolves an object' do
+          container.register(:item) { 'item' }
 
-        expect(container.resolve(:item)).to eq('item')
-        expect(container[:item]).to eq('item')
+          expect(container.resolve(:item)).to eq('item')
+        end
       end
-    end
 
-    context 'with option call: false' do
-      it 'registers and resolves a proc' do
-        container.register(:item, proc { 'item' }, call: false)
+      context 'with option call: false' do
+        it 'registers and resolves a proc' do
+          container.register(:item, call: false) { 'item' }
 
-        expect(container.resolve(:item).call).to eq('item')
-        expect(container[:item].call).to eq('item')
+          expect(container.resolve(:item).call).to eq('item')
+          expect(container[:item].call).to eq('item')
+        end
       end
     end
-  end
 
-  describe 'registering an object' do
-    context 'without options' do
-      it 'registers and resolves the object' do
-        item = 'item'
-        container.register(:item, item)
+    describe 'registering a proc' do
+      context 'without options' do
+        it 'registers and resolves an object' do
+          container.register(:item, proc { 'item' })
 
-        expect(container.resolve(:item)).to be(item)
-        expect(container[:item]).to be(item)
+          expect(container.resolve(:item)).to eq('item')
+          expect(container[:item]).to eq('item')
+        end
+      end
+
+      context 'with option call: false' do
+        it 'registers and resolves a proc' do
+          container.register(:item, proc { 'item' }, call: false)
+
+          expect(container.resolve(:item).call).to eq('item')
+          expect(container[:item].call).to eq('item')
+        end
       end
     end
 
-    context 'with option call: false' do
-      it 'registers and resolves an object' do
-        item = -> { 'test' }
-        container.register(:item, item, call: false)
+    describe 'registering an object' do
+      context 'without options' do
+        it 'registers and resolves the object' do
+          item = 'item'
+          container.register(:item, item)
 
-        expect(container.resolve(:item)).to eq(item)
-        expect(container[:item]).to eq(item)
+          expect(container.resolve(:item)).to be(item)
+          expect(container[:item]).to be(item)
+        end
+      end
+
+      context 'with option call: false' do
+        it 'registers and resolves an object' do
+          item = -> { 'test' }
+          container.register(:item, item, call: false)
+
+          expect(container.resolve(:item)).to eq(item)
+          expect(container[:item]).to eq(item)
+        end
       end
     end
-  end
 
-  describe 'registering with the same key multiple times' do
-    it do
-      container.register(:item, proc { 'item' })
+    describe 'registering with the same key multiple times' do
+      it do
+        container.register(:item, proc { 'item' })
 
-      expect { container.register(:item, proc { 'item' }) }.to raise_error(Dry::Container::Error)
+        expect { container.register(:item, proc { 'item' }) }.to raise_error(Dry::Container::Error)
+      end
     end
-  end
 
-  describe 'resolving with a key that has not been registered' do
-    it do
-      expect { container.resolve(:item) }.to raise_error(Dry::Container::Error)
+    describe 'resolving with a key that has not been registered' do
+      it do
+        expect { container.resolve(:item) }.to raise_error(Dry::Container::Error)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-container
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thread_safe
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +101,8 @@ files:
 - lib/dry/container/error.rb
 - lib/dry/container/item.rb
 - lib/dry/container/mixin.rb
+- lib/dry/container/registry.rb
+- lib/dry/container/resolver.rb
 - lib/dry/container/version.rb
 - rakelib/rubocop.rake
 - spec/integration/container_spec.rb