dry-container 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25d869f2ebe16d1f8fdb1d1516c501def7aaeb94
-  data.tar.gz: 596fc6859c7fef0f70c40aae379eea4a632e59fa
+  metadata.gz: 5e3d3bf439e6c3bd3b03269a0b1b078df324550a
+  data.tar.gz: 43daf4430f1496b7444becd4619db45a1f5c47ea
 SHA512:
-  metadata.gz: 7b80fbff0503dcb46b0c026c93643abab69fa0f11517b85280f46878217bd8edeef96d4b2f14d6c29b4b25e2f7e87186e213cce01a2b26b4d8b820ffdd3b3196
-  data.tar.gz: f237d2987d1b195abf05afc0537abb46980427dccc465371fceace2cacab63589411f3f957474e81dd0fcf8371807f570b433c6aadebdcee71160f5f33d18e30
+  metadata.gz: 3eb73cfbddb9a59a929c1e6a27dc5087830c48733077f584f77cc974c72a0f5661ae2a42d78899ecec9c3e9bba3ddb134bffae771442258a8fa8eb31b08e61a8
+  data.tar.gz: ec5253b3eb128f50420befe89f40a9855b22a60638fb323a9fba34f16a7744dfa5eaab1a5522e6442b682de3863022445839376da96c4f193c0cc7ce5817f423

data/README.md

@@ -10,6 +10,20 @@ A simple, configurable container implemented in Ruby
 
 ## Synopsis
 
