dry-initializer 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c99b0349e94feff82082c286d57dab769c73e6c
-  data.tar.gz: b4c23613507bd539f72dda1ae60b68ebf81024fd
+  metadata.gz: 852519c02a938d27a827cff9c4cfd1e40c9c9dac
+  data.tar.gz: 94923136d38c0afbc74ffa76ed35c4074c9ba75b
 SHA512:
-  metadata.gz: 2a916174077ac5ebdd6894bf416c10e0b6802658f1c9f848dd3902890c2e5b9c000468a60cea0b17ba4545a16f8d5c39474fe05849b14f5d67caeb51b5f67ada
-  data.tar.gz: d42931e206096f1dfd528675891ffbae169324f5c80a08204fb118d17c2ebce0c9a2daec91dfcb8f9063cd7172e0769603d75686ac60f6fed7613401e32e3b64
+  metadata.gz: c4195fe8176762d89b1593f05cde79e4c249dda71ace60fb070a75f92222f344d349cc97b3567e032d3aa67ac4556e97bc4282133fac724ea655decc1a4e95e7
+  data.tar.gz: 0d50b2012d31467424ff6c232c5c3d8fff0e5d601eacf533c23f080933205aaa384948b98cc0831496ec6ac30b38697bf99554ef8d79b3f04f0922ef10de0b7e

data/.rubocop.yml

@@ -5,62 +5,24 @@ AllCops:
   StyleGuideCopsOnly: true
   TargetRubyVersion:  2.2
 
-Lint/HandleExceptions:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Lint/RescueException:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Metrics/LineLength:
-  Max: 80
-  Exclude:
-    - spec/**/*_spec.rb
-
-Style/AccessorMethodName:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/BlockDelimiters:
-  Exclude:
-    - spec/**/*_spec.rb
-
 Style/CaseEquality:
   Enabled: false
 
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/Documentation:
+Style/ClassVars:
   Enabled: false
 
 Style/DoubleNegation:
   Enabled: false
 
-Style/EmptyLinesAroundClassBody:
-  Enabled: false
-
-Style/EmptyLinesAroundModuleBody:
-  Enabled: false
-
-Style/EmptyLineBetweenDefs:
-  Enabled: false
-
 Style/FileName:
-  Enabled: false
+  Exclude:
+    - lib/dry-initializer.rb
 
 Style/Lambda:
   Exclude:
     - spec/**/*_spec.rb
 
-Style/ModuleFunction:
+Style/LambdaCall:
   Enabled: false
 
 Style/RaiseArgs:
@@ -73,27 +35,8 @@ Style/Semicolon:
 Style/SignalException:
   EnforcedStyle: semantic
 
