dry-system 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a21788fc7c60708d5a764c16be462eb0efba44d1
-  data.tar.gz: f147f16d6283e31fa9382392259b3313c481c92a
+  metadata.gz: 6f148327cdac0f870ac0ac39a244d59cc2edfb15
+  data.tar.gz: d712c57e08f1968fb7092a99e3c84fe706bb4097
 SHA512:
-  metadata.gz: 4f6252dd95293e42e307dbbf38991c07153b08f532ca222659625a166a29447e328c6a1acbe74070447ea8f143673fa86c4b3f7bbb13efa0aab50eb23015d21b
-  data.tar.gz: 8357c9d5e79c649d7d6794db762debf0056db52e213616a04e1660a2974b2d6c5ea75def5f43031385b794cd9d329063c81cec816e19ff8121ec3c35caf0b3d5
+  metadata.gz: 9fa712dbe64d87958faa6eaac6fc7dfbbf0d5b30e20b1cc52c196c2159db05380fdb45da00c39b52f02488db0aebaebbc65602fab66cbc091406ac73fe44c354
+  data.tar.gz: d5214fded99b89eed583d9fbb6397432d73407eba966bfab7026a8007d9670e7b214e3a50b07ffa964a84a0a6d1b349abae7b818e3d71b57e57851edc1ea5dde

data/.travis.yml

@@ -10,11 +10,8 @@ rvm:
   - 2.1
   - 2.2
   - 2.3.1
-  - rbx
+  - 2.4.1
   - jruby-9.1.5.0
