immutable-struct 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af44014a283429f556ddd83301f23cf85b8ce988
-  data.tar.gz: f749729fb930b33ed6a6a48014e982a0253f9958
+  metadata.gz: 5c5b40b44baa7449ead521ed6adcc3d29f2d631c
+  data.tar.gz: afbd6ff4c6959e8cc1cde9432e53e606484ff4cb
 SHA512:
-  metadata.gz: a23377a3878c39a98af6bb91a5f46964344119732b6c7ba8df3eab2c20490a0ee3ed49caf2dda55194f073b48b8fd3dbf54823c6e085b01085bace42ced5ec5a
-  data.tar.gz: 130d852c29953497d09d9fe5a6248bdd11d56cdafe13a266417ad8e76d435b775a39e466bfcc2880f6a7952aeccf592c39eb5a1b1e60aab235955efb24c0b7a0
+  metadata.gz: 95da502d7c1f22a08bf24ec16a4c543350ef51d2124e88d865df9c7c61ec746fee65bd068dde00ba02a5822f2aa928b0c50e7d90f51229bd669323d5cba74518
+  data.tar.gz: 26aa7ba089b984a87362b6b1404763f6a453dc07f6ffcb61ce7cff40e689d62a6cfdb60691b77b525e052fa834b54799008a37b979634faeefc88f6f03b37c17

data/.ruby-version

@@ -1 +1 @@
-2.1.0
+2.2.2

data/.travis.yml

@@ -3,5 +3,6 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.2.2
   - rbx-2
   - ruby-head

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,6 @@
+# Code of Conduct
+
+We are committed to keeping our community open and inclusive.
+
+**Our Code of Conduct can be found here**:
+http://opensource.stitchfix.com/code-of-conduct.html

