hamsterdam 1.0.1 → 1.0.2

data/CHANGELOG

@@ -1,3 +1,7 @@
+Hamsterdam v1.0.2
+  * Field name defs, constructor keys and merge keys are now stringified internally to prevent string/symbol mismatching
+  * Added syntax helper for this kind of thing: class Castle < Hamsterdam::Struct(:gate, :walls)
+
 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)

data/TODO.txt

@@ -0,0 +1,4 @@
+- Add commas in to_s
+- .set_defaults({}) to provide default values for constructors
+- Want to use fun "Status < Hamsterdam::Struct(:one, :two)" but something is wrong with inheritance of field_names that blows up the flesh_out func.
+- FIXED: Symbol/string insensitivity (use symbols internally and when listing field names, but accept :foo and 'foo' when constructing and merging

data/lib/hamsterdam.rb

@@ -1,11 +1,16 @@
 require 'hamster'
 
 module Hamsterdam
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
+
+  def self.Struct(*field_names)
+    Hamsterdam::Struct.define(*field_names)
+  end
 
   class Struct
     def self.define(*field_names)
       struct_class = Class.new(Hamsterdam::Struct) do
+        field_names = field_names.map &:to_sym
         field_names.each do |fname|
           define_method fname do 
             return @data[fname]
@@ -22,10 +27,18 @@ module Hamsterdam
       struct_class.instance_variable_set(:@field_names_list, Hamster.list(*field_names))
       class << struct_class 
         def field_names
-          @field_names
+          if !@field_names.nil?
+            @field_names
+          else
+            superclass.field_names
+          end
         end
         def field_names_list
-          @field_names_list
+          if !@field_names_list.nil?
+            @field_names_list
+          else
+            superclass.field_names_list
+          end
         end
       end
       struct_class
@@ -88,7 +101,9 @@ module Hamsterdam
     end
 
     def flesh_out(data)
+      # binding.pry
       fnames = self.class.field_names
+      data = symbolize_keys(data)
       miss = fnames - data.keys
       if miss.any?
         return miss.inject(data) { |h,name| h.put(name,nil) }
@@ -97,5 +112,14 @@ module Hamsterdam
       end
     end
 
+    def symbolize_keys(data)
+      data.reduce(data) do |memo,k,v|
+        if Symbol === k
+          memo
+        else
+          memo.delete(k).put(k.to_sym, v)
+        end
+      end
+    end
   end
 end

data/spec/hamsterdam_spec.rb

@@ -47,6 +47,22 @@ 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
+
+    describe "inheritance-based definition" do
+      class Castle < Hamsterdam::Struct(:gate, :mote, :walls)
+        def tally
+          gate + mote + walls
+        end
+      end
+
+      it "provides convenient syntax for deriving classes from immutable struct def" do
+        c = Castle.new gate: 2, mote: 1, walls: 4
+        c.gate.should == 2
+        c.mote.should == 1
+        c.walls.should == 4
+        c.tally.should == 7
+      end
+    end
   end
 
   describe "equality" do
@@ -157,10 +173,39 @@ describe "Hamsterdam structures" do
     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 = Hamstest::Thinger.new a_hash: Hamster.hash(red: "fish"), a_set: Hamster.set(42), a_list: Hamster.list(:oh, :the, :things)
+      expected = "<Thinger a_hash: {:red => \"fish\"} a_set: {42} a_list: [:oh, :the, :things]>"
       thinger.inspect.should == expected
       thinger.to_s.should == expected
     end
   end
+
+  describe "symbol/string insensitivity" do
+    let(:mixed_up) { Hamsterdam::Struct.define(:foo, 'bar') }
+
+    it "lets you define the field names using a mix of string and symbols" do
+      val = mixed_up.new(foo: 1, bar: 2)
+      val.foo.should == 1
+      val.bar.should == 2
+      val = val.set_foo(3)
+      val.foo.should == 3
+    end
+
+    it "lets you construct new values using a mix of strings and symbols" do
+      val = mixed_up.new("foo" => 1, :bar => 2)
+      val.foo.should == 1
+      val.bar.should == 2
+    end
+
+    it "lets you merge values using a mix of strings and symbols" do
+      val = mixed_up.new("foo" => 1, :bar => 2)
+      val.foo.should == 1
+      val.bar.should == 2
+      val = val.merge(:foo => 3, "bar" => 4)
+      val.foo.should == 3
+      val.bar.should == 4
+
+      val.to_hamster_hash.should == Hamster.hash(foo: 3, bar: 4)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hamsterdam
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -102,6 +102,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- TODO.txt
 - hamsterdam.gemspec
 - lib/hamsterdam.rb
 - rake_tasks/rspec.rake