attr_extras 6.2.0 → 6.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a03ce9220bfff01deb8bd149a84375a38873bc7f
-  data.tar.gz: d4b97c8e31eaaa0e12a44fc872f7882325ed94d7
+  metadata.gz: 36d34fd523db74313e3c0509e90c7a55447577f6
+  data.tar.gz: 829cdcf1b0cfbd47beaefcbec7910e96cb518cea
 SHA512:
-  metadata.gz: e8a01917e46705498fafd11c0df34424cc0cf35c69d9376c091f7ceb58b08553ee528e1ccf9fdc2fbf2961352745ecfa9ec030c1b9dac513b432cb6231926a32
-  data.tar.gz: 449c6e92127085a5efb2b8021a6335de05bce8a75008ec51ab523956eb057ce2cdd2d6384206ede335ec368f93a6ed8e3c130cfdbbfcbeb9f76aef609f7bd299
+  metadata.gz: bfaa6b07c0878a8f3c3f4d73fbbe44da05964ea4ee2e387e70345580692b25172dc0edd2ff349c324d120707b940b2e416001d39581c35b4806e360a4a8f4c8c
+  data.tar.gz: a6cf49dc70ab9cb77ca13d618a985185538d623cc96918a26274bdd4aefdc0fd7ea66234e89845347b32e3e1cea0fd1d4e4edd3f3e53ab2ae4d8a8aac6521edc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+# 6.2.1
+
+* Bugfix with keyword argument defaults. Thanks to [Roman Dubrovsky](https://github.com/barsoom/attr_extras/pull/29)!
+
 # 6.2.0
 
 * Another bugfix when passing hash values to positional arguments.

data/README.md

@@ -59,14 +59,35 @@ Also provides conveniences for creating value objects, method objects, query met
 
 `attr_initialize [:bar, :baz!]` defines an initializer that takes two keyword arguments, assigning `@bar` (optional) and `@baz` (required).
 
-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.
 
+#### Default values
+
+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"`).
+
+Note that default values are evaluated *when the class is loaded* and not on every instantition. So `attr_initialize [time: Time.now]` might not do what you expect.
+
+You can always use regular Ruby methods to achieve this:
+
+```
+class Foo
+  attr_initialize [:time]
+
+  private
+
+  def time
+    @time || Time.now
+  end
+end
+```
+
+Or just use a regular initializer with default values.
+
 
 ### `attr_private`
 

data/lib/attr_extras/utils.rb

@@ -1,5 +1,7 @@
 module AttrExtras::Utils
   def self.flat_names(names)
-    names.flatten.map { |x| x.to_s.sub(/!\z/, "") }
+    names.flatten.
+      flat_map { |x| x.is_a?(Hash) ? x.keys : x }.
+      map { |x| x.to_s.sub(/!\z/, "") }
   end
 end

data/lib/attr_extras/version.rb

@@ -1,3 +1,3 @@
 module AttrExtras
-  VERSION = "6.2.0"
+  VERSION = "6.2.1"
 end

data/spec/attr_extras/aattr_initialize_spec.rb

@@ -24,7 +24,7 @@ describe Object, ".aattr_initialize" do
 
   it "works with hash ivars" do
     klass = Class.new do
-      aattr_initialize :foo, [:bar, :baz!]
+      aattr_initialize :foo, [ :bar, :baz! ]
     end
 
     example = klass.new("Foo", bar: "Bar", baz: "Baz")
@@ -32,6 +32,16 @@ describe Object, ".aattr_initialize" do
     example.baz.must_equal "Baz"
   end
 
+  it "works with hash ivars and default values" do
+    klass = Class.new do
+      aattr_initialize :foo, [ bar: "Bar", baz!: "Baz" ]
+    end
+
+    example = klass.new("Foo")
+
+    example.baz.must_equal "Baz"
+  end
+
   it "accepts a block for initialization" do
     klass = Class.new do
       aattr_initialize :value do

data/spec/attr_extras/attr_initialize_spec.rb

@@ -112,6 +112,7 @@ describe Object, ".attr_initialize" do
 
     # Should not raise.
     example = klass.new({ "invalid.ivar.name" => 123 })
+
     example.foo.must_equal({ "invalid.ivar.name" => 123 })
   end
 

data/spec/attr_extras/pattr_initialize_spec.rb

@@ -19,6 +19,15 @@ describe Object, ".pattr_initialize" do
     example.send(:baz).must_equal "Baz"
   end
 
+  it "works with hash ivars and default values" do
+    klass = Class.new do
+      pattr_initialize :foo, [ bar: "Bar", baz!: "Baz" ]
+    end
+
+    example = klass.new("Foo")
+    example.send(:baz).must_equal "Baz"
+  end
+
   it "can reference private initializer methods in an initializer block" do
     klass = Class.new do
       pattr_initialize :value do

data/spec/attr_extras/rattr_initialize_spec.rb

@@ -12,13 +12,22 @@ describe Object, ".rattr_initialize" do
 
   it "works with hash ivars" do
     klass = Class.new do
-      rattr_initialize :foo, [:bar, :baz!]
+      rattr_initialize :foo, [ :bar, :baz! ]
     end
 
     example = klass.new("Foo", bar: "Bar", baz: "Baz")
     example.public_send(:baz).must_equal "Baz"
   end
 
+  it "works with hash ivars and default values" do
+    klass = Class.new do
+      rattr_initialize :foo, [ bar: "Bar", baz!: "Baz" ]
+    end
+
+    example = klass.new("Foo")
+    example.send(:baz).must_equal "Baz"
+  end
+
   it "accepts the alias attr_reader_initialize" do
     klass = Class.new do
       attr_reader_initialize :foo, :bar

data/spec/attr_extras/utils_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe AttrExtras::Utils do
+  describe ".flat_names" do
+    subject { AttrExtras::Utils.flat_names(names) }
+
+    it "strips any bangs from a flat list of arguments" do
+      AttrExtras::Utils.flat_names([ :foo, :bar! ]).must_equal [ "foo", "bar" ]
+    end
+
+    it "flattens hash arguments and strips any bangs" do
+      AttrExtras::Utils.flat_names([ :foo, [ :bar, :baz! ] ]).must_equal [ "foo", "bar", "baz" ]
+    end
+
+    it "flattens hash arguments with defaults and strips any bangs" do
+      AttrExtras::Utils.flat_names([ :foo, [ bar: "Bar", baz!: "Baz"] ]).must_equal [ "foo", "bar", "baz" ]
+    end
+  end
+end

data/spec/attr_extras/vattr_initialize_spec.rb

@@ -24,6 +24,17 @@ describe Object, ".vattr_initialize" do
     example1.must_equal example2
   end
 
+  it "works with hash ivars and default values" do
+    klass = Class.new do
+      vattr_initialize :foo, [ bar: "Bar", baz!: "Baz" ]
+    end
+
+    example1 = klass.new("Foo")
+    example2 = klass.new("Foo")
+    example1.baz.must_equal "Baz"
+    example1.must_equal example2
+  end
+
   it "can accept an initializer block" do
     called = false
     klass = Class.new do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_extras
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.2.1
 platform: ruby
 authors:
 - Henrik Nyh
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-31 00:00:00.000000000 Z
+date: 2019-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -93,6 +93,7 @@ files:
 - spec/attr_extras/pattr_initialize_spec.rb
 - spec/attr_extras/rattr_initialize_spec.rb
 - spec/attr_extras/static_facade_spec.rb
+- spec/attr_extras/utils_spec.rb
 - spec/attr_extras/vattr_initialize_spec.rb
 - spec/attr_extras_spec.rb
 - spec/spec_helper.rb
@@ -135,6 +136,7 @@ test_files:
 - spec/attr_extras/pattr_initialize_spec.rb
 - spec/attr_extras/rattr_initialize_spec.rb
 - spec/attr_extras/static_facade_spec.rb
+- spec/attr_extras/utils_spec.rb
 - spec/attr_extras/vattr_initialize_spec.rb
 - spec/attr_extras_spec.rb
 - spec/spec_helper.rb