hamsterdam 1.0.5 → 1.0.6

data/CHANGELOG

@@ -1,3 +1,6 @@
+Hamsterdam v1.0.5
+  * Added hamsterdam/clj to allow for optionally using the Clojure PersistentHashMap isntead of a Hamster hash as the backing data structure
+
 Hamsterdam v1.0.5
   * Setters return the same instance of the object if the value being set is unchanged
   * Optimized creation of a new struct caused by a setter modification by skipping validation

data/lib/hamsterdam.rb

@@ -2,10 +2,67 @@ require 'hamster'
 
 module Hamsterdam
 
+  module Hamster
+
+    def self.hash(*hash)
+      ::Hamster.hash(*hash)
+    end
+
+    def self.set(*values)
+      ::Hamster.set(*values)
+    end
+
+    def self.list(*values)
+      ::Hamster.list(*values)
+    end
+
+    def self.internal_hash_class
+      ::Hamster::Hash
+    end
+
+    def self.symbolize_keys(hash)
+      hash.reduce(hash) do |memo,k,v|
+        if Symbol === k
+          memo
+        else
+          memo.delete(k).put(k.to_sym, v)
+        end
+      end
+    end
+  end
+
   def self.Struct(*field_names)
     Hamsterdam::Struct.define(*field_names)
   end
 
+  def self.internals=(mod)
+    @internal_representation_module = mod
+  end
+
+  def self.internals
+    @internal_representation_module
+  end
+
+  def self.hash(*hash)
+    internals.hash(*hash)
+  end
+
+  def self.set(*values)
+    internals.set(*values)
+  end
+
+  def self.list(*values)
+    internals.list(*values)
+  end
+
+  def self.internal_hash_class
+    internals.internal_hash_class
+  end
+
+  def self.symbolize_keys(hash)
+    internals.symbolize_keys(hash)
+  end
+
   class Struct
     def self.define(*field_names)
       struct_class = Class.new(Hamsterdam::Struct) do
@@ -23,11 +80,10 @@ module Hamsterdam
             end
           end
         end
-
       end
 
-      struct_class.instance_variable_set(:@field_names, Hamster.set(*field_names))
-      struct_class.instance_variable_set(:@field_names_list, Hamster.list(*field_names))
+      struct_class.instance_variable_set(:@field_names, Hamsterdam.set(*field_names))
+      struct_class.instance_variable_set(:@field_names_list, Hamsterdam.list(*field_names))
       class << struct_class 
         def field_names
           if !@field_names.nil?
@@ -47,9 +103,9 @@ module Hamsterdam
       struct_class
     end
 
-    def initialize(values=Hamster.hash, validate=true)
+    def initialize(values=Hamsterdam.hash, validate=true)
       if validate
-        @data = flesh_out(ensure_hamster_hash(values))
+        @data = flesh_out(ensure_expected_hash(values))
         validate_keys(@data)
       else
         @data = values
@@ -57,11 +113,11 @@ module Hamsterdam
     end
 
     def merge(values)
-      self.class.new(@data.merge(ensure_hamster_hash(values)))
+      self.class.new(@data.merge(ensure_expected_hash(values)))
     end
 
     def ==(other)
-      @data == other.to_hamster_hash
+      internal_hash == other.internal_hash
     end
 
     def eql?(other)
@@ -72,9 +128,10 @@ module Hamsterdam
       @data.hash
     end
 
-    def to_hamster_hash
+    def internal_hash
       @data
     end
+    alias_method :to_hamster_hash, :internal_hash
 
     def inspect
       to_s
@@ -82,7 +139,7 @@ module Hamsterdam
 
     def to_s
       name = self.class.name ? self.class.name.split(/::/).last : self.class.to_s
-      data = to_hamster_hash
+      data = internal_hash
       fields = self.class.field_names_list.map { |fname| "#{fname}: #{data[fname].inspect}" }
       "<#{([name]+fields).join(" ")}>"
     end
@@ -90,20 +147,20 @@ module Hamsterdam
     private
     def validate_keys(data)
       valid_keys = self.class.field_names
-      bad_keys = data.keys - valid_keys
+      bad_keys = data.keys - valid_keys.to_a
       if bad_keys.any?
         raise "#{self.class.name || "Anonymous Hamsterdam::Struct"} can't be constructed with #{bad_keys.inspect}. Valid keys: #{valid_keys.inspect}"
       end
     end
 
-    def ensure_hamster_hash(h)
+    def ensure_expected_hash(h)
       case h
       when Hash
-        Hamster.hash(h)
-      when Hamster::Hash
+        Hamsterdam.hash(h)
+      when Hamsterdam.internal_hash_class
         h
       else
-        raise "Expected Hash or Hamster::Hash. Do not want: #{h.inspect}"
+        raise "Expected Hash or #{Hamsterdam.internal_hash_class}. Do not want: #{h.inspect}"
       end
     end
 
@@ -120,13 +177,8 @@ module Hamsterdam
     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
+      Hamsterdam.symbolize_keys(data)
     end
   end
 end
+Hamsterdam.internals = Hamsterdam::Hamster

data/lib/hamsterdam/clj.rb

@@ -0,0 +1,77 @@
+
+class Java::ClojureLang::PersistentHashMap
+  alias_method :put, :assoc
+  alias_method :delete, :without
+  alias_method :==, :equals
+end
+
+# java_import 'clojure.lang.PersistentList$EmptyList'
+# class EmptyList
+#   def inspect
+#     to_a.inspect
+#   end
+# end
+#
+# class Java::ClojureLang::PersistentList
+#   def inspect
+#     to_a.inspect
+#   end
+# end
+#
+# class Java::ClojureLang::PersistentHashSet
+#   def inspect
+#     to_set.inspect
+#   end
+#
+#   def -(other)
+#     reject { |e| other.include?(e) }
+#   end
+#
+#   alias_method :add, :cons
+# end
+
+module Hamsterdam
+  module Clojure
+    def self.hash(h = nil)
+      if h.nil?
+        Java::ClojureLang::PersistentHashMap::EMPTY
+      else
+        Java::ClojureLang::PersistentHashMap.create(h)
+      end
+    end
+
+    def self.internal_hash_class
+      Java::ClojureLang::PersistentHashMap
+    end
+
+    # def self.set(*values)
+    #   Java::ClojureLang::PersistentHashSet.create(values)
+    # end
+
+    # def self.list(*values)
+    #   values.reverse.inject(Java::ClojureLang::PersistentList::EMPTY) do |list, value|
+    #     list.cons(value)
+    #   end
+    # end
+
+    def self.set(*values)
+      ::Hamster.set(*values)
+    end
+
+    def self.list(*values)
+      ::Hamster.list(*values)
+    end
+
+    def self.symbolize_keys(hash)
+      hash.reduce(hash) do |memo,(k,v)|
+        if Symbol === k
+          memo
+        else
+          memo.delete(k).put(k.to_sym, v)
+        end
+      end
+    end
+  end
+end
+
+Hamsterdam.internals = Hamsterdam::Clojure

data/lib/hamsterdam/version.rb

@@ -1,3 +1,3 @@
 module Hamsterdam
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/spec/hamsterdam_spec.rb

@@ -7,6 +7,53 @@ describe "Hamsterdam structures" do
 
   let(:struct_class) { define_hamsterdam_struct(:top, :bottom) }
 
+  describe "immutable data structure helpers" do
+    describe "#hash" do
+      it "provides an empty hash" do
+        h = Hamsterdam.hash
+        h.should be_empty
+        h.class.should == Hamsterdam.internal_hash_class
+        h.should == Hamsterdam.hash
+      end
+
+      it "provides a hash populated with passed in key/values" do
+        h = Hamsterdam.hash(a: "1", b: "2")
+        h[:a].should == "1"
+        h[:b].should == "2"
+        h.class.should == Hamsterdam.internal_hash_class
+      end
+    end
+
+    describe "#set" do
+      it "provides an empty set" do
+        s = Hamsterdam.set
+        s.should be_empty
+      end
+
+      it "provides a set populated with passed values" do
+        s = Hamsterdam.set("a", "b", "c", "a")
+        s.should_not be_empty
+        s.should have(3).entries
+        s.should include("a", "b", "c")
+      end
+    end
+
+    describe "#list" do
+      it "provides an empty list" do
+        l = Hamsterdam.list
+        l.should be_empty
+      end
+
+      it "provides a list populated with passed values" do
+        l = Hamsterdam.list("a", "b", "c", "a")
+        l.should_not be_empty
+        l.should have(4).items
+        l.should include("a", "b", "c")
+        l.to_a.should == ["a", "b", "c", "a"]
+      end
+    end
+  end
+
   describe "Struct.define" do
 
     it "creates a structure class based on the given fields" do
@@ -16,8 +63,8 @@ describe "Hamsterdam structures" do
       struct.bottom.should == "all the way down"
     end
 
-    it "can be built with Hamster hashes" do
-      struct = struct_class.new(Hamster.hash(top: 10, bottom: "low"))
+    it "can be built with underlying persistent data structure hashes hashes" do
+      struct = struct_class.new(Hamsterdam.hash(top: 10, bottom: "low"))
       struct.should be
       struct.top.should == 10
       struct.bottom.should == "low"
@@ -39,9 +86,9 @@ describe "Hamsterdam structures" do
       struct.bottom.should be_nil
     end
 
-    it "provides access to the internal data as a Hamster.hash" do
+    it "provides access to the internal data as the correct hash type" do
       s1 = struct_class.new(top: 50, bottom: 75)
-      s1.to_hamster_hash.should == Hamster.hash(top: 50, bottom: 75)
+      s1.internal_hash.should == Hamsterdam.hash(top: 50, bottom: 75)
     end
 
     it "raises helpful error when constructed with invalid objects" do
@@ -98,16 +145,16 @@ describe "Hamsterdam structures" do
     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
+      # binding.pry
       (s1 == s2).should == true
+      s1.eql?(s2).should == true
       s1.should == s2
     end
   end
 
-  it "uses the same #hash as Hamster::Hash" do
+  it "uses the same #hash as the underlying data structure" do
     s1 = struct_class.new(top: 50, bottom: 75)
-    s1.hash.should == Hamster.hash(top:50, bottom:75).hash
+    s1.hash.should == Hamsterdam.hash(top:50, bottom:75).hash
   end
 
   describe "transformation" do
@@ -141,10 +188,10 @@ describe "Hamsterdam structures" do
       struct3.bottom.should == "very"
     end
 
-    it "can merge-in Hamster::Hash" do
+    it "can merge-in a non-ruby hash" do
       struct = struct_class.new(top: 10, bottom: 1)
 
-      struct2 = struct.merge(Hamster.hash(bottom: "newer", top: "newest"))
+      struct2 = struct.merge(Hamsterdam.hash(bottom: "newer", top: "newest"))
       struct2.top.should == "newest"
       struct2.bottom.should == "newer"
 
@@ -211,7 +258,7 @@ describe "Hamsterdam structures" do
       val.foo.should == 3
       val.bar.should == 4
 
-      val.to_hamster_hash.should == Hamster.hash(foo: 3, bar: 4)
+      val.internal_hash.should == Hamsterdam.hash(foo: 3, bar: 4)
     end
   end
 end

data/spec/spec_helper.rb

@@ -11,9 +11,14 @@ end
 
 #ENV["APP_ENV"] = "rspec"
 
+require 'pry'
 require 'hamsterdam'
 
-require 'pry'
+if ENV['clj'] == 'true'
+  require "#{PROJECT_ROOT}/spec/jars/clojure-1.5.1.jar"
+  require 'hamsterdam/clj'
+end
+
 
 # Load all support files
 Dir["#{PROJECT_ROOT}/spec/support/*.rb"].each do |support|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hamsterdam
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-02 00:00:00.000000000 Z
+date: 2013-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hamster
@@ -100,6 +100,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - CHANGELOG
+- lib/hamsterdam/clj.rb
 - lib/hamsterdam/version.rb
 - lib/hamsterdam.rb
 - spec/hamsterdam_spec.rb
@@ -117,12 +118,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4489320240594326591
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4489320240594326591
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24