dry-initializer 3.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.4.0, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct)

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Issue Guidelines
+
+## Reporting bugs
+
+If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
+
+## Reporting feature requests
+
+Report a feature request **only after discussing it first on [discourse.dry-rb.org](https://discourse.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
+
+## Reporting questions, support requests, ideas, concerns etc.
+
+**PLEASE DON'T** - use [discourse.dry-rb.org](http://discourse.dry-rb.org) instead.
+
+# Pull Request Guidelines
+
+A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
+
+Other requirements:
+
+1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
+2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
+3) Add API documentation if it's a new feature
+4) Update API documentation if it changes an existing feature
+5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
+
+# Asking for help
+
+If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org) or join [our chat](https://dry-rb.zulipchat.com).

data/Gemfile

@@ -0,0 +1,38 @@
+source "https://rubygems.org"
+
+# Specify your gem"s dependencies in dry-initializer.gemspec
+gemspec
+
+unless ENV['CI'].eql?('true')
+  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
+end
+
+group :development, :test do
+  gem "pry", platform: :mri
+  gem "pry-byebug", platform: :mri
+  if RUBY_VERSION >= "2.4"
+    gem 'ossy', git: 'https://github.com/solnic/ossy.git', branch: 'master', platform: :mri
+  end
+end
+
+group :test do
+  gem 'simplecov', require: false
+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

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2019 dry-rb team
+
+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/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,89 @@
+# dry-initializer [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
+
+[![Gem Version](https://badge.fury.io/rb/dry-initializer.svg)][gem]
+[![Build Status](https://github.com/dry-rb/dry-initializer/workflows/ci/badge.svg)][ci]
+[![Code Climate](https://codeclimate.com/github/dry-rb/dry-initializer/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://api.codeclimate.com/v1/badges/73cb64231f3fb2c86e26/test_coverage)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/dry-rb/dry-initializer.svg?branch=master)][inchpages]
+
+[gem]: https://rubygems.org/gems/dry-initializer
+[ci]: https://github.com/dry-rb/dry-initializer/actions?query=workflow%3Aci
+[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
+[chat]: https://dry-rb.zulipchat.com
+
+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