dry-component 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f3c7bc83200152d244ec311a77affb840f5340f
-  data.tar.gz: e437ce4b730ce49d617fbc86a4bc46f089a1df1e
+  metadata.gz: 62d04c04b930c78a211b75bbe2b12e81709d5d72
+  data.tar.gz: 4142d98f2cbea51f1d33f3864b8a952ede77416a
 SHA512:
-  metadata.gz: 3ce61aa0a4bc7e95f486adfe712b4f73a585631d5dba1e2e441ecbef99aef9da82a49039c605ec6651bad6db3d285320ec4fd97f74db3dd5bb66630fc402a468
-  data.tar.gz: c095e172c4af2ffeff3056eddaea8bd0281244cea470379738dc73e943978d18223a4c12b82beafa904692e7758c5661f379370617b069b4cb6669d89b7939ab
+  metadata.gz: 461b2819291b294fca018c24f12e392ee1fe3e9272232b9b87c79f5031968d74d9f91a2a7e52935ebc4c59fb3ec8f33e103eeeb94160a0ce5cceea184c9492c1
+  data.tar.gz: 0441572d29a273a379388e6bfb2f7a6c31b94ffd55051a55ebdfe1b7eac35fb57004443334d632b5f2fa857099f16bdd38c72dbe44617c57b2277923db75f3cd

data/.travis.yml

@@ -5,7 +5,6 @@ bundler_args: --without tools
 script:
   - bundle exec rake spec
 rvm:
-  - 2.0
   - 2.1
   - 2.2
   - 2.3.1

data/CHANGELOG.md

@@ -1,6 +1,57 @@
+# 0.4.2 - 2016-07-26
+
+### Fixed
+
+- Ensure file components can be loaded when they're requested for the first time using their shorthand container identifier (i.e. with the container's default namespace removed) (timriley)
+
+# 0.4.1 - 2016-07-26 [YANKED]
+
+### Fixed
+
+- Require the 0.4.0 release of dry-auto_inject for the features below (in 0.4.0) to work properly (timriley)
+
+[Compare v0.3.0...v0.4.0](https://github.com/dry-rb/dry-component/compare/v0.4.0...v0.4.1)
+
+# 0.4.0 - 2016-07-26 [YANKED]
+
+### Added
+
+- Support for supplying a default namespace to a container, which is passed to the container's injector to allow for convenient shorthand access to registered objects in the same namespace (timriley in [#20](https://github.com/dry-rb/dry-component/pull/20))
+
+    ```ruby
+    # Set up container with default namespace
+    module Admin
+      class Container < Dry::Component::Container
+        configure do |config|
+          config.root = Pathname.new(__dir__).join("../..")
+          config.default_namespace = "admin"
+        end
+      end
+
+      Import = Container.injector
+    end
+
+    module Admin
+      class CreateUser
+        # "users.repository" will resolve an Admin::Users::Repository instance,
+        # where previously you had to identify it as "admin.users.repository"
+        include Admin::Import["users.repository"]
+      end
+    end
+    ```
+
+- Support for supplying to options directly to dry-auto_inject's `Builder` via `Dry::Component::Container#injector(options)`. This allows you to provide dry-auto_inject customizations like your own container of injection strategies (timriley in [#20](https://github.com/dry-rb/dry-component/pull/20))
+- Support for accessing all available injector strategies, not just the defaults (e.g. `MyContainer.injector.some_custom_strategy`) (timriley in [#19](https://github.com/dry-rb/dry-component/pull/19))
+
+### Changed
+
+- Subclasses of `Dry::Component::Container` no longer have an `Injector` constant automatically defined within them. The recommended approach is to save your own injector object to a constant, which allows you to pass options to it at the same time, e.g. `MyApp::Import = MyApp::Container.injector(my_options)` (timriley in [#19](https://github.com/dry-rb/dry-component/pull/19))
+
+[Compare v0.3.0...v0.4.0](https://github.com/dry-rb/dry-component/compare/v0.3.0...v0.4.0)
+
 # 0.3.0 - 2016-06-18
 
-## Changed
+### Changed
 
 Removed two pieces that are moving to dry-web:
 
@@ -8,20 +59,24 @@ Removed two pieces that are moving to dry-web:
 - Removed `Dry::Component::Config` and `options` setting from `Container` (timriley)
 - Changed `Component#configure` behavior so it can be run multiple times for configuration to be applied in multiple passes (timriley)
 
+[Compare v0.2.0...v0.3.0](https://github.com/dry-rb/dry-component/compare/v0.2.0...v0.3.0)
+
 # 0.2.0 - 2016-06-13
 
-## Changed
+### Changed
 
 - Component core directory is now `component/` by default (timriley)
 - Injector default stragegy is now whatever dry-auto_inject's default is (rather than hard-coding a particular default strategy for dry-component) (timriley)
 
-## Fixed
+### Fixed
 
 - Fixed bug where specified auto-inject strategies were not respected (timriley)
 
+[Compare v0.1.0...v0.2.0](https://github.com/dry-rb/dry-component/compare/v0.1.0...v0.2.0)
+
 # 0.1.0 - 2016-06-07
 
-## Added
+### Added
 
 * Provide a dependency injector as an `Inject` constant inside any subclass of `Dry::Component::Container`. This injector supports all of `dry-auto_inject`'s default injection strategies, and will lazily load any dependencies as they are injected. It also supports arbitrarily switching strategies, so they can be used in different classes as required (e.g. `include MyComponent::Inject.args["dep"]`) (timriley)
 * Support aliased dependency names when calling the injector object (e.g. `MyComponent::Inject[foo: "my_app.foo", bar: "another.thing"]`) (timriley)
@@ -36,7 +91,7 @@ Removed two pieces that are moving to dry-web:
     end
     ```
 
-## Changed
+### Changed
 
 * `Container.boot` now only makes a simple `require` for the boot file (solnic)
 * Container object is passed to `Container.finalize` blocks (solnic)
@@ -45,17 +100,21 @@ Removed two pieces that are moving to dry-web:
 * `Container.import_module` renamed to `.injector` (timriley)
 * Default injection strategy is now `kwargs`, courtesy of the new dry-auto_inject default (timriley)
 
+[Compare v0.0.2...v0.1.0](https://github.com/dry-rb/dry-component/compare/v0.0.2...v0.1.0)
+
 # 0.0.2 - 2015-12-24
 
-## Added
+### Added
 
 * Containers have a `name` setting (solnic)
 * Containers can be imported into one another (solnic)
 
-## Changed
+### Changed
 
 * Container name is used to determine the name of its config file (solnic)
 
+[Compare v0.0.1...v0.0.2](https://github.com/dry-rb/dry-component/compare/v0.0.1...v0.0.2)
+
 # 0.0.1 - 2015-12-24
 
 First public release, extracted from rodakase project

data/dry-component.gemspec

@@ -15,9 +15,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.1.0'
+
   spec.add_runtime_dependency 'inflecto', '>= 0.0.2'
   spec.add_runtime_dependency 'dry-container', '~> 0.3', '>= 0.3.4'
-  spec.add_runtime_dependency 'dry-auto_inject', '~> 0.3'
+  spec.add_runtime_dependency 'dry-auto_inject', '>= 0.4.0'
   spec.add_runtime_dependency 'dry-configurable', '~> 0.1'
 
   spec.add_development_dependency 'bundler'

data/lib/dry/component/container.rb

@@ -9,21 +9,19 @@ require 'dry/component/loader'
 
 module Dry
   module Component
+    FileNotFoundError = Class.new(StandardError)
+
     class Container
       extend Dry::Configurable
       extend Dry::Container::Mixin
 
       setting :name
+      setting :default_namespace
       setting :root, Pathname.pwd.freeze
       setting :core_dir, 'component'.freeze
       setting :auto_register
       setting :loader, Dry::Component::Loader
 
-      def self.inherited(subclass)
-        super
-        subclass.const_set :Inject, subclass.injector
-      end
-
       def self.configure(&block)
         super(&block)
 
@@ -63,8 +61,12 @@ module Dry
         freeze
       end
 
-      def self.injector
-        Injector.new(self)
+      def self.loader
+        @loader ||= config.loader.new(config)
+      end
+
+      def self.injector(options = {})
+        Injector.new(self, options: options)
       end
 
       def self.auto_register!(dir, &_block)
@@ -72,7 +74,7 @@ module Dry
 
         Dir["#{root}/#{dir}/**/*.rb"].each do |path|
           component_path = path.to_s.gsub("#{dir_root}/", '').gsub('.rb', '')
-          config.loader.new(component_path).tap do |component|
+          loader.load(component_path).tap do |component|
             next if key?(component.identifier)
 
             Kernel.require component.path
@@ -121,7 +123,7 @@ module Dry
       end
 
       def self.load_component(key)
-        component = config.loader.new(key)
+        component = loader.load(key)
         src_key = component.namespaces[0]
 
         if imports.key?(src_key)
@@ -133,7 +135,15 @@ module Dry
 
           import_container(src_key, src_container)
         else
-          require_component(component) { |klass| register(key) { klass.new } }
+          begin
+            require_component(component) { |klass| register(key) { klass.new } }
+          rescue FileNotFoundError => e
+            if config.default_namespace
+              load_component("#{config.default_namespace}#{config.namespace_separator}#{component.identifier}")
+            else
+              raise e
+            end
+          end
         end
       end
 
@@ -144,7 +154,7 @@ module Dry
           Kernel.require component.path
           yield(component.constant) if block
         else
-          fail ArgumentError, "could not resolve require file for #{component.identifier}"
+          fail FileNotFoundError, "could not resolve require file for #{component.identifier}"
         end
       end
 

data/lib/dry/component/injector.rb

@@ -2,23 +2,21 @@ require "dry-auto_inject"
 
 module Dry
   module Component
-    class Injector
+    class Injector < BasicObject
       # @api private
       attr_reader :container
 
+      # @api private
+      attr_reader :options
+
       # @api private
       attr_reader :injector
 
       # @api private
-      def initialize(container, strategy: nil, strategies_cache: nil)
+      def initialize(container, options: {}, strategy: :default)
         @container = container
-        @strategies = strategies_cache
-        @injector =
-          if strategy
-            Dry::AutoInject(container).send(strategy)
-          else
-            Dry::AutoInject(container)
-          end
+        @options = options
+        @injector = ::Dry::AutoInject(container, options).__send__(strategy)
       end
 
       # @api public
@@ -27,37 +25,24 @@ module Dry
         injector[*deps]
       end
 
-      # @api public
-      def args
-        strategies[:args]
-      end
-
-      # @api public
-      def hash
-        strategies[:hash]
+      def method_missing(name, *args, &block)
+        ::Dry::Component::Injector.new(container, options: options, strategy: name)
       end
 
-      # @api public
-      def kwargs
-        strategies[:kwargs]
+      def respond_to?(name, include_private = false)
+        injector.respond_to?(name, include_private)
       end
 
       private
 
       def load_components(*components)
         components = components.dup
-        aliases = components.last.is_a?(Hash) ? components.pop : {}
+        aliases = components.last.is_a?(::Hash) ? components.pop : {}
 
         (components + aliases.values).each do |key|
           container.load_component(key) unless container.key?(key)
         end
       end
-
-      def strategies
-        @strategies ||= Hash.new do |cache, strategy|
-          cache[strategy] = self.class.new(container, strategy: strategy, strategies_cache: cache)
-        end
-      end
     end
   end
 end

data/lib/dry/component/loader.rb

@@ -3,33 +3,56 @@ require 'inflecto'
 module Dry
   module Component
     class Loader
-      IDENTIFIER_SEPARATOR = '.'.freeze
-      PATH_SEPARATOR = '/'.freeze
+      class Component
+        attr_reader :loader
+        attr_reader :identifier, :path, :file
 
-      attr_reader :identifier, :path, :file
+        def initialize(loader, input)
+          @loader = loader
 
-      def initialize(input)
-        @identifier = input.to_s.gsub(PATH_SEPARATOR, IDENTIFIER_SEPARATOR)
-        @path = input.to_s.gsub(IDENTIFIER_SEPARATOR, PATH_SEPARATOR)
-        @file = "#{path}.rb"
-      end
+          @identifier = input.to_s.gsub(loader.path_separator, loader.namespace_separator)
+          if loader.default_namespace
+            re = /^#{Regexp.escape(loader.default_namespace)}#{Regexp.escape(loader.namespace_separator)}/
+            @identifier = @identifier.sub(re, '')
+          end
 
-      def namespaces
-        identifier.split(IDENTIFIER_SEPARATOR).map(&:to_sym)
-      end
+          @path = input.to_s.gsub(loader.namespace_separator, loader.path_separator)
+          @file = "#{path}.rb"
+        end
 
-      def constant
-        Inflecto.constantize(name)
-      end
+        def namespaces
+          identifier.split(loader.namespace_separator).map(&:to_sym)
+        end
+
+        def constant
+          Inflecto.constantize(constant_name)
+        end
+
+        def instance(*args)
+          constant.new(*args)
+        end
 
-      def instance(*args)
-        constant.new(*args)
+        private
+
+        def constant_name
+          Inflecto.camelize(path)
+        end
       end
 
-      private
+      PATH_SEPARATOR = '/'.freeze
+
+      attr_reader :default_namespace
+      attr_reader :namespace_separator
+      attr_reader :path_separator
+
+      def initialize(config)
+        @default_namespace = config.default_namespace
+        @namespace_separator = config.namespace_separator
+        @path_separator = PATH_SEPARATOR
+      end
 
-      def name
-        Inflecto.camelize(path)
+      def load(component_path)
+        Component.new(self, component_path)
       end
     end
   end

data/lib/dry/component/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Component
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.2'.freeze
   end
 end

data/spec/fixtures/namespaced_components/namespaced/bar.rb

@@ -0,0 +1,5 @@
+module Namespaced
+  class Bar
+    include Test::Container.injector["foo"]
+  end
+end

data/spec/fixtures/namespaced_components/namespaced/foo.rb

@@ -0,0 +1,4 @@
+module Namespaced
+  class Foo
+  end
+end

data/spec/unit/container/auto_register_spec.rb

@@ -1,7 +1,7 @@
 require 'dry/component/container'
 
 RSpec.describe Dry::Component::Container, '.auto_register!' do
-  context 'with the standard loader' do
+  context 'standard loader' do
     before do
       class Test::Container < Dry::Component::Container
         configure do |config|
@@ -18,15 +18,39 @@ RSpec.describe Dry::Component::Container, '.auto_register!' do
     it { expect(Test::Container['bar.baz']).to be_an_instance_of(Bar::Baz) }
   end
 
+  context 'standard loader with a default namespace configured' do
+    before do
+      class Test::Container < Dry::Component::Container
+        configure do |config|
+          config.root = SPEC_ROOT.join('fixtures').realpath
+          config.default_namespace = 'namespaced'
+        end
+
+        load_paths!('namespaced_components')
+        auto_register!('namespaced_components')
+      end
+    end
+
+    specify { expect(Test::Container['bar']).to be_a(Namespaced::Bar) }
+    specify { expect(Test::Container['bar'].foo).to be_a(Namespaced::Foo) }
+    specify { expect(Test::Container['foo']).to be_a(Namespaced::Foo) }
+  end
+
   context 'with a custom loader' do
     before do
       class Test::Loader < Dry::Component::Loader
-        def identifier
-          super.gsub('.', '-')
+        class Component < Dry::Component::Loader::Component
+          def identifier
+            super + ".yay"
+          end
+
+          def instance(*args)
+            constant.respond_to?(:call) ? constant : constant.new(*args)
+          end
         end
 
-        def instance(*args)
-          constant.respond_to?(:call) ? constant : constant.new(*args)
+        def load(component_path)
+          Component.new(self, component_path)
         end
       end
 
@@ -41,9 +65,9 @@ RSpec.describe Dry::Component::Container, '.auto_register!' do
       end
     end
 
-    it { expect(Test::Container['foo']).to be_an_instance_of(Foo) }
-    it { expect(Test::Container['bar']).to eq(Bar) }
-    it { expect(Test::Container['bar'].call).to eq("Welcome to my Moe's Tavern!") }
-    it { expect(Test::Container['bar-baz']).to be_an_instance_of(Bar::Baz) }
+    it { expect(Test::Container['foo.yay']).to be_an_instance_of(Foo) }
+    it { expect(Test::Container['bar.yay']).to eq(Bar) }
+    it { expect(Test::Container['bar.yay'].call).to eq("Welcome to my Moe's Tavern!") }
+    it { expect(Test::Container['bar.baz.yay']).to be_an_instance_of(Bar::Baz) }
   end
 end

data/spec/unit/container/import_spec.rb

@@ -57,7 +57,7 @@ RSpec.describe Dry::Component::Container, '.import' do
       end
 
       module Test
-        Import = Container::Inject
+        Import = Container.injector
       end
 
       class Test::Foo

data/spec/unit/container/injector_spec.rb

@@ -0,0 +1,29 @@
+require "dry/component/container"
+
+RSpec.describe Dry::Component::Container, ".injector" do
+  context "injector_options provided" do
+    it "builds an injector with the provided options" do
+      Test::Foo = Class.new
+
+      Test::Container = Class.new(Dry::Component::Container) do
+        register "foo", Test::Foo.new
+      end
+
+      Test::Inject = Test::Container.injector(strategies: {
+        default: Dry::AutoInject::Strategies::Args,
+        australian: Dry::AutoInject::Strategies::Args
+      })
+
+      injected_class = Class.new do
+        include Test::Inject.australian["foo"]
+      end
+
+      obj = injected_class.new
+      expect(obj.foo).to be_a Test::Foo
+
+      another = Object.new
+      obj = injected_class.new(another)
+      expect(obj.foo).to eq another
+    end
+  end
+end

data/spec/unit/container_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe Dry::Component::Container do
       end
 
       module Test
-        Import = Container::Inject
+        Import = Container.injector
       end
     end
 

data/spec/unit/injector_spec.rb

@@ -7,11 +7,13 @@ RSpec.describe Dry::Component::Injector do
 
       load_paths! "lib"
     end
+
+    Test::Inject = Test::Container.injector
   end
 
   it "supports args injection by default" do
     obj = Class.new do
-      include Test::Container::Inject["test.dep"]
+      include Test::Inject["test.dep"]
     end.new
 
     expect(obj.dep).to be_a Test::Dep
@@ -19,7 +21,7 @@ RSpec.describe Dry::Component::Injector do
 
   it "supports args injection with explicit method" do
     obj = Class.new do
-      include Test::Container::Inject.args["test.dep"]
+      include Test::Inject.args["test.dep"]
     end.new
 
     expect(obj.dep).to be_a Test::Dep
@@ -27,7 +29,7 @@ RSpec.describe Dry::Component::Injector do
 
   it "supports hash injection" do
     obj = Class.new do
-      include Test::Container::Inject.hash["test.dep"]
+      include Test::Inject.hash["test.dep"]
     end.new
 
     expect(obj.dep).to be_a Test::Dep
@@ -35,7 +37,7 @@ RSpec.describe Dry::Component::Injector do
 
   it "support kwargs injection" do
     obj = Class.new do
-      include Test::Container::Inject.kwargs["test.dep"]
+      include Test::Inject.kwargs["test.dep"]
     end.new
 
     expect(obj.dep).to be_a Test::Dep
@@ -43,7 +45,7 @@ RSpec.describe Dry::Component::Injector do
 
   it "allows injection strategies to be swapped" do
     obj = Class.new do
-      include Test::Container::Inject.kwargs.hash["test.dep"]
+      include Test::Inject.kwargs.hash["test.dep"]
     end.new
 
     expect(obj.dep).to be_a Test::Dep
@@ -51,7 +53,7 @@ RSpec.describe Dry::Component::Injector do
 
   it "supports aliases" do
     obj = Class.new do
-      include Test::Container::Inject[foo: "test.dep"]
+      include Test::Inject[foo: "test.dep"]
     end.new
 
     expect(obj.foo).to be_a Test::Dep

data/spec/unit/loader_spec.rb

@@ -40,20 +40,23 @@ RSpec.describe Dry::Component::Loader do
     end
   end
 
+  let(:container) { Class.new(Dry::Component::Container) }
+  let(:loader) { Dry::Component::Loader.new(container.config) }
+
   context 'from identifier as a symbol' do
-    subject(:component) { Dry::Component::Loader.new(:'test.bar') }
+    subject(:component) { loader.load(:'test.bar') }
 
     it_behaves_like 'a valid component'
   end
 
   context 'from identifier as a string' do
-    subject(:component) { Dry::Component::Loader.new('test.bar') }
+    subject(:component) { loader.load('test.bar') }
 
     it_behaves_like 'a valid component'
   end
 
   context 'from path' do
-    subject(:component) { Dry::Component::Loader.new('test/bar') }
+    subject(:component) { loader.load('test/bar') }
 
     it_behaves_like 'a valid component'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-component
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflecto
@@ -48,16 +48,16 @@ dependencies:
   name: dry-auto_inject
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
@@ -152,6 +152,8 @@ files:
 - spec/fixtures/lazytest/lib/test/models.rb
 - spec/fixtures/lazytest/lib/test/models/book.rb
 - spec/fixtures/lazytest/lib/test/models/user.rb
+- spec/fixtures/namespaced_components/namespaced/bar.rb
+- spec/fixtures/namespaced_components/namespaced/foo.rb
 - spec/fixtures/other/config/boot/bar.rb
 - spec/fixtures/other/lib/test/dep.rb
 - spec/fixtures/other/lib/test/foo.rb
@@ -169,6 +171,7 @@ files:
 - spec/spec_helper.rb
 - spec/unit/container/auto_register_spec.rb
 - spec/unit/container/import_spec.rb
+- spec/unit/container/injector_spec.rb
 - spec/unit/container_spec.rb
 - spec/unit/injector_spec.rb
 - spec/unit/loader_spec.rb
@@ -184,7 +187,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -211,6 +214,8 @@ test_files:
 - spec/fixtures/lazytest/lib/test/models.rb
 - spec/fixtures/lazytest/lib/test/models/book.rb
 - spec/fixtures/lazytest/lib/test/models/user.rb
+- spec/fixtures/namespaced_components/namespaced/bar.rb
+- spec/fixtures/namespaced_components/namespaced/foo.rb
 - spec/fixtures/other/config/boot/bar.rb
 - spec/fixtures/other/lib/test/dep.rb
 - spec/fixtures/other/lib/test/foo.rb
@@ -228,6 +233,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/container/auto_register_spec.rb
 - spec/unit/container/import_spec.rb
+- spec/unit/container/injector_spec.rb
 - spec/unit/container_spec.rb
 - spec/unit/injector_spec.rb
 - spec/unit/loader_spec.rb