qoobaa-to_hash 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,12 +1,63 @@
 = to_hash
 
-Easy and powerful object to hash serialization tool. It may be used together with to_json/to_xml/to_yaml standard methods.
+Easy and powerful object to hash serialization tool. It may be used together with to_json/to_xml/to_yaml methods.
 
 == Usage
 
-  hash = employee.to_hash(:firstName => :first_name, :lastName => :last_name, :projects => [:projects, :title])
-  # => { :firstName => "John", :lastName => "Doe", :projects => [{ :title => "Project 1" }, { :title => "Project 2" }] }
-  { :employee => hash }.to_json
+Take a look at the example below:
+
+  class Category < ActiveRecord::Base
+    def name
+      #...
+    end
+  end
+
+  class Comment < ActiveRecord::Base
+    def author_name
+      #...
+    end
+  end
+
+  class Post < ActiveRecord::Base
+    has_one :category
+    has_many :comments
+
+    include ToHash
+
+    def title
+      #...
+    end
+
+    def body
+      #...
+    end
+  end
+
+  # simple serialization
+  Post.first.to_hash(:title, :body)
+  #=> { :title => "Post Title", :body => "Post body" }
+
+  # serialization with key changing
+  Post.first.to_hash(:title => :title, :content => :body)
+  #=> { :title => "Post Title", :content => "Post body" }
+
+  # simple serialization of nested objects
+  Post.first.to_hash(:title, [:category, :name])
+  #=> { :title => "Post Title", :category => { :name => "Category Name" } }
+
+  # serialization of nested objects with key changing
+  Post.first.to_hash(:title, [:category, { :categoryName => :name }])
+  #=> { :title => "Post Title", :category => { :categoryName => "Category Name" } }
+
+  # serialization of nested arrays
+  Post.first.to_hash(:title, [:comments, { :author => :author_name }])
+  #=> { :title => "Post Title", :comments => [{ :author => "John Doe" }, { :author => "Jim Smith" }] }
+
+  # creating JSON
+  Post.first.to_hash(:t => :title, :b => :body).to_json
+  #=> "{\"t\": \"Post Title\", \"b\": \"Post body\"}"
+
+* ToHash module doesn't require the class to inherit from ActiveRecord::Base - it can be used with any other classes as well.
 
 = License
 

data/test/to_hash_test.rb

@@ -45,7 +45,37 @@ class ToHashTest < Test::Unit::TestCase
       assert_equal hash, { :myTitle => "Project 1", :myDesc => "Project 1 description" }
     end
 
-    # TODO: more test (no time right now)
+    should "allow to include other objects in hash" do
+      hash = @project1.to_hash([:authors, :first_name])
+      assert_equal hash, { :authors => [{ :first_name => "John" }, { :first_name => "Michael" }, { :first_name => "Jimmy" }] }
+    end
+
+    should "allow to include other objects with multiple attributes in hash" do
+      hash = @project1.to_hash([:authors, :first_name, :last_name])
+      assert_equal hash, { :authors => [{ :first_name => "John", :last_name => "Doe" },
+                                        { :first_name => "Michael", :last_name => "Smith" },
+                                        { :first_name => "Jimmy", :last_name => "Parker" }] }
+    end
+
+    should "allow to include other objects with changed key" do
+      hash = @project1.to_hash(:people => [:authors, :first_name])
+      assert_equal hash, { :people => [{ :first_name => "John" }, { :first_name => "Michael" }, { :first_name => "Jimmy" }] }
+    end
+
+    should "allow to include other objects with inner keys changed" do
+      hash = @project1.to_hash(:people => [:authors, { :firstName => :first_name }])
+      assert_equal hash, { :people => [{ :firstName => "John" }, { :firstName => "Michael" }, { :firstName => "Jimmy" }] }
+    end
+
+    should "allow using different serialization methods described above" do
+      hash = @project1.to_hash(:title, [:authors, { :firstName => :first_name }])
+      assert_equal hash, { :title => "Project 1", :authors => [{ :firstName => "John" }, { :firstName => "Michael" }, { :firstName => "Jimmy" }]}
+    end
+
+    should "serialize singular nested object" do
+      hash = @project1.to_hash(:title, [:company, :name])
+      assert_equal hash, { :title => "Project 1", :company => { :name => "HAL" } }
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: qoobaa-to_hash
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - "Jakub Ku\xC5\xBAma"