to_hash 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jakub
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,64 @@
+= to_hash
+
+Easy and powerful object to hash serialization tool. It may be used together with to_json/to_xml/to_yaml methods.
+
+== Usage
+
+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
+
+Copyright (c) 2009 Jakub Kuźma, released under the MIT license

data/Rakefile

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "to_hash"
+    gem.summary = %Q{TODO}
+    gem.email = "qoobaa@gmail.com"
+    gem.homepage = "http://github.com/qoobaa/to_hash"
+    gem.authors = ["Jakub Kuźma"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "to_hash #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/to_hash.rb

@@ -0,0 +1,37 @@
+module ToHash
+  def self.eval_object(object, attributes)
+    if object.kind_of?(Array)
+      object.map { |o| eval_attributes(o, attributes) }
+    else
+      eval_attributes(object, attributes)
+    end
+  end
+
+  def self.eval_attributes(object, attributes)
+    result = {}
+    attributes = attributes.first if attributes.first.kind_of?(Hash)
+    case attributes
+    when Array
+      attributes.each do |attribute|
+        if attribute.kind_of?(Array)
+          result[attribute.first] = eval_object(object.send(attribute.first), attribute[1..-1])
+        else
+          result[attribute] = object.send(attribute)
+        end
+      end
+    when Hash
+      attributes.each do |key, attribute|
+        if attribute.kind_of?(Array)
+          result[key] = eval_object(object.send(attribute.first), attribute[1..-1])
+        else
+          result[key] = object.send(attribute)
+        end
+      end
+    end
+    result
+  end
+
+  def to_hash(*attributes)
+    ToHash.eval_attributes(self, attributes)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'to_hash'
+
+class Test::Unit::TestCase
+end

data/test/to_hash_test.rb

@@ -0,0 +1,81 @@
+require "test/unit"
+require "shoulda"
+require "ostruct"
+
+require File.join(File.dirname(__FILE__), "..", "lib", "to_hash")
+
+class ToHashTest < Test::Unit::TestCase
+  context "project structures serialization" do
+    setup do
+      @project1 = OpenStruct.new(:title => "Project 1", :description => "Project 1 description")
+      @project2 = OpenStruct.new(:title => "Project 2")
+      @project3 = OpenStruct.new(:title => "Project 3")
+
+      @project1.authors = []
+      @project1.authors << OpenStruct.new(:first_name => "John", :last_name => "Doe", :projects => [@project1])
+      @project1.authors << OpenStruct.new(:first_name => "Michael", :last_name => "Smith", :projects => [@project1, @project2])
+      @project1.authors << OpenStruct.new(:first_name => "Jimmy", :last_name => "Parker", :projects => [@project1, @project2, @project3])
+      @project1.company = OpenStruct.new(:name => "HAL")
+
+      @project1.extend(ToHash)
+    end
+
+    should "return empty hash when no arguments given" do
+      hash = @project1.to_hash
+      assert_equal hash, {}
+    end
+
+    should "serialize data using title symbol" do
+      hash = @project1.to_hash(:title)
+      assert_equal hash, { :title => "Project 1" }
+    end
+
+    should "serialize data using title and description" do
+      hash = @project1.to_hash(:title, :description)
+      assert_equal hash, { :title => "Project 1", :description => "Project 1 description" }
+    end
+
+    should "allow to change one key in hash" do
+      hash = @project1.to_hash(:myTitle => :title)
+      assert_equal hash, { :myTitle => "Project 1" }
+    end
+
+    should "allow to change multiple keys in hash" do
+      hash = @project1.to_hash(:myTitle => :title, :myDesc => :description)
+      assert_equal hash, { :myTitle => "Project 1", :myDesc => "Project 1 description" }
+    end
+
+    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

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: to_hash
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- "Jakub Ku\xC5\xBAma"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-13 00:00:00 Z
+dependencies: []
+
+description: 
+email: qoobaa@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/to_hash.rb
+- test/test_helper.rb
+- test/to_hash_test.rb
+homepage: http://github.com/qoobaa/to_hash
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A fork of qoobaa's to_hash gem forked to build the gem on rubygems.org
+test_files: 
+- test/to_hash_test.rb
+- test/test_helper.rb