dry-system 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '085640c18c734b66700738f731ea66d0001cdc83'
-  data.tar.gz: a6c6835df5df05045cddbc41615a581c11c4ea1d
+  metadata.gz: '0793e53e85b2a2fa0ea7da93bb11734362f87cd9'
+  data.tar.gz: 9d0cc9e0989fe9f071468e4e6b310a3fc009b06f
 SHA512:
-  metadata.gz: 415e4f12b22eeb6e7f7b9f6f856b21953f1126b634d82cc17e9c3da3eab1f6aff30c261fddde7401495d6bccd1092fa7185a772031abf886732d913b1182aeee
-  data.tar.gz: 3082441096b4e4208f1db30d817a816a809026b3cd07886b417edfc77be235167c54cdd9e5de4336109b88daa2633cca1c122a3f8fcbac8cea6421a099a0c633
+  metadata.gz: 50818887822ec2a8130910a359d45690312cd10c28b1537d5dbf0a45f98eb2f1abc0d70bf6f709313a939927a22c2d8e29fc8f2aa5806f53206d0b6390c37b6d
+  data.tar.gz: 1a350ffcba4a4bd7fca37be0976a55711aad5feaa70d493280aa477d4ea0723d5092fa35031c71c2b1d1ab6adaff6054d2a24e12fbdf4517b6eadb77e2850fe7

data/CHANGELOG.md

@@ -1,13 +1,47 @@
-# 0.6.0 2016-02-02
+# 0.7.0 - 2017-06-15
+
+### Added
+
+- Added `manual_registrar` container setting (along with default `ManualRegistrar` implementation), and `registrations_dir` setting. These provide support for a well-established place for keeping files with manual container registrations (timriley)
+- AutoRegistrar parses initial lines of Ruby source files for "magic comments" when auto-registering components. An `# auto_register: false` magic comment will prevent a Ruby file from being auto-registered (timriley)
+- `Container.auto_register!`, when called with a block, yields a configuration object to control the auto-registration behavior for that path, with support for configuring 2 different aspects of auto-registration behavior (both optional):
+
+    ```ruby
+    class MyContainer < Dry::System::Container
+      auto_register!('lib') do |config|
+        config.instance do |component|
+          # custom logic for initializing a component
+        end
+
+        config.exclude do |component|
+          # return true to skip auto-registration of the component, e.g.
+          # component.path =~ /entities/
+        end
+      end
+    end
+    ```
+
+- A helpful error will be raised if a bootable component's finalize block name doesn't match its boot file name (GustavoCaso)
+
+### Changed
+
+- The `default_namespace` container setting now supports multi-level namespaces (GustavoCaso)
+- `Container.auto_register!` yields a configuration block instead of a block for returning a custom instance (see above) (GustavoCaso)
+- `Container.import` now requires an explicit local name for the imported container (e.g. `import(local_name: AnotherContainer)`) (timriley)
+
+[Compare v0.6.0...v0.7.0](https://github.com/dry-rb/dry-system/compare/v0.6.0...v0.7.0)
+
+
+# 0.6.0 - 2016-02-02
 
 ### Changed
 
 * Lazy load components as they are resolved, rather than on injection (timriley)
 * Perform registration even though component already required (blelump)
 
-[Compare v0.5.0...v0.6.0](https://github.com/dry-rb/dry-system/compare/v0.5.1...v0.6.0)
+[Compare v0.5.1...v0.6.0](https://github.com/dry-rb/dry-system/compare/v0.5.1...v0.6.0)
 
-# 0.5.1 2016-08-23
+# 0.5.1 - 2016-08-23
 
 ### Fixed
 
@@ -15,7 +49,7 @@
 
 [Compare v0.5.0...v0.5.1](https://github.com/dry-rb/dry-system/compare/v0.5.0...v0.5.1)
 
-# 0.5.0 2016-08-15
+# 0.5.0 - 2016-08-15
 
 This is a major refactoring with better internal APIs and improved support
 for multi-container setups. As part of this release `dry-system` has been renamed to `dry-system`.

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Issue Guidelines
+
+## Reporting bugs
+
+If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
+
+## Reporting feature requests
+
+Report a feature request **only after discussing it first on [discuss.dry-rb.org](https://discuss.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
+
+## Reporting questions, support requests, ideas, concerns etc.
+
+**PLEASE DON'T** - use [discuss.dry-rb.org](http://discuss.dry-rb.org) instead.
+
+# Pull Request Guidelines
+
+A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
+
+Other requirements:
+
+1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
+2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
+3) Add API documentation if it's a new feature
+4) Update API documentation if it changes an existing feature
+5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
+
+# Asking for help
+
+If these guidelines aren't helpful, and you're stuck, please post a message on [discuss.dry-rb.org](https://discuss.dry-rb.org).

data/examples/custom_configuration_auto_register/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'dry-system', path: '../..'
+gem 'sequel'
+gem 'sqlite3'

data/examples/custom_configuration_auto_register/lib/entities/user.rb

@@ -0,0 +1,7 @@
+require 'import'
+
+module Entities
+  class User
+    include Import['persistence.db']
+  end
+end

data/examples/custom_configuration_auto_register/lib/user_repo.rb

@@ -0,0 +1,5 @@
+require 'import'
+
+class UserRepo
+  include Import['persistence.db']
+end

data/examples/custom_configuration_auto_register/run.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require_relative 'system/container'
+
+App.finalize!
+
+user_repo = App['user_repo']
+puts "User has not been loaded" unless App.key?('entities.user')
+puts user_repo.db.inspect

data/examples/custom_configuration_auto_register/system/boot/persistence.rb

@@ -0,0 +1,13 @@
+App.finalize(:persistence) do |persistence|
+  init do
+    require 'sequel'
+  end
+
+  start do
+    persistence.register('persistence.db', Sequel.connect('sqlite::memory'))
+  end
+
+  stop do
+    db.close_connection
+  end
+end

data/examples/custom_configuration_auto_register/system/container.rb

@@ -0,0 +1,16 @@
+require 'dry/system/container'
+
+class App < Dry::System::Container
+  load_paths!('lib', 'system')
+
+  auto_register!('lib') do |config|
+    config.instance do |component|
+      # some custom initialization logic
+      component.instance
+    end
+
+    config.exclude do |component|
+      component.path =~ /entities/
+    end
+  end
+end

data/examples/custom_configuration_auto_register/system/import.rb

@@ -0,0 +1,3 @@
+require_relative 'container'
+
+Import = App.injector

data/lib/dry/system/auto_registrar.rb

@@ -1,4 +1,6 @@
 require 'dry/system/constants'
+require 'dry/system/magic_comments_parser'
+require 'dry/system/auto_registrar/configuration'
 
 module Dry
   module System
@@ -6,7 +8,7 @@ module Dry
     #
     # This is currently configured by default for every System::Container.
     # Auto-registrar objects are responsible for loading files from configured
-    # auto-register paths and registering components automatically withing the
+    # auto-register paths and registering components automatically within the
     # container.
     #
     # @api private
@@ -26,14 +28,14 @@ module Dry
       end
 
       # @api private
-      def call(dir, &block)
+      def call(dir)
+        registration_config = Configuration.new
+        yield(registration_config) if block_given?
         components(dir).each do |component|
+          next if !component.auto_register? || registration_config.exclude.(component)
+
           container.require_component(component) do
-            if block
-              register(component.identifier, yield(component))
-            else
-              register(component.identifier) { component.instance }
-            end
+            register(component.identifier) { registration_config.instance.(component) }
           end
         end
       end
@@ -42,23 +44,31 @@ module Dry
 
       # @api private
       def components(dir)
-        paths(dir).
-          map { |path| component(path) }.
+        files(dir).
+          map { |file_name| [file_name, file_options(file_name)] }.
+          map { |(file_name, options)| component(relative_path(dir, file_name), **options) }.
           reject { |component| key?(component.identifier) }
       end
 
       # @api private
-      def paths(dir)
+      def files(dir)
+        Dir["#{root}/#{dir}/**/*.rb"]
+      end
+
+      # @api private
+      def relative_path(dir, file_path)
         dir_root = root.join(dir.to_s.split('/')[0])
+        file_path.to_s.sub("#{dir_root}/", '').sub(RB_EXT, EMPTY_STRING)
+      end
 
-        Dir["#{root}/#{dir}/**/*.rb"].map { |path|
-          path.to_s.sub("#{dir_root}/", '').sub(RB_EXT, EMPTY_STRING)
-        }
+      # @api private
+      def file_options(file_name)
+        MagicCommentsParser.(file_name)
       end
 
       # @api private
-      def component(path)
-        container.component(path)
+      def component(path, options)
+        container.component(path, options)
       end
 
       # @api private

data/lib/dry/system/auto_registrar/configuration.rb

@@ -0,0 +1,39 @@
+module Dry
+  module System
+    class AutoRegistrar
+      # Default auto_registrar configuration
+      #
+      # This is currently configured by default for every System::Container.
+      # Configuration allows to define custom initializtion logic as well
+      # as exclusion, for each component that is been register by Dry::System
+      # auto-registration.
+      #
+      # @api private
+      class Configuration
+        DEFAULT_INSTANCE = -> component { component.instance }.freeze
+        FALSE_PROC = -> * { false }.freeze
+
+        def self.setting(name)
+          define_method(name) do |&block|
+            ivar = "@#{name}"
+
+            if block
+              instance_variable_set(ivar, block)
+            else
+              instance_variable_get(ivar)
+            end
+          end
+        end
+
+        setting :exclude
+        setting :instance
+
+        # @api private
+        def initialize
+          @instance = DEFAULT_INSTANCE
+          @exclude = FALSE_PROC
+        end
+      end
+    end
+  end
+end

data/lib/dry/system/booter.rb

@@ -66,11 +66,11 @@ module Dry
       def call(name)
         container, finalizer = finalizers[name]
 
-        if finalizer
-          lifecycle = Lifecycle.new(container, &finalizer)
-          yield(lifecycle) if block_given?
-          lifecycle
-        end
+        raise ComponentFileMismatchError.new(name, registered_booted_keys) unless finalizer
+
+        lifecycle = Lifecycle.new(container, &finalizer)
+        yield(lifecycle) if block_given?
+        lifecycle
       end
 
       # @api private
@@ -81,6 +81,11 @@ module Dry
 
       private
 
+      # @api private
+      def registered_booted_keys
+        finalizers.keys - booted.keys
+      end
+
       # @api private
       def boot_files
         path.join('**/*.rb').to_s

data/lib/dry/system/component.rb

@@ -47,9 +47,7 @@ module Dry
           options = DEFAULT_OPTIONS.merge(options || {})
 
           ns, sep = options.values_at(:namespace, :separator)
-
-          ns_name = ensure_valid_namespace(ns, sep)
-          identifier = ensure_valid_identifier(name, ns_name, sep)
+          identifier = ensure_valid_identifier(name, ns, sep)
 
           path = name.to_s.gsub(sep, PATH_SEPARATOR)
           loader = options.fetch(:loader, Loader).new(path)
@@ -59,21 +57,14 @@ module Dry
       end
 
       # @api private
-      def self.ensure_valid_namespace(ns, sep)
-        ns_name = ns.to_s
-        raise InvalidNamespaceError, ns_name if ns && ns_name.include?(sep)
-        ns_name
-      end
-
-      # @api private
-      def self.ensure_valid_identifier(name, ns_name, sep)
+      def self.ensure_valid_identifier(name, ns, sep)
         keys = name.to_s.scan(WORD_REGEX)
 
         if keys.uniq.size != keys.size
           raise InvalidComponentError, name, 'duplicated keys in the name'
         end
 
-        keys.reject { |s| ns_name == s }.join(sep)
+        keys.reject { |s| ns.to_s.include?(s) }.join(sep)
       end
 
       # @api private
@@ -152,6 +143,11 @@ module Dry
         options[:namespace]
       end
 
+      # @api private
+      def auto_register?
+        !!options.fetch(:auto_register) { true }
+      end
+
       # @api private
       def root_key
         namespaces.first

data/lib/dry/system/constants.rb

@@ -1,6 +1,7 @@
 module Dry
   module System
     RB_EXT = '.rb'.freeze
+    RB_GLOB = '*.rb'.freeze
     EMPTY_STRING = ''.freeze
     PATH_SEPARATOR = '/'.freeze
     DEFAULT_SEPARATOR = '.'.freeze

data/lib/dry/system/container.rb

@@ -8,6 +8,7 @@ require 'dry/system/errors'
 require 'dry/system/loader'
 require 'dry/system/booter'
 require 'dry/system/auto_registrar'
+require 'dry/system/manual_registrar'
 require 'dry/system/importer'
 require 'dry/system/component'
 require 'dry/system/constants'
@@ -67,10 +68,12 @@ module Dry
       setting :default_namespace
       setting :root, Pathname.pwd.freeze
       setting :system_dir, 'system'.freeze
+      setting :registrations_dir, 'container'.freeze
       setting :auto_register, []
       setting :loader, Dry::System::Loader
       setting :booter, Dry::System::Booter
       setting :auto_registrar, Dry::System::AutoRegistrar
+      setting :manual_registrar, Dry::System::ManualRegistrar
       setting :importer, Dry::System::Importer
 
       class << self
@@ -101,7 +104,6 @@ module Dry
         #   class Core < Dry::System::Container
         #     configure do |config|
         #       config.root = Pathname("/path/to/app")
-        #       config.name = :core
         #       config.auto_register = %w(lib/apis lib/core)
         #     end
         #   end
@@ -112,14 +114,13 @@ module Dry
         #   class MyApp < Dry::System::Container
         #     configure do |config|
         #       config.root = Pathname("/path/to/app")
-        #       config.name = :core
         #       config.auto_register = %w(lib/apis lib/core)
         #     end
         #
         #     import core: Core
         #   end
         #
-        # @param other [Hash,Dry::Container::Namespace,Dry::System::Container]
+        # @param other [Hash,Dry::Container::Namespace]
         #
         # @api public
         def import(other)
@@ -127,9 +128,7 @@ module Dry
           when Hash then importer.register(other)
           when Dry::Container::Namespace then super
           else
-            if other < System::Container
-              importer.register(other.config.name => other)
-            end
+            raise ArgumentError, "+other+ must be a hash of names and systems, or a Dry::Container namespace"
           end
         end
 
@@ -247,6 +246,7 @@ module Dry
 
           importer.finalize!
           booter.finalize!
+          manual_registrar.finalize!
           auto_registrar.finalize!
 
           freeze
@@ -312,11 +312,18 @@ module Dry
           self
         end
 
+        # @api public
+        def load_registrations!(name)
+          manual_registrar.(name)
+          self
+        end
+
         # Auto-registers components from the provided directory
         #
         # Typically you want to configure auto_register directories, and it will
         # work automatically. Use this method in cases where you want to have an
-        # explicit way where some components are auto-registered.
+        # explicit way where some components are auto-registered, or if you want
+        # to exclude some components from been auto-registered
         #
         # @example
         #   class MyApp < Dry::System::Container
@@ -328,15 +335,21 @@ module Dry
         #     auto_register!('lib/core')
         #
         #     # with a dir and a custom registration block
-        #     auto_register!('lib/core') do |component|
-        #       # custom way of initializing a component
+        #     auto_register!('lib/core') do |config|
+        #       config.instance do |component|
+        #         # custom way of initializing a component
+        #       end
+        #
+        #       config.exclude do |component|
+        #         # return true to exclude component from auto-registration
+        #       end
         #     end
         #   end
         #
         # @param [String] dir The dir name relative to the root dir
         #
-        # @yield [Component]
-        # @see [Component]
+        # @yield AutoRegistrar::Configuration
+        # @see AutoRegistrar::Configuration
         #
         # @return [self]
         #
@@ -435,18 +448,24 @@ module Dry
           @auto_registrar ||= config.auto_registrar.new(self)
         end
 
+        # @api private
+        def manual_registrar
+          @manual_registrar ||= config.manual_registrar.new(self)
+        end
+
         # @api private
         def importer
           @importer ||= config.importer.new(self)
         end
 
         # @api private
-        def component(key)
+        def component(key, **options)
           Component.new(
             key,
             loader: config.loader,
             namespace: config.default_namespace,
-            separator: config.namespace_separator
+            separator: config.namespace_separator,
+            **options,
           )
         end
 
@@ -483,15 +502,17 @@ module Dry
         private
 
         # @api private
-        def load_local_component(component, fallback = false)
+        def load_local_component(component, default_namespace_fallback = false)
           if component.bootable?(booter.path) || component.file_exists?(load_paths)
             booter.boot_dependency(component) unless frozen?
 
             require_component(component) do
               register(component.identifier) { component.instance }
             end
-          elsif !fallback
+          elsif !default_namespace_fallback
             load_local_component(component.prepend(config.default_namespace), true)
+          elsif manual_registrar.file_exists?(component)
+            manual_registrar.(component)
           else
             raise ComponentLoadError, component
           end

data/lib/dry/system/errors.rb

@@ -10,21 +10,21 @@ module Dry
       end
     end
 
-    # Error raised when a resolved component couldn't be found
+    # Error raised when booter file do not match with register component
     #
     # @api public
-    ComponentLoadError = Class.new(StandardError) do
-      def initialize(component)
-        super("could not load component #{component.inspect}")
+    ComponentFileMismatchError = Class.new(StandardError) do
+      def initialize(filename, registered_booted_keys)
+        super("Mismatch between filename +#{filename}+ and registered components +#{registered_booted_keys}+")
       end
     end
 
-    # Error raised when invalid namespace name was provided
+    # Error raised when a resolved component couldn't be found
     #
     # @api public
-    InvalidNamespaceError = Class.new(StandardError) do
-      def initialize(ns)
-        super("Namespace #{ns} cannot include a separator")
+    ComponentLoadError = Class.new(StandardError) do
+      def initialize(component)
+        super("could not load component #{component.inspect}")
       end
     end
 

data/lib/dry/system/magic_comments_parser.rb

@@ -0,0 +1,31 @@
+module Dry
+  module System
+    class MagicCommentsParser
+      VALID_LINE_RE = /^(#.*)?$/.freeze
+      COMMENT_RE = /^#\s+(?<name>[A-Za-z]{1}[A-Za-z0-9_]+):\s+(?<value>.+?)$/.freeze
+
+      COERCIONS = {
+        'true' => true,
+        'false' => false,
+      }.freeze
+
+      def self.call(file_name)
+        {}.tap do |options|
+          File.foreach(file_name) do |line|
+            break unless line =~ VALID_LINE_RE
+
+            if (comment = line.match(COMMENT_RE))
+              options[comment[:name].to_sym] = coerce(comment[:value])
+            end
+          end
+        end
+      end
+
+      private
+
+      def self.coerce(value)
+        COERCIONS.fetch(value) { value }
+      end
+    end
+  end
+end

data/lib/dry/system/manual_registrar.rb

@@ -0,0 +1,57 @@
+require 'pathname'
+require 'dry/system/constants'
+
+module Dry
+  module System
+    # Default manual registration implementation
+    #
+    # This is currently configured by default for every System::Container.
+    # Manual registrar objects are responsible for loading files from configured
+    # manual registration paths, which should hold code to explicitly register
+    # certain objects with the container.
+    #
+    # @api private
+    class ManualRegistrar
+      attr_reader :container
+
+      attr_reader :config
+
+      def initialize(container)
+        @container = container
+        @config = container.config
+      end
+
+      # @api private
+      def finalize!
+        Dir[registrations_dir.join(RB_GLOB)].each do |file|
+          call(File.basename(file, RB_EXT))
+        end
+      end
+
+      # @api private
+      def call(name)
+        name = name.respond_to?(:root_key) ? name.root_key.to_s : name
+
+        require(root.join(config.registrations_dir, name))
+      end
+
+      def file_exists?(name)
+        name = name.respond_to?(:root_key) ? name.root_key.to_s : name
+
+        File.exist?(File.join(registrations_dir, "#{name}#{RB_EXT}"))
+      end
+
+      private
+
+      # @api private
+      def registrations_dir
+        root.join(config.registrations_dir)
+      end
+
+      # @api private
+      def root
+        Pathname(container.root)
+      end
+    end
+  end
+end

data/lib/dry/system/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module System
-    VERSION = '0.6.0'.freeze
+    VERSION = '0.7.0'.freeze
   end
 end

data/spec/fixtures/components/no_register.rb

@@ -0,0 +1,4 @@
+# auto_register: false
+
+class NoRegister
+end

data/spec/fixtures/magic_comments/comments.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# This is a file with a mix of valid and invalid magic comments
+
+# valid_comment: hello
+# true_comment: true
+# false_comment: false
+# comment_123: alpha-numeric and underscores allowed
+# 123_will_not_match: will not match
+# not-using-underscores: value for comment using dashes
+
+  # not_at_start_of_line: will not match
+
+module Test
+end
+
+# after_code: will not match

data/spec/fixtures/manual_registration/container/foo.rb

@@ -0,0 +1,6 @@
+Test::Container.namespace(:foo) do |container|
+  container.register('special') do
+    require 'test/foo'
+    Test::Foo.new('special')
+  end
+end

data/spec/fixtures/manual_registration/lib/test/foo.rb

@@ -0,0 +1,9 @@
+module Test
+  class Foo
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+  end
+end

data/spec/fixtures/multiple_namespaced_components/multiple/level/baz.rb

@@ -0,0 +1,7 @@
+module Multiple
+  module Level
+    class Baz
+      include Test::Container.injector["foz"]
+    end
+  end
+end

data/spec/fixtures/multiple_namespaced_components/multiple/level/foz.rb

@@ -0,0 +1,6 @@
+module Multiple
+  module Level
+    class Foz
+    end
+  end
+end

data/spec/fixtures/other/config/boot/hell.rb

@@ -0,0 +1,3 @@
+Test::Container.finalize :heaven do |container|
+  container.register('heaven', 'string')
+end

data/spec/fixtures/test/system/boot/hell.rb

@@ -0,0 +1,3 @@
+Test::Container.finalize :heaven do |container|
+  container.register('heaven', 'string')
+end

data/spec/integration/container/lazy_loading/manual_registration_spec.rb

@@ -0,0 +1,18 @@
+RSpec.describe 'Lazy-loading manual registration files' do
+  before do
+    module Test
+      class Container < Dry::System::Container
+        configure do |config|
+          config.root = SPEC_ROOT.join('fixtures/manual_registration').realpath
+        end
+
+        load_paths!('lib')
+      end
+    end
+  end
+
+  it 'loads a manual registration file if the component could not be found' do
+    expect(Test::Container['foo.special']).to be_a(Test::Foo)
+    expect(Test::Container['foo.special'].name).to eq "special"
+  end
+end

data/spec/integration/import_spec.rb

@@ -36,7 +36,7 @@ RSpec.describe 'Lazy-booting external deps' do
 
     before do
       module Test
-        Umbrella.import(App)
+        Umbrella.import(main: App)
         Import = Umbrella.injector
       end
     end
@@ -53,7 +53,7 @@ RSpec.describe 'Lazy-booting external deps' do
 
     before do
       module Test
-        App.import(Umbrella)
+        App.import(core: Umbrella)
         Import = App.injector
       end
     end

data/spec/unit/auto_registrar/configuration_spec.rb

@@ -0,0 +1,26 @@
+require 'dry/system/auto_registrar/configuration'
+
+RSpec.describe Dry::System::AutoRegistrar::Configuration do
+  subject(:auto_registration_conf) { Dry::System::AutoRegistrar::Configuration.new }
+
+  describe "deafult values" do
+    it "will setup exclude default proc" do
+      expect(subject.exclude.(8)).to eq false
+    end
+
+    it "will setup instance default proc" do
+      component = double("component")
+      expect(component).to receive(:instance)
+      subject.instance.(component)
+    end
+  end
+
+  describe "add custom proc object to configuration" do
+    it "execute proc that was previously save" do
+      proc = Proc.new { |value| value + 1 }
+      subject.instance(&proc)
+      result = subject.instance.(5)
+      expect(result).to eq 6
+    end
+  end
+end

data/spec/unit/component_spec.rb

@@ -12,11 +12,6 @@ RSpec.describe Dry::System::Component do
       expect(create.()).to be(create.())
     end
 
-    it 'raises when namespace includes a separator' do
-      expect { Dry::System::Component.new('foo.bar.baz', namespace: 'foo.bar') }
-        .to raise_error(Dry::System::InvalidNamespaceError, /foo\.bar/)
-    end
-
     it 'raises when identifier/path has duplicated keys' do
       expect { Dry::System::Component.new('foo.bar.foo', namespace: 'foo') }
         .to raise_error(Dry::System::InvalidComponentError, /foo\.bar\.foo/)

data/spec/unit/container/auto_register_spec.rb

@@ -16,9 +16,13 @@ RSpec.describe Dry::System::Container, '.auto_register!' do
     it { expect(Test::Container['foo']).to be_an_instance_of(Foo) }
     it { expect(Test::Container['bar']).to be_an_instance_of(Bar) }
     it { expect(Test::Container['bar.baz']).to be_an_instance_of(Bar::Baz) }
+
+    it "doesn't register files with inline option 'auto_register: false'" do
+      expect(Test::Container.key?('no_register')).to eql false
+    end
   end
 
-  context 'with custom registration block' do
+  context 'with custom configuration block' do
     before do
       class Test::Container < Dry::System::Container
         configure do |config|
@@ -29,14 +33,21 @@ RSpec.describe Dry::System::Container, '.auto_register!' do
       end
     end
 
-    it 'yields found components' do
-      Test::Container.auto_register!('components') do |component|
-        component.identifier
+    it 'exclude specific components' do
+      Test::Container.auto_register!('components') do |config|
+        config.instance do |component|
+          component.identifier
+        end
+
+        config.exclude do |component|
+          component.path =~ /bar/
+        end
       end
 
       expect(Test::Container['foo']).to eql('foo')
-      expect(Test::Container['bar']).to eql('bar')
-      expect(Test::Container['bar.baz']).to eql('bar.baz')
+
+      expect(Test::Container.key?('bar')).to eql false
+      expect(Test::Container.key?('bar.baz')).to eql false
     end
   end
 
@@ -58,6 +69,23 @@ RSpec.describe Dry::System::Container, '.auto_register!' do
     specify { expect(Test::Container['foo']).to be_a(Namespaced::Foo) }
   end
 
+  context 'standard loader with a default namespace with multiple level' do
+    before do
+      class Test::Container < Dry::System::Container
+        configure do |config|
+          config.root = SPEC_ROOT.join('fixtures').realpath
+          config.default_namespace = 'multiple.level'
+        end
+
+        load_paths!('multiple_namespaced_components')
+        auto_register!('multiple_namespaced_components')
+      end
+    end
+
+    specify { expect(Test::Container['baz']).to be_a(Multiple::Level::Baz) }
+    specify { expect(Test::Container['foz']).to be_a(Multiple::Level::Foz) }
+  end
+
   context 'with a custom loader' do
     before do
       class Test::Loader < Dry::System::Loader

data/spec/unit/container/import_spec.rb

@@ -9,31 +9,14 @@ RSpec.describe Dry::System::Container, '.import' do
     end
   end
 
-  shared_examples_for 'an extended container' do
-    it 'imports one container into another' do
-      expect(app.key?('persistence.users')).to be(false)
+  it 'imports one container into another' do
+    app.import(persistence: db)
 
-      app.finalize!
+    expect(app.key?('persistence.users')).to be(false)
 
-      expect(app['persistence.users']).to eql(%w(jane joe))
-    end
-  end
-
-  context 'when a container has a name' do
-    before do
-      db.configure { |c| c.name = :persistence }
-      app.import(db)
-    end
-
-    it_behaves_like 'an extended container'
-  end
-
-  context 'when container does not have a name' do
-    before do
-      app.import(persistence: db)
-    end
+    app.finalize!
 
-    it_behaves_like 'an extended container'
+    expect(app['persistence.users']).to eql(%w(jane joe))
   end
 
   describe 'import module' do

data/spec/unit/container_spec.rb

@@ -142,6 +142,14 @@ RSpec.describe Dry::System::Container do
           'component identifier +foo+ is invalid or boot file is missing'
         )
       end
+
+      describe "missmatch betwenn finalize name and registered component" do
+        it "raises a meaningful error" do
+          expect{
+            container.boot!(:hell)
+          }.to raise_error(Dry::System::ComponentFileMismatchError)
+        end
+      end
     end
 
     context 'with the default core dir' do

data/spec/unit/magic_comments_parser_spec.rb

@@ -0,0 +1,41 @@
+require 'dry/system/magic_comments_parser'
+
+RSpec.describe Dry::System::MagicCommentsParser, '.call' do
+  let(:file_name) { SPEC_ROOT.join('fixtures/magic_comments/comments.rb') }
+  let(:comments) { described_class.(file_name) }
+
+  it 'makes comment names available as symbols' do
+    expect(comments.key?(:valid_comment)).to eql true
+  end
+
+  it 'finds magic comments after other commented lines or blank lines' do
+    expect(comments[:valid_comment]).to eq 'hello'
+  end
+
+  it 'does not match comments with invalid names' do
+    expect(comments.values).not_to include 'value for comment using dashes'
+  end
+
+  it 'supports comment names with alpha-numeric characters and underscores (numbers not allowed for first character)' do
+    expect(comments[:comment_123]).to eq 'alpha-numeric and underscores allowed'
+    expect(comments.keys).not_to include(:"123_will_not_match")
+  end
+
+  it 'only matches comments at the start of the line' do
+    expect(comments.key?(:not_at_start_of_line)).to eql false
+  end
+
+  it 'does not match any comments after any lines of code' do
+    expect(comments.key?(:after_code)).to eql false
+  end
+
+  describe 'coercions' do
+    it 'coerces "true" to true' do
+      expect(comments[:true_comment]).to eq true
+    end
+
+    it 'coerces "false" to false' do
+      expect(comments[:false_comment]).to eq false
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-system
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflecto
@@ -145,16 +145,22 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - dry-system.gemspec
+- examples/custom_configuration_auto_register/Gemfile
+- examples/custom_configuration_auto_register/lib/entities/user.rb
+- examples/custom_configuration_auto_register/lib/user_repo.rb
+- examples/custom_configuration_auto_register/run.rb
+- examples/custom_configuration_auto_register/system/boot/persistence.rb
+- examples/custom_configuration_auto_register/system/container.rb
+- examples/custom_configuration_auto_register/system/import.rb
 - examples/standalone/Gemfile
 - examples/standalone/lib/user_repo.rb
 - examples/standalone/run.rb
@@ -164,6 +170,7 @@ files:
 - lib/dry-system.rb
 - lib/dry/system.rb
 - lib/dry/system/auto_registrar.rb
+- lib/dry/system/auto_registrar/configuration.rb
 - lib/dry/system/booter.rb
 - lib/dry/system/component.rb
 - lib/dry/system/constants.rb
@@ -172,10 +179,13 @@ files:
 - lib/dry/system/importer.rb
 - lib/dry/system/lifecycle.rb
 - lib/dry/system/loader.rb
+- lib/dry/system/magic_comments_parser.rb
+- lib/dry/system/manual_registrar.rb
 - lib/dry/system/version.rb
 - spec/fixtures/components/bar.rb
 - spec/fixtures/components/bar/baz.rb
 - spec/fixtures/components/foo.rb
+- spec/fixtures/components/no_register.rb
 - spec/fixtures/import_test/config/application.yml
 - spec/fixtures/import_test/lib/test/bar.rb
 - spec/fixtures/import_test/lib/test/foo.rb
@@ -187,9 +197,15 @@ files:
 - spec/fixtures/lazytest/lib/test/models/book.rb
 - spec/fixtures/lazytest/lib/test/models/user.rb
 - spec/fixtures/lazytest/system/boot/bar.rb
+- spec/fixtures/magic_comments/comments.rb
+- spec/fixtures/manual_registration/container/foo.rb
+- spec/fixtures/manual_registration/lib/test/foo.rb
+- spec/fixtures/multiple_namespaced_components/multiple/level/baz.rb
+- spec/fixtures/multiple_namespaced_components/multiple/level/foz.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/config/boot/hell.rb
 - spec/fixtures/other/lib/test/dep.rb
 - spec/fixtures/other/lib/test/foo.rb
 - spec/fixtures/other/lib/test/models.rb
@@ -207,11 +223,14 @@ files:
 - spec/fixtures/test/system/boot/bar.rb
 - spec/fixtures/test/system/boot/client.rb
 - spec/fixtures/test/system/boot/db.rb
+- spec/fixtures/test/system/boot/hell.rb
 - spec/fixtures/test/system/boot/logger.rb
 - spec/fixtures/umbrella/system/boot/db.rb
 - spec/integration/boot_spec.rb
+- spec/integration/container/lazy_loading/manual_registration_spec.rb
 - spec/integration/import_spec.rb
 - spec/spec_helper.rb
+- spec/unit/auto_registrar/configuration_spec.rb
 - spec/unit/component_spec.rb
 - spec/unit/container/auto_register_spec.rb
 - spec/unit/container/finalize_spec.rb
@@ -219,6 +238,7 @@ files:
 - spec/unit/container/injector_spec.rb
 - spec/unit/container_spec.rb
 - spec/unit/loader_spec.rb
+- spec/unit/magic_comments_parser_spec.rb
 homepage: http://dry-rb.org/gems/dry-system
 licenses:
 - MIT
@@ -239,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.9
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Organize your code into reusable components
@@ -247,6 +267,7 @@ test_files:
 - spec/fixtures/components/bar.rb
 - spec/fixtures/components/bar/baz.rb
 - spec/fixtures/components/foo.rb
+- spec/fixtures/components/no_register.rb
 - spec/fixtures/import_test/config/application.yml
 - spec/fixtures/import_test/lib/test/bar.rb
 - spec/fixtures/import_test/lib/test/foo.rb
@@ -258,9 +279,15 @@ test_files:
 - spec/fixtures/lazytest/lib/test/models/book.rb
 - spec/fixtures/lazytest/lib/test/models/user.rb
 - spec/fixtures/lazytest/system/boot/bar.rb
+- spec/fixtures/magic_comments/comments.rb
+- spec/fixtures/manual_registration/container/foo.rb
+- spec/fixtures/manual_registration/lib/test/foo.rb
+- spec/fixtures/multiple_namespaced_components/multiple/level/baz.rb
+- spec/fixtures/multiple_namespaced_components/multiple/level/foz.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/config/boot/hell.rb
 - spec/fixtures/other/lib/test/dep.rb
 - spec/fixtures/other/lib/test/foo.rb
 - spec/fixtures/other/lib/test/models.rb
@@ -278,11 +305,14 @@ test_files:
 - spec/fixtures/test/system/boot/bar.rb
 - spec/fixtures/test/system/boot/client.rb
 - spec/fixtures/test/system/boot/db.rb
+- spec/fixtures/test/system/boot/hell.rb
 - spec/fixtures/test/system/boot/logger.rb
 - spec/fixtures/umbrella/system/boot/db.rb
 - spec/integration/boot_spec.rb
+- spec/integration/container/lazy_loading/manual_registration_spec.rb
 - spec/integration/import_spec.rb
 - spec/spec_helper.rb
+- spec/unit/auto_registrar/configuration_spec.rb
 - spec/unit/component_spec.rb
 - spec/unit/container/auto_register_spec.rb
 - spec/unit/container/finalize_spec.rb
@@ -290,3 +320,4 @@ test_files:
 - spec/unit/container/injector_spec.rb
 - spec/unit/container_spec.rb
 - spec/unit/loader_spec.rb
+- spec/unit/magic_comments_parser_spec.rb

data/.rubocop.yml

@@ -1,34 +0,0 @@
-# Generated by `rubocop --auto-gen-config`
-inherit_from: .rubocop_todo.yml
-
-# No need to handle LoadError in spec helper
-Lint/HandleExceptions:
-  Exclude:
-    - spec/spec_helper.rb
-
-Style/FileName:
-  Exclude:
-    - 'lib/dry-component.rb'
-
-# Documentation checked by Inch CI
-Style/Documentation:
-  Enabled: false
-
-# Ain't nobody got time for that!
-Style/MethodCallParentheses:
-  Enabled: false
-
-Style/Lambda:
-  Enabled: false
-
-Style/BlockDelimiters:
-  Enabled: false
-
-Style/LambdaCall:
-  EnforcedStyle: braces
-
-Style/MultilineBlockChain:
-  Enabled: false
-
-Style/StabbyLambdaParentheses:
-  EnforcedStyle: require_no_parentheses

data/.rubocop_todo.yml

@@ -1,26 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2015-12-23 21:42:26 +0000 using RuboCop version 0.35.1.
-# 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
-Metrics/AbcSize:
-  Max: 25
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 130
-
-# Offense count: 1
-# Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
-  Max: 84
-
-# Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 14