hamsterdam 1.0.0 → 1.0.1

data/CHANGELOG

@@ -1,3 +1,7 @@
+Hamsterdam v1.0.1
+  * Added nice to_s and inspect
+	* Also storing .field_names_list as another way of getting field names of a struct, but retaining order of declaration (.field_names is a Hamster.set, .field_names_list is a Hamster.list)
+
 Hamsterdam v1.0.0
   * Can define immutable record types via Hamsterdam::Struct.define(*field_names)
 	* Provides getters for all fields, and set_* transformers that return the updated version of the record.

data/lib/hamsterdam.rb

@@ -1,7 +1,7 @@
 require 'hamster'
 
 module Hamsterdam
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 
   class Struct
     def self.define(*field_names)
@@ -19,10 +19,14 @@ module Hamsterdam
       end
 
       struct_class.instance_variable_set(:@field_names, Hamster.set(*field_names))
+      struct_class.instance_variable_set(:@field_names_list, Hamster.list(*field_names))
       class << struct_class 
         def field_names
           @field_names
         end
+        def field_names_list
+          @field_names_list
+        end
       end
       struct_class
     end
@@ -52,6 +56,17 @@ module Hamsterdam
       @data
     end
 
+    def inspect
+      to_s
+    end
+
+    def to_s
+      name = self.class.name.split(/::/).last
+      data = to_hamster_hash
+      fields = self.class.field_names_list.map { |fname| "#{fname}: #{data[fname].inspect}" }
+      "<#{([name]+fields).join(" ")}>"
+    end
+
     private
     def validate_keys(data)
       valid_keys = self.class.field_names

data/spec/hamsterdam_spec.rb

@@ -4,8 +4,10 @@ describe "Hamsterdam structures" do
   def define_hamsterdam_struct(*field_names)
     Hamsterdam::Struct.define(*field_names)
   end
+
+  let(:struct_class) { define_hamsterdam_struct(:top, :bottom) }
+
   describe "Struct.define" do
-    let(:struct_class) { define_hamsterdam_struct(:top, :bottom) }
 
     it "creates a structure class based on the given fields" do
       struct = struct_class.new(top: 200, bottom: "all the way down")
@@ -45,89 +47,120 @@ describe "Hamsterdam structures" do
     it "raises helpful error when constructed with invalid objects" do
       lambda do struct_class.new("LAWDY") end.should raise_error /Do not want.*LAWDY/
     end
+  end
+
+  describe "equality" do
+    it "considers two structs equal if they have the same field values" do
+      s1 = struct_class.new(top: 50, bottom: 75)
+      s2 = struct_class.new(top: 50, bottom: 75)
+      s1.eql?(s2).should == true
+      (s1 == s2).should == true
+      s1.should == s2
+    end
 
-    describe "equality" do
-      it "considers two structs equal if they have the same field values" do
-        s1 = struct_class.new(top: 50, bottom: 75)
-        s2 = struct_class.new(top: 50, bottom: 75)
-        s1.eql?(s2).should == true
-        (s1 == s2).should == true
-        s1.should == s2
-      end
-
-      it "considers two structs NOT equal if they have the different field values" do
-        s1 = struct_class.new(top: 50, bottom: 75)
-        s2 = struct_class.new(top: 50, bottom: 74)
-        s3 = struct_class.new(top: 51, bottom: 75)
-
-        s1.eql?(s2).should_not == true
-        (s1 == s2).should_not == true
-        s1.should_not == s2
-
-        s1.eql?(s3).should_not == true
-        (s1 == s3).should_not == true
-        s1.should_not == s3
-      end
-
-      it "doesn't consider to structs eql? unless they are same class" do
-        s1 = struct_class.new(top: 50, bottom: 75)
-        s2 = define_hamsterdam_struct(:top, :bottom).new(top:50, bottom:75)
-        s1.eql?(s2).should == false
-        (s1 == s2).should == true # should still be ==
-      end
-
-      it "considers equal two structs if one has missing keys, and the other has nil values for those keys" do
-        s1 = struct_class.new(top: 50, bottom: nil)
-        s2 = struct_class.new(top: 50)
-        #binding.pry
-        s1.eql?(s2).should == true
-        (s1 == s2).should == true
-        s1.should == s2
-      end
-    end
-
-    it "uses the same #hash as Hamster::Hash" do
+    it "considers two structs NOT equal if they have the different field values" do
       s1 = struct_class.new(top: 50, bottom: 75)
