attr_extras 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08a7329a2b945733d0baf670533dd8801c1880a9
-  data.tar.gz: 7f01ba7e4aadab65bb51ec5cdca127f97be8461e
+  metadata.gz: 02abc2f4fe382b84b370d6f777be15a50bf136c7
+  data.tar.gz: bfee4d693acfdb8c1a15f9ed50677be6f21149a5
 SHA512:
-  metadata.gz: c3df45d212321d6d1e1046c7439fc9825e047b8b1d769f2b5e2b453f028449dec6bd07034560f821b1e43f3cb6446a13ac5a18edbb1e2725e49c6d44b895863d
-  data.tar.gz: ba8800473f4c53b5b83118bd125fa4212728610f2a65475c92af65ef5611094810c343cdf20ab493b675adfd1b5f9cdbe10bfaaae600a7572c5416c546fc186e
+  metadata.gz: 5a44ccd28222d3708b7f4b87d74f7f1a605b462ef8980e6b510844e8eca0aa2db9e4f0ae12df38f33b66bf9bbf4a48b08321763ba223ab8bea0abd2eb5c9bfe0
+  data.tar.gz: eff2da3b058ff22016362fec1e5a92e5a9c3cc5c1d88eea67341cc4bfec9b421b572d4296996c63b3baf50dbe168f150aae5111523ac0cee72afaad9f707dcb2

data/README.md

@@ -35,11 +35,12 @@ Also provides conveniences for creating value objects, method objects, query met
 
 ## Usage
 
