dry-initializer 1.4.1 → 2.0.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Andrew Kozin (nepalez), Vladimir Kochnev (marshall-lee)
+Copyright (c) 2016-2017 Andrew Kozin (nepalez), Vladimir Kochnev (marshall-lee)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -49,10 +49,10 @@ class User
   extend Dry::Initializer::Mixin
 
   # Params of the initializer along with corresponding readers
-  param  :name,  type: Dry::Types["strict.string"]
-  param  :role,  default: proc { 'customer' }
+  param  :name,  proc(&:to_s)
+  param  :role,  default: -> { 'customer' }
   # Options of the initializer along with corresponding readers
-  option :admin, default: proc { false }
+  option :admin, default: -> { false }
   option :vip,   optional: true
 end
 

data/Rakefile

@@ -4,50 +4,5 @@ Bundler::GemHelper.install_tasks
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new :default
 
-namespace :benchmark do
-  desc "Runs benchmarks without options"
-  task :without_options do
-    system "ruby benchmarks/without_options.rb"
-  end
-
-  desc "Runs benchmarks for several defaults"
-  task :several_defaults do
-    system "ruby benchmarks/several_defaults.rb"
-  end
-
-  desc "Runs benchmarks for defaults of params vs. options"
-  task :params_vs_options do
-    system "ruby benchmarks/params_vs_options.rb"
-  end
-
-  desc "Runs benchmarks with types"
-  task :with_types do
-    system "ruby benchmarks/with_types.rb"
-  end
-
-  desc "Runs benchmarks with defaults"
-  task :with_defaults do
-    system "ruby benchmarks/with_defaults.rb"
-  end
-
-  desc "Runs benchmarks with types and defaults"
-  task :with_types_and_defaults do
-    system "ruby benchmarks/with_types_and_defaults.rb"
-  end
-
-  desc "Runs benchmarks for plain params"
-  task :params do
-    system "ruby benchmarks/params.rb"
-  end
-
-  desc "Runs benchmarks various opts"
-  task :options 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
+load "lib/tasks/benchmark.rake"
+load "lib/tasks/profile.rake"

data/benchmarks/{several_defaults.rb → compare_several_defaults.rb}

@@ -2,7 +2,7 @@ Bundler.require(:benchmarks)
 
 require "dry-initializer"
 class WithoutDefaults
-  extend Dry::Initializer::Mixin
+  extend Dry::Initializer
 
   param :foo
   param :bar
@@ -10,7 +10,7 @@ class WithoutDefaults
 end
 
 class WithOneDefault
-  extend Dry::Initializer::Mixin
+  extend Dry::Initializer
 
   param :foo
   param :bar
@@ -18,7 +18,7 @@ class WithOneDefault
 end
 
 class WithTwoDefaults
-  extend Dry::Initializer::Mixin
+  extend Dry::Initializer
 
   param :foo
   param :bar, default: proc { "BAR" }
@@ -26,7 +26,7 @@ class WithTwoDefaults
 end
 
 class WithThreeDefaults
-  extend Dry::Initializer::Mixin
+  extend Dry::Initializer
 
   param :foo, default: proc { "FOO" }
   param :bar, default: proc { "BAR" }

data/benchmarks/{without_options.rb → plain_options.rb}

@@ -1,5 +1,20 @@
 Bundler.require(:benchmarks)
 
+require "dry-initializer"
+class DryTest
+  extend Dry::Initializer[undefined: false]
+
+  option :foo
+  option :bar
+end
+
+class DryTestUndefined
+  extend Dry::Initializer
+
+  option :foo
+  option :bar
+end
+
 class PlainRubyTest
   attr_reader :foo, :bar
 
@@ -9,14 +24,6 @@ class PlainRubyTest
   end
 end
 
-require "dry-initializer"
-class DryTest
-  extend Dry::Initializer::Mixin
-
-  option :foo
-  option :bar
-end
-
 require "anima"
 class AnimaTest
   include Anima.new(:foo, :bar)
@@ -27,7 +34,7 @@ class KwattrTest
   kwattr :foo, :bar
 end
 
-puts "Benchmark for instantiation without options"
+puts "Benchmark for instantiation with plain options"
 
 Benchmark.ips do |x|
   x.config time: 15, warmup: 10
@@ -40,6 +47,10 @@ Benchmark.ips do |x|
     DryTest.new foo: "FOO", bar: "BAR"
   end
 
