surus 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 0.3.0 (February 16, 2012)
+
+* Can now round-trip any value YAML can dump and load as an hstore key or value
+
+# 0.2.0 (February 4, 2012)
+
+* Added symbol to types that are successfully round-tripped as hstore keys and values
+* Added synchronous_commit support
+* Added benchmarks
+* Added rdoc documentation and expanded readme.
+
 # 0.1.0 (February 2, 2012)
 
 * Added array serializers

data/README.md

@@ -25,11 +25,18 @@ type that can be indexed for fast searching.
     end
     
     User.create :properties => { :favorite_color => "green", :results_per_page => 20 }
+    User.create :properties => { :favorite_colors => ["green", "blue", "red"] }
     
 Even though the underlying hstore can only use strings for keys and values
 (and NULL for values) Surus can successfully maintain type for integers,
-floats, bigdecimals, and dates. It does this by storing an extra key
-value pair (or two) to maintain type information.
+floats, bigdecimals, dates, and any value that YAML can serialize. It does
+this by storing an extra key value pair (or two) to maintain type information.
+
+Because it falls back to YAML serialization for complex types, this means that
+nested data structures can be serialized to an hstore. In other words, any
+hash that can be serialized with the normal Rails YAML serialization can be
+serialized with Surus. But you can get the benefits of PostgreSQL indexing
+on the top level keys and values for free.
 
 Hstores can be searched with helper scopes.
 

data/lib/surus/hstore/serializer.rb

@@ -125,7 +125,7 @@ module Surus
         elsif value == nil
           [nil, "String"] # we don't actually stringify nil because format_value special cases nil
         else
-          [value.to_s, "String"] # coerce to string as we don't know how to reconstitue an unknown class
+          [YAML.dump(value), "YAML"]
         end  
       end
       
@@ -145,6 +145,8 @@ module Surus
           true
         when "FalseClass"
           false
+        when "YAML"
+          YAML.load(value)
         else
           raise ArgumentError, "Can't typecast: #{type}"
         end

data/lib/surus/version.rb

@@ -1,3 +1,3 @@
 module Surus
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/hstore/serializer_spec.rb

@@ -47,7 +47,9 @@ describe Surus::Hstore::Serializer do
     [BigDecimal("-1"), "negative BigDecimal"],
     [true, "true"],
     [false, "false"],
-    [Date.today, "date"]
+    [Date.today, "date"],
+    [{"foo" => [1,2,3], "bar" => {"baz" => 42}}, "nested hash"],
+    [[1,2,3], "array"]
   ].each do |value, description|
     round_trip_examples << [{"foo" => value}, "value is #{description}"]
     round_trip_examples << [{value => "bar"}, "key is #{description}"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: surus
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-05 00:00:00.000000000 Z
+date: 2012-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &13148960 !ruby/object:Gem::Requirement
+  requirement: &11662280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13148960
+  version_requirements: *11662280
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &13161940 !ruby/object:Gem::Requirement
+  requirement: &11661280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *13161940
+  version_requirements: *11661280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &13159120 !ruby/object:Gem::Requirement
+  requirement: &11660340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *13159120
+  version_requirements: *11660340
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &13155700 !ruby/object:Gem::Requirement
+  requirement: &11659560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *13155700
+  version_requirements: *11659560
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &13173200 !ruby/object:Gem::Requirement
+  requirement: &11624780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *13173200
+  version_requirements: *11624780
 description: Includes serializers and search scopes for hstore and array. Also includes
   control over synchronous_commit to boost insert and update speed.
 email: