active_nomad 0.1.0 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.2.0 2010-10-05
+
+ * No longer overriding ActiveRecord::Base#to_json.
+
 == 0.1.0 2010-10-05
 
  * Provide multiple serialization formats (query string, json).

data/README.markdown

@@ -26,7 +26,7 @@ persist to a cookie:
 
     thing = Thing.from_json(cookies[:thing])
     thing.to_save do |thing|
-      cookies[:thing] = thing.to_json
+      cookies[:thing] = thing.to_ordered_json
       true
     end
 
@@ -34,9 +34,9 @@ Things to note:
 
  * The proc should return true if persistence was successful, false
    otherwise. This will be the return value of `save`, etc.
- * Active Nomad defines `to_json` and `from_json` which will serialize to and
-   from a JSON string with predictable attribute order (i.e., appropriate for a
-   cookie).
+ * Active Nomad defines `to_ordered_json` and `from_json` which will serialize
+   to and from a JSON string with predictable attribute order (i.e., appropriate
+   for a cookie).
  * You may alternatively override `persist` in a subclass if you don't want to
    register a proc for every instance.
 
@@ -44,8 +44,8 @@ Things to note:
 
 Active Nomad provides serialization to and from:
 
- * JSON (`to_json` and `from_json`)
- * Query string (`to_query_string` and `from_query_string`)
+ * JSON (`to_ordered_json` and `from_json`)
+ * Query string (`to_ordered_query_string` and `from_query_string`)
 
 You can define your own formats easily using `to_serialized_attributes` and
 `from_serialized_attributes`. The former returns an `ActiveSupport::OrderedHash`

data/lib/active_nomad/version.rb

@@ -1,5 +1,5 @@
 module ActiveNomad
-  VERSION = [0, 1, 0]
+  VERSION = [0, 2, 0]
 
   class << VERSION
     include Comparable

data/lib/active_nomad.rb

@@ -45,7 +45,9 @@ module ActiveNomad
     #
     # Serialize this record as a query string.
     #
-    def to_query_string
+    # Attributes are sorted by name.
+    #
+    def to_ordered_query_string
       to_serialized_attributes.map do |name, value|
         next nil if value.nil?
         "#{CGI.escape(name)}=#{CGI.escape(value)}"
@@ -54,7 +56,7 @@ module ActiveNomad
 
     #
     # Deserialize this record from a query string returned by
-    # #to_query_string.
+    # #to_ordered_query_string.
     #
     def self.from_query_string(string)
       return new if string.blank?
@@ -68,12 +70,15 @@ module ActiveNomad
     #
     # Serialize this record as a JSON string.
     #
-    def to_json
+    # Attributes are sorted by name.
+    #
+    def to_ordered_json
       to_serialized_attributes.to_json
     end
 
     #
-    # Deserialize this record from a JSON string returned by #to_json.
+    # Deserialize this record from a JSON string returned by
+    # #to_ordered_json.
     #
     def self.from_json(string)
       return new if string.blank?

data/spec/unit/active_nomad_spec.rb

@@ -238,14 +238,14 @@ describe ActiveNomad::Base do
     end
   end
 
-  describe "#to_query_string" do
+  describe "#to_ordered_query_string" do
     it "should serialize the attributes as a query string" do
       klass = Class.new(ActiveNomad::Base) do
         attribute :first_name, :string
         attribute :last_name, :string
       end
       instance = klass.new(:first_name => 'Joe', :last_name => 'Blow')
-      instance.to_query_string.should == 'first_name=Joe&last_name=Blow'
+      instance.to_ordered_query_string.should == 'first_name=Joe&last_name=Blow'
     end
   end
 
@@ -348,14 +348,14 @@ describe ActiveNomad::Base do
 
   it_should_roundtrip_through(:to_serialized_attributes, :from_serialized_attributes)
 
-  it_should_roundtrip_through(:to_query_string, :from_query_string) do
+  it_should_roundtrip_through(:to_ordered_query_string, :from_query_string) do
     it "should not be tripped up by delimiters in the keys" do
       klass = Class.new(ActiveNomad::Base) do
         attribute :'a=x', :string
         attribute :'b&x', :string
       end
       original = klass.new("a=x" => "1", "b&x" => "2")
-      roundtripped = klass.from_query_string(original.to_query_string)
+      roundtripped = klass.from_query_string(original.to_ordered_query_string)
       roundtripped.send("a=x").should == "1"
       roundtripped.send("b&x").should == "2"
     end
@@ -366,19 +366,19 @@ describe ActiveNomad::Base do
         attribute :b, :string
       end
       original = klass.new(:a => "1=2", :b => "3&4")
-      roundtripped = klass.from_query_string(original.to_query_string)
+      roundtripped = klass.from_query_string(original.to_ordered_query_string)
       roundtripped.a.should == "1=2"
       roundtripped.b.should == "3&4"
     end
   end
 
-  it_should_roundtrip_through(:to_json, :from_json) do
+  it_should_roundtrip_through(:to_ordered_json, :from_json) do
     it "should not be tripped up by delimiters in the keys" do
       klass = Class.new(ActiveNomad::Base) do
         attribute :"'a':b,c", :string
       end
       original = klass.new("'a':b,c" => "1")
-      roundtripped = klass.from_json(original.to_json)
+      roundtripped = klass.from_json(original.to_ordered_json)
       roundtripped.send("'a':b,c").should == "1"
     end
 
@@ -387,7 +387,7 @@ describe ActiveNomad::Base do
         attribute :a, :string
       end
       original = klass.new(:a => "'a':b,c")
-      roundtripped = klass.from_json(original.to_json)
+      roundtripped = klass.from_json(original.to_ordered_json)
       roundtripped.a.should == "'a':b,c"
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: active_nomad
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - George Ogata