+  x.report("dry-initializer (with UNDEFINED)") do
+    DryTestUndefined.new foo: "FOO", bar: "BAR"
+  end
+
   x.report("anima") do
     AnimaTest.new foo: "FOO", bar: "BAR"
   end

data/benchmarks/{params.rb → plain_params.rb}

@@ -1,5 +1,20 @@
 Bundler.require(:benchmarks)
 
+require "dry-initializer"
+class DryTest
+  extend Dry::Initializer[undefined: false]
+
+  param :foo
+  param :bar
+end
+
+class DryTestUndefined
+  extend Dry::Initializer
+
+  param :foo
+  param :bar
+end
+
 class PlainRubyTest
   attr_reader :foo, :bar
 
@@ -11,14 +26,6 @@ end
 
 StructTest = Struct.new(:foo, :bar)
 
-require "dry-initializer"
-class DryTest
-  extend Dry::Initializer
-
-  param :foo
-  param :bar
-end
-
 require "concord"
 class ConcordTest
   include Concord.new(:foo, :bar)
@@ -36,7 +43,7 @@ class AttrExtrasText
   attr_reader :foo, :bar
 end
 
-puts "Benchmark for instantiation of plain params"
+puts "Benchmark for instantiation with plain params"
 
 Benchmark.ips do |x|
   x.config time: 15, warmup: 10
@@ -61,6 +68,10 @@ Benchmark.ips do |x|
     DryTest.new "FOO", "BAR"
   end
 
+  x.report("dry-initializer (with UNDEFINED)") do
+    DryTestUndefined.new "FOO", "BAR"
+  end
+
   x.report("concord") do
     ConcordTest.new "FOO", "BAR"
   end

data/benchmarks/{with_types.rb → with_coercion.rb}

@@ -1,5 +1,20 @@
 Bundler.require(:benchmarks)
 
+require "dry-initializer"
+class DryTest
+  extend Dry::Initializer[undefined: false]
+
+  option :foo, proc(&:to_s)
+  option :bar, proc(&:to_s)
+end
+
+class DryTestUndefined
+  extend Dry::Initializer
+
+  option :foo, proc(&:to_s)
+  option :bar, proc(&:to_s)
+end
+
 class PlainRubyTest
   attr_reader :foo, :bar
 
@@ -9,14 +24,6 @@ class PlainRubyTest
   end
 end
 
-require "dry-initializer"
-class DryTest
-  extend Dry::Initializer::Mixin
-
-  option :foo, &(:to_s)
-  option :bar, &(:to_s)
-end
-
 require "virtus"
 class VirtusTest
   include Virtus.model
@@ -35,7 +42,7 @@ class FastAttributesTest
   end
 end
 
-puts "Benchmark for instantiation with type constraints"
+puts "Benchmark for instantiation with coercion"
 
 Benchmark.ips do |x|
   x.config time: 15, warmup: 10
@@ -48,6 +55,10 @@ Benchmark.ips do |x|
     DryTest.new foo: "FOO", bar: "BAR"
   end
 
+  x.report("dry-initializer (with UNDEFINED)") do
+    DryTestUndefined.new foo: "FOO", bar: "BAR"
+  end
+
   x.report("virtus") do
     VirtusTest.new foo: "FOO", bar: "BAR"
   end

data/benchmarks/with_defaults.rb

@@ -1,5 +1,20 @@
 Bundler.require(:benchmarks)
 
+require "dry-initializer"
+class DryTest
+  extend Dry::Initializer[undefined: false]
+
+  option :foo, default: -> { "FOO" }
+  option :bar, default: -> { "BAR" }
+end
+
+class DryTestUndefined
+  extend Dry::Initializer
+
+  option :foo, default: -> { "FOO" }
+  option :bar, default: -> { "BAR" }
+end
+
 class PlainRubyTest
   attr_reader :foo, :bar
 
@@ -9,14 +24,6 @@ class PlainRubyTest
   end
 end
 
-require "dry-initializer"
-class DryTest
-  extend Dry::Initializer::Mixin
-
-  option :foo, default: proc { "FOO" }
-  option :bar, default: proc { "BAR" }
-end
-
 require "kwattr"
 class KwattrTest
   kwattr foo: "FOO", bar: "BAR"