-Style/SingleLineBlockParams:
-  Enabled: false
-
-Style/SingleLineMethods:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Style/SpaceBeforeFirstArg:
-  Enabled: false
-
-Style/SpecialGlobalVars:
-  Exclude:
-    - Gemfile
-    - dry-initializer.gemspec
-
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
-
-Style/TrivialAccessors:
-  Exclude:
-    - spec/**/*_spec.rb

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## v1.1.0 2017-01-28
+
+# Added:
+- enhancement via `Dry::Initializer::Attribute.dispatchers` registry (nepalez)
+
+    # Register dispatcher for `:string` option
+    Dry::Initializer::Attribute.dispatchers << ->(string: nil, **op) do
+      string ? op.merge(type: proc(&:to_s)) : op
+    end
+
+    # Now you can use the `:string` key for `param` and `option`
+    class User
+      extend Dry::Initializer
+      param :name, string: true
+    end
+
+    User.new(:Andy).name # => "Andy"
+
+# Internals:
+- optimize assignments for performance (nepalez)
+
+[Compare v1.0.0...v1.1.0](https://github.com/dry-rb/dry-initializer/compare/v1.0.0...v1.1.0)
+
 ## v1.0.0 2017-01-22
 
 In this version the code has been rewritten for simplicity

data/Gemfile

@@ -21,6 +21,7 @@ group :benchmarks do
   gem "value_struct"
   gem "values"
   gem "virtus"
+  gem "ruby-prof"
 end
 
 group :development, :test do

data/Rakefile

@@ -45,3 +45,9 @@ namespace :benchmark do
     system "ruby benchmarks/options.rb"
   end
 end
+
+desc "Runs profiler"
+task :profile do
+  system "ruby benchmarks/profiler.rb && " \
+         "dot -Tpng ./tmp/profile.dot > ./tmp/profile.png"
+end

data/benchmarks/params.rb

@@ -13,7 +13,7 @@ StructTest = Struct.new(:foo, :bar)
 
 require "dry-initializer"
 class DryTest
-  extend Dry::Initializer::Mixin
+  extend Dry::Initializer
 
   param :foo
   param :bar

data/benchmarks/profiler.rb

@@ -0,0 +1,28 @@
+require "dry-initializer"
+require "ruby-prof"
+require "fileutils"
+
+class User
+  extend Dry::Initializer
+
+  param  :first_name,  proc(&:to_s), default: proc { "Unknown" }
+  param  :second_name, proc(&:to_s), default: proc { "Unknown" }
+  option :email,       proc(&:to_s), optional: true
+  option :phone,       proc(&:to_s), optional: true
+end
+
+result = RubyProf.profile do
+  1_000.times { User.new :Andy, email: :"andy@example.com" }
+end
+
+FileUtils.mkdir_p "./tmp"
+
+FileUtils.touch "./tmp/profile.dot"
+File.open("./tmp/profile.dot", "w+") do |output|
+  RubyProf::DotPrinter.new(result).print(output, min_percent: 0)
+end
+
+FileUtils.touch "./tmp/profile.html"
+File.open("./tmp/profile.html", "w+") do |output|
+  RubyProf::CallStackPrinter.new(result).print(output, min_percent: 0)
+end

data/benchmarks/with_types.rb

@@ -3,11 +3,9 @@ Bundler.require(:benchmarks)
 class PlainRubyTest
   attr_reader :foo, :bar
 
-  def initialize(foo:, bar:)
-    @foo = foo
-    @bar = bar
-    fail TypeError unless String === @foo
-    fail TypeError unless String === @bar
+  def initialize(options)
+    @foo = options[:foo].to_s
+    @bar = options[:bar].to_s
   end
 end
 

data/benchmarks/without_options.rb

@@ -3,9 +3,9 @@ Bundler.require(:benchmarks)
 class PlainRubyTest
   attr_reader :foo, :bar
 
-  def initialize(foo:, bar:)
-    @foo = foo
-    @bar = bar
+  def initialize(options = {})
+    @foo = options[:foo]
+    @bar = options[:bar]
   end
 end
 

data/dry-initializer.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "dry-initializer"
-  gem.version  = "1.0.0"
+  gem.version  = "1.1.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/attribute.rb

@@ -1,8 +1,58 @@
 module Dry::Initializer
   # Contains definitions for a single attribute, and builds its parts of mixin
   class Attribute
+    class << self
+      # Collection of additional dispatchers for method options
+      #
+      # @example Enhance the gem by adding :coercer alias for type
+      #   Dry::Initializer::Attribute.dispatchers << -> (string: nil, **op) do
+      #     op[:type] = proc(&:to_s) if string
+      #     op
+      #   end
+      #
+      #   class User
+      #     extend Dry::Initializer
+      #     param :name, string: true # same as `type: proc(&:to_s)`
+      #   end
+      #
+      def dispatchers
+        @@dispatchers ||= []
+      end
+
+      def new(source, coercer = nil, **options)
+        options[:source] = source
+        options[:target] = options.delete(:as) || source
+        options[:type] ||= coercer
+        params = dispatchers.inject(options) { |h, m| m.call(h) }
+
+        super(params)
+      end
+
+      def param(*args)
+        Param.new(*args)
+      end
+
+      def option(*args)
+        Option.new(*args)
+      end
+    end
+
     attr_reader :source, :target, :coercer, :default, :optional, :reader
 
+    def initialize(options)
+      @source   = options[:source]
+      @target   = options[:target]
+      @coercer  = options[:type]
+      @default  = options[:default]
+      @optional = !!(options[:optional] || @default)
+      @reader   = options.fetch(:reader, :public)
+      validate
+    end
+
+    def ==(other)
+      source == other.source
+    end
+
     # definition for the getter method
     def getter
       return unless reader
@@ -18,16 +68,6 @@ module Dry::Initializer
 
     private
 
-    def initialize(source, coercer = nil, **options)
-      @source   = source
-      @target   = options.fetch(:as, source)
-      @coercer  = coercer || options[:type]
-      @reader   = options.fetch(:reader, :public)
-      @default  = options[:default]
-      @optional = !!(options[:optional] || @default)
-      validate
-    end
-
     def validate
       validate_target
       validate_default

data/lib/dry/initializer/builder.rb

@@ -1,12 +1,12 @@
 module Dry::Initializer
   class Builder
     def param(*args)
-      @params = insert(@params, Param, *args)
+      @params = insert(@params, Attribute.param(*args))
       validate_collections
     end
 
     def option(*args)
-      @options = insert(@options, Option, *args)
+      @options = insert(@options, Attribute.option(*args))
       validate_collections
     end
 
@@ -25,16 +25,9 @@ module Dry::Initializer
       @options = []
     end
 
-    def insert(collection, klass, source, *args)
-      index = collection.index { |option| option.source == source.to_s }
-
-      if index
-        new_item = klass.new(source, *args)
-        collection.dup.tap { |list| list[index] = new_item }
-      else
-        new_item = klass.new(source, *args)
-        collection + [new_item]
-      end
+    def insert(collection, new_item)
+      index = collection.index(new_item) || collection.count
+      collection.dup.tap { |list| list[index] = new_item }
     end
 
     def code
@@ -56,26 +49,30 @@ module Dry::Initializer
       @params + @options
     end
 
+    def duplications
+      attributes.group_by(&:target)
+                .reject { |_, val| val.count == 1 }
+                .keys
+    end
+
     def initializer_signatures
       sig = @params.map(&:initializer_signature).compact.uniq
-      sig << (@options.any? ? "**__options__" : "__options__ = {}")
+      sig << (sig.any? && @options.any? ? "**__options__" : "__options__ = {}")
       sig.join(", ")
     end
 
     def initializer_presetters
-      attributes.map(&:initializer_presetter)
-                .compact
-                .uniq
-                .map { |line| "  #{line}" }
-                .join("\n")
+      dups = duplications
+      attributes
+        .map { |a| "  #{a.presetter}" if dups.include? a.target }
+        .compact.uniq.join("\n")
     end
 
     def initializer_setters
-      attributes.map(&:initializer_setter)
-                .compact
-                .uniq
-                .map { |text| text.lines.map { |line| "  #{line}" }.join }
-                .join("\n")
+      dups = duplications
+      attributes.map do |a|
+        dups.include?(a.target) ? "  #{a.safe_setter}" : "  #{a.fast_setter}"
+      end.compact.uniq.join("\n")
     end
 
     def getters

data/lib/dry/initializer/option.rb

@@ -5,14 +5,19 @@ module Dry::Initializer
       "**__options__"
     end
 
-    # part of __initializer__ body
-    def initializer_presetter
-      "@#{target} = Dry::Initializer::UNDEFINED"
+    # parts of __initalizer__
+    def presetter
+      "@#{target} = Dry::Initializer::UNDEFINED" if dispensable?
     end
 
-    # part of __initializer__ body
-    def initializer_setter
-      "#{setter_part}#{maybe_optional}"
+    def safe_setter
+      "@#{target} = #{safe_coerced}#{maybe_optional}"
+    end
+
+    def fast_setter
+      return safe_setter unless dispensable?
+      "@#{target} = __options__.key?(:'#{source}') ? #{safe_coerced} : " \
+      "Dry::Initializer::UNDEFINED"
     end
 
     # part of __defaults__
@@ -22,33 +27,35 @@ module Dry::Initializer
 
     # part of __coercers__
     def coercer_hash
-      coercer ? { :"option_#{source}" => coercer } : {}
+      return {} unless coercer
+      value = proc { |v| (v == Dry::Initializer::UNDEFINED) ? v : coercer.(v) }
+      { :"option_#{source}" => value }
     end
 
     private
 
-    def maybe_optional
-      " if __options__.key? :'#{source}'" if optional && !default
+    def dispensable?
+      optional && !default
     end
 
-    def setter_part
-      "@#{target} = #{maybe_coerced}"
+    def maybe_optional
+      " if __options__.key? :'#{source}'" if dispensable?
     end
 
-    def maybe_coerced
-      return maybe_default unless coercer
-      "__coercers__[:'option_#{source}'].call(#{maybe_default})"
+    def safe_coerced
+      return safe_default unless coercer
+      "__coercers__[:'option_#{source}'].call(#{safe_default})"
     end
 
-    def maybe_default
-      "__options__.fetch(:'#{source}') { #{default_part} }"
+    def safe_default
+      "__options__.fetch(:'#{source}')#{default_part}"
     end
 
     def default_part
       if default
-        "instance_eval(&__defaults__[:'option_#{source}'])"
-      else
-        "raise ArgumentError, \"option :'#{source}' is required\""
+        " { instance_eval(&__defaults__[:'option_#{source}']) }"
+      elsif !optional
+        " { raise ArgumentError, \"option :'#{source}' is required\" }"
       end
     end
   end

data/lib/dry/initializer/param.rb

@@ -5,14 +5,17 @@ module Dry::Initializer
       optional ? "#{target} = Dry::Initializer::UNDEFINED" : target
     end
 
-    # part of __initializer__ body
-    def initializer_presetter; end
+    # parts of __initalizer__
+    def presetter; end
 
-    # part of __initializer__ body
-    def initializer_setter
+    def safe_setter
       "@#{target} = #{maybe_coerced}"
     end
 
+    def fast_setter
+      safe_setter
+    end
+
     # part of __defaults__
     def default_hash
       default ? { :"param_#{target}" => default } : {}
@@ -20,7 +23,9 @@ module Dry::Initializer
 
     # part of __coercers__
     def coercer_hash
-      coercer ? { :"param_#{target}" => coercer } : {}
+      return {} unless coercer
+      value = proc { |v| (v == Dry::Initializer::UNDEFINED) ? v : coercer.(v) }
+      { :"param_#{target}" => value }
     end
 
     private

data/spec/enhancement_spec.rb

@@ -0,0 +1,18 @@
+describe "gem enhancement" do
+  before do
+    Dry::Initializer::Attribute.dispatchers << ->(string: false, **op) do
+      op[:type] = proc(&:to_s) if string
+      op
+    end
+
+    class Test::Foo
+      extend Dry::Initializer
+      param :bar, string: true
+    end
+  end
+
+  it "works" do
+    foo = Test::Foo.new(:BAZ)
+    expect(foo.bar).to eq "BAZ"
+  end
+end

data/spec/several_assignments_spec.rb

@@ -0,0 +1,41 @@
+describe "attribute with several assignments" do
+  before do
+    class Test::Foo
+      extend Dry::Initializer::Mixin
+
+      option :bar, proc(&:to_s),    optional: true
+      option :"some foo", as: :bar, optional: true
+    end
+  end
+
+  context "when not defined" do
+    subject { Test::Foo.new }
+
+    it "is left undefined" do
+      expect(subject.bar).to be_nil
+      expect(subject.instance_variable_get :@bar)
+        .to eq Dry::Initializer::UNDEFINED
+    end
+  end
+
+  context "when set directly" do
+    subject { Test::Foo.new bar: :BAZ }
+
+    it "sets the attribute" do
+      expect(subject.bar).to eq "BAZ"
+    end
+  end
+
+  context "when renamed" do
+    subject { Test::Foo.new "some foo": :BAZ }
+
+    it "renames the attribute" do
+      expect(subject.bar).to eq :BAZ
+      expect(subject).not_to respond_to :foo
+    end
+
+    it "renames the variable" do
+      expect(subject.instance_variable_get(:@bar)).to eq :BAZ
+    end
+  end
+end

data/spec/type_constraint_spec.rb

@@ -28,20 +28,21 @@ describe "type constraint" do
     context "if optional value not set" do
       subject { Test::Foo.new }
 
-      it "applies type constraint to Dry::Initializer::UNDEFINED" do
-        expect { subject }.to raise_error Dry::Types::ConstraintError
+      it "not applicable to Dry::Initializer::UNDEFINED" do
+        expect(subject.instance_variable_get(:@foo))
+          .to eq Dry::Initializer::UNDEFINED
       end
     end
   end
 
   context "by invalid constraint" do
     it "raises TypeError" do
-      expect {
+      expect do
         class Test::Foo
           extend Dry::Initializer::Mixin
           param :foo, type: String
         end
-      }.to raise_error(TypeError)
+      end.to raise_error(TypeError)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-initializer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Vladimir Kochnev (marshall-lee)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-22 00:00:00.000000000 Z
+date: 2017-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -91,6 +91,7 @@ files:
 - benchmarks/options.rb
 - benchmarks/params.rb
 - benchmarks/params_vs_options.rb
+- benchmarks/profiler.rb
 - benchmarks/several_defaults.rb
 - benchmarks/with_defaults.rb
 - benchmarks/with_types.rb
@@ -111,14 +112,15 @@ files:
 - spec/custom_initializer_spec.rb
 - spec/default_nil_spec.rb
 - spec/default_values_spec.rb
+- spec/enhancement_spec.rb
 - spec/invalid_default_spec.rb
 - spec/missed_default_spec.rb
 - spec/optional_spec.rb
 - spec/options_tolerance_spec.rb
 - spec/options_var_spec.rb
 - spec/reader_spec.rb
-- spec/renaming_options_spec.rb
 - spec/repetitive_definitions_spec.rb
+- spec/several_assignments_spec.rb
 - spec/spec_helper.rb
 - spec/subclassing_spec.rb
 - spec/type_argument_spec.rb
@@ -154,14 +156,15 @@ test_files:
 - spec/custom_initializer_spec.rb
 - spec/default_nil_spec.rb
 - spec/default_values_spec.rb
+- spec/enhancement_spec.rb
 - spec/invalid_default_spec.rb
 - spec/missed_default_spec.rb
 - spec/optional_spec.rb
 - spec/options_tolerance_spec.rb
 - spec/options_var_spec.rb
 - spec/reader_spec.rb
-- spec/renaming_options_spec.rb
 - spec/repetitive_definitions_spec.rb
+- spec/several_assignments_spec.rb
 - spec/spec_helper.rb
 - spec/subclassing_spec.rb
 - spec/type_argument_spec.rb

data/spec/renaming_options_spec.rb

@@ -1,20 +0,0 @@
-describe "renaming options" do
-  before do
-    class Test::Foo
-      extend Dry::Initializer::Mixin
-
-      option :"some foo", as: :bar
-    end
-  end
-
-  subject { Test::Foo.new "some foo": :BAZ }
-
-  it "renames the attribute" do
-    expect(subject.bar).to eq :BAZ
-    expect(subject).not_to respond_to :foo
-  end
-
-  it "renames the variable" do
-    expect(subject.instance_variable_get(:@bar)).to eq :BAZ
-  end
-end