ruby_peter_v 0.0.5 → 0.0.6

data/HISTORY.txt

@@ -1,24 +1,27 @@
 0.0.1 (2012-12-20)
 
-* #single (self for nil; first for empty or 1 element; raise if size > 1)
+* Enumerable#single (self for nil; first for empty or 1 element; raise if size > 1)
 
 0.0.2 (2013-01-03)
 
-* #single raises exception for nil (similar to #first)
+* Enumerable#single raises exception for nil (similar to #first)
 
 0.0.3 (2013-05-22)
 
-* Object#max_with_nil(a, b) added
+* Object#max_with_nil(a, b)
 
 0.0.4 (2013-05-22)
 
-* Object#set_once(attribute, value) added
+* Object#set_once(attribute, value)
 
 0.0.5 (2013-05-31)
 
 * Object#do_recursively
 
-TODO:
+0.0.6 (2013-06-02)
 
-* Object#define_eql
+* module DefineEquality
+* Module#DefineEquality
+
+TODO
 * Object#assert_keys_in

data/README.md

@@ -13,7 +13,7 @@ Add this line to your application's Gemfile:
 
 ## Usage
 
-### single on enumerable (instead of unstable .first)
+### single on Enumerable (instead of unstable .first)
 
   The background of this is that in many cases,
   the developer knows there _should_ only be 1
@@ -48,10 +48,12 @@ Add this line to your application's Gemfile:
   over objects that are read from a file that is much larger than
   the memory size, needed for Big Data processing).
 
-## Contributing
+### DefineEquality(*accessors) on Module
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+  Defining the equality (.eql?, ==, hash) between instances.
+  The class is included by default in the accessor list in
+  the usage `include DefineEquality(:foo, :bar)`.
+
+  Defining equality for instances of different classes is
+  possible by manually defining the `equality_accessors`
+  function (see the spec with the b5 instance).

data/lib/ruby_peter_v/define_equality.rb

@@ -0,0 +1,46 @@
+##
+# Modified from the equitable function from ruby facets
+#
+# https://github.com/rubyworks/facets/blob/master/lib/standard/facets/equitable.rb
+#
+# Copyright (c) 2005,2010 Thomas Sawyer
+# Licensed under the Ruby license and GPL license
+# See https://github.com/rubyworks/facets/blob/master/LICENSE.txt
+#
+# This modified version falls under the license for this package
+
+module DefineEquality
+
+  # NOTE added :class as a default accessor
+  def self.identify(base, *accessors)
+    base.send(:define_method, :equality_accessors){ [:class] + accessors }
+    self
+  end
+
+  def ==(o)
+    equality_accessors.all?{ |a| send(a) == o.send(a) }
+  end
+
+  def eql?(o)
+    equality_accessors.all?{ |a| send(a).eql?(o.send(a)) }
+  end
+
+  def hash
+    equality_accessors.inject(0){ |acc, a| acc ^ send(a).hash }
+  end
+
+end
+
+class Module
+
+  # In `include DefineEquality(:foo)`
+  # * this _method_ is called first
+  # * it sets the equality_accessors list of accessors
+  # * that returns self (the module DefineEquality)
+  # * which is then included and overrides the
+  #   equality and hash methods
+  def DefineEquality(*accessors)
+    DefineEquality.identify(self, *accessors)
+  end
+
+end

data/lib/ruby_peter_v/version.rb

@@ -1,3 +1,3 @@
 module RubyPeterV
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/ruby_peter_v.rb

@@ -3,3 +3,4 @@ require 'ruby_peter_v/single'
 require 'ruby_peter_v/max_with_nil'
 require 'ruby_peter_v/set_once'
 require 'ruby_peter_v/do_recursively'
+require 'ruby_peter_v/define_equality'

data/spec/lib/ruby_peter_v/define_equality_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+describe "define_equality" do
+  describe "without defining eql on the instance var" do
+
+    let(:a) { Object.new }
+
+    it "objects are eql? and == and same hash when they are actually the same in memory" do
+      a.should be_eql(a)
+      a.should ==  a
+      a.hash.should ==  a.hash
+    end
+
+    it "objects are not (eql? and == and same hash) when they are not the same in memory" do
+      a.should_not be_eql(Object.new)
+      a.should_not ==  Object.new
+      a.hash.should_not ==  Object.new.hash
+    end
+  end
+
+  describe "with define_equality" do
+
+    let(:a1) do
+      Object.new.tap do |_o|
+        _o.instance_eval do
+          @foo = '1'
+          @bar = '1'
+          self.singleton_class.class_eval { include DefineEquality() }
+        end
+      end
+    end
+
+    let(:a2) do
+      Object.new.tap do |_o|
+        _o.instance_eval do
+          @foo = '1'
+          @bar = '2'
+          self.singleton_class.class_eval { include DefineEquality() }
+        end
+      end
+    end
+
+    let(:b1) do
+      Object.new.tap do |_o|
+        _o.instance_eval do
+          @foo = '1'
+          @bar = '1'
+          def foo ; @foo ; end
+          self.singleton_class.class_eval { include DefineEquality(:foo) }
+        end
+      end
+    end
+
+    let(:b2) do
+      Object.new.tap do |_o|
+        _o.instance_eval do
+          @foo = '1'
+          @bar = '2'
+          def foo ; @foo ; end
+          self.singleton_class.class_eval { include DefineEquality(:foo) }
+        end
+      end
+    end
+
+    let(:b3) do
+      Object.new.tap do |_o|
+        _o.instance_eval do
+          @foo = '2'
+          @bar = '1'
+          def foo ; @foo ; end
+          self.singleton_class.class_eval { include DefineEquality(:foo) }
+        end
+      end
+    end
+
+    it "objects are eql? and == and same hash when they are actually the same in memory" do
+      a1.should be_eql(a1)
+      a1.should == a1
+      a1.hash.should == a1.hash
+    end
+
+    # the instance_eval only affects the singleton_class of the test object
+    it "should not leak into general Object" do
+      a1.should be_eql(a2)
+      o1 = Object.new
+      o2 = Object.new
+      o1.should_not be_eql(o2)
+      o1.should_not == o2
+      o1.hash.should_not == o2.hash
+    end
+
+    describe "objects are eql? and == and same hash when" do
+      describe "they have same class and" do
+        it "no instance vars in define_equality" do
+          a1.should be_eql(a2)
+          a1.should == a2
+          a1.hash.should == a2.hash
+        end
+
+        it "equal instance vars in define_equality" do
+          b1.should be_eql(b2)
+          b1.should == b2
+          b1.hash.should == b2.hash
+        end
+      end
+    end
+
+    describe "objects are not (eql? and == and same hash) when" do
+      it "they are different class" do
+        a1.should_not be_eql('')
+        a1.should_not == ''
+        a1.hash.should_not == ''.hash
+      end
+
+      it "they are same class and different instance var value" do
+        b1.should_not be_eql(b3)
+        b1.should_not == b3
+        b1.hash.should_not == b3.hash
+      end
+    end
+
+    let(:b4) do
+      Object.new.tap do |_o|
+        _o.instance_eval do
+          self.singleton_class.class_eval { include DefineEquality }
+        end
+      end
+    end
+
+    let(:b5) do
+      Object.new.tap do |_o|
+        _o.instance_eval do
+          def equality_accessors ; [:to_s] ; end
+          def to_s ; "foobar" ; end
+          self.singleton_class.class_eval { include DefineEquality }
+        end
+      end
+    end
+
+    describe "the equality_accessors can be set manually with `include DefineEquality`" do
+      it "without equality_accessors it fails" do
+        lambda{ b4 == b4 }.should raise_error NameError, /equality_accessors/
+      end
+
+      it "with equality_accessors (e.g. without class) it allows equality with other class" do
+        b5.should == 'foobar'
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_peter_v
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -92,12 +92,14 @@ files:
 - README.md
 - Rakefile
 - lib/ruby_peter_v.rb
+- lib/ruby_peter_v/define_equality.rb
 - lib/ruby_peter_v/do_recursively.rb
 - lib/ruby_peter_v/max_with_nil.rb
 - lib/ruby_peter_v/set_once.rb
 - lib/ruby_peter_v/single.rb
 - lib/ruby_peter_v/version.rb
 - ruby_peter_v.gemspec
+- spec/lib/ruby_peter_v/define_equality_spec.rb
 - spec/lib/ruby_peter_v/do_recursively_spec.rb
 - spec/lib/ruby_peter_v/max_with_nil_spec.rb
 - spec/lib/ruby_peter_v/set_once_spec.rb
@@ -128,6 +130,7 @@ signing_key:
 specification_version: 3
 summary: Ruby helpers for @peter_v
 test_files:
+- spec/lib/ruby_peter_v/define_equality_spec.rb
 - spec/lib/ruby_peter_v/do_recursively_spec.rb
 - spec/lib/ruby_peter_v/max_with_nil_spec.rb
 - spec/lib/ruby_peter_v/set_once_spec.rb