attr_extras 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17e3dfb363304609f6981fe839b36c318f9726ea
-  data.tar.gz: d32ee310679a5135dd5433e288b561451418a88f
+  metadata.gz: 6d151eb4e76dda68fdeef01c651351ddc24bd55a
+  data.tar.gz: 87c5fad6b639817d4c2884ef24c319924b1437dc
 SHA512:
-  metadata.gz: c24ba0b62181e236814657c9e06fdff80263696d77f3d824b62eeec038e20b7ff0cd4979783d16aec71c884fd2f7711429c7983e3cdc7321b301c52e8f33e958
-  data.tar.gz: 7846ad4e0bd1808dccdec81857477a8e7372cf56378e6e1e95659fe4a19339ba2c4759f713fa18577aa4705b4a939fd165bf26cc83f3e122e4fe532b37c8b0c4
+  metadata.gz: 1b65f8a8e1b9ed0cd46f4628f76ddde7459c3a2c848263b560af9e3a6b012816d62bf8ba2973f68c1dfa0bbd5e73fcf5a2070b1e7e155946b3c5077509753e8f
+  data.tar.gz: c49227cae57dbb9f2178bee8eee1ce9a344ba5a6918093011396e6462051e8d7b3fdc8326d104c188f639144e33eff2d29cd21eb9fedb87c508da091cd20f23d

data/README.md

@@ -2,7 +2,7 @@
 
 # attr\_extras
 
-Takes some boilerplate out of Ruby, lowering the barrier to extracting small focused classes, without the downsides of using `Struct`.
+Takes some boilerplate out of Ruby, lowering the barrier to extracting small focused classes, without [the downsides of using `Struct`](http://thepugautomatic.com/2013/08/struct-inheritance-is-overused/).
 
 Instead of
 
@@ -34,20 +34,26 @@ This nicely complements Ruby's built-in `attr_accessor`, `attr_reader` and `attr
 `attr_initialize :foo, :bar`<br>
 Defines an initializer that takes two arguments and assigns `@foo` and `@bar`.
 
-`attr_initialize :foo, [:bar, :baz!]`<br>
+`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_private :foo, :bar`<br>
 Defines private readers for `@foo` and `@bar`.
 
 `pattr_initialize :foo, :bar`<br>
-Defines both initializer and private readers.
+Defines both initializer and private readers. The `[]` notation for hash arguments is also supported.
 
 `attr_value :foo, :bar`<br>
-Defines both initializer and public readers.
+NOTE: experimental. Likely to be renamed, modified or removed soon.<br>
+Defines both initializer and public readers. Does not define writers as value objects are typically immutable. Defines object equality: two value objects of the same class with the same values are equal.
 
 `method_object :fooable?, :foo`<br>
-Defines a `.fooable?` class method that takes one argument (`:foo`) and delegates to an instance method that can access `foo` as a private reader.
+Defines a `.fooable?` class method that takes one argument (`:foo`) and delegates to an instance method that can access `foo` as a private reader, useful for [method objects](http://refactoring.com/catalog/replaceMethodWithMethodObject.html). The `[]` notation for hash arguments is also supported.
+
+You don't have to specify readers if you don't want them: `method_object :fooable?` is also valid.
 
 `attr_id_query :foo?, :bar?`<br>
 Defines query methods like `foo?`, which is true iff `foo_id` is truthy. Goes well with Active Record.

data/lib/attr_extras.rb

@@ -49,7 +49,15 @@ module AttrExtras
 
     def attr_value(*names)
       attr_initialize(*names)
-      attr_reader *attr_flat_names(names)
+
+      flat_names = attr_flat_names(names)
+      attr_reader *flat_names
+
+      define_method(:==) do |other|
+        return false unless other.is_a?(self.class)
+
+        flat_names.all? { |attr| self.public_send(attr) == other.public_send(attr) }
+      end
     end
 
     def method_object(method_name, *names)

data/lib/attr_extras/version.rb

@@ -1,3 +1,3 @@
 module AttrExtras
-  VERSION = "1.8.1"
+  VERSION = "1.9.0"
 end

data/spec/attr_extras_spec.rb

@@ -1,10 +1,12 @@
+# encoding: utf-8
+
 require "minitest/autorun"
 require "minitest/pride"
 require "attr_extras"
 
 describe Object, ".method_object" do
-  let(:klass) do
-    Class.new do
+  it "creates a class method that instantiates and runs that instance method" do
+    klass = Class.new do
       method_object :fooable?,
         :foo
 
@@ -12,12 +14,22 @@ describe Object, ".method_object" do
         foo
       end
     end
-  end
 
-  it "creates a class method that instantiates and runs that instance method" do
     assert klass.fooable?(true)
     refute klass.fooable?(false)
   end
+
+  it "doesn't require attributes" do
+    klass = Class.new do
+      method_object :fooable?
+
+      def fooable?
+        true
+      end
+    end
+
+    assert klass.fooable?
+  end
 end
 
 describe Object, ".attr_initialize" do
@@ -130,6 +142,36 @@ describe Object, ".attr_value" do
     example.bar.must_equal "Bar"
     example.baz.must_equal "Baz"
   end
+
+  it "defines equality based on the attributes" do
+    klass = Class.new do
+      attr_value :foo, :bar
+    end
+
+    example1 = klass.new("Foo", "Bar")
+    example2 = klass.new("Foo", "Bar")
+    example3 = klass.new("Arroz", "Feijão")
+
+    assert example1 == example2, "Examples should be equal"
+    refute example1 != example2, "Examples should be equal"
+
+    assert example1 != example3, "Examples should not be equal"
+  end
+
+  it "defines equality based on the actual type" do
+    klass1 = Class.new do
+      attr_value :foo
+    end
+    klass2 = Class.new do
+      attr_value :foo
+    end
+
+    example1 = klass1.new("Foo")
+    example2 = klass2.new("Foo")
+
+    assert example1 != example2, "Examples should not be equal"
+    refute example1 == example2, "Examples should not be equal"
+  end
 end
 
 describe Object, ".attr_id_query" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_extras
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Henrik Nyh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-09 00:00:00.000000000 Z
+date: 2014-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake