attr_extras 1.9.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d151eb4e76dda68fdeef01c651351ddc24bd55a
-  data.tar.gz: 87c5fad6b639817d4c2884ef24c319924b1437dc
+  metadata.gz: d86d1ce2f78e900f9dd4c9792df912f94ed6973f
+  data.tar.gz: 41d756b1d2b14f6f66ce1b8eb7e0127b4839d9b3
 SHA512:
-  metadata.gz: 1b65f8a8e1b9ed0cd46f4628f76ddde7459c3a2c848263b560af9e3a6b012816d62bf8ba2973f68c1dfa0bbd5e73fcf5a2070b1e7e155946b3c5077509753e8f
-  data.tar.gz: c49227cae57dbb9f2178bee8eee1ce9a344ba5a6918093011396e6462051e8d7b3fdc8326d104c188f639144e33eff2d29cd21eb9fedb87c508da091cd20f23d
+  metadata.gz: 5f4c36e7c979590d62a5a8fccc7f450eda9ec9cb1cd21466b8634c995b9bd2921bf1edbab33a09e85a7136f618d4e99ace7a3d8c70701420d216eb3b67695710
+  data.tar.gz: 4eb369edb50ea00c9bfdb36f78053cfdbabecd9ce826050fa8d588ede9942e72ebefa064ed2b05f10edaf4b4f58be2e9cf347919892c5d74dbee34312a6f45df

data/README.md

@@ -31,37 +31,72 @@ This nicely complements Ruby's built-in `attr_accessor`, `attr_reader` and `attr
 
 ## Usage
 
-`attr_initialize :foo, :bar`<br>
+
+### `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 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 [:bar, :baz!]`,
-Defines an initializer that takes one hash argument, assigning `@bar` (optional) and `@baz` (required).
+### `attr_private :foo, :bar`
 
-`attr_private :foo, :bar`<br>
 Defines private readers for `@foo` and `@bar`.
 
-`pattr_initialize :foo, :bar`<br>
-Defines both initializer and private readers. The `[]` notation for hash arguments is also supported.
 
-`attr_value :foo, :bar`<br>
-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.
+### `attr_value :foo, :bar`
+
+Defines 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.
+
+
+### `pattr_initialize :foo, :bar`
+
+Defines both initializer and private readers: shortcut for
+
+```
+attr_initialize :foo, :bar
+attr_private :foo, :bar
+```
+
+The `attr_initialize` notation notation for hash arguments is also supported: `pattr_initialize :foo, [:bar, :baz!]`
+
 
-`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, useful for [method objects](http://refactoring.com/catalog/replaceMethodWithMethodObject.html). The `[]` notation for hash arguments is also supported.
+### `vattr_initialize :foo, :bar`
+
+Defines initializer, public readers and value object identity: shortcut for
+
+```
+attr_initialize :foo, :bar
+attr_value :foo, :bar
+```
+
+The `attr_initialize` notation notation for hash arguments is also supported: `vattr_initialize :foo, [:bar, :baz!]`
+
+
+### `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, useful for [method objects](http://refactoring.com/catalog/replaceMethodWithMethodObject.html).
+
+The `attr_initialize` notation notation for hash arguments is also supported: `method_object :fooable?, :foo, [:bar, :baz!]`
 
 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>
+
+### `attr_id_query :foo?, :bar?`<br>
 Defines query methods like `foo?`, which is true iff `foo_id` is truthy. Goes well with Active Record.
 
-`attr_query :foo?, :bar?`<br>
+
+### `attr_query :foo?, :bar?`<br>
 Defines query methods like `foo?`, which is true iff `foo` is truthy.
 
-Findability has been a central consideration.
+
+## Philosophy
+
+Findability is a core value.
 Hence the long name `attr_initialize`, so you see it when scanning for the initializer;
 and the enforced questionmarks with `attr_id_query :foo?`, so you can search for that method.
 

data/lib/attr_extras/version.rb

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

data/lib/attr_extras.rb

@@ -47,16 +47,18 @@ module AttrExtras
       attr_private *attr_flat_names(names)
     end
 
-    def attr_value(*names)
+    def vattr_initialize(*names)
       attr_initialize(*names)
+      attr_value *attr_flat_names(names)
+    end
 
-      flat_names = attr_flat_names(names)
-      attr_reader *flat_names
+    def attr_value(*names)
+      attr_reader *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) }
+        names.all? { |attr| self.public_send(attr) == other.public_send(attr) }
       end
     end
 

data/spec/attr_extras_spec.rb

@@ -117,34 +117,50 @@ describe Object, ".pattr_initialize" do
     end
 
     example = klass.new("Foo", :bar => "Bar", :baz => "Baz")
-    example.send(:bar).must_equal "Bar"
     example.send(:baz).must_equal "Baz"
   end
 end
 
-describe Object, ".attr_value" do
-  it "creates both initializer and public readers" do
+describe Object, ".vattr_initialize" do
+  it "creates initializer, value readers and value object identity" do
     klass = Class.new do
-      attr_value :foo, :bar
+      vattr_initialize :foo, :bar
     end
 
-    example = klass.new("Foo", "Bar")
-    example.foo.must_equal "Foo"
-    lambda { example.foo = "new value" }.must_raise NoMethodError
+    example1 = klass.new("Foo", "Bar")
+    example2 = klass.new("Foo", "Bar")
+
+    example1.foo.must_equal "Foo"
+    example1.must_equal example2
   end
 
   it "works with hash ivars" do
     klass = Class.new do
-      attr_value :foo, [:bar, :baz!]
+      vattr_initialize :foo, [:bar, :baz!]
     end
 
-    example = klass.new("Foo", :bar => "Bar", :baz => "Baz")
-    example.bar.must_equal "Bar"
-    example.baz.must_equal "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
+end
+
+describe Object, ".attr_value" do
+  it "creates public readers" do
+    klass = Class.new do
+      attr_value :foo, :bar
+    end
+
+    example = klass.new
+    example.instance_variable_set("@foo", "Foo")
+    example.foo.must_equal "Foo"
+    lambda { example.foo = "new value" }.must_raise NoMethodError
   end
 
   it "defines equality based on the attributes" do
     klass = Class.new do
+      attr_initialize :foo, :bar
       attr_value :foo, :bar
     end
 
@@ -155,14 +171,17 @@ describe Object, ".attr_value" do
     assert example1 == example2, "Examples should be equal"
     refute example1 != example2, "Examples should be equal"
 
+    refute example1 == example3, "Examples should not 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_initialize :foo
       attr_value :foo
     end
     klass2 = Class.new do
+      attr_initialize :foo
       attr_value :foo
     end
 
@@ -172,6 +191,28 @@ describe Object, ".attr_value" do
     assert example1 != example2, "Examples should not be equal"
     refute example1 == example2, "Examples should not be equal"
   end
+
+  it "considers an instance equal to itself" do
+    klass = Class.new do
+      attr_initialize :foo
+      attr_value :foo
+    end
+
+    instance = klass.new("Foo")
+
+    assert instance == instance, "Instance should be equal to itself"
+  end
+
+  it "can compare value objects to other kinds of objects" do
+    klass = Class.new do
+      attr_initialize :foo
+      attr_value :foo
+    end
+
+    instance = klass.new("Foo")
+
+    assert instance != "a string"
+  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.9.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Henrik Nyh