@@ -43,6 +50,10 @@ Benchmark.ips do |x|
     DryTest.new
   end
 
+  x.report("dry-initializer (with UNDEFINED)") do
+    DryTestUndefined.new
+  end
+
   x.report("kwattr") do
     KwattrTest.new
   end

data/benchmarks/{with_types_and_defaults.rb → with_defaults_and_coercion.rb}

@@ -1,24 +1,31 @@
 Bundler.require(:benchmarks)
 
+require "dry-initializer"
+class DryTest
+  extend Dry::Initializer[undefined: false]
+
+  option :foo, proc(&:to_s), default: -> { "FOO" }
+  option :bar, proc(&:to_s), default: -> { "BAR" }
+end
+
+class DryTestUndefined
+  extend Dry::Initializer
+
+  option :foo, proc(&:to_s), default: -> { "FOO" }
+  option :bar, proc(&:to_s), default: -> { "BAR" }
+end
+
 class PlainRubyTest
   attr_reader :foo, :bar
 
   def initialize(foo: "FOO", bar: "BAR")
     @foo = foo
     @bar = bar
-    fail TypeError unless String === @foo
-    fail TypeError unless String === @bar
+    raise TypeError unless String === @foo
+    raise TypeError unless String === @bar
   end
 end
 
-require "dry-initializer"
-class DryTest
-  extend Dry::Initializer::Mixin
-
-  option :foo, proc(&:to_s), default: proc { "FOO" }
-  option :bar, proc(&:to_s), default: proc { "BAR" }
-end
-
 require "virtus"
 class VirtusTest
   include Virtus.model
@@ -40,6 +47,10 @@ Benchmark.ips do |x|
     DryTest.new
   end
 
+  x.report("dry-initializer (with UNDEFINED)") do
+    DryTest.new
+  end
+
   x.report("virtus") do
     VirtusTest.new
   end

data/dry-initializer.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |gem|
   gem.name     = "dry-initializer"
-  gem.version  = "1.4.1"
+  gem.version  = "2.0.0"
   gem.author   = ["Vladimir Kochnev (marshall-lee)", "Andrew Kozin (nepalez)"]
-  gem.email    = ["hashtable@yandex.ru", "andrew.kozin@gmail.com"]
+  gem.email    = "andrew.kozin@gmail.com"
   gem.homepage = "https://github.com/dryrb/dry-initializer"
   gem.summary  = "DSL for declaring params and options of the initializer"
   gem.license  = "MIT"
@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.test_files       = gem.files.grep(/^spec/)
   gem.extra_rdoc_files = Dir["README.md", "LICENSE", "CHANGELOG.md"]
 
-  gem.required_ruby_version = ">= 2.2"
+  gem.required_ruby_version = ">= 2.3"
 
   gem.add_development_dependency "rspec", "~> 3.0"
   gem.add_development_dependency "rake", "> 10"

data/lib/dry/initializer/builders/attribute.rb

@@ -0,0 +1,76 @@
+module Dry::Initializer::Builders
+  # @private
+  class Attribute
+    def self.[](definition)
+      new(definition).call
+    end
+
+    def call
+      lines.compact
+    end
+
+    private
+
+    # rubocop: disable Style/MethodLength
+    def initialize(definition)
+      @definition = definition
+      @option     = definition.option
+      @type       = definition.type
+      @optional   = definition.optional
+      @default    = definition.default
+      @source     = definition.source
+      @ivar       = definition.ivar
+      @null       = definition.null ? "Dry::Initializer::UNDEFINED" : "nil"
+      @opts       = "__dry_initializer_options__"
+      @congif     = "__dry_initializer_config__"
+      @item       = "__dry_initializer_definition__"
+      @val        = @option ? "__dry_initializer_value__" : @source
+    end
+    # rubocop: enable Style/MethodLength
+
+    def lines
+      [
+        "",
+        definition_line,
+        reader_line,
+        default_line,
+        coercion_line,
+        assignment_line
+      ]
+    end
+
+    def reader_line
+      return unless @option
+      @optional ? optional_reader : required_reader
+    end
+
+    def optional_reader
+      "#{@val} = #{@opts}.fetch(:'#{@source}', #{@null})"
+    end
+
+    def required_reader
+      "#{@val} = #{@opts}.fetch(:'#{@source}')" \
+      " { raise KeyError, \"\#{self.class}: #{@definition} is required\" }"
+    end
+
+    def definition_line
+      return unless @type || @default
+      "#{@item} = __dry_initializer_config__.definitions[:'#{@source}']"
+    end
+
+    def default_line
+      return unless @default
+      "#{@val} = instance_exec(&#{@item}.default) if #{@val} == #{@null}"
+    end
+
+    def coercion_line
+      return unless @type
+      "#{@val} = #{@item}.type.call(#{@val}) unless #{@val} == #{@null}"
+    end
+
+    def assignment_line
+      "#{@ivar} = #{@val}" \
+      " unless #{@val} == #{@null} && instance_variable_defined?(:#{@ivar})"
+    end
+  end
+end

