README.md in equatable-0.3.0 vs README.md in equatable-0.4.0
- old
+ new
@@ -1,7 +1,7 @@
# Equatable
-[](http://badge.fury.io/rb/equatable) [][travis] [][codeclimate]
+[](http://badge.fury.io/rb/equatable) [][travis] [][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.
@@ -25,37 +25,36 @@
## 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
+class Value
+ include Equatable
- attr_reader :value
+ attr_reader :value
- def initialize(value)
- @value = value
- end
+ def initialize(value)
+ @value = value
end
+end
- val1 = Value.new(11)
- val2 = Value.new(11)
- val3 = Value.new(13)
+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 == val2 # => true
+val1.hash == val2.hash # => true
+val1 eql? val2 # => true
- val1 == val3 # => false
- val1.hash == val3.hash # => false
- val1 eql? val3 # => false
-
+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. Therefore you should avoid specifying attributes that depend on unreliable resources like IP address that require network access.
-Note that adding a extra attr reader to a subclass will violate the equivalence contract.
+Note that adding an extra attribute reader to a subclass will violate the equivalence contract.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -63,6 +62,6 @@
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Copyright
-Copyright (c) 2012-2013 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2012-2014 Piotr Murach. See LICENSE for further details.