equalizer 0.0.1

data/.gitignore

@@ -0,0 +1,37 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+.rbx
+
+## PROJECT::GENERAL
+*.gem
+coverage
+profiling
+turbulence
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.lock
+
+## PROJECT::SPECIFIC

data/.rvmrc

@@ -0,0 +1 @@
+rvm use @$(basename `pwd`) --create

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+bundler_args: --without yard guard
+script: "bundle exec rake spec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ree
+  - ruby-head
+  - jruby-head
+notifications:
+  email:
+    - dan.kubb@gmail.com
+    - mbj@seonic.net

data/Gemfile

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :yard do
+  gem 'yard',      '~> 0.8.3'
+  gem 'redcarpet', '~> 2.2.2', :platforms => [ :mri, :rbx ]
+end
+
+group :guard do
+  gem 'guard',         '~> 1.5.4'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-rspec',   '~> 1.2.1'
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.7.4'
+  end
+end
+
+group :metrics do
+  gem 'flay',      '~> 1.4.3'
+  gem 'flog',      '~> 2.5.3'
+  gem 'reek',      '~> 1.2.8', :github => 'dkubb/reek'
+  gem 'roodi',     '~> 2.1.0'
+  gem 'yardstick', '~> 0.8.0'
+  gem 'simplecov'
+
+  platforms :ruby_18, :ruby_19 do
+    # this indirectly depends on ffi which does not build on ruby-head
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platforms :mri_18 do
+    gem 'arrayfields', '~> 4.7.4'  # for metric_fu
+    gem 'fattr',       '~> 2.2.0'  # for metric_fu
+    gem 'heckle',      '~> 1.4.3'
+    gem 'json',        '~> 1.7.3'  # for metric_fu rake task
+    gem 'map',         '~> 6.2.0'  # for metric_fu
+    gem 'metric_fu',   '~> 2.1.1'
+    gem 'mspec',       '~> 1.5.17'
+    gem 'rcov',        '~> 1.0.0'
+    gem 'ruby2ruby',   '= 1.2.2'   # for heckle
+  end
+
+  platforms :rbx do
+    gem 'pelusa', '~> 0.2.1'
+  end
+end

