attr_extras 5.2.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31be8de6a1c2dbbb19e44ea4255d099e656728b3
-  data.tar.gz: f5a8e9dbfdef34e1f1d368c889ae7a0f825e07e2
+  metadata.gz: d927809a2d8cd1a5da0e4e910942027d230dfb45
+  data.tar.gz: 80988c71e715df538d82b902846ca660e5f5a4fb
 SHA512:
-  metadata.gz: 30d562066800bdcc69011c4eb7ed26966d61aae06e4ebd1050ba7346bb15ef1b131edaa547f2aec9504f61ef103c9022126c40a2ebdd12bf4838d3b8722f387d
-  data.tar.gz: 4ba342974d86d1c4d0d3eeb30d41caa1fa97720b4626e7bbbafe7245fbf5dd48c4a10ef52c7ce8a43d3f2557a9c7ccb19218c2c21fc94e711fe31a7918958f32
+  metadata.gz: 8d9bd920c1a3227cd592dab70c0035124322bc0a358ed535b8aa5e42c6a8fb26bdcde0c85c8ef92a81131179e0b9fafbb928ccff2ab454164bc549cec36bd745
+  data.tar.gz: 96ff27fb9e371d898f3056159a644cb3828ad2e10bc3c83273fb38ab8441661e78f46bf4f2960b59f0af09affaa39cb8033f5a75b64efbc74476705268a73735

data/.travis.yml

@@ -1,5 +1,10 @@
 language: ruby
 rvm:
