98 lines
2.8 KiB
Markdown
98 lines
2.8 KiB
Markdown
equalizer
|
|
=========
|
|
|
|
Module to define equality, equivalence and inspection methods
|
|
|
|
[][gem]
|
|
[][travis]
|
|
[][gemnasium]
|
|
[][codeclimate]
|
|
[][coveralls]
|
|
|
|
[gem]: https://rubygems.org/gems/equalizer
|
|
[travis]: https://travis-ci.org/dkubb/equalizer
|
|
[gemnasium]: https://gemnasium.com/dkubb/equalizer
|
|
[codeclimate]: https://codeclimate.com/github/dkubb/equalizer
|
|
[coveralls]: https://coveralls.io/r/dkubb/equalizer
|
|
|
|
Examples
|
|
--------
|
|
|
|
``` ruby
|
|
class GeoLocation
|
|
include Equalizer.new(:latitude, :longitude)
|
|
|
|
attr_reader :latitude, :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
|
|
```
|
|
|
|
Supported Ruby Versions
|
|
-----------------------
|
|
|
|
This library aims to support and is [tested against][travis] the following Ruby
|
|
implementations:
|
|
|
|
* Ruby 1.8.7
|
|
* Ruby 1.9.2
|
|
* Ruby 1.9.3
|
|
* Ruby 2.0.0
|
|
* [JRuby][]
|
|
* [Rubinius][]
|
|
* [Ruby Enterprise Edition][ree]
|
|
|
|
[jruby]: http://jruby.org/
|
|
[rubinius]: http://rubini.us/
|
|
[ree]: http://www.rubyenterpriseedition.com/
|
|
|
|
If something doesn't work on one of these versions, it's a bug.
|
|
|
|
This library may inadvertently work (or seem to work) on other Ruby versions or
|
|
implementations, however support will only be provided for the implementations
|
|
listed above.
|
|
|
|
If you would like this library to support another Ruby version or
|
|
implementation, you may volunteer to be a maintainer. Being a maintainer
|
|
entails making sure all tests run and pass on that implementation. When
|
|
something breaks on your implementation, you will be responsible for providing
|
|
patches in a timely fashion. If critical issues for a particular implementation
|
|
exist at the time of a major release, support for that Ruby version may be
|
|
dropped.
|
|
|
|
Credits
|
|
-------
|
|
|
|
* Dan Kubb ([dkubb](https://github.com/dkubb))
|
|
* Piotr Solnica ([solnic](https://github.com/solnic))
|
|
* Markus Schirp ([mbj](https://github.com/mbj))
|
|
* Erik Michaels-Ober ([sferik](https://github.com/sferik))
|
|
|
|
Contributing
|
|
-------------
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
|
|
|
|
Copyright
|
|
---------
|
|
|
|
Copyright © 2009-2013 Dan Kubb. See LICENSE for details.
|