dry-initializer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f262a2ae5fa55ff9bc86dee062ec773868b4671
-  data.tar.gz: a89671bbf85a6b4da055a639b7125a44456fe249
+  metadata.gz: a155e17b7e2f0fb9274bf3b6511c64380784ae90
+  data.tar.gz: 967ba81a147fa585ba889b3e97378a3340db312a
 SHA512:
-  metadata.gz: 0d09cbdfa72b94010534ce22a4d252c8158267b94e46a88a0d588bed2070c0256701be42c701290b51eabdfbced55135012c216e7fecf9386caf3cbd5c1e2fa9
-  data.tar.gz: a360f864906d84a652f62355082f6ad605ac569ef0d3c0db4a07203f3d34e359b5736b40279a9561a371221ce1dcdc47e063256d86e0e7760b5f607199b69d62
+  metadata.gz: af677c57dc5ca40e7c2d3540cb566e145643daecf2eb564c752f95b3123f74bfed8320edecf9764cb933cd007ee7421728e1965941f122187dcdbd7ff0b830bd
+  data.tar.gz: 7d8d21a38ff8a0cb08a41ee8e3c37665a020a1314bb59851f3c85d3eff58b96196a105c8a32c8f9b46bb8961f5c2681122c578fe6a01d481d270d02a2a956944

data/.rubocop.yml

@@ -7,20 +7,20 @@ AllCops:
 
 Lint/HandleExceptions:
   Exclude:
-    - '**/*_spec.rb'
+    - spec/**/*_spec.rb
 
 Lint/RescueException:
   Exclude:
-    - '**/*_spec.rb'
+    - spec/**/*_spec.rb
 
 Metrics/LineLength:
   Max: 80
   Exclude:
-    - 'spec/**/*.rb'
+    - spec/**/*_spec.rb
 
 Style/AccessorMethodName:
   Exclude:
-    - '**/*_spec.rb'
+    - spec/**/*_spec.rb
 
 Style/Alias:
   EnforcedStyle: prefer_alias_method
@@ -52,6 +52,10 @@ Style/EmptyLineBetweenDefs:
 Style/FileName:
   Enabled: false
 
+Style/Lambda:
+  Exclude:
+    - spec/**/*_spec.rb
+
 Style/ModuleFunction:
   Enabled: false
 
@@ -60,7 +64,7 @@ Style/RaiseArgs:
 
 Style/Semicolon:
   Exclude:
-    - '**/*_spec.rb'
+    - spec/**/*_spec.rb
 
 Style/SignalException:
   EnforcedStyle: semantic
@@ -70,15 +74,15 @@ Style/SingleLineBlockParams:
 
 Style/SingleLineMethods:
   Exclude:
-    - '**/*_spec.rb'
+    - spec/**/*_spec.rb
 
 Style/SpaceBeforeFirstArg:
   Enabled: false
 
 Style/SpecialGlobalVars:
   Exclude:
-    - '**/Gemfile'
-    - '**/*.gemspec'
+    - Gemfile
+    - dry-initializer.gemspec
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -88,4 +92,4 @@ Style/StringLiteralsInInterpolation:
 
 Style/TrivialAccessors:
   Exclude:
-    - '**/*_spec.rb'
+    - spec/**/*_spec.rb

data/CHANGELOG.md

