dry-initializer 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a766e40753a382067be26c74413c5559153aa5c
-  data.tar.gz: c42a2c954be3312dd1c319afa9cbd8c27f3651b3
+  metadata.gz: ae0e61fb5894f53da09eea595818f5c6d9dc5482
+  data.tar.gz: d4b4eb054a1a5ccaf9d8211aed807c841fe3b0a0
 SHA512:
-  metadata.gz: c8825deefcd6da06a075b83a17fbcbafcbd0f5d4887330567b71df464979970aae455b7c9c9f4bb40a34abddfa4ffde89553712f1a2b81de249ea24009511e0a
-  data.tar.gz: 31c7ec0f9c6b582967438cf0feb8bb270e5ac6c9028d4e587f4c68a6b5980ba6ccfde630555f9295af90477003cb49988048e2f23a7644a383bf83efcff5be11
+  metadata.gz: ab37761b6ef475ba335e92b2751db1276d68b67a43d2e6f69a9e6e98f5e0ba2ffeb916739d2aab863327b8ab3fc64c30569144ceba881c90108628e4e50eb065
+  data.tar.gz: 866ec3b26e494e5f40066e0dd8f98a926f7cd696fdda71837ff0d06f099ab83252cca2e68e175f7632fe28c34902705ea4396246a9860ad731da62742002d648

data/CHANGELOG.md

@@ -1,3 +1,43 @@
+## v0.3.0 2016-05-19
+
+Breaks interface for adding new plugins. Register new plugin via:
+
+```
+def self.extended(klass)
+  klass.register_initializer_plugin NewPlugin
+end
+```
+
+instead of:
+
+```
+def self.extended(klass)
+  klass.initializer_builder.register NewPlugin
+end
+```
+
+While the private method ##initializer_builder is still accessible
+its method #register doesn't mutate the builder instance.
+
+### Changed (backward-incompatible changes)
+
+* Made Mixin##initializer_builder method private (@nepalez)
+* Add Mixin#register_initializer_plugin(plugin) method (@nepalez)
+
+### Bugs Fixed
+
+* Prevent plugin's registry from polluting superclass (@nepalez)
+
+[Compare v0.2.1...v0.3.0](https://github.com/dry-rb/dry-initializer/compare/v0.2.1..v0.3.0)
+
+### Internals
+
+* Make all instances (Builder and Signature) immutable (@nepalez)
+* Decouple mixin from a builder to prevent pollution (@nepalez)
+* Ensure default value block can use private variables (@jeremyf)
+
+[Compare v0.2.0...v0.2.1](https://github.com/dry-rb/dry-initializer/compare/v0.2.0...v0.2.1)
+
 ## v0.2.1 2016-05-19
 
 ### Bugs Fixed

data/dry-initializer.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "dry-initializer"
-  gem.version  = "0.2.1"
+  gem.version  = "0.3.0"
   gem.author   = ["Vladimir Kochnev (marshall-lee)", "Andrew Kozin (nepalez)"]
   gem.email    = ["hashtable@yandex.ru", "andrew.kozin@gmail.com"]
   gem.homepage = "https://github.com/dryrb/dry-initializer"

data/lib/dry/initializer/builder.rb

@@ -24,26 +24,33 @@ module Dry::Initializer
 
     # Defines new agrument and reloads mixin definitions
     #
-    # @param [Module] mixin
+    # @param (see #call)
     # @param [#to_sym] name
     # @param [Hash<Symbol, Object>] settings
     #
     # @return [self] itself
     #
-    def reload(mixin, name, settings)
+    def define(mixin, name, settings)
       signature = @signature.add(name, settings)
       parts     = @parts + @plugins.map { |p| p.call(name, settings) }.compact
 
       copy do
         @signature = signature
         @parts     = parts
-
-        define_readers(mixin)
-        reload_initializer(mixin)
-        reload_callback(mixin)
+        call(mixin)
       end
     end
 
+    # Redeclares initializer and readers in the mixin module
+    #
+    # @param [Module] mixin
+    #
+    def call(mixin)
+      define_readers(mixin)
+      reload_initializer(mixin)
+      reload_callback(mixin)
+    end
+
     private
 
     def copy(&block)

data/lib/dry/initializer/mixin.rb

@@ -13,7 +13,7 @@ module Dry::Initializer
     #
     def param(name, **options)
       @initializer_builder = initializer_builder
-                             .reload(self, name, option: false, **options)
+                             .define(self, name, option: false, **options)
       self
     end
 
@@ -25,16 +25,27 @@ module Dry::Initializer
     #
     def option(name, **options)
       @initializer_builder = initializer_builder
-                             .reload(self, name, option: true, **options)
+                             .define(self, name, option: true, **options)
       self
     end
 
-    # @private
+    # Adds new plugin to the builder
+    #
+    # @param  [Dry::Initializer::Plugins::Base] plugin
+    # @return [self] itself
+    #
+    def register_initializer_plugin(plugin)
+      @initializer_builder = initializer_builder.register(plugin)
+      initializer_builder.call(self)
+      self
+    end
+
+    private
+
     def initializer_builder
       @initializer_builder ||= Builder.new
     end
 
-    # @private
     def inherited(klass)
       klass.instance_variable_set :@initializer_builder, initializer_builder.dup
     end

data/spec/dry/plugin_registry_spec.rb

@@ -0,0 +1,45 @@
+describe "plugin registry" do
+  before do
+    # Define a plugin
+    module Test::Stringifier
+      class Plugin < Dry::Initializer::Plugins::Base
+        def call
+          "@#{name} = @#{name}.to_s"
+        end
+      end
+
+      def self.extended(klass)
+        klass.register_initializer_plugin(Plugin)
+      end
+    end
+
+    # Define superclass
+    class Test::Foo
+      extend Dry::Initializer::Mixin
+
+      param :foo
+    end
+
+    # Apply the plugin to the subclass
+    class Test::Bar < Test::Foo
+      extend Test::Stringifier
+
+      param :bar
+    end
+  end
+
+  let(:instance_of_superclass) { Test::Foo.new :FOO }
+  let(:instance_of_subclass)   { Test::Bar.new :FOO, :BAR }
+
+  it "does not pollute superclass" do
+    expect(instance_of_superclass.foo).to eql :FOO
+  end
+
+  it "preserves declarations made in superclass" do
+    expect(instance_of_subclass.foo).to eql :FOO
+  end
+
+  it "applies plugin to new declarations" do
+    expect(instance_of_subclass.bar).to eql "BAR"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-initializer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Vladimir Kochnev (marshall-lee)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -116,6 +116,7 @@ files:
 - spec/dry/missed_default_spec.rb
 - spec/dry/object_type_constraint_spec.rb
 - spec/dry/plain_type_constraint_spec.rb
+- spec/dry/plugin_registry_spec.rb
 - spec/dry/reader_spec.rb
 - spec/dry/repetitive_definitions_spec.rb
 - spec/dry/subclassing_spec.rb
@@ -155,6 +156,7 @@ test_files:
 - spec/dry/missed_default_spec.rb
 - spec/dry/object_type_constraint_spec.rb
 - spec/dry/plain_type_constraint_spec.rb
+- spec/dry/plugin_registry_spec.rb
 - spec/dry/reader_spec.rb
 - spec/dry/repetitive_definitions_spec.rb
 - spec/dry/subclassing_spec.rb