+### Brief Example
+
+```ruby
+container = Dry::Container.new
+container.register(:parrot) { |a| puts a }
+
+parrot = container.resolve(:parrot)
+parrot.call("Hello World")
+# Hello World
+# => nil
+```
+
+### Detailed Example
+
 ```ruby
 User = Struct.new(:name, :email)
 

data/lib/dry/container/mixin.rb

@@ -105,7 +105,7 @@ module Dry
       def resolve(key)
         config.resolver.call(_container, key)
       end
-      alias_method :[], :resolve
+      alias [] resolve
 
       # Merge in the items of the other container
       #
@@ -132,6 +132,15 @@ module Dry
         config.resolver.key?(_container, key)
       end
 
+      # An array of registered names for the container
+      #
+      # @return [Array<String>]
+      #
+      # @api public
+      def keys
+        config.resolver.keys(_container)
+      end
+
       # Evaluate block and register items in namespace
       #
       # @param [Mixed] namespace

data/lib/dry/container/namespace_dsl.rb

@@ -25,7 +25,7 @@ module Dry
         if block.arity.zero?
           instance_eval(&block)
         else
-          block.call(self)
+          yield self
         end
       end
 

data/lib/dry/container/registry.rb

@@ -28,13 +28,13 @@ module Dry
       #
       # @api public
       def call(container, key, item, options)
+        key = key.to_s.dup.freeze
         @_mutex.synchronize do
           if container.key?(key)
-            fail Error, "There is already an item registered with the key #{key.inspect}"
-          else
-            key = key.is_a?(::String) ? key.dup.freeze : key
-            container[key] = ::Dry::Container::Item.new(item, options)
+            raise Error, "There is already an item registered with the key #{key.inspect}"
           end
+
+          container[key] = ::Dry::Container::Item.new(item, options)
         end
       end
     end

data/lib/dry/container/resolver.rb

@@ -18,8 +18,8 @@ module Dry
       #
       # @api public
       def call(container, key)
-        item = container.fetch(key) do
-          fail Error, "Nothing registered with the key #{key.inspect}"
+        item = container.fetch(key.to_s) do
+          raise Error, "Nothing registered with the key #{key.inspect}"
         end
 
         item.call
@@ -36,7 +36,16 @@ module Dry
       #
       # @api public
       def key?(container, key)
-        container.key?(key)
+        container.key?(key.to_s)
+      end
+
+      # An array of registered names for the container
+      #
+      # @return [Array]
+      #
+      # @api public
+      def keys(container)
+        container.keys
       end
     end
   end

data/lib/dry/container/stub.rb

@@ -0,0 +1,48 @@
+module Dry
+  class Container
+    module Stub
+      # Overrides resolve to look into stubbed keys first
+      #
+      # @api public
+      def resolve(key)
+        _stubs.fetch(key) { super }
+      end
+
+      # Add a stub to the container
+      def stub(key, value, &block)
+        _stubs[key] = value
+
+        if block
+          yield
+          unstub(key)
+        end
+
+        self
+      end
+
+      # Remove stubbed keys from the container
+      def unstub(*keys)
+        keys = _stubs.keys if keys.empty?
+        keys.each { |key| _stubs.delete(key) }
+      end
+
+      # Stubs have already been enabled turning this into a noop
+      def enable_stubs!
+      end
+
+      private
+
+      # Stubs container
+      def _stubs
+        @_stubs ||= {}
+      end
+    end
+
+    module Mixin
+      # Enable stubbing functionality into the current container
+      def enable_stubs!
+        extend Dry::Container::Stub
+      end
+    end
+  end
+end

data/lib/dry/container/version.rb

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

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'dry/container'
+require 'dry/container/stub'
 
 Dir[Pathname(__FILE__).dirname.join('support/**/*.rb').to_s].each do |file|
   require file

data/spec/support/shared_examples/container.rb

@@ -116,6 +116,7 @@ shared_examples 'a container' do
           it 'registers and resolves an object' do
             container.register(:item) { 'item' }
 
+            expect(container.keys).to eq(['item'])
             expect(container.key?(:item)).to be true
             expect(container.resolve(:item)).to eq('item')
           end
@@ -134,6 +135,7 @@ shared_examples 'a container' do
         it 'registers and resolves a proc' do
           container.register(:item, call: false) { 'item' }
 
+          expect(container.keys).to eq(['item'])
           expect(container.key?(:item)).to be true
           expect(container.resolve(:item).call).to eq('item')
           expect(container[:item].call).to eq('item')
@@ -147,6 +149,7 @@ shared_examples 'a container' do
           it 'registers and resolves an object' do
             container.register(:item, proc { 'item' })
 
+            expect(container.keys).to eq(['item'])
             expect(container.key?(:item)).to be true
             expect(container.resolve(:item)).to eq('item')
             expect(container[:item]).to eq('item')
@@ -157,6 +160,7 @@ shared_examples 'a container' do
           it 'registers and resolves a proc' do
             container.register(:item, proc { |item| item })
 
+            expect(container.keys).to eq(['item'])
             expect(container.key?(:item)).to be true
             expect(container.resolve(:item).call('item')).to eq('item')
             expect(container[:item].call('item')).to eq('item')
@@ -168,6 +172,7 @@ shared_examples 'a container' do
         it 'registers and resolves a proc' do
           container.register(:item, proc { 'item' }, call: false)
 
+          expect(container.keys).to eq(['item'])
           expect(container.key?(:item)).to be true
           expect(container.resolve(:item).call).to eq('item')
           expect(container[:item].call).to eq('item')
@@ -181,6 +186,7 @@ shared_examples 'a container' do
           item = 'item'
           container.register(:item, item)
 
+          expect(container.keys).to eq(['item'])
           expect(container.key?(:item)).to be true
           expect(container.resolve(:item)).to be(item)
           expect(container[:item]).to be(item)
@@ -192,6 +198,7 @@ shared_examples 'a container' do
           item = -> { 'test' }
           container.register(:item, item, call: false)
 
+          expect(container.keys).to eq(['item'])
           expect(container.key?(:item)).to be true
           expect(container.resolve(:item)).to eq(item)
           expect(container[:item]).to eq(item)
@@ -214,6 +221,13 @@ shared_examples 'a container' do
       end
     end
 
+    describe 'mixing Strings and Symbols' do
+      it do
+        container.register(:item, 'item')
+        expect(container.resolve('item')).to eql('item')
+      end
+    end
+
     describe '#merge' do
       let(:key) { :key }
       let(:other) { Dry::Container.new }
@@ -299,4 +313,48 @@ shared_examples 'a container' do
       end
     end
   end
+
+  describe 'stubbing' do
+    before do
+      container.enable_stubs!
+
+      container.register(:item, 'item')
+      container.register(:foo, 'bar')
+    end
+
+    after do
+      container.unstub
+    end
+
+    it 'keys can be stubbed' do
+      container.stub(:item, 'stub')
+      expect(container.resolve(:item)).to eql('stub')
+    end
+
+    it 'only other keys remain accesible' do
+      container.stub(:item, 'stub')
+      expect(container.resolve(:foo)).to eql('bar')
+    end
+
+    it 'keys can be reverted back to their original value' do
+      container.stub(:item, 'stub')
+      container.unstub(:item)
+
+      expect(container.resolve(:item)).to eql('item')
+    end
+
+    describe 'with block argument' do
+      it 'executes the block with the given stubs' do
+        expect { |b| container.stub(:item, 'stub', &b) }.to yield_control
+      end
+
+      it 'keys are stubbed only while inside the block' do
+        container.stub(:item, 'stub') do
+          expect(container.resolve(:item)).to eql('stub')
+        end
+
+        expect(container.resolve(:item)).to eql('item')
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-container
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thread_safe
@@ -112,6 +112,7 @@ files:
 - lib/dry/container/namespace_dsl.rb
 - lib/dry/container/registry.rb
 - lib/dry/container/resolver.rb
+- lib/dry/container/stub.rb
 - lib/dry/container/version.rb
 - rakelib/rubocop.rake
 - spec/integration/container_spec.rb