dry-initializer 3.0.1

data/Gemfile

@@ -0,0 +1,29 @@
+source "https://rubygems.org"
+
+# Specify your gem"s dependencies in dry-initializer.gemspec
+gemspec
+
+group :benchmarks do
+  if RUBY_VERSION < "2.4"
+    gem "activesupport", "< 5"
+  else
+    gem "activesupport"
+  end
+
+  gem "active_attr"
+  gem "anima"
+  gem "attr_extras"
+  gem "benchmark-ips", "~> 2.5"
+  gem "concord"
+  gem "fast_attributes"
+  gem "kwattr"
+  gem "ruby-prof", platform: :mri
+  gem "value_struct"
+  gem "values"
+  gem "virtus"
+end
+
+group :development, :test do
+  gem "pry", platform: :mri
+  gem "pry-byebug", platform: :mri
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/(spec_helper|support)}) { "spec" }
+  watch(%r{^lib/.+}) { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# dry-initializer [![Join the chat at https://gitter.im/dry-rb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dry-rb/chat)
+
+[![Gem Version](https://badge.fury.io/rb/dry-initializer.svg)][gem]
+[![Build Status](https://travis-ci.org/dry-rb/dry-initializer.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/dry-rb/dry-initializer/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/dry-rb/dry-initializer/badges/coverage.svg)][coveralls]
+[![Inline docs](http://inch-ci.org/github/dry-rb/dry-initializer.svg?branch=master)][inchpages]
+
+[gem]: https://rubygems.org/gems/dry-initializer
+[travis]: https://travis-ci.org/dry-rb/dry-initializer
+[gemnasium]: https://gemnasium.com/dry-rb/dry-initializer
+[codeclimate]: https://codeclimate.com/github/dry-rb/dry-initializer
+[coveralls]: https://coveralls.io/r/dry-rb/dry-initializer
+[inchpages]: http://inch-ci.org/github/dry-rb/dry-initializer
+[docs]: http://dry-rb.org/gems/dry-initializer/
+[benchmarks]: https://github.com/dry-rb/dry-initializer/wiki
+[license]: http://opensource.org/licenses/MIT
+
+DSL for building class initializer with params and options.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dry-initializer'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install dry-initializer
+```
+
+## Synopsis
+
+```ruby
+require 'dry-initializer'
+require 'dry-types'
+
+class User
+  extend Dry::Initializer
+
+  # Params of the initializer along with corresponding readers
+  param  :name,  proc(&:to_s)
+  param  :role,  default: -> { 'customer' }
+  # Options of the initializer along with corresponding readers
+  option :admin, default: -> { false }
+  option :vip,   optional: true
+end
+
+# Defines the initializer with params and options
+user = User.new 'Vladimir', 'admin', admin: true
+
+# Defines readers for single attributes
+user.name  # => 'Vladimir'
+user.role  # => 'admin'
+user.admin # => true
+user.vip   # => Dry::Initializer::UNDEFINED
+```
+
+See full documentation on the [Dry project official site][docs]
+
+## Benchmarks
+
+The `dry-initializer` is pretty fast for rubies 2.3+ [comparing to other libraries][benchmarks].
+
+## Compatibility
+
+Tested under rubies [compatible to MRI 2.3+](.travis.yml).
+
+## Contributing
+
+* [Fork the project](https://github.com/dry-rb/dry-initializer)
+* Create your feature branch (`git checkout -b my-new-feature`)
+* Add tests for it
+* Commit your changes (`git commit -am '[UPDATE] Add some feature'`)
+* Push to the branch (`git push origin my-new-feature`)
+* Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License][license].
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new :default
+
+load "lib/tasks/benchmark.rake"
+load "lib/tasks/profile.rake"

data/benchmarks/compare_several_defaults.rb

@@ -0,0 +1,82 @@
+Bundler.require(:benchmarks)
+
+require "dry-initializer"
+class WithoutDefaults
+  extend Dry::Initializer
+
+  param :foo
+  param :bar
+  param :baz
+end
+
+class WithOneDefault
+  extend Dry::Initializer
+
+  param :foo
+  param :bar
+  param :baz, default: proc { "BAZ" }
+end
+
+class WithTwoDefaults
+  extend Dry::Initializer
+
+  param :foo
+  param :bar, default: proc { "BAR" }
+  param :baz, default: proc { "BAZ" }
+end
+
+class WithThreeDefaults
+  extend Dry::Initializer
+
+  param :foo, default: proc { "FOO" }
+  param :bar, default: proc { "BAR" }
+  param :baz, default: proc { "BAZ" }
+end
+
+puts "Benchmark for various options"
+
+Benchmark.ips do |x|
+  x.config time: 15, warmup: 10
+
+  x.report("without defaults") do
+    WithoutDefaults.new "FOO", "BAR", "BAZ"
+  end
+
+  x.report("with 0 of 1 default used") do
+    WithOneDefault.new "FOO", "BAR", "BAZ"
+  end
+
+  x.report("with 1 of 1 default used") do
+    WithOneDefault.new "FOO", "BAR"
+  end
+
+  x.report("with 0 of 2 defaults used") do
+    WithTwoDefaults.new "FOO", "BAR", "BAZ"
+  end
+
+  x.report("with 1 of 2 defaults used") do
+    WithTwoDefaults.new "FOO", "BAR"
+  end
+
+  x.report("with 2 of 2 defaults used") do
+    WithTwoDefaults.new "FOO"
+  end
+
+  x.report("with 0 of 3 defaults used") do
+    WithThreeDefaults.new "FOO", "BAR", "BAZ"
+  end
+
+  x.report("with 1 of 3 defaults used") do
+    WithThreeDefaults.new "FOO", "BAR"
+  end
+
+  x.report("with 2 of 3 defaults used") do
+    WithThreeDefaults.new "FOO"
+  end
+
+  x.report("with 3 of 3 defaults used") do
+    WithThreeDefaults.new
+  end
+
+  x.compare!
+end

data/benchmarks/plain_options.rb

@@ -0,0 +1,63 @@
+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
+
+  def initialize(options = {})
+    @foo = options[:foo]
+    @bar = options[:bar]
+  end
+end
+
+require "anima"
+class AnimaTest
+  include Anima.new(:foo, :bar)
+end
+
+require "kwattr"
+class KwattrTest
+  kwattr :foo, :bar
+end
+
+puts "Benchmark for instantiation with plain options"
+
+Benchmark.ips do |x|
+  x.config time: 15, warmup: 10
+
+  x.report("plain Ruby") do
+    PlainRubyTest.new foo: "FOO", bar: "BAR"
+  end
+
+  x.report("dry-initializer") do
+    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
+
+  x.report("kwattr") do
+    KwattrTest.new foo: "FOO", bar: "BAR"
+  end
+
+  x.compare!
+end

data/benchmarks/plain_params.rb

@@ -0,0 +1,84 @@
+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
+
+  def initialize(foo, bar)
+    @foo = foo
+    @bar = bar
+  end
+end
+
+StructTest = Struct.new(:foo, :bar)
+
+require "concord"
+class ConcordTest
+  include Concord.new(:foo, :bar)
+end
+
+require "values"
+ValueTest = Value.new(:foo, :bar)
+
+require "value_struct"
+ValueStructTest = ValueStruct.new(:foo, :bar)
+
+require "attr_extras"
+class AttrExtrasText
+  attr_initialize :foo, :bar
+  attr_reader :foo, :bar
+end
+
+puts "Benchmark for instantiation with plain params"
+
+Benchmark.ips do |x|
+  x.config time: 15, warmup: 10
+
+  x.report("plain Ruby") do
+    PlainRubyTest.new "FOO", "BAR"
+  end
+
+  x.report("Core Struct") do
+    StructTest.new "FOO", "BAR"
+  end
+
+  x.report("values") do
+    ValueTest.new "FOO", "BAR"
+  end
+
+  x.report("value_struct") do
+    ValueStructTest.new "FOO", "BAR"
+  end
+
+  x.report("dry-initializer") do
+    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
+
+  x.report("attr_extras") do
+    AttrExtrasText.new "FOO", "BAR"
+  end
+
+  x.compare!
+end

data/benchmarks/with_coercion.rb

@@ -0,0 +1,71 @@
+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
+
+  def initialize(options)
+    @foo = options[:foo].to_s
+    @bar = options[:bar].to_s
+  end
+end
+
+require "virtus"
+class VirtusTest
+  include Virtus.model
+
+  attribute :foo, String
+  attribute :bar, String
+end
+
+require "fast_attributes"
+class FastAttributesTest
+  extend FastAttributes
+
+  define_attributes initialize: true do
+    attribute :foo, String
+    attribute :bar, String
+  end
+end
+
+puts "Benchmark for instantiation with coercion"
+
+Benchmark.ips do |x|
+  x.config time: 15, warmup: 10
+
+  x.report("plain Ruby") do
+    PlainRubyTest.new foo: "FOO", bar: "BAR"
+  end
+
+  x.report("dry-initializer") do
+    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
+
+  x.report("fast_attributes") do
+    FastAttributesTest.new foo: "FOO", bar: "BAR"
+  end
+
+  x.compare!
+end