-matrix:
-  allow_failures:
-    - rvm: rbx
 notifications:
   email: false
   webhooks:

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 0.7.2 - 2017-08-02
+
+### Added
+
+* `Container.enable_stubs!` for test environments which enables stubbing components (GustavoCaso)
+
+### Changed
+
+* Component identifiers can now include same name more than once ie `foo.stuff.foo` (GustavoCaso)
+* `Container#boot!` was renamed to `Container#start` (davydovanton)
+* `Container#boot` was renamed to `Container#init` (davydovanton)
+
+[Compare v0.7.1...v0.7.2](https://github.com/dry-rb/dry-system/compare/v0.7.1...v0.7.2)
+
 # 0.7.1 - 2017-06-16
 
 ### Changed

data/dry-system.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'inflecto', '>= 0.0.2'
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
+  spec.add_runtime_dependency 'dry-core', '>= 0.3.1'
   spec.add_runtime_dependency 'dry-equalizer', '~> 0.2'
   spec.add_runtime_dependency 'dry-container', '~> 0.6'
   spec.add_runtime_dependency 'dry-auto_inject', '>= 0.4.0'

data/lib/dry/system/booter.rb

@@ -33,13 +33,13 @@ module Dry
       # @api private
       def finalize!
         Dir[boot_files].each do |path|
-          boot!(File.basename(path, '.rb').to_sym)
+          start(File.basename(path, '.rb').to_sym)
         end
         freeze
       end
 
       # @api private
-      def boot(name)
+      def init(name)
         Kernel.require(path.join(name.to_s))
 
         call(name) do |lifecycle|
@@ -51,12 +51,12 @@ module Dry
       end
 
       # @api private
-      def boot!(name)
+      def start(name)
         check_component_identifier(name)
 
         return self if booted.key?(name)
 
-        boot(name) { |lifecycle| lifecycle.(:start) }
+        init(name) { |lifecycle| lifecycle.(:start) }
         booted[name] = true
 
         self
@@ -76,7 +76,7 @@ module Dry
       # @api private
       def boot_dependency(component)
         boot_file = component.boot_file(path)
-        boot!(boot_file.basename('.*').to_s.to_sym) if boot_file.exist?
+        start(boot_file.basename('.*').to_s.to_sym) if boot_file.exist?
       end
 
       private

data/lib/dry/system/component.rb

@@ -47,7 +47,7 @@ module Dry
           options = DEFAULT_OPTIONS.merge(options || {})
 
           ns, sep = options.values_at(:namespace, :separator)
-          identifier = ensure_valid_identifier(name, ns, sep)
+          identifier = extract_identifier(name, ns, sep)
 
           path = name.to_s.gsub(sep, PATH_SEPARATOR)
           loader = options.fetch(:loader, Loader).new(path)
@@ -57,14 +57,18 @@ module Dry
       end
 
       # @api private
-      def self.ensure_valid_identifier(name, ns, sep)
-        keys = name.to_s.scan(WORD_REGEX)
+      def self.extract_identifier(name, ns, sep)
+        name_s = name.to_s
+        identifier = ns ? remove_namespace_from_path(name_s, ns) : name_s
 
-        if keys.uniq.size != keys.size
-          raise InvalidComponentError, name, 'duplicated keys in the name'
-        end
+        identifier.scan(WORD_REGEX).join(sep)
+      end
 
-        keys.reject { |s| ns.to_s.include?(s) }.join(sep)
+      # @api private
+      def self.remove_namespace_from_path(name, ns)
+        match_value = name.match(/^(?<remove_namespace>#{ns}).(?<identifier>.*)/)
+        raise InvalidComponentError.new(name, "namespace +#{ns}+ not found in path") unless match_value
+        match_value[:identifier]
       end
 
       # @api private

data/lib/dry/system/container.rb

@@ -4,6 +4,8 @@ require 'dry-auto_inject'
 require 'dry-configurable'
 require 'dry-container'
 
+require 'dry/core/deprecations'
+
 require 'dry/system/errors'
 require 'dry/system/loader'
 require 'dry/system/booter'
@@ -77,6 +79,7 @@ module Dry
       setting :importer, Dry::System::Importer
 
       class << self
+        extend Dry::Core::Deprecations['Dry::System::Container']
         # Configures the container
         #
         # @example
@@ -239,7 +242,7 @@ module Dry
         # @return [self] frozen container
         #
         # @api public
-        def finalize!(&block)
+        def finalize!(freeze: true, &block)
           return self if frozen?
 
           yield(self) if block
@@ -249,7 +252,7 @@ module Dry
           manual_registrar.finalize!
           auto_registrar.finalize!
 
-          freeze
+          self.freeze if freeze
         end
 
         # Boots a specific component
@@ -257,17 +260,18 @@ module Dry
         # As a result, `init` and `start` lifecycle triggers are called
         #
         # @example
-        #   MyApp.boot!(:persistence)
+        #   MyApp.start(:persistence)
         #
         # @param name [Symbol] the name of a registered bootable component
         #
         # @return [self]
         #
         # @api public
-        def boot!(name)
-          booter.boot!(name)
+        def start(name)
+          booter.start(name)
           self
         end
+        deprecate :boot!, :start
 
         # Boots a specific component but calls only `init` lifecycle trigger
         #
@@ -275,17 +279,18 @@ module Dry
         # needed but its started environment is not required
         #
         # @example
-        #   MyApp.boot(:persistence)
+        #   MyApp.init(:persistence)
         #
         # @param [Symbol] name The name of a registered bootable component
         #
         # @return [self]
         #
         # @api public
-        def boot(name)
-          booter.boot(name)
+        def init(name)
+          booter.init(name)
           self
         end
+        deprecate :boot, :init
 
         # Sets load paths relative to the container's root dir
         #

data/lib/dry/system/lifecycle.rb

@@ -71,7 +71,7 @@ module Dry
       # @api private
       def use(*names)
         names.each do |name|
-          container.boot!(name)
+          container.start(name)
         end
       end
 

data/lib/dry/system/stubs.rb

@@ -0,0 +1,20 @@
+module Dry
+  module System
+    class Container
+      # Incuded only in the Test environment
+      # Sending the message enable_stubs! allow you to stub components after
+      # finalize your container in your tests.
+      #
+      # @api private
+      module Stubs
+        def finalize!(&block)
+          super(freeze: false, &block)
+        end
+      end
+
+      def self.enable_stubs!
+        extend ::Dry::System::Container::Stubs
+      end
+    end
+  end
+end

data/lib/dry/system/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module System
-    VERSION = '0.7.1'.freeze
+    VERSION = '0.7.2'.freeze
   end
 end

data/spec/fixtures/stubbing/lib/stubbing/car.rb

@@ -0,0 +1,7 @@
+module Stubbing
+  class Car
+    def wheels_count
+      4
+    end
+  end
+end

data/spec/fixtures/stubbing/system/boot/mock.rb

@@ -0,0 +1,3 @@
+Test::Container.finalize(:mock) do |container|
+  container.register(:mock, false)
+end

data/spec/integration/boot_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe 'boot files' do
   end
 
   it 'auto-boots dependency of a bootable component' do
-    system.boot!(:client)
+    system.start(:client)
 
     expect(system[:client]).to be_a(Client)
     expect(system[:client].logger).to be_a(Logger)

data/spec/spec_helper.rb

@@ -15,6 +15,7 @@ Dir[SPEC_ROOT.join('support/*.rb').to_s].each { |f| require f }
 Dir[SPEC_ROOT.join('shared/*.rb').to_s].each { |f| require f }
 
 require 'dry/system/container'
+require 'dry/system/stubs'
 
 module TestNamespace
   def remove_constants

data/spec/unit/component_spec.rb

@@ -12,9 +12,19 @@ RSpec.describe Dry::System::Component do
       expect(create.()).to be(create.())
     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/)
+    it 'allows to have the same key multiple times in the identifier/path' do
+      component = Dry::System::Component.new('foo.bar.foo', namespace: 'foo')
+      expect(component.identifier).to eql('bar.foo')
+    end
+
+    it 'removes only the initial part from the identifier/path' do
+      component = Dry::System::Component.new('foo.bar.foo.user.foo.bar', namespace: 'foo.bar.foo')
+      expect(component.identifier).to eql('user.foo.bar')
+    end
+
+    it 'raises when namepsace is not present  in path' do
+      expect { Dry::System::Component.new('foo.bar.foo', namespace: 'baz') }
+        .to raise_error(Dry::System::InvalidComponentError, /baz/)
     end
   end
 

data/spec/unit/container/finalize_spec.rb

@@ -53,28 +53,28 @@ RSpec.describe Dry::System::Container, '.finalize' do
   end
 
   specify 'boot triggers init' do
-    system.booter.boot(:db)
+    system.booter.init(:db)
 
     expect(db).to have_received(:establish_connection)
     expect(db).to_not have_received(:load)
   end
 
-  specify 'boot! triggers init + start' do
-    system.booter.boot!(:db)
+  specify 'start triggers init + start' do
+    system.booter.start(:db)
 
     expect(db).to have_received(:establish_connection)
     expect(db).to have_received(:load)
   end
 
-  specify 'boot! raises error on undefined method or variable' do
+  specify 'start raises error on undefined method or variable' do
     expect {
       system.finalize(:db) { oops('arg') }
-      system.booter.boot!(:db)
+      system.booter.start(:db)
     }.to raise_error(NoMethodError, /oops/)
 
     expect {
       system.finalize(:db) { oops }
-      system.booter.boot!(:db)
+      system.booter.start(:db)
     }.to raise_error(NameError, /oops/)
   end
 
@@ -83,11 +83,11 @@ RSpec.describe Dry::System::Container, '.finalize' do
   end
 
   specify 'lifecycle triggers are called only once' do
-    system.booter.boot!(:db)
-    system.booter.boot!(:db)
+    system.booter.start(:db)
+    system.booter.start(:db)
 
-    system.booter.boot(:db)
-    system.booter.boot(:db)
+    system.booter.init(:db)
+    system.booter.init(:db)
 
     expect(db).to have_received(:establish_connection).exactly(1)
     expect(db).to have_received(:load).exactly(1)

data/spec/unit/container_spec.rb

@@ -100,7 +100,7 @@ RSpec.describe Dry::System::Container do
     end
   end
 
-  describe '.boot' do
+  describe '.init' do
     before do
       class Test::Container < Dry::System::Container
         configure do |config|
@@ -112,17 +112,17 @@ RSpec.describe Dry::System::Container do
     end
 
     it 'lazy-boot a given system' do
-      container.boot(:bar)
+      container.init(:bar)
 
       expect(Test.const_defined?(:Bar)).to be(true)
       expect(container.key?('test.bar')).to be(false)
     end
   end
 
-  describe '.boot!' do
+  describe '.start' do
     shared_examples_for 'a booted system' do
       it 'boots a given system and finalizes it' do
-        container.boot!(:bar)
+        container.start(:bar)
 
         expect(Test.const_defined?(:Bar)).to be(true)
         expect(container['test.bar']).to eql('I was finalized')
@@ -130,13 +130,13 @@ RSpec.describe Dry::System::Container do
 
       it 'expects a symbol identifier matching file name' do
         expect {
-          container.boot!('bar')
+          container.start('bar')
         }.to raise_error(ArgumentError, 'component identifier "bar" must be a symbol')
       end
 
       it 'expects identifier to point to an existing boot file' do
         expect {
-          container.boot!(:foo)
+          container.start(:foo)
         }.to raise_error(
           ArgumentError,
           'component identifier +foo+ is invalid or boot file is missing'
@@ -146,7 +146,7 @@ RSpec.describe Dry::System::Container do
       describe "missmatch betwenn finalize name and registered component" do
         it "raises a meaningful error" do
           expect{
-            container.boot!(:hell)
+            container.start(:hell)
           }.to raise_error(Dry::System::ComponentFileMismatchError)
         end
       end
@@ -195,4 +195,48 @@ RSpec.describe Dry::System::Container do
       expect(Test::Container[:w00t]).to be(:awesome)
     end
   end
+
+  context 'Allow to stub container' do
+    before do
+      class Test::Container < Dry::System::Container
+        configure do |config|
+          config.root = SPEC_ROOT.join('fixtures/stubbing').realpath
+        end
+        load_paths!('lib')
+        auto_register!('lib')
+      end
+    end
+
+    describe 'without enable_stubs!' do
+      before do
+        container.finalize!
+      end
+
+      it 'raises error when trying to stub freeze container' do
+        expect {
+          allow(container).to receive(:[]).with('mock').and_return(true)
+        }.to raise_error(RuntimeError, /frozen/)
+      end
+    end
+
+    describe 'with enable_stubs!' do
+      before do
+        container.enable_stubs!
+        container.finalize!
+      end
+
+      it 'allows to stub the container it self' do
+        expect(container['mock']).to eq false
+        allow(container).to receive(:[]).with('mock').and_return(true)
+        expect(container['mock']).to eq true
+      end
+
+      it 'allows to stub components' do
+        car = container['stubbing.car']
+        expect(car.wheels_count).to eq 4
+        allow(car).to receive(:wheels_count).and_return(5)
+        expect(car.wheels_count).to eq 5
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-system
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-16 00:00:00.000000000 Z
+date: 2017-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflecto
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dry-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: dry-equalizer
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +201,7 @@ files:
 - lib/dry/system/loader.rb
 - lib/dry/system/magic_comments_parser.rb
 - lib/dry/system/manual_registrar.rb
+- lib/dry/system/stubs.rb
 - lib/dry/system/version.rb
 - spec/fixtures/components/bar.rb
 - spec/fixtures/components/bar/baz.rb
@@ -217,6 +232,8 @@ files:
 - spec/fixtures/other/lib/test/models.rb
 - spec/fixtures/other/lib/test/models/book.rb
 - spec/fixtures/other/lib/test/models/user.rb
+- spec/fixtures/stubbing/lib/stubbing/car.rb
+- spec/fixtures/stubbing/system/boot/mock.rb
 - spec/fixtures/test/config/application.yml
 - spec/fixtures/test/config/subapp.yml
 - spec/fixtures/test/lib/test/dep.rb
@@ -300,6 +317,8 @@ test_files:
 - spec/fixtures/other/lib/test/models.rb
 - spec/fixtures/other/lib/test/models/book.rb
 - spec/fixtures/other/lib/test/models/user.rb
+- spec/fixtures/stubbing/lib/stubbing/car.rb
+- spec/fixtures/stubbing/system/boot/mock.rb
 - spec/fixtures/test/config/application.yml
 - spec/fixtures/test/config/subapp.yml
 - spec/fixtures/test/lib/test/dep.rb