-  - 2.2.1
-  - 2.0.0
-  - jruby-19mode
+  - 2.6.1
+  - 2.5.3
+  - 2.4.1
+  - 2.3.3
+  - jruby-head
+before_install:  # For jruby-head to work.
+  - gem install bundler
+  - gem update bundler

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+# 6.1.0
+
+* Bugfix when passing hash values to positional arguments.
+
+# 6.0.0 (yanked)
+
+* Default arguments! Thanks to [Ola K](https://github.com/lesin). For example: `pattr_initialize [:foo, bar: "default value"]`
+
+# 5.2.0 and earlier
+
+Please [see Git history](https://github.com/barsoom/attr_extras/releases).

data/README.md

@@ -1,4 +1,4 @@
-[![Build status](https://secure.travis-ci.org/barsoom/attr_extras.png)](https://travis-ci.org/#!/barsoom/attr_extras/builds)
+[![Build status](https://secure.travis-ci.org/barsoom/attr_extras.svg)](https://travis-ci.org/#!/barsoom/attr_extras/builds)
 [![Code Climate](https://codeclimate.com/github/barsoom/attr_extras/badges/gpa.svg)](https://codeclimate.com/github/barsoom/attr_extras)
 
 # attr\_extras
@@ -29,7 +29,7 @@ end
 
 This nicely complements Ruby's built-in `attr_accessor`, `attr_reader` and `attr_writer`.
 
-Supports positional arguments as well as optional and required hash arguments.
+Supports positional arguments as well as optional and required keyword arguments.
 
 Also provides conveniences for creating value objects, method objects, query methods and abstract methods.
 
@@ -55,11 +55,15 @@ Also provides conveniences for creating value objects, method objects, query met
 
 `attr_initialize :foo, :bar` defines an initializer that takes two arguments and assigns `@foo` and `@bar`.
 
-`attr_initialize :foo, [:bar, :baz!]` defines an initializer that takes one regular argument, assigning `@foo`, and one hash argument, assigning `@bar` (optional) and `@baz` (required).
+`attr_initialize :foo, [:bar, :baz!]` defines an initializer that takes one regular argument, assigning `@foo`, and two keyword arguments, assigning `@bar` (optional) and `@baz` (required).
 
-`attr_initialize [:bar, :baz!]` defines an initializer that takes one hash argument, assigning `@bar` (optional) and `@baz` (required).
+`attr_initialize [:bar, :baz!]` defines an initializer that takes two keyword arguments, assigning `@bar` (optional) and `@baz` (required).
 
-If you pass unknown hash arguments, you will get an `ArgumentError`.
+Keyword arguments can have default values:
+`attr_initialize [:bar, baz: "default value"]` defines an initializer that takes two keyword arguments, assigning `@bar` (optional) and `@baz` (optional with default value `"default value"`).
+
+If you pass unknown keyword arguments, you will get an `ArgumentError`.
+If you don't pass required arguments and don't define default value for them, you will get a `KeyError`.
 
 `attr_initialize` can also accept a block which will be invoked after initialization. This is useful for e.g. initializing private data as necessary.
 
@@ -102,7 +106,7 @@ end
 Item.new("Pug", 100).price_with_vat  # => 125.0
 ```
 
-[The `attr_initialize` notation](#attr_initialize) for hash arguments is also supported: `pattr_initialize :foo, [:bar, :baz!]`
+[The `attr_initialize` notation](#attr_initialize) for keyword arguments is also supported: `pattr_initialize :foo, [:bar, :baz!]`
 
 ### `vattr_initialize`
 ### `attr_value_initialize`
@@ -127,7 +131,7 @@ Country.new("SE") == Country.new("SE")  # => true
 Country.new("SE").code  # => "SE"
 ```
 
-[The `attr_initialize` notation](#attr_initialize) for hash arguments is also supported: `vattr_initialize :foo, [:bar, :baz!]`
+[The `attr_initialize` notation](#attr_initialize) for keyword arguments is also supported: `vattr_initialize :foo, [:bar, :baz!]`
 
 
 ### `rattr_initialize`
@@ -157,7 +161,7 @@ service = PublishBook.new("A Novel", publisher)
 service.book_name  # => "A Novel"
 ```
 
-[The `attr_initialize` notation](#attr_initialize) for hash arguments is also supported: `rattr_initialize :foo, [:bar, :baz!]`
+[The `attr_initialize` notation](#attr_initialize) for keyword arguments is also supported: `rattr_initialize :foo, [:bar, :baz!]`
 
 ### `aattr_initialize`
 ### `attr_accessor_initialize`
@@ -185,7 +189,7 @@ client.access_token = "NEW_SECRET"
 client.access_token # => "NEW_SECRET"
 ```
 
-[The `attr_initialize` notation](#attr_initialize) for hash arguments and blocks is also supported.
+[The `attr_initialize` notation](#attr_initialize) for keyword arguments and blocks is also supported.
 
 ### `static_facade`
 
@@ -223,7 +227,7 @@ def self.allow?(user)
 end
 ```
 
-[The `attr_initialize` notation](#attr_initialize) for hash arguments is also supported: `static_facade :allow?, :user, [:user_agent, :ip!]`
+[The `attr_initialize` notation](#attr_initialize) for keyword arguments is also supported: `static_facade :allow?, :user, [:user_agent, :ip!]`
 
 You don't have to specify arguments/readers if you don't want them: just `static_facade :tuesday?` is also valid.
 
@@ -288,7 +292,7 @@ def self.call(foo)
 end
 ```
 
-[The `attr_initialize` notation](#attr_initialize) for hash arguments is also supported: `method_object :foo, [:bar, :baz!]`
+[The `attr_initialize` notation](#attr_initialize) for keyword arguments is also supported: `method_object :foo, [:bar, :baz!]`
 
 You don't have to specify arguments/readers if you don't want them: just `method_object` is also valid.
 

data/Rakefile

@@ -19,5 +19,5 @@ Rake::TestTask.new(:test_explicit) do |t|
   t.test_files = explicit_tests
 end
 
-task :test => [ :test_implicit, :test_explicit ]
-task :default => :test
+task test: [ :test_implicit, :test_explicit ]
+task default: :test

data/attr_extras.gemspec

@@ -2,7 +2,7 @@
 require File.expand_path('../lib/attr_extras/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Henrik Nyh", "Joakim Kolsjö", "Victor Arias"]
+  gem.authors       = ["Henrik Nyh", "Joakim Kolsjö", "Victor Arias", "Ola K"]
   gem.email         = ["henrik@nyh.se"]
   gem.summary       = %q{Takes some boilerplate out of Ruby with methods like attr_initialize.}
   gem.homepage      = "https://github.com/barsoom/attr_extras"
@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = AttrExtras::VERSION
 
   gem.add_development_dependency "minitest", ">= 5"
-  gem.add_development_dependency "m", "~> 1.3.1"  # Running individual tests.
+  gem.add_development_dependency "m", "~> 1.5.0"  # Running individual tests.
 
   # For Travis CI.
   gem.add_development_dependency "rake"

data/lib/attr_extras/attr_initialize.rb

@@ -1,3 +1,5 @@
+require "attr_extras/params_builder"
+
 class AttrExtras::AttrInitialize
   def initialize(klass, names, block)
     @klass, @names, @block = klass, names, block
@@ -9,31 +11,29 @@ class AttrExtras::AttrInitialize
   def apply
     # The define_method block can't call our methods, so we need to make
     # things available via local variables.
-    names = @names
     block = @block
+
+    klass_params = AttrExtras::AttrInitialize::ParamsBuilder.new(names)
+
     validate_arity = method(:validate_arity)
-    set_ivar_from_hash = method(:set_ivar_from_hash)
+    validate_args = method(:validate_args)
 
     klass.send(:define_method, :initialize) do |*values|
+      hash_values = values.select { |name| name.is_a?(Hash) }.inject(:merge) || {}
+
       validate_arity.call(values.length, self.class)
+      validate_args.call(values, klass_params)
+
+      klass_params.default_values.each do |name, default_value|
+        instance_variable_set("@#{name}", default_value)
+      end
+
+      klass_params.positional_args.zip(values).each do |name, value|
+        instance_variable_set("@#{name}", value)
+      end
 
-      names.zip(values).each do |name_or_names, value|
-        if name_or_names.is_a?(Array)
-          hash = value || {}
-
-          known_keys = name_or_names.map { |name| name.to_s.sub(/!\z/, "").to_sym }
-          unknown_keys = hash.keys - known_keys
-          if unknown_keys.any?
-            raise ArgumentError, "Got unknown keys: #{unknown_keys.inspect}; allowed keys: #{known_keys.inspect}"
-          end
-
-          name_or_names.each do |name|
-            set_ivar_from_hash.call(self, name, hash)
-          end
-        else
-          name = name_or_names
-          instance_variable_set("@#{name}", value)
-        end
+      hash_values.each do |name, value|
+        instance_variable_set("@#{name}", value)
       end
 
       if block
@@ -54,15 +54,17 @@ class AttrExtras::AttrInitialize
     end
   end
 
-  def set_ivar_from_hash(instance, name, hash)
-    if name.to_s.end_with?("!")
-      actual_name = name.to_s.chop.to_sym
-      value = hash.fetch(actual_name)
-    else
-      actual_name = name
-      value = hash[actual_name]
+  def validate_args(values, klass_params)
+    hash_values = values[(klass_params.positional_args.length)..-1].inject(:merge) || {}
+    unknown_keys = hash_values.keys - klass_params.hash_args_names
+
+    if unknown_keys.any?
+      raise ArgumentError, "Got unknown keys: #{unknown_keys.inspect}; allowed keys: #{klass_params.hash_args_names.inspect}"
     end
 
-    instance.instance_variable_set("@#{actual_name}", value)
+    missing_args = klass_params.hash_args_required - klass_params.default_values.keys - hash_values.keys
+    if missing_args.any?
+      raise KeyError, "Missing required keys: #{missing_args.inspect}"
+    end
   end
 end

data/lib/attr_extras/params_builder.rb

@@ -0,0 +1,49 @@
+module AttrExtras
+  class AttrInitialize
+    class ParamsBuilder
+      REQUIRED_SIGN = "!".freeze
+
+      def initialize(names)
+        @names = names
+      end
+
+      attr_reader :names
+      private :names
+
+      def positional_args
+        @positional_args ||= names.take_while { |name| !name.is_a?(Array) }
+      end
+
+      def hash_args
+        @hash_args ||= (names - positional_args).flatten.flat_map { |name|
+          name.is_a?(Hash) ? name.keys : name
+        }
+      end
+
+      def hash_args_names
+        @hash_args_names ||= hash_args.map { |name| remove_required_sign(name) }
+      end
+
+      def hash_args_required
+        @hash_args_required ||= hash_args.select { |name| name.to_s.end_with?(REQUIRED_SIGN) }.
+          map { |name| remove_required_sign(name) }
+      end
+
+      def default_values
+        @default_values ||= begin
+          default_values_hash = names.flatten.select { |name| name.is_a?(Hash) }.inject(:merge) || {}
+
+          default_values_hash.map { |name, value|
+            [ remove_required_sign(name), value ]
+          }.to_h
+        end
+      end
+
+      private
+
+      def remove_required_sign(name)
+        name.to_s.sub(/#{REQUIRED_SIGN}\z/, "").to_sym
+      end
+    end
+  end
+end

data/lib/attr_extras/version.rb

@@ -1,3 +1,3 @@
 module AttrExtras
-  VERSION = "5.2.0"
+  VERSION = "6.1.0"
 end

data/spec/attr_extras/aattr_initialize_spec.rb

@@ -27,7 +27,7 @@ describe Object, ".aattr_initialize" do
       aattr_initialize :foo, [:bar, :baz!]
     end
 
-    example = klass.new("Foo", :bar => "Bar", :baz => "Baz")
+    example = klass.new("Foo", bar: "Bar", baz: "Baz")
 
     example.baz.must_equal "Baz"
   end

data/spec/attr_extras/attr_initialize_spec.rb

@@ -27,22 +27,36 @@ describe Object, ".attr_initialize" do
       attr_initialize :foo, [:bar, :baz]
     end
 
-    example = klass.new("Foo", :bar => "Bar", :baz => "Baz")
+    example = klass.new("Foo", bar: "Bar", baz: "Baz")
     example.instance_variable_get("@foo").must_equal "Foo"
     example.instance_variable_get("@bar").must_equal "Bar"
     example.instance_variable_get("@baz").must_equal "Baz"
   end
 
+  it "can set default values for keyword arguments" do
+    klass = Class.new do
+      attr_initialize :foo, [:bar, baz: "default baz"]
+    end
+
+    example = klass.new("Foo", bar: "Bar")
+    example.instance_variable_get("@foo").must_equal "Foo"
+    example.instance_variable_get("@bar").must_equal "Bar"
+    example.instance_variable_get("@baz").must_equal "default baz"
+
+    example = klass.new("Foo", bar: "Bar", baz: "Baz")
+    example.instance_variable_get("@baz").must_equal "Baz"
+  end
+
   it "treats hash values as optional" do
     klass = Class.new do
       attr_initialize :foo, [:bar, :baz]
     end
 
-    example = klass.new("Foo", :bar => "Bar")
-    example.instance_variable_get("@baz").must_equal nil
+    example = klass.new("Foo", bar: "Bar")
+    example.instance_variable_defined?("@baz").must_equal false
 
     example = klass.new("Foo")
-    example.instance_variable_get("@bar").must_equal nil
+    example.instance_variable_defined?("@bar").must_equal false
   end
 
   it "can require hash values" do
@@ -50,10 +64,10 @@ describe Object, ".attr_initialize" do
       attr_initialize [:optional, :required!]
     end
 
-    example = klass.new(:required => "X")
+    example = klass.new(required: "X")
     example.instance_variable_get("@required").must_equal "X"
 
-    lambda { klass.new(:optional => "X") }.must_raise KeyError
+    lambda { klass.new(optional: "X") }.must_raise KeyError
   end
 
   it "complains about unknown hash values" do
@@ -62,12 +76,33 @@ describe Object, ".attr_initialize" do
     end
 
     # Should not raise.
-    klass.new("Foo", :bar => "Bar", :baz => "Baz")
+    klass.new("Foo", bar: "Bar", baz: "Baz")
 
-    exception = lambda { klass.new("Foo", :bar => "Bar", :baz => "Baz", :hello => "Hello") }.must_raise ArgumentError
+    exception = lambda { klass.new("Foo", bar: "Bar", baz: "Baz", hello: "Hello") }.must_raise ArgumentError
     exception.message.must_include "[:hello]"
   end
 
+  # Regression.
+  it "assigns hash values to positional arguments even when there's also hash arguments" do
+    klass = Class.new do
+      attr_initialize :foo, [:bar]
+    end
+
+    # Should not raise.
+    klass.new({ inside_foo: 123 }, bar: 456)
+  end
+
+  # Regression.
+  it "only looks at hash arguments when determining missing required keys" do
+    klass = Class.new do
+      attr_initialize :foo, [:bar!]
+    end
+
+    # Provides a hash to "foo" but does not provide "bar".
+    exception = lambda { klass.new({ bar: 123 }) }.must_raise KeyError
+    exception.message.must_include "[:bar]"
+  end
+
   it "accepts a block for initialization" do
     klass = Class.new do
       attr_initialize :value do

data/spec/attr_extras/params_builder_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe AttrExtras::AttrInitialize::ParamsBuilder do
+  subject { AttrExtras::AttrInitialize::ParamsBuilder.new(names) }
+
+  describe "when positional and hash params are present" do
+    let(:names) { [ :foo, :bar, [ :baz, :qux!, quux: "Quux" ]] }
+
+    it "properly devides params by the type" do
+      subject.positional_args.must_equal [ :foo, :bar ]
+      subject.hash_args.must_equal [ :baz, :qux!, :quux ]
+      subject.hash_args_names.must_equal [ :baz, :qux, :quux ]
+      subject.hash_args_required.must_equal [ :qux ]
+      subject.default_values.must_equal({ quux: "Quux" })
+    end
+  end
+
+  describe "when only positional params are present" do
+    let(:names) { [ :foo, :bar] }
+
+    it "properly devides params by the type" do
+      subject.positional_args.must_equal [ :foo, :bar ]
+      subject.hash_args.must_be_empty
+      subject.hash_args_names.must_be_empty
+      subject.hash_args_required.must_be_empty
+      subject.default_values.must_be_empty
+    end
+  end
+
+  describe "when only hash params are present" do
+    let(:names) { [[ { baz: "Baz" }, :qux!, { quux: "Quux" } ]] }
+
+    it "properly devides params by the type" do
+      subject.positional_args.must_be_empty
+      subject.hash_args.must_equal [ :baz, :qux!, :quux ]
+      subject.hash_args_names.must_equal [ :baz, :qux, :quux ]
+      subject.hash_args_required.must_equal [ :qux ]
+      subject.default_values.must_equal({ quux: "Quux", baz: "Baz" })
+    end
+  end
+
+  describe "when params are empty" do
+    let(:names) { [] }
+
+    it "properly devides params by the type" do
+      subject.positional_args.must_be_empty
+      subject.hash_args.must_be_empty
+      subject.hash_args_names.must_be_empty
+      subject.hash_args_required.must_be_empty
+      subject.default_values.must_be_empty
+    end
+  end
+end

data/spec/attr_extras/pattr_initialize_spec.rb

@@ -15,7 +15,7 @@ describe Object, ".pattr_initialize" do
       pattr_initialize :foo, [:bar, :baz!]
     end
 
-    example = klass.new("Foo", :bar => "Bar", :baz => "Baz")
+    example = klass.new("Foo", bar: "Bar", baz: "Baz")
     example.send(:baz).must_equal "Baz"
   end
 

data/spec/attr_extras/rattr_initialize_spec.rb

@@ -15,7 +15,7 @@ describe Object, ".rattr_initialize" do
       rattr_initialize :foo, [:bar, :baz!]
     end
 
-    example = klass.new("Foo", :bar => "Bar", :baz => "Baz")
+    example = klass.new("Foo", bar: "Bar", baz: "Baz")
     example.public_send(:baz).must_equal "Baz"
   end
 

data/spec/attr_extras/vattr_initialize_spec.rb

@@ -18,8 +18,8 @@ describe Object, ".vattr_initialize" do
       vattr_initialize :foo, [:bar, :baz!]
     end
 
-    example1 = klass.new("Foo", :bar => "Bar", :baz => "Baz")
-    example2 = klass.new("Foo", :bar => "Bar", :baz => "Baz")
+    example1 = klass.new("Foo", bar: "Bar", baz: "Baz")
+    example2 = klass.new("Foo", bar: "Bar", baz: "Baz")
     example1.baz.must_equal "Baz"
     example1.must_equal example2
   end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: attr_extras
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Henrik Nyh
 - Joakim Kolsjö
 - Victor Arias
+- Ola K
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -32,14 +33,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -63,6 +64,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -74,6 +76,7 @@ files:
 - lib/attr_extras/attr_query.rb
 - lib/attr_extras/attr_value.rb
 - lib/attr_extras/explicit.rb
+- lib/attr_extras/params_builder.rb
 - lib/attr_extras/utils.rb
 - lib/attr_extras/version.rb
 - script/test
@@ -86,6 +89,7 @@ files:
 - spec/attr_extras/attr_value_spec.rb
 - spec/attr_extras/explicit_spec.rb
 - spec/attr_extras/method_object_spec.rb
+- spec/attr_extras/params_builder_spec.rb
 - spec/attr_extras/pattr_initialize_spec.rb
 - spec/attr_extras/rattr_initialize_spec.rb
 - spec/attr_extras/static_facade_spec.rb
@@ -113,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Takes some boilerplate out of Ruby with methods like attr_initialize.
@@ -127,6 +131,7 @@ test_files:
 - spec/attr_extras/attr_value_spec.rb
 - spec/attr_extras/explicit_spec.rb
 - spec/attr_extras/method_object_spec.rb
+- spec/attr_extras/params_builder_spec.rb
 - spec/attr_extras/pattr_initialize_spec.rb
 - spec/attr_extras/rattr_initialize_spec.rb
 - spec/attr_extras/static_facade_spec.rb