-      s1.hash.should == Hamster.hash(top:50, bottom:75).hash
+      s2 = struct_class.new(top: 50, bottom: 74)
+      s3 = struct_class.new(top: 51, bottom: 75)
+
+      s1.eql?(s2).should_not == true
+      (s1 == s2).should_not == true
+      s1.should_not == s2
+
+      s1.eql?(s3).should_not == true
+      (s1 == s3).should_not == true
+      s1.should_not == s3
+    end
+
+    it "doesn't consider to structs eql? unless they are same class" do
+      s1 = struct_class.new(top: 50, bottom: 75)
+      s2 = define_hamsterdam_struct(:top, :bottom).new(top:50, bottom:75)
+      s1.eql?(s2).should == false
+      (s1 == s2).should == true # should still be ==
+    end
+
+    it "considers equal two structs if one has missing keys, and the other has nil values for those keys" do
+      s1 = struct_class.new(top: 50, bottom: nil)
+      s2 = struct_class.new(top: 50)
+      #binding.pry
+      s1.eql?(s2).should == true
+      (s1 == s2).should == true
+      s1.should == s2
+    end
+  end
+
+  it "uses the same #hash as Hamster::Hash" do
+    s1 = struct_class.new(top: 50, bottom: 75)
+    s1.hash.should == Hamster.hash(top:50, bottom:75).hash
+  end
+
+  describe "transformation" do
+    it "provides setters for individual fields that return an updated version of the struct" do
+      struct = struct_class.new(top: 10, bottom: 1)
+      struct2 = struct.set_top("woot")
+      struct2.top.should == "woot"
+      struct2.bottom.should == 1
+
+      struct.top.should == 10
+      struct.bottom.should == 1
     end
 
-    describe "transformation" do
-      it "provides setters for individual fields that return an updated version of the struct" do
-        struct = struct_class.new(top: 10, bottom: 1)
-        struct2 = struct.set_top("woot")
-        struct2.top.should == "woot"
-        struct2.bottom.should == 1
+    it "provides a merge function" do
+      struct = struct_class.new(top: 10, bottom: 1)
 
-        struct.top.should == 10
-        struct.bottom.should == 1
-      end
+      struct2 = struct.merge(bottom: "new")
+      struct2.top.should == 10
+      struct2.bottom.should == "new"
 
-      it "provides a merge function" do
-        struct = struct_class.new(top: 10, bottom: 1)
+      struct.top.should == 10
+      struct.bottom.should == 1
 
-        struct2 = struct.merge(bottom: "new")
-        struct2.top.should == 10
-        struct2.bottom.should == "new"
+      struct3 = struct2.merge(top: "newer", bottom: "very")
+      struct3.top.should == "newer"
+      struct3.bottom.should == "very"
+    end
 
-        struct.top.should == 10
-        struct.bottom.should == 1
+    it "can merge-in Hamster::Hash" do
+      struct = struct_class.new(top: 10, bottom: 1)
 
-        struct3 = struct2.merge(top: "newer", bottom: "very")
-        struct3.top.should == "newer"
-        struct3.bottom.should == "very"
-      end
+      struct2 = struct.merge(Hamster.hash(bottom: "newer", top: "newest"))
+      struct2.top.should == "newest"
+      struct2.bottom.should == "newer"
 
-      it "can merge-in Hamster::Hash" do
-        struct = struct_class.new(top: 10, bottom: 1)
+      struct.top.should == 10
+      struct.bottom.should == 1
+    end
+  end
+
+  describe "inspect and to_s" do
+    module Hamstest
+      Wheel = Hamsterdam::Struct.define(:x,:y,:radius,:label)
+      Vehicle = Hamsterdam::Struct.define(:wheels, :body_style)
+      Thinger = Hamsterdam::Struct.define(:a_hash, :a_set, :a_list)
+    end
 
-        struct2 = struct.merge(Hamster.hash(bottom: "newer", top: "newest"))
-        struct2.top.should == "newest"
-        struct2.bottom.should == "newer"
 
-        struct.top.should == 10
-        struct.bottom.should == 1
-      end
+    it "generates a nice clear string representation of the internal data" do
+      wheel = Hamstest::Wheel.new x: 50, y: 100, radius: 5.0, label: "front"
+      expected = "<Wheel x: 50 y: 100 radius: 5.0 label: \"front\">"
+      wheel.inspect.should == expected
+      wheel.to_s.should == expected
     end
 
+    it "does a nice job with other Hamsterdam structs" do
+      wheel1 = Hamstest::Wheel.new x: 50, y: 100, radius: 5.0, label: "front"
+      wheel2 = Hamstest::Wheel.new x: 100, y: 100, radius: 5.0, label: "back"
+      car = Hamstest::Vehicle.new wheels: Hamster.list(wheel1, wheel2), body_style: "sedan"
+      expected = "<Vehicle wheels: [<Wheel x: 50 y: 100 radius: 5.0 label: \"front\">, <Wheel x: 100 y: 100 radius: 5.0 label: \"back\">] body_style: \"sedan\">"
+      car.inspect.should == expected
+      car.to_s.should == expected
+    end
+
+    it "does a nice job with Hamster Lists, Sets, and Hashes" do
+      thinger = Hamstest::Thinger.new a_hash: Hamster.hash(red: "fish"), a_set: Hamster.set(42,37), a_list: Hamster.list(:oh, :the, :things)
+      expected = "<Thinger a_hash: {:red => \"fish\"} a_set: {42, 37} a_list: [:oh, :the, :things]>"
+      thinger.inspect.should == expected
+      thinger.to_s.should == expected
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hamsterdam
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors: