dry-container 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80070803509a4e967b6874018aa178ab1fff0c12
-  data.tar.gz: 3a46e86e6ada0346d0da825d93c04bb225f6d31d
+  metadata.gz: 00fac333cd99a672b9cb5d60dac62f5ebcb197c1
+  data.tar.gz: 3e040234421d7e23618d0a8fc6e5273ccdb73fb0
 SHA512:
-  metadata.gz: e32f26c42d3d6c268866b72eba0b4a6bac760c278da01c8d3b46d0ac12b9c5ebcfa31a6150bd38ae88998d7561d77fe0f95d8ea33dc8d0ce0be7be657f1d676f
-  data.tar.gz: 8dc9547baf6a1b3ba22767c9008d4cd467e444269a0341e4cf0a1da01ebc90b6cc91cf673ea695cb237b5775389213dbec52eef05e6b0c6ab0364acfb482f3eb
+  metadata.gz: f161b567597ebd6f7a102ca2815687dbd1d50b4bf6d95187e4252f4793e28ef9318cf38ffd71ffdd136721ad7b65aeadde21f392e8016c538b016236c2485618
+  data.tar.gz: 1d6644026909c74463aa84963876d6af086ed7c6c2e8246769159298e76a8bcec1381955d2031b99fdc129e9edcc1cc05eb2784d8f5f2b0d5d4161bbc028d510

data/.rubocop.yml

@@ -18,3 +18,7 @@ Lint/NestedMethodDefinition:
 Metrics/MethodLength:
   Exclude:
     - lib/dry/container/mixin.rb
+
+Style/FileName:
+  Exclude:
+    - lib/dry-container.rb

data/README.md

@@ -49,6 +49,25 @@ container.register(:block, call: false) do
 end
 container.resolve(:block)
 # => #<Proc:0x007fa75e6830f0@(irb):36>
+
+# You can also register items under namespaces using the #namespace method
+container.namespace('repositories') do
+  namespace('checkout') do
+    register('orders') { ThreadSafe::Array.new }
+  end
+end
+container.resolve('repositories.checkout.orders')
+# => []
+
+# Or import a namespace
+ns = Dry::Container::Namespace.new('repositories') do
+  namespace('authentication') do
+    register('users') { ThreadSafe::Array.new }
+  end
+end
+container.import(ns)
+container.resolve('repositories.authentication.users')
+# => []
 ```
 
 You can also get container behaviour at both the class and instance level via the mixin:
@@ -76,7 +95,7 @@ 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] }
+  config.resolver = ->(container, key) { container[key] }
 end
 
 class Container
@@ -84,7 +103,7 @@ class Container
 
   configure do |config|
     config.registry = ->(container, key, item, options) { container[key] = item }
-    config.resolver = ->(key) { container[key] }
+    config.resolver = ->(container, key) { container[key] }
   end
 end
 
@@ -93,7 +112,7 @@ class ContainerObject
 
   configure do |config|
     config.registry = ->(container, key, item, options) { container[key] = item }
-    config.resolver = ->(key) { container[key] }
+    config.resolver = ->(container, key) { container[key] }
   end
 end
 ```

data/lib/dry/container.rb

@@ -2,11 +2,15 @@ require 'thread_safe'
 require 'dry-configurable'
 require 'dry/container/error'
 require 'dry/container/item'
+require 'dry/container/namespace'
 require 'dry/container/registry'
 require 'dry/container/resolver'
+require 'dry/container/namespace_dsl'
 require 'dry/container/mixin'
 require 'dry/container/version'
 
+# A collection of micro-libraries, each intended to encapsulate
+# a common task in Ruby
 module Dry
   # Inversion of Control (IoC) container
   #

data/lib/dry/container/mixin.rb

@@ -31,10 +31,11 @@ module Dry
         base.class_eval do
           extend ::Dry::Configurable
 
-          setting :registry, Registry.new
-          setting :resolver, Resolver.new
+          setting :registry, ::Dry::Container::Registry.new
+          setting :resolver, ::Dry::Container::Resolver.new
+          setting :namespace_separator, '.'
 
-          @_container = ThreadSafe::Cache.new
+          @_container = ::ThreadSafe::Cache.new
         end
       end
       # @private
@@ -42,13 +43,14 @@ module Dry
         base.class_eval do
           extend ::Dry::Configurable
 
-          setting :registry, Registry.new
-          setting :resolver, Resolver.new
+          setting :registry, ::Dry::Container::Registry.new
+          setting :resolver, ::Dry::Container::Resolver.new
+          setting :namespace_separator, '.'
 
           attr_reader :_container
 
           def initialize(*args, &block)
-            @_container = ThreadSafe::Cache.new
+            @_container = ::ThreadSafe::Cache.new
             super(*args, &block)
           end
 
@@ -69,7 +71,7 @@ module Dry
       #   If a block is given, contents will be ignored and the block
       #   will be registered instead
       #
-      # @return [Dry::Container] self
+      # @return [Dry::Container::Mixin] self
       #
       # @api public
       def register(key, contents = nil, options = {}, &block)
@@ -96,6 +98,37 @@ module Dry
         config.resolver.call(_container, key)
       end
       alias_method :[], :resolve
+      # Evaluate block and register items in namespace
+      #
+      # @param [Mixed] namespace
+      #   The namespace to register items in
+      #
+      # @return [Dry::Container::Mixin] self
+      #
+      # @api public
+      def namespace(namespace, &block)
+        ::Dry::Container::NamespaceDSL.new(
+          self,
+          namespace,
+          config.namespace_separator,
+          &block
+        )
+
+        self
+      end
+      # Import a namespace
+      #
+      # @param [Dry::Container::Namespace] namespace
+      #   The namespace to import
+      #
+      # @return [Dry::Container::Mixin] self
+      #
+      # @api public
+      def import(namespace)
+        namespace(namespace.name, &namespace.block)
+
+        self
+      end
     end
   end
 end

data/lib/dry/container/namespace.rb

@@ -0,0 +1,38 @@
+module Dry
+  class Container
+    # Create a namespace to be imported
+    #
+    # @example
+    #
+    #   ns = Dry::Container::Namespace.new('name') do
+    #     register('item', 'item')
+    #   end
+    #
+    #   container = Dry::Container.new
+    #
+    #   container.import(ns)
+    #
+    #   container.resolve('name.item')
+    #   => 'item'
+    #
+    #
+    # @api public
+    class Namespace
+      attr_reader :name, :block
+      # Create a new namespace
+      #
+      # @param [Mixed] name
+      #   The name of the namespace
+      # @yield
+      #   The block to evaluate when the namespace is imported
+      #
+      # @return [Dry::Container::Namespace]
+      #
+      # @api public
+      def initialize(name, &block)
+        @name = name
+        @block = block
+      end
+    end
+  end
+end

data/lib/dry/container/namespace_dsl.rb

@@ -0,0 +1,39 @@
+module Dry
+  class Container
+    # @api private
+    class NamespaceDSL < ::SimpleDelegator
+      def initialize(container, namespace, namespace_separator, &block)
+        @namespace = namespace
+        @namespace_separator = namespace_separator
+
+        super(container)
+
+        if block.arity.zero?
+          instance_eval(&block)
+        else
+          block.call(self)
+        end
+      end
+
+      def register(key, *args, &block)
+        super(namespaced(key), *args, &block)
+      end
+
+      def namespace(namespace, &block)
+        super(namespaced(namespace), &block)
+      end
+
+      def import(namespace)
+        namespace(namespace.name, &namespace.block)
+
+        self
+      end
+
+      private
+
+      def namespaced(key)
+        [@namespace, key].join(@namespace_separator)
+      end
+    end
+  end
+end

data/lib/dry/container/registry.rb

@@ -6,7 +6,7 @@ module Dry
     class Registry
       # @private
       def initialize
-        @_mutex = Mutex.new
+        @_mutex = ::Mutex.new
       end
       # Register an item with the container to be resolved later
       #
@@ -31,7 +31,7 @@ module Dry
           if container.key?(key)
             fail Error, "There is already an item registered with the key #{key.inspect}"
           else
-            container[key] = Item.new(item, options)
+            container[key] = ::Dry::Container::Item.new(item, options)
           end
         end
       end

data/lib/dry/container/version.rb

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

data/spec/support/shared_examples/container.rb

@@ -72,6 +72,41 @@ shared_examples 'a container' do
         it { is_expected.to eq(item) }
       end
     end
+
+    describe 'namespace_separator' do
+      describe 'default' do
+        it { expect(klass.config.namespace_separator).to eq('.') }
+      end
+
+      describe 'custom' do
+        let(:custom_registry) { double('Registry') }
+        let(:key) { 'key' }
+        let(:namespace_separator) { '-' }
+        let(:namespace) { 'one' }
+
+        before do
+          klass.configure do |config|
+            config.namespace_separator = namespace_separator
+          end
+
+          container.namespace(namespace) do
+            register('key', 'item')
+          end
+        end
+
+        after do
+          # HACK: Have to reset the configuration so that it doesn't
+          # interfere with other specs
+          klass.configure do |config|
+            config.namespace_separator = '.'
+          end
+        end
+
+        subject! { container.resolve([namespace, key].join(namespace_separator)) }
+
+        it { is_expected.to eq('item') }
+      end
+    end
   end
 
   context 'with default configuration' do
@@ -149,5 +184,75 @@ shared_examples 'a container' do
         expect { container.resolve(:item) }.to raise_error(Dry::Container::Error)
       end
     end
+
+    describe 'namespace' do
+      context 'when block does not take arguments' do
+        before do
+          container.namespace('one') do
+            register('two', 2)
+          end
+        end
+
+        subject! { container.resolve('one.two') }
+
+        it 'registers items under the given namespace' do
+          is_expected.to eq(2)
+        end
+      end
+
+      context 'when block takes arguments' do
+        before do
+          container.namespace('one') do |c|
+            c.register('two', 2)
+          end
+        end
+
+        subject! { container.resolve('one.two') }
+
+        it 'registers items under the given namespace' do
+          is_expected.to eq(2)
+        end
+      end
+
+      context 'with nesting' do
+        before do
+          container.namespace('one') do
+            namespace('two') do
+              register('three', 3)
+            end
+          end
+        end
+
+        subject! { container.resolve('one.two.three') }
+
+        it 'registers items under the given namespaces' do
+          is_expected.to eq(3)
+        end
+      end
+    end
+
+    describe 'import' do
+      it 'allows importing of namespaces' do
+        ns = Dry::Container::Namespace.new('one') do
+          register('two', 2)
+        end
+
+        container.import(ns)
+
+        expect(container.resolve('one.two')).to eq(2)
+      end
+
+      it 'allows importing of nested namespaces' do
+        ns = Dry::Container::Namespace.new('two') do
+          register('three', 3)
+        end
+
+        container.namespace('one') do
+          import(ns)
+        end
+
+        expect(container.resolve('one.two.three')).to eq(3)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-container
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thread_safe
@@ -102,6 +102,8 @@ files:
 - lib/dry/container/error.rb
 - lib/dry/container/item.rb
 - lib/dry/container/mixin.rb
+- lib/dry/container/namespace.rb
+- lib/dry/container/namespace_dsl.rb
 - lib/dry/container/registry.rb
 - lib/dry/container/resolver.rb
 - lib/dry/container/version.rb