-* [`pattr_initialize`](#pattr_initialize)
-* [`vattr_initialize`](#vattr_initialize)
 * [`attr_initialize`](#attr_initialize)
 * [`attr_private`](#attr_private)
 * [`attr_value`](#attr_value)
+* [`pattr_initialize`](#pattr_initialize) / [`attr_private_initialize`](#attr_private_initialize)
+* [`vattr_initialize`](#vattr_initialize) / [`attr_value_initialize`](#attr_value_initialize)
+* [`rattr_initialize`](#rattr_initialize) / [`attr_reader_initialize`](#attr_reader_initialize)
 * [`static_facade`](#static_facade)
 * [`method_object`](#method_object)
 * [`attr_implement`](#attr_implement)
@@ -47,16 +48,41 @@ Also provides conveniences for creating value objects, method objects, query met
 * [`attr_id_query`](#attr_id_query)
 
 
+### `attr_initialize`
+
+`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 [:bar, :baz!]` defines an initializer that takes one hash argument, assigning `@bar` (optional) and `@baz` (required).
+
+`attr_initialize` can also accept a block which will be invoked after initialization. This is useful for calling `super` appropriately in subclasses or initializing private data as necessary.
+
+
+### `attr_private`
+
+`attr_private :foo, :bar` defines private readers for `@foo` and `@bar`.
+
+
+### `attr_value`
+
+`attr_value :foo, :bar` defines public readers for `@foo` and `@bar` and also defines object equality: two value objects of the same class with the same values will be considered equal (with `==` and `eql?`, in `Set`s, as `Hash` keys etc).
+
+It does not define writers, because [value objects](http://en.wikipedia.org/wiki/Value_object) are typically immutable.
+
 
 ### `pattr_initialize`
+### `attr_private_initialize`
 
-`pattr_initialize :foo, :bar` defines both initializer and private readers: shortcut for
+`pattr_initialize :foo, :bar` defines both initializer and private readers. Shortcut for:
 
 ``` ruby
 attr_initialize :foo, :bar
 attr_private :foo, :bar
 ```
 
+`pattr_initialize` is aliased as `attr_private_initialize` if you prefer a longer but clearer name.
+
 Example:
 
 ``` ruby
@@ -73,16 +99,18 @@ 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!]`
 
-
 ### `vattr_initialize`
+### `attr_value_initialize`
 
-`vattr_initialize :foo, :bar` defines initializer, public readers and [value object identity](#attr_value): shortcut for
+`vattr_initialize :foo, :bar` defines initializer, public readers and [value object identity](#attr_value). Shortcut for:
 
 ``` ruby
 attr_initialize :foo, :bar
 attr_value :foo, :bar
 ```
 
+`vattr_initialize` is aliased as `attr_value_initialize` if you prefer a longer but clearer name.
+
 Example:
 
 ``` ruby
@@ -97,28 +125,34 @@ Country.new("SE").code  # => "SE"
 [The `attr_initialize` notation](#attr_initialize) for hash arguments is also supported: `vattr_initialize :foo, [:bar, :baz!]`
 
 
-### `attr_initialize`
-
-`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 [:bar, :baz!]` defines an initializer that takes one hash argument, assigning `@bar` (optional) and `@baz` (required).
-
-`attr_initialize` can also accept a block which will be invoked after initialization. This is useful for calling `super` appropriately in subclasses or initializing private data as necessary.
+### `rattr_initialize`
+### `attr_reader_initialize`
 
+`rattr_initialize :foo, :bar` defines both initializer and public readers. Shortcut for:
 
-### `attr_private`
+``` ruby
+attr_initialize :foo, :bar
+attr_reader :foo, :bar
+```
 
-`attr_private :foo, :bar` defines private readers for `@foo` and `@bar`.
+`rattr_initialize` is aliased as `attr_reader_initialize` if you prefer a longer but clearer name.
 
+Example:
 
-### `attr_value`
+``` ruby
+class PublishBook
+  rattr_initalize :book_name, :publisher_backend
 
-`attr_value :foo, :bar` defines public readers for `@foo` and `@bar` and also defines object equality: two value objects of the same class with the same values will be considered equal (with `==` and `eql?`, in `Set`s, as `Hash` keys etc).
+  def call
+    publisher_backend.publish book_name
+  end
+end
 
-It does not define writers, because [value objects](http://en.wikipedia.org/wiki/Value_object) are typically immutable.
+service = PublishBook.new("A Novel")
+service.book_name  # => "A Novel"
+```
 
+[The `attr_initialize` notation](#attr_initialize) for hash arguments is also supported: `rattr_initialize :foo, [:bar, :baz!]`
 
 ### `static_facade`
 
@@ -307,6 +341,7 @@ Or to see warnings (try not to have any):
 * [Teo Ljungberg](https://github.com/teoljungberg)
 * [Kim Persson](https://github.com/lavinia)
 * [Joe Ferris](https://github.com/jferris)
+* [Julien Vanier](https://github.com/monkbroc)
 
 
 ## License

data/lib/attr_extras.rb

@@ -41,11 +41,22 @@ module AttrExtras
       attr_private(*Utils.flat_names(names))
     end
 
+    alias_method :attr_private_initialize, :pattr_initialize
+
     def vattr_initialize(*names, &block)
       attr_initialize(*names, &block)
       attr_value(*Utils.flat_names(names))
     end
 
+    alias_method :attr_value_initialize, :vattr_initialize
+
+    def rattr_initialize(*names, &block)
+      attr_initialize(*names, &block)
+      attr_reader(*Utils.flat_names(names))
+    end
+
+    alias_method :attr_reader_initialize, :rattr_initialize
+
     def static_facade(method_name, *names)
       define_singleton_method(method_name) do |*values|
         new(*values).public_send(method_name)

data/lib/attr_extras/version.rb

@@ -1,3 +1,3 @@
 module AttrExtras
-  VERSION = "4.1.0"
+  VERSION = "4.2.0"
 end

data/spec/pattr_initialize_spec.rb

@@ -32,4 +32,13 @@ describe Object, ".pattr_initialize" do
 
     example.copy.must_equal "expected"
   end
+
+  it "accepts the alias attr_private_initializer" do
+    klass = Class.new do
+      attr_private_initialize :foo, :bar
+    end
+
+    example = klass.new("Foo", "Bar")
+    example.send(:foo).must_equal "Foo"
+  end
 end

data/spec/rattr_initialize_spec.rb

@@ -0,0 +1,30 @@
+require_relative "spec_helper"
+
+describe Object, ".rattr_initialize" do
+  it "creates both initializer and public readers" do
+    klass = Class.new do
+      rattr_initialize :foo, :bar
+    end
+
+    example = klass.new("Foo", "Bar")
+    example.public_send(:foo).must_equal "Foo"
+  end
+
+  it "works with hash ivars" do
+    klass = Class.new do
+      rattr_initialize :foo, [:bar, :baz!]
+    end
+
+    example = klass.new("Foo", :bar => "Bar", :baz => "Baz")
+    example.public_send(:baz).must_equal "Baz"
+  end
+
+  it "accepts the alias attr_reader_initializer" do
+    klass = Class.new do
+      attr_reader_initialize :foo, :bar
+    end
+
+    example = klass.new("Foo", "Bar")
+    example.public_send(:foo).must_equal "Foo"
+  end
+end

data/spec/vattr_initialize_spec.rb

@@ -36,4 +36,16 @@ describe Object, ".vattr_initialize" do
 
     called.must_equal true
   end
+
+  it "accepts the alias attr_value_initializer" do
+    klass = Class.new do
+      attr_value_initialize :foo, :bar
+    end
+
+    example1 = klass.new("Foo", "Bar")
+    example2 = klass.new("Foo", "Bar")
+
+    example1.foo.must_equal "Foo"
+    example1.must_equal example2
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_extras
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Henrik Nyh
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -70,6 +70,7 @@ files:
 - spec/attr_value_spec.rb
 - spec/method_object_spec.rb
 - spec/pattr_initialize_spec.rb
+- spec/rattr_initialize_spec.rb
 - spec/spec_helper.rb
 - spec/static_facade_spec.rb
 - spec/vattr_initialize_spec.rb
@@ -93,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Takes some boilerplate out of Ruby with methods like attr_initialize.
@@ -107,6 +108,7 @@ test_files:
 - spec/attr_value_spec.rb
 - spec/method_object_spec.rb
 - spec/pattr_initialize_spec.rb
+- spec/rattr_initialize_spec.rb
 - spec/spec_helper.rb
 - spec/static_facade_spec.rb
 - spec/vattr_initialize_spec.rb