@@ -1,8 +1,75 @@
+## v0.2.0 2016-04-28
+
+The gem internals has been rewritten heavily to make the gem pluggable and fix
+bugs in "container style". Type constraints were extracted to a plugin
+that should be added explicitly.
+
+Small extensions were added to type constraints to support constraint by any
+object, and apply value coercion via `dry-types`.
+
+Default assignments became slower (while plain type constraint are not)!
+
+### Changed (backward-incompatible changes)
+
+* Make dry-types constraint to coerce variables (@nepalez)
+
+  ```ruby
+  # This will coerce `name: :foo` to `"foo"`
+  option :name, type: Dry::Types::Coercible::String
+  ```
+
+* Stop supporing proc type constraint (@nepalez)
+
+  ```ruby
+  option :name, type: ->(v) { String === v } # this does NOT work any more
+  ```
+
+  later it will be implemented via coercion plugin (not added by default):
+
+  ```ruby
+  require 'dry/initializer/coercion'
+
+  class MyClass
+    extend Dry::Initializer::Mixin
+    extend Dry::Initializer::Coercion
+
+    option :name, coercer: ->(v) { (String === v) ? v.to_sym : fail }
+  end
+  ```
+
+### Added
+
+* Support type constraint via every object's case equality (@nepalez)
+
+  ```ruby
+  option :name, type: /foo/
+  option :name, type: (1..14)
+  ```
+
+* Support defaults and type constraints for the "container" syntax (@nepalez)
+* Support adding extensions via plugin system (@nepalez)
+
+### Internal
+
+* Private method `##__after_initialize__` is added by the `Mixin` along with `#initialize` (@nepalez)
+
+  The previous implementation required defaults and types to be stored in the class method `.initializer_builder`.
+  That made "container" syntax to support neither defaults nor types.
+
+  Now the `#initializer` is still defined via `instance_eval(code)` for efficiency. Some operations
+  (like default assignments, coercions, dry-type constraints etc.) cannot be implemented in this way.
+  They are made inside `##__after_initialize__` callback, that is biult via `default_method(&block)`
+  using instance evals.
+
+[Compare v0.1.1...v0.2.0](https://github.com/dry-rb/dry-initializer/compare/v0.1.1...v0.2.0)
+
 ## v0.1.1 2016-04-28
 
 ### Added
 
-* `include Dry::Initializer.define -> do .. end` syntax (flash-gordon)
+* `include Dry::Initializer.define -> do .. end` syntax (@flash-gordon)
+
+[Compare v0.1.0...v0.1.1](https://github.com/dry-rb/dry-initializer/compare/v0.1.0...v0.1.1)
 
 ## v0.1.0 2016-04-26
 
@@ -11,11 +78,13 @@ Backward compatibility is broken.
 
 ### Changed (backward-incompatible changes)
 
-* Use `extend Dry::Initializer::Mixin` instead of `extend Dry::Initializer` (nepalez)
+* Use `extend Dry::Initializer::Mixin` instead of `extend Dry::Initializer` (@nepalez)
 
 ### Added
 
-* Use `include Dry::Initializer.define(&block)` as an alternative to extending the class (nepalez)
+* Use `include Dry::Initializer.define(&block)` as an alternative to extending the class (@nepalez)
+
+[Compare v0.0.1...v0.1.0](https://github.com/dry-rb/dry-initializer/compare/v0.0.1...v0.1.0)
 
 ## v0.0.1 2016-04-09
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Andrew Kozin (aka nepalez)
+Copyright (c) 2016 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

@@ -13,6 +13,9 @@
 [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.
 
@@ -45,7 +48,7 @@ class User
   extend Dry::Initializer::Mixin
 
   # Params of the initializer along with corresponding readers
-  param  :name, type: String
+  param  :name
   param  :role, default: proc { 'customer' }
   # Options of the initializer along with corresponding readers
   option :admin, default: proc { false }
@@ -60,286 +63,11 @@ user.role  # => 'admin'
 user.admin # => true
 ```
 
-This is pretty the same as:
-
-```ruby
-class User
-  attr_reader :name, :type, :admin
-
-  def initializer(name, type = 'customer', admin: false)
-    @name  = name
-    @type  = type
-    @admin = admin
-
-    fail TypeError unless String === @name
-  end
-end
-```
-
-### Container Version
-
-Instead of extending a class with the `Dry::Initializer::Mixin`, you can include a container with the initializer:
-
-```ruby
-require 'dry-initializer'
-
-class User
-  # notice `-> do .. end` syntax
-  include Dry::Initializer.define -> do
-    param  :name,  type: String
-    param  :role,  default: proc { 'customer' }
-    option :admin, default: proc { false }
-  end
-end
-```
-
-Now you do not pollute a class with new variables, but isolate them in a special "container" module with the initializer and attribute readers. This method should be preferred when you don't need subclassing.
-
-If you still need the DSL (`param` and `option`) to be inherited, use the direct extension:
-
-```ruby
-require 'dry-initializer'
-
-class BaseService
-  extend Dry::Initializer::Mixin
-  alias_method :dependency, :param
-end
-
-class ShowUser < BaseService
-  dependency :user
-
-  def call
-    puts user&.name
-  end
-end
-```
-
-### Params and Options
-
-Use `param` to define plain argument:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param :name
-  param :email
-end
-
-user = User.new 'Andrew', 'andrew@email.com'
-user.name  # => 'Andrew'
-user.email # => 'andrew@email.com'
-```
-
-Use `option` to define named (hash) argument:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  option :name
-  option :email
-end
-
-user = User.new email: 'andrew@email.com', name: 'Andrew'
-user.name  # => 'Andrew'
-user.email # => 'andrew@email.com'
-```
-
-All names should be unique:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param  :name
-  option :name # => raises #<SyntaxError ...>
-end
-```
-
-### Default Values
-
-By default both params and options are mandatory. Use `:default` key to make them optional:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param  :name,  default: proc { 'Unknown user' }
-  option :email, default: proc { 'unknown@example.com' }
-end
-
-user = User.new
-user.name  # => 'Unknown user'
-user.email # => 'unknown@example.com'
-
-user = User.new 'Vladimir', email: 'vladimir@example.com'
-user.name  # => 'Vladimir'
-user.email # => 'vladimir@example.com'
-```
-
-Set `nil` as a default value explicitly:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param  :name
-  option :email, default: proc { nil }
-end
-
-user = User.new 'Andrew'
-user.email # => nil
-
-user = User.new
-# => #<ArgumentError ...>
-```
-
-You **must** wrap default values into procs.
-
-If you need to **assign** proc as a default value, wrap it to another one:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param :name_proc, default: proc { proc { 'Unknown user' } }
-end
-
-user = User.new
-user.name_proc.call # => 'Unknown user'
-```
-
-Proc will be executed in a scope of new instance. You can refer to other arguments:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param :name
-  param :email, default: proc { "#{name.downcase}@example.com" }
-end
-
-user = User.new 'Andrew'
-user.email # => 'andrew@example.com'
-```
-
-**Warning**: when using lambdas instead of procs, don't forget an argument, required by [instance_eval][instance_eval] (you can skip in in a proc).
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param :name, default: -> (obj) { 'Dude' }
-end
-```
-
-[instance_eval]: http://ruby-doc.org/core-2.2.0/BasicObject.html#method-i-instance_eval
-
-### Order of Declarations
-
-You cannot define required parameter after optional ones. The following example raises `SyntaxError` exception:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param :name, default: proc { 'Unknown name' }
-  param :email # => #<SyntaxError ...>
-end
-```
-
-### Type Constraints
-
-To set type constraint use `:type` key:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param :name, type: String
-end
-
-user = User.new 'Andrew'
-user.name # => 'Andrew'
-
-user = User.new :andrew
-# => #<TypeError ...>
-```
-
-You can use plain Ruby classes and modules as type constraint (see above), or use [dry-types][dry-types]:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param :name, type: Dry::Types::Coercion::String
-end
-```
-
-Or you can define custom constraint as a proc:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param :name, type: proc { |v| raise TypeError if String === v }
-end
-
-user = User.new name: 'Andrew'
-# => #<TypeError ...>
-```
-
-[dry-types]: https://github.com/dryrb/dry-types
-
-### Reader
-
-By default `attr_reader` is defined for every param and option.
-
-To skip the reader, use `reader: false`:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param :name
-  param :email, reader: false
-end
-
-user = User.new 'Luke', 'luke@example.com'
-user.name  # => 'Luke'
-
-user.email                         # => #<NoMethodError ...>
-user.instance_variable_get :@email # => 'luke@example.com'
-```
-
-No writers are defined. Define them using pure ruby `attr_writer` when necessary.
-
-### Subclassing
-
-Subclassing preserves all definitions being made inside a superclass:
-
-```ruby
-class User
-  extend Dry::Initializer::Mixin
-
-  param :name
-end
-
-class Employee < User
-  param :position
-end
-
-employee = Employee.new('John', 'supercargo')
-employee.name     # => 'John'
-employee.position # => 'supercargo'
-```
+See full documentation on the [Dry project official site][docs]
 
 ## Benchmarks
 
-The `dry-initializer` is a [fastest DSL][benchmarks] for rubies 2.2+ except for cases when core `Struct` is sufficient.
-
-[benchmarks]: https://github.com/dry-rb/dry-initializer/wiki
+The `dry-initializer` is pretty fast for rubies 2.2+ [comparing to other libraries][benchmarks].
 
 ## Compatibility
 
@@ -356,5 +84,5 @@ Tested under rubies [compatible to MRI 2.2+](.travis.yml).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License][license].