data/lib/dry/initializer/builders/initializer.rb

@@ -0,0 +1,61 @@
+module Dry::Initializer::Builders
+  # @private
+  class Initializer
+    require_relative "signature"
+    require_relative "attribute"
+
+    def self.[](config)
+      new(config).call
+    end
+
+    def call
+      lines.flatten.compact.join("\n")
+    end
+
+    private
+
+    def initialize(config)
+      @config = config
+      @definitions = config.definitions.values
+    end
+
+    def lines
+      [
+        undef_line,
+        define_line,
+        params_lines,
+        options_lines,
+        end_line
+      ]
+    end
+
+    def undef_line
+      "undef :__dry_initializer_initialize__" \
+      " if private_method_defined? :__dry_initializer_initialize__"
+    end
+
+    def define_line
+      "private def __dry_initializer_initialize__(#{Signature[@config]})"
+    end
+
+    def params_lines
+      @definitions.reject(&:option)
+                  .flat_map { |item| Attribute[item] }
+                  .map { |line| "  " << line }
+    end
+
+    def options_lines
+      @definitions.select(&:option)
+                  .flat_map { |item| Attribute[item] }
+                  .map { |line| "  " << line }
+    end
+
+    def end_line
+      "end"
+    end
+
+    def private_line
+      "private :__dry_initializer_initialize__"
+    end
+  end
+end

data/lib/dry/initializer/builders/reader.rb

@@ -0,0 +1,50 @@
+module Dry::Initializer::Builders
+  # @private
+  class Reader
+    def self.[](definition)
+      new(definition).call
+    end
+
+    def call
+      lines.flatten.compact.join("\n")
+    end
+
+    private
+
+    def initialize(definition)
+      @target = definition.target
+      @ivar   = definition.ivar
+      @null   = definition.null
+      @reader = definition.reader
+    end
+
+    def lines
+      [undef_line, attribute_line, method_lines, type_line]
+    end
+
+    def undef_line
+      "undef :#{@target} if method_defined?(:#{@target})" \
+      "  || private_method_defined?(:#{@target})" \
+      "  || protected_method_defined?(:#{@target})"
+    end
+
+    def attribute_line
+      return unless @reader
+      "attr_reader :#{@target}" unless @null
+    end
+
+    def method_lines
+      return unless @reader
+      return unless @null
+      [
+        "def #{@target}",
+        "  #{@ivar} unless #{@ivar} == Dry::Initializer::UNDEFINED",
+        "end"
+      ]
+    end
+
+    def type_line
+      "#{@reader} :#{@target}" if %i[private protected].include? @reader
+    end
+  end
+end

data/lib/dry/initializer/builders/signature.rb

@@ -0,0 +1,32 @@
+module Dry::Initializer::Builders
+  # @private
+  class Signature
+    def self.[](config)
+      new(config).call
+    end
+
+    def call
+      [*required_params, *optional_params, "*", options].compact.join(", ")
+    end
+
+    private
+
+    def initialize(config)
+      @config  = config
+      @options = config.options.any?
+      @null    = config.null ? "Dry::Initializer::UNDEFINED" : "nil"
+    end
+
+    def required_params
+      @config.params.reject(&:optional).map(&:source)
+    end
+
+    def optional_params
+      @config.params.select(&:optional).map { |rec| "#{rec.source} = #{@null}" }
+    end
+
+    def options
+      "**__dry_initializer_options__" if @options
+    end
+  end
+end

data/lib/dry/initializer/builders.rb

@@ -0,0 +1,7 @@
+module Dry::Initializer
+  # @private
+  module Builders
+    require_relative "builders/reader"
+    require_relative "builders/initializer"
+  end
+end