immutable-struct 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08fb6160fb58ba3ab29f75f41a166a0a93332410
-  data.tar.gz: f9f956a1e7da833ff74758111f12f4c5742fa5dd
+  metadata.gz: a9c0a785dd4e418fdae0fe7dfd89f3ceef53077b
+  data.tar.gz: 4411b12c43b62e461b86489e55cf2d7996e45172
 SHA512:
-  metadata.gz: 376b0a0c7b46858f974bd18563abdf5e20bf429847ea22cbfe0c88e310f446cfc79a4a5b24fc9cbf1371c86721c043cd4fa351177e7c3e8bd7c0e3a681207ffe
-  data.tar.gz: 2226048c79444ae2c8da4d4e7b83b8f07e87c4b024bd154e03eae7115537d9f55ad4a3a5e1b48b476af067a0bb4b289de7d294f53f208b642af5891bdb7322ee
+  metadata.gz: 7c5c10d71cea0da0ae00f11d349a19e3f06557f1cfe80195c9f1131681a3e860ed68c5581a9df8971fe26c0a4b3793f6e75568adf5440eeb8a713121fc48b4c4
+  data.tar.gz: fe3d852d289626c1314e323b6610558470ad330feadd5b39509141261d80fa5c4a596f61a860ca3d9ffc8752c51f40c3c41c3c66437b774c57bf5bdd43769606

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    immutable-struct (2.2.1)
+    immutable-struct (2.2.2)
 
 GEM
   remote: https://rubygems.org/
@@ -12,7 +12,7 @@ GEM
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
       rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.1)
+    rspec-core (3.4.2)
       rspec-support (~> 3.4.0)
     rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)

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.2.1' #:nodoc:
+  VERSION='2.2.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.
@@ -22,7 +22,7 @@ class ImmutableStruct
   #
   # Example:
   #
-  #     Person = ImmutableStruct.new(:name, :location, :minor?)
+  #     Person = ImmutableStruct.new(:name, :location, :minor?, [:aliases])
   #
   #     p = Person.new(name: 'Dave', location: Location.new("DC"), minor: false)
   #     p.name     # => 'Dave'
@@ -41,6 +41,21 @@ class ImmutableStruct
   #     new_person.age     # => 41
   #     new_person.active? # => true
   #
+  # Note that you also get an implementation of `to_h` that will include **all** no-arg methods in its
+  # output:
+  #
+  #     Person = ImmutableStruct.new(:name, :location, :minor?, [:aliases])
+  #     p = Person.new(name: 'Dave', minor: "yup", aliases: [ "davetron", "davetron5000" ])
+  #     p.to_h # => { name: "Dave", minor: "yup", minor?: true, aliases: ["davetron", "davetron5000" ] }
+  # 
+  # This has two subtle side-effects:
+  #
+  # * Methods that take no args, but are not 'attributes' will get called by `to_h`.  This shouldn't be a
+  #   problem, because you should not generally be doing this on a struct-like class.
+  # * Methods that take no args, but call `to_h` will stack overflow.  This is because the class'
+  #   internals have no way to know about this.  This is particularly a problem if you want to
+  #   define your own `to_json` method that serializes the result of `to_h`.
+  #
   def self.new(*attributes,&block)
     klass = Class.new do
       attributes.each do |attribute|
@@ -82,13 +97,24 @@ class ImmutableStruct
       end
 
       alias_method :eql?, :==
+
+      define_method(:hash) do
+        attribute_values = attributes.map { |attr| self.send(attr) }
+        (attribute_values + [self.class]).hash
+      end
     end
     klass.class_exec(&block) unless block.nil?
-    imethods = klass.instance_methods(include_super=false)
+
+    imethods = klass.instance_methods(include_super=false).map { |method_name|
+      klass.instance_method(method_name)
+    }.reject { |method|
+      method.arity != 0
+    }.map(&:name).map(&:to_sym)
+
     klass.class_exec(imethods) do |imethods|
       define_method(:to_h) do
         imethods.inject({}) do |hash, method|