data/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributing
+Thanks for using and improving *ImmutableStruct*! If you'd like to help out, check out [the project's issues list][issues] for ideas on what could be improved.  If there's an idea you'd like to propose, or a design change, feel free to file a new issue or send a pull request:
+
+1. [Fork][fork] the repo.
+1. [Create a topic branch.][branch]
+1. Write tests.
+1. Implement your feature or fix bug.
+1. Add, commit, and push your changes.
+1. [Submit a pull request.][pr]
+
+[fork]: https://help.github.com/articles/fork-a-repo/
+[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
+[pr]: https://help.github.com/articles/using-pull-requests/
+
+## General Guidelines
+
+* When in doubt, test it.  If you can't test it, re-think what you are doing.
+* Code formatting and internal application architecture should be consistent.

data/README.rdoc

@@ -41,6 +41,17 @@ If not using bundler, just use RubyGems:
     p.minor?    # => false
     p.addresses # => []
 
+    p2 = Person.new(name: "Dave", age: 40, active: true)
+
+    p == p2     # => true
+    p.eql?(p2)  # => true
+
+    SimilarPerson = ImmutableStruct.new(:name, :age, :job, :active?, [:addresses])
+
+    sp = SimilarPerson.new(name: "Dave", age: 40, active: true)
+
+    p == sp     # => false         # Different class leads to inequality
+
 You can also treat the interior as a normal class definition.  
 
 == Links

data/immutable-struct.gemspec

@@ -6,10 +6,10 @@ require 'immutable-struct'
 Gem::Specification.new do |spec|
   spec.name          = "immutable-struct"
   spec.version       = ImmutableStruct::VERSION
-  spec.authors       = ["Stitch Fix Engineering"]
-  spec.email         = ["opensource@stitchfix.com"]
+  spec.authors       = ["Stitch Fix Engineering","Dave Copeland","Simeon Willbanks"]
+  spec.email         = ["opensource@stitchfix.com","davetron5000@gmail.com","simeon@simeons.net"]
   spec.description   = %q{Easily create value objects without the pain of Ruby's Struct (or its setters)}
-  spec.summary   = %q{Easily create value objects without the pain of Ruby's Struct (or its setters)}
+  spec.summary       = %q{Easily create value objects without the pain of Ruby's Struct (or its setters)}
   spec.homepage      = "https://github.com/stitchfix/immutable-struct"
   spec.license       = "MIT"
 

data/lib/immutable-struct.rb

@@ -6,7 +6,7 @@
 # will be evaluated as if it were inside a class definition, allowing you
 # to add methods, include or extend modules, or do whatever else you want.
 class ImmutableStruct
-  VERSION='2.1.1' #:nodoc:
+  VERSION='2.1.2' #:nodoc:
   # Create a new class with the given read-only attributes.
   #
   # attributes:: list of symbols or strings that can be used to create attributes.
@@ -64,12 +64,22 @@ class ImmutableStruct
           end
         end
       end
+
+      define_method(:==) do |other|
+        return false unless other.is_a?(klass)
+        attributes.all? { |attribute| self.send(attribute) == other.send(attribute) }
+      end
+
+      alias_method :eql?, :==
     end
     klass.class_exec(&block) unless block.nil?
     imethods = klass.instance_methods(include_super=false)
     klass.class_exec(imethods) do |imethods|
       define_method(:to_h) do
-        imethods.inject({}){ |hash, method| hash.merge(method.to_sym => self.send(method)) }
+        imethods.inject({}) do |hash, method|
+          next hash if [:==, :eql?].include?(method)
+          hash.merge(method.to_sym => self.send(method))
+        end
       end
     end
     klass

data/spec/immutable_struct_spec.rb

@@ -73,7 +73,7 @@ describe ImmutableStruct do
     it "allows defining class methods" do
       klass = ImmutableStruct.new(:foo, :bar) do
         def self.from_array(array)
-          self.new(foo: array[0], bar: array[1])
+          new(foo: array[0], bar: array[1])
         end
       end
       instance = klass.from_array(["hello","world"])
@@ -113,4 +113,57 @@ describe ImmutableStruct do
       instance.to_h.should == {flappy: 'bird', lawsuit: 'pending'}
     end
   end
+
+  describe "equality" do
+
+    before do
+      klass_1 = ImmutableStruct.new(:foo, :bar)
+      klass_2 = ImmutableStruct.new(:foo, :bar)
+      @k1_a = klass_1.new(foo: 'foo', bar: 'bar')
+      @k1_b = klass_1.new(foo: 'xxx', bar: 'yyy')
+      @k1_c = klass_1.new(foo: 'foo', bar: 'bar')
+      @k2_a = klass_2.new(foo: 'foo', bar: 'bar')
+    end
+
+    describe "==" do
+
+      it "should be equal to itself" do
+        (@k1_a == @k1_a).should be true
+      end
+
+      it "should be equal to same class with identical attribute values" do
+        (@k1_a == @k1_c).should be true
+      end
+
+      it 'should not be equal to same class with different attribute values' do
+        (@k1_a == @k1_b).should be false
+      end
+
+      it 'should not be equal to different class with identical attribute values' do
+        (@k1_a == @k3_a).should be false
+      end
+
+    end
+
+    describe "eql?" do
+
+      it "should be equal to itself" do
+        @k1_a.eql?(@k1_a).should be true
+      end
+
+      it "should be equal to same class with identical attribute values" do
+        @k1_a.eql?(@k1_c).should be true
+      end
+
+      it 'should not be equal to same class with different attribute values' do
+        @k1_a.eql?(@k1_b).should be false
+      end
+
+      it 'should not be equal to different class with identical attribute values' do
+        @k1_a.eql?(@k3_a).should be false
+      end
+
+    end
+
+  end
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: immutable-struct
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Stitch Fix Engineering
+- Dave Copeland
+- Simeon Willbanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,6 +58,8 @@ description: Easily create value objects without the pain of Ruby's Struct (or i
   setters)
 email:
 - opensource@stitchfix.com
+- davetron5000@gmail.com
+- simeon@simeons.net
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -64,6 +68,8 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.rdoc
@@ -92,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Easily create value objects without the pain of Ruby's Struct (or its setters)