data/Guardfile

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+guard :bundler do
+  watch('Gemfile')
+end
+
+guard :rspec do
+  # run all specs if the spec_helper or supporting files files are modified
+  watch('spec/spec_helper.rb')                      { 'spec' }
+  watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
+
+  # run unit specs if associated lib code is modified
+  watch(%r{\Alib/(.+)\.rb\z})                                         { |m| Dir["spec/unit/#{m[1]}"] }
+  watch("lib/#{File.basename(File.expand_path('../', __FILE__))}.rb") { 'spec'                       }
+
+  # run a spec if it is modified
+  watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
+end

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009-2012 Dan Kubb
+Copyright (c) 2012 Markus Schirp (packaging)
+
+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,105 @@
+equalizer
+=========
+
+[![Build Status](https://secure.travis-ci.org/dkubb/equalizer.png?branch=master)](http://travis-ci.org/dkubb/equalizer)
+[![Dependency Status](https://gemnasium.com/dkubb/equalizer.png)](https://gemnasium.com/dkubb/equalizer)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/dkubb/equalizer)
+
+Module to define equality, equivalence and inspection methods
+
+Installation
+------------
+
+With Rubygems:
+
+```bash
+$ gem install equalizer
+$ irb -rubygems
+>> require 'equalizer'
+=> true
+```
+
+With git and local working copy:
+
+```bash
+$ git clone git://github.com/dkubb/equalizer.git
+$ cd equalizer
+$ rake install
+$ irb -rubygems
+>> require 'equalizer'
+=> true
+```
+
+Examples
+--------
+
+``` ruby
+class GeoLocation
+  include Equalizer.new(:latitude, :longitude)
+
+  attr_reader :latitidue, :longitude
+
+  def initialize(latitude, longitude)
+    @latitude, @longitude = latitude, longitude
+  end
+end
+
+point_a = GeoLocation.new(1, 2)
+point_b = GeoLocation.new(1, 2)
+point_c = GeoLocation.new(2, 2)
+
+point_a.inspect    # => "#<GeoLocation latitude=1 longitude=2>"
+
+point_a == point_b           # => true
+point_a.hash == point_b.hash # => true
+point_a.eql?(point_b)        # => true
+point_a.equal?(point_b)      # => false
+
+point_a == point_c           # => false
+point_a.hash == point_c.hash # => false
+point_a.eql?(point_c)        # => false
+point_a.equal?(point_c)      # => false
+```
+
+Credits
+-------
+
+* Dan Kubb ([dkubb](https://github.com/dkubb))
+* Piotr Solnica ([solnic](https://github.com/solnic))
+* Markus Schirp ([mbj](https://github.com/mbj))
+
+Contributing
+------------
+
+* If you want your code merged into the mainline, please discuss the proposed changes with me before doing any work on it. This library is still in early development, and the direction it is going may not always be clear. Some features may not be appropriate yet, may need to be deferred until later when the foundation for them is laid, or may be more applicable in a plugin.
+* Fork the project.
+* Make your feature addition or bug fix.
+* Follow this [style guide](https://github.com/dkubb/styleguide).
+* Add specs for it. This is important so I don't break it in a future version unintentionally. Tests must cover all branches within the code, and code must be fully covered.
+* Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Run "rake ci". This must pass and not show any regressions in the metrics for the code to be merged.
+* Send me a pull request. Bonus points for topic branc
+
+License
+-------
+
+Copyright (c) 2011-2012 Dan Kubb
+
+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/Rakefile

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'rake'
+
+require File.expand_path('../lib/equalizer/version', __FILE__)
+
+FileList['tasks/**/*.rake'].each { |task| import task }
+
+task :default => :spec

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 6
+total_score: 29

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 25

data/config/roodi.yml

@@ -0,0 +1,18 @@
+---
+AbcMetricMethodCheck:            { score: 10.3 }
+AssignmentInConditionalCheck:    { }
+CaseMissingElseCheck:            { }
+ClassLineCountCheck:             { line_count: 293 }
+ClassNameCheck:                  { pattern: !ruby/regexp '/\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/' }
+ClassVariableCheck:              { }
+CyclomaticComplexityBlockCheck:  { complexity: 2 }
+CyclomaticComplexityMethodCheck: { complexity: 4 }
+EmptyRescueBodyCheck:            { }
+ForLoopCheck:                    { }
+# TODO: decrease line_count to 5 to 10
+MethodLineCountCheck:            { line_count: 14 }
+MethodNameCheck:                 { pattern: !ruby/regexp '/\A(?:[a-z\d](?:_?[a-z\d])+[?!=]?|\[\]=?|==|<=>|[+*&|-])\z/' }
+ModuleLineCountCheck:            { line_count: 295 }
+ModuleNameCheck:                 { pattern: !ruby/regexp '/\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/' }
+# TODO: decrease parameter_count to 2 or less
+ParameterNumberCheck:            { parameter_count: 3 }

data/config/site.reek

@@ -0,0 +1,91 @@
+---
+UncommunicativeParameterName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LargeClass:
+  max_methods: 10
+  exclude: []
+  enabled: true
+  max_instance_variables: 2
+UncommunicativeMethodName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LongParameterList:
+  max_params: 2  # TODO: decrease max_params to 2
+  exclude: []
+  enabled: true
+  overrides: {}
+FeatureEnvy:
+  exclude: []
+  enabled: true
+ClassVariable:
+  exclude: []
+  enabled: true
+BooleanParameter:
+  exclude: []
+  enabled: true
+IrresponsibleModule:
+  exclude: []
+  enabled: true
+UncommunicativeModuleName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+NestedIterators:
+  ignore_iterators: []
+  exclude: []
+  enabled: true
+  max_allowed_nesting: 2
+LongMethod:
+  max_statements: 7  # TODO: decrease max_statements to 5 or less
+  exclude: []
+  enabled: true
+Duplication:
+  allow_calls: []
+  exclude: []
+  enabled: true
+  max_calls: 1
+UtilityFunction:
+  max_helper_calls: 1
+  exclude: []
+  enabled: true
+Attribute:
+  exclude: []
+  enabled: false
+UncommunicativeVariableName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+SimulatedPolymorphism:
+  exclude: []
+  enabled: true
+  max_ifs: 1
+DataClump:
+  exclude: []
+  enabled: true
+  max_copies: 1
+  min_clump_size: 3
+ControlCouple:
+  exclude: []
+  enabled: true
+LongYieldList:
+  max_params: 1
+  exclude: []
+  enabled: true

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/equalizer.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require File.expand_path('../lib/equalizer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'equalizer'
+  gem.version     = Equalizer::VERSION.dup
+  gem.authors     = ['Dan Kubb', 'Markus Schirp']
+  gem.email       = %w[dan.kubb@gmail.com mbj@seonic.net]
+  gem.description = 'Module to define equality, equivalence and inspection methods'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/dkubb/equalizer'
+
+  gem.require_paths    = %w[lib]
+  gem.files            = `git ls-files`.split($/)
+  gem.test_files       = `git ls-files -- {spec}/*`.split($/)
+  gem.extra_rdoc_files = %w[LICENSE README.md TODO]
+
+  gem.add_runtime_dependency('backports',  '~> 2.6.4')
+  gem.add_runtime_dependency('adamantium', '~> 0.0.3')
+
+  gem.add_development_dependency('rake',  '~> 10.0.2')
+  gem.add_development_dependency('rspec', '~> 1.3.2')
+end

data/lib/equalizer.rb

@@ -0,0 +1,121 @@
+# encoding: utf-8
+
+require 'adamantium'
+
+# Define equality, equivalence and inspection methods
+class Equalizer < Module
+  include Adamantium
+
+  # Initialize an Equalizer with the given keys
+  #
+  # Will use the keys with which it is initialized to define #cmp?,
+  # #hash, and #inspect
+  #
+  # @param [Array<Symbol>] keys
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def initialize(*keys)
+    @keys = keys
+    define_methods
+    include_comparison_methods
+  end
+
+private
+
+  # Define the equalizer methods based on #keys
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def define_methods
+    define_cmp_method
+    define_hash_method
+    define_inspect_method
+  end
+
+  # Define an #cmp? method based on the instance's values identified by #keys
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def define_cmp_method
+    keys = @keys
+    define_method(:cmp?) do |comparator, other|
+      keys.all? { |key| send(key).send(comparator, other.send(key)) }
+    end
+    private :cmp?
+  end
+
+  # Define a #hash method based on the instance's values identified by #keys
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def define_hash_method
+    keys = @keys
+    define_method(:hash) do
+      keys.map { |key| send(key).hash }.reduce(self.class.hash, :^)
+    end
+  end
+
+  # Define an inspect method that reports the values of the instance's keys
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def define_inspect_method
+    keys = @keys
+    define_method(:inspect) do
+      klass = self.class
+      name  = klass.name || klass.inspect
+      "#<#{name}#{keys.map { |key| " #{key}=#{send(key).inspect}" }.join}>"
+    end
+  end
+
+  # Include the #eql? and #== methods
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def include_comparison_methods
+    module_eval { include Methods }
+  end
+
+  # The comparison methods
+  module Methods
+
+    # Compare the object with other object for equality
+    #
+    # @example
+    #   object.eql?(other)  # => true or false
+    #
+    # @param [Object] other
+    #   the other object to compare with
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def eql?(other)
+      instance_of?(other.class) && cmp?(__method__, other)
+    end
+
+    # Compare the object with other object for equivalency
+    #
+    # @example
+    #   object == other  # => true or false
+    #
+    # @param [Object] other
+    #   the other object to compare with
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def ==(other)
+      other = coerce(other) if respond_to?(:coerce, true)
+      !!(self.class <=> other.class) && cmp?(__method__, other)
+    end
+
+  end # module Methods
+end # class Equalizer