-          next hash if [:==, :eql?, :merge].include?(method)
+          next hash if [:==, :eql?, :merge, :hash].include?(method)
           hash.merge(method.to_sym => self.send(method))
         end
       end

data/spec/immutable_struct_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper.rb'
+require 'json'
 
 module TestModule
   def hello; "hello"; end
@@ -112,14 +113,61 @@ describe ImmutableStruct do
   end
 
   describe "to_h" do
-    it "should include the output of params and block methods in the hash" do
-      klass = ImmutableStruct.new(:flappy) do
-        def lawsuit
-          'pending'
+    context "vanilla struct with just derived values" do
+      it "should include the output of params and block methods in the hash" do
+        klass = ImmutableStruct.new(:name, :minor?, :location, [:aliases]) do
+          def nick_name
+            'bob'
+          end
         end
+        instance = klass.new(name: "Rudy", minor: "ayup", aliases: [ "Rudyard", "Roozoola" ])
+        instance.to_h.should == {
+          name: "Rudy",
+          minor: "ayup",
+          minor?: true,
+          location: nil,
+          aliases: [ "Rudyard", "Roozoola"],
+          nick_name: "bob",
+        }
+      end
+    end
+    context "additional method that takes arguments" do
+      it "should not call the additional method" do
+        klass = ImmutableStruct.new(:name, :minor?, :location, [:aliases]) do
+          def nick_name
+            'bob'
+          end
+          def location_near?(other_location)
+            false
+          end
+        end
+        instance = klass.new(name: "Rudy", minor: "ayup", aliases: [ "Rudyard", "Roozoola" ])
+        instance.to_h.should == {
+          name: "Rudy",
+          minor: "ayup",
+          minor?: true,
+          location: nil,
+          aliases: [ "Rudyard", "Roozoola"],
+          nick_name: "bob",
+        }
+      end
+    end
+
+    context "no-arg method that uses to_h" do
+      it "blows up" do
+        klass = ImmutableStruct.new(:name, :minor?, :location, [:aliases]) do
+          def nick_name
+            'bob'
+          end
+          def to_json
+            to_h.to_json
+          end
+        end
+        instance = klass.new(name: "Rudy", minor: "ayup", aliases: [ "Rudyard", "Roozoola" ])
+        expect {
+          instance.to_json.should == instance.to_h.to_json
+        }.to raise_error(SystemStackError)
       end
-      instance = klass.new(flappy: 'bird')
-      instance.to_h.should == {flappy: 'bird', lawsuit: 'pending'}
     end
   end
 
@@ -192,5 +240,45 @@ describe ImmutableStruct do
 
     end
 
+    describe "hash" do
+
+      it "should have same hash value as itself" do
+        @k1_a.hash.eql?(@k1_a.hash).should be true
+      end
+
+      it "should have same hash value as same class with identical attribute values" do
+        @k1_a.hash.eql?(@k1_c.hash).should be true
+      end
+
+      it 'should not have hash value as same class with different attribute values' do
+        @k1_a.hash.eql?(@k1_b.hash).should be false
+      end
+
+      it 'should not have hash value equal to different class with identical attribute values' do
+        @k1_a.hash.eql?(@k3_a.hash).should be false
+      end
+
+      it 'should reject set addition if same instance is already a member' do
+        set = Set.new([@k1_a])
+        set.add?(@k1_a).should be nil
+      end
+
+      it 'should reject set addition if different instance, but attributes are the same' do
+        set = Set.new([@k1_a])
+        set.add?(@k1_c).should be nil
+      end
+
+      it 'should allow set addition if different instance and attribute values' do
+        set = Set.new([@k1_a])
+        set.add?(@k1_b).should_not be nil
+      end
+
+      it 'should allow set addition if different class' do
+        set = Set.new([@k1_a])
+        set.add?(@k2_a).should_not be nil
+      end
+
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immutable-struct
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-27 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+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)