equatable 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sw*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-f s

data/.rvmrc

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+environment_id="ruby-1.9.3-p0@equatable"
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
+fi
+
+if [[ $- == *i* ]] # check for interactive shells
+then
+    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+else 
+	echo "Using: $GEM_HOME" # don't use colors in interactive shells
+fi

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+before_install:
+  - gem install bundler
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ree
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-19mode
+    - rvm: rbx-19mode

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Piotr Murach
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Equatable
+[![Build Status](https://secure.travis-ci.org/peter-murach/equatable.png?branch=master)][travis] [![Code Climate](https://codeclimate.com/badge.png)][codeclimate]
+
+[travis]: http://travis-ci.org/peter-murach/equatable
+[codeclimate]: https://codeclimate.com/github/peter-murach/equatable
+
+Allows ruby objects to implement equality comparison and inspection methods.
+
+By including this module, a class indicates that its instances have explicit general contracts for `hash`, `==` and `eql?` methods. Specifically `eql?` contract requires that it implements an equivalence relation. By default each instance of the class is equal only to itself. This is a right behaviour when you have distinct objects. Howerver, it is the responsibility of any class to clearly define their equality. Failure to do so may prevent instances to behave as expected when for instance `Array#uniq` is invoked or when they are used as `Hash` keys.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'equatable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install equatable
+
+## Usage
+
+It is assumed that your objects are value objects and the only values that affect equality comparison are the ones specified by your attribute readers. Each attribute reader should be a significant field in determining objects values.
+
+```ruby
+  class Value
+    include Equatable
+
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+  end
+
+  val1 = Value.new(11)
+  val2 = Value.new(11)
+  val3 = Value.new(13)
+
+  val1 == val2            # => true
+  val1.hash == val2.hash  # => true
+  val1 eql? val2          # => true
+
+  val1 == val3            # => false
+  val1.hash == val3.hash  # => false
+  val1 eql? val3          # => false
+
+```
+
+It is important that the attribute readers should allow for performing deterministic computations on class instances.
+
+## Contributing
+
+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
+
+## Copyright
+
+Copyright (c) 2012 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.expand_path('../lib', __FILE__)
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+FileList['tasks/**/*.rake'].each { |task| import task }
+
+task :default => [:spec]

data/equatable.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'equatable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "equatable"
+  gem.version       = Equatable::VERSION
+  gem.authors       = ["Piotr Murach"]
+  gem.email         = [""]
+  gem.description   = %q{Allows ruby objects to implement equality comparison and inspection methods. By including this module, a class indicates that its instances have explicit general contracts for `hash`, `==` and `eql?` methods.}
+  gem.summary       = %q{Allows ruby objects to implement equality comparison and inspection methods.}
+  gem.homepage      = "http://github.com/peter-murach/equatable"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'yard'
+end

data/lib/equatable.rb

@@ -0,0 +1,150 @@
+# -*- encoding: utf-8 -*-
+
+require "equatable/version"
+
+# Make it easy to define equality and hash methods.
+module Equatable
+
+  # Hook into module inclusion.
+  #
+  # @param [Module] base
+  #   the module or class including Equatable
+  #
+  # @return [self]
+  #
+  # @api private
+  def self.included(base)
+    super
+    base.extend(self)
+    base.class_eval do
+      define_comparison_attrs
+      include Methods
+      define_methods
+    end
+    self
+  end
+
+  # Holds all attributes used for comparison.
+  #
+  # @return [Array<Symbol>]
+  #
+  # @api private
+  attr_reader :comparison_attrs
+
+  # Objects that include this module are assumed to be value objects.
+  # It is also assumed that the only values that affect the results of
+  # equality comparison are the values of the object's attributes.
+  #
+  # @param [Array<Symbol>] *args
+  #
+  # @return [undefined]
+  #
+  # @api public
+  def attr_reader(*args)
+    super
+    @comparison_attrs.concat(args)
+  end
+
+  # Copy the comparison_attrs into the subclass.
+  #
+  # @param [Class] subclass
+  #
+  # @api private
+  def inherited(subclass)
+    super
+    subclass.instance_variable_set(:@comparison_attrs, comparison_attrs.dup)
+  end
+
+  private
+
+  # Define class instance #comparison_attrs as an empty array.
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def define_comparison_attrs
+    instance_variable_set('@comparison_attrs', [])
+  end
+
+  # Define all methods needed for ensuring object's equality.
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def define_methods
+    define_compare
+    define_hash
+    define_inspect
+  end
+
+  # Define a #compare? method to check if the receiver is the same
+  # as the other object.
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def define_compare
+    define_method(:compare?) do |comparator, other|
+      attrs = comparison_attrs || []
+      !attrs.find { |attr| send(attr).send(comparator, other.send(attr)) }
+    end
+  end
+
+  # Define a hash method that ensures that the hash value is the same for
+  # the same instance attributes and their corresponding values.
+  #
+  # @api private
+  def define_hash
+    define_method(:hash) do
+      klass = self.class
+      attrs = klass.comparison_attrs || []
+      ([klass] + attrs.map { |attr| send(attr)}).hash
+    end
+  end
+
+  # Define an inspect method that shows the class name and the values for the
+  # instance's attributes.
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def define_inspect
+    define_method(:inspect) do
+      klass = self.class
+      name = klass.name || klass.inspect
+      attrs = klass.comparison_attrs || []
+      "#<#{name}#{attrs.map { |attr| " #{attr}=#{send(attr).inspect}" }.join}>"
+    end
+  end
+
+  module Methods
+
+    # Compare two objects for equality based on their value
+    # and being an instance of the given class.
+    #
+    # @param [Object] other
+    #   the other object in comparison
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def eql?(other)
+      instance_of?(other.class) and compare?(__method__, other)
+    end
+
+    # Compare two objects for equality based on their value
+    # and being a subclass of the given class.
+    #
+    # @param [Object] other
+    #   the other object in comparison
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def ==(other)
+      return false unless self.class <=> other.class
+      compare?(__method__, other)
+    end
+
+  end # Methods
+end # Equatable

data/lib/equatable/version.rb

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+
+module Equatable
+  VERSION = "0.1.0"
+end

data/spec/equatable/eql_spec.rb

@@ -0,0 +1,206 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe Equatable do
+  let(:name) { 'Value' }
+
+  context 'without attributes' do
+    let(:klass) { ::Class.new }
+
+    subject { klass.new }
+
+    before {
+      klass.stub(:name).and_return 'Value'
+      klass.send :include, described_class
+    }
+
+    it { should respond_to :compare? }
+
+    it { should be_instance_of klass }
+
+    describe '#eql?' do
+      context 'when objects are similar' do
+        let(:other) { subject.dup }
+
+        it { subject.eql?(other).should be_true }
+      end
+
+      context 'when objects are different' do
+        let(:other) { stub('other') }
+
+        it { subject.eql?(other).should be_false }
+      end
+    end
+
+    describe '#==' do
+      context 'when objects are similar' do
+        let(:other) { subject.dup }
+
+        it { (subject == other).should be_true }
+      end
+
+      context 'when objects are different' do
+        let(:other) { stub('other') }
+
+        it { (subject == other)}
+      end
+    end
+
+    describe '#inspect' do
+      it { subject.inspect.should eql('#<Value>') }
+    end
+
+    describe '#hash' do
+      it { subject.hash.should eql([klass].hash) }
+    end
+
+
+  end
+
+  context 'with attributes' do
+    let(:value) { 11 }
+    let(:klass) {
+      ::Class.new do
+        include Equatable
+
+        attr_reader :value
+
+        def initialize(value)
+          @value = value
+        end
+      end
+    }
+
+    before {
+      klass.stub(:name).and_return name
+    }
+
+    subject { klass.new(value) }
+
+    it 'dynamically defines #hash method' do
+      klass.method_defined?(:hash).should be_true
+    end
+
+    it 'dynamically defines #inspect method' do
+      klass.method_defined?(:inspect).should be_true
+    end
+
+    it { should respond_to :compare? }
+
+    it { should respond_to :eql? }
+
+    describe '#eql?' do
+      context 'when objects are similar' do
+        let(:other) { subject.dup }
+
+        it { subject.eql?(other).should be_true }
+      end
+
+      context 'when objects are different' do
+        let(:other) { stub('other') }
+
+        it { subject.eql?(other).should be_false }
+      end
+    end
+
+    describe '#==' do
+      context 'when objects are similar' do
+        let(:other) { subject.dup }
+
+        it { (subject == other).should be_true }
+      end
+
+      context 'when objects are different' do
+        let(:other) { stub('other') }
+
+        it { (subject == other).should be_false }
+      end
+    end
+
+    describe '#inspect' do
+      it { subject.inspect.should eql('#<Value value=11>') }
+    end
+
+    describe '#hash' do
+      it { subject.hash.should eql( ([klass] + [value]).hash) }
+    end
+
+    context 'equivalence relation' do
+      let(:other) { subject.dup }
+
+      it 'is not equal to nil reference' do
+         subject.eql?(nil).should be_false
+      end
+
+      it 'is reflexive' do
+        subject.eql?(subject).should be_true
+      end
+
+      it 'is symmetric' do
+        (subject.eql?(other)).should eql( other.eql?(subject) )
+      end
+
+      it 'is transitive'
+    end
+  end
+
+  context 'subclass' do
+    let(:value) { 11 }
+    let(:klass) {
+      ::Class.new do
+        include Equatable
+
+        attr_reader :value
+
+        def initialize(value)
+          @value = value
+        end
+      end
+    }
+    let(:subclass) { ::Class.new(klass) }
+
+    before {
+      klass.stub(:name).and_return name
+    }
+
+    subject { subclass.new(value) }
+
+    it { subclass.superclass.should == klass }
+
+    it { should respond_to :value }
+
+    describe '#inspect' do
+      it { subject.inspect.should eql('#<Value value=11>') }
+    end
+
+    describe '#eql?' do
+      context 'when objects are similar' do
+        let(:other) { subject.dup }
+
+        it { subject.eql?(other).should be_true }
+      end
+
+      context 'when objects are different' do
+        let(:other) { stub('other') }
+
+        it { subject.eql?(other).should be_false }
+      end
+    end
+
+    describe '#==' do
+      context 'when objects are similar' do
+        let(:other) { subject.dup }
+
+        it { (subject == other).should be_true }
+      end
+
+      context 'when objects are different' do
+        let(:other) { stub('other') }
+
+        it { (subject == other)}
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'equatable'
+
+RSpec.configure do |config|
+  config.order = :rand
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: equatable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152488300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152488300
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152487800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152487800
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2152487380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152487380
+description: Allows ruby objects to implement equality comparison and inspection methods.
+  By including this module, a class indicates that its instances have explicit general
+  contracts for `hash`, `==` and `eql?` methods.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- equatable.gemspec
+- lib/equatable.rb
+- lib/equatable/version.rb
+- spec/equatable/eql_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/peter-murach/equatable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Allows ruby objects to implement equality comparison and inspection methods.
+test_files:
+- spec/equatable/eql_spec.rb
+- spec/spec_helper.rb
+has_rdoc: