hash-serializer 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea/*
+hash-serializer.iml

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in hash-serializer.gemspec
+gemspec
+
+group :test do
+  gem "rspec-core", ">=2.5.0"
+  gem "rspec-mocks", ">=2.5.0"
+  gem "rspec-expectations", ">=2.5.0"
+
+end

data/README.md

@@ -0,0 +1,42 @@
+
+# INTRODUCTION
+
+The aim of this gem is to enable an easy way to serialize an object in a Hash object or a JSON data structure using
+the attributes name as keys.
+
+This can be useful if you need to work with XSD schemas while using code generators that convert an schema in
+ruby objects but still you haven't a way to convert to JSON or any other format.
+
+# INSTALLATION
+    gem install hash-serializer
+
+# HOW TO USE
+
+    require 'hash-serializer'
+
+    class User
+        attr_accessor :nickname
+        attr_accessor :email
+        attr_accessor :password
+
+        def initialize(nickname = nil, email = nil, password = nil)
+            @nickname = nickname
+            @email = email
+            @password = password
+        end
+    end
+
+    u = User.new("juandebravo", "juan at pollinimini dot net", "*******")
+
+    u.serialize_to_hash
+        => {"nickname"=>"juandebravo", "email"=>"juan at pollinimini dot net", "password"=>"*******"}
+
+    u.serialize_to_hash(u.nickname)
+        => {"juandebravo"=>{"nickname"=>"juandebravo", "email"=>"juan at pollinimini dot net", "password"=>"*******"}}
+
+    puts u.serialize_to_json
+        => {"nickname":"juandebravo","email":"juan at pollinimini dot net","password":"*******"}
+
+    puts u.serialize_to_json("user")
+        => {"user":{"nickname":"juandebravo","email":"juan at pollinimini dot net","password":"*******"}}
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/hash-serializer.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "hash-serializer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hash-serializer"
+  s.version     = HashSerializer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Juan de Bravo"]
+  s.email       = ["juandebravo@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{This gem provides an easy way to wrap a class attributes in a key-value representation (Hash object in ruby)}
+  s.description = <<END
+    Some months ago I worked in a project that defined the data serialization using a XSD schema. I used soap4r gem to create
+    ruby objects from the XSD schema, but later I needed to serialize the object value in JSON format. So I defined this
+    this extension that enables an easy way to encode an object attributes in Hash and in JSON format.
+END
+
+  s.rubyforge_project = "hash-serializer"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("json_pure", ">= 1.4.3")
+end

data/lib/hash-serializer.rb

@@ -0,0 +1,4 @@
+require 'hash-serializer/extensions/object'
+module HashSerializer
+  # Your code goes here...
+end

data/lib/hash-serializer/extensions/object.rb

@@ -0,0 +1,63 @@
+require 'json'
+
+class Object
+
+  #
+  # Instance method to parse an object to an equivalent Hash format
+  # Used to serialize body data
+  #
+  def serialize_to_hash(root_name = nil)
+    result = Hash.new
+    self.instance_variables.each do |column|
+      aux = self.instance_variable_get(column)
+      unless aux.nil?
+        if aux.instance_of?(String) or aux.kind_of?(String)
+          # It's required to erase any '_' character because
+          # soap4r has included it (not idea about the reason)
+          result[self.class.get_column_value(column)] = aux.to_s
+        else
+          if aux.is_a?(Array)
+            result_aux = Array.new
+            aux.each do |elem|
+              result_aux << elem.serialize_to_hash
+            end
+          else
+            result_aux = aux.serialize_to_hash
+          end
+          result[self.class.get_column_value(column)] = result_aux
+        end
+      end
+    end
+    unless root_name.nil?
+      temp = result
+      result = {}
+      result[root_name] = temp
+    end
+    result
+  end
+
+  #
+  # Convert the Hashed object to a String containing the object JSON format
+  #
+  def serialize_to_json(root_name = nil)
+    serialize_to_hash(root_name).to_json
+  end
+
+  private
+
+  class << self
+    #
+    # Retrieves the attribute name
+    #
+    def get_column_value(column)
+      column = column.to_s.sub(/@/, '')
+      unless column.index('_').nil?
+        column = column.split('_')[1]
+      end
+      column
+    end
+
+  end
+
+
+end

data/lib/hash-serializer/version.rb

@@ -0,0 +1,4 @@
+module HashSerializer
+  VERSION = "0.1.0"
+end
+

data/spec/hash-serializer-spec.rb

@@ -0,0 +1,161 @@
+require 'hash-serializer'
+
+describe "hash-serializer" do
+
+  # Generates a method whose return value is memoized after the first call.
+  let(:obj) {
+    obj = Object.new
+    obj.instance_variable_set("@foo".to_sym, "bar")
+    obj.instance_variable_set("@bar".to_sym, "bazz")
+    obj
+  }
+
+  # Generates a method whose return value is memoized after the first call.
+  let(:complex_obj) {
+    complex_obj = Object.new
+    complex_obj.instance_variable_set("@foo".to_sym, "bar")
+    complex_obj.instance_variable_set("@bar".to_sym, "bazz")
+    complex_obj.instance_variable_set("@bazz".to_sym, obj)
+    complex_obj.instance_variable_set("@array".to_sym, [obj, obj])
+    complex_obj
+  }
+
+  describe "basic object" do
+
+    describe "object to json extension" do
+      it "converts properly a basic object with root name" do
+        json_obj = obj.serialize_to_json("object")
+        json_obj.should be_a_kind_of(String)
+        json_obj = JSON.parse(json_obj)
+        json_obj.should be_a_kind_of(Hash)
+
+        json_obj.should have_key("object")
+        json_obj = json_obj["object"]
+        json_obj.should have_key("foo")
+        json_obj.should have_key("bar")
+      end
+
+
+      it "converts properly a basic object without root name" do
+        json_obj = obj.serialize_to_json
+        json_obj.should be_a_kind_of(String)
+        json_obj = JSON.parse(json_obj)
+        json_obj.should be_a_kind_of(Hash)
+
+        json_obj.should have_key("foo")
+        json_obj.should have_key("bar")
+      end
+
+    end
+
+    describe "object to hash extension" do
+      it "converts properly a basic object without root name" do
+        json_obj = obj.serialize_to_hash
+
+        json_obj.should be_a_kind_of(Hash)
+        json_obj.should have_key("foo")
+        json_obj.should have_key("bar")
+      end
+
+      it "converts properly a basic object with root name" do
+        json_obj = obj.serialize_to_hash("foo")
+        json_obj.should be_a_kind_of(Hash)
+        json_obj.should have_key("foo")
+
+        json_obj = json_obj["foo"]
+        json_obj.should have_key("foo")
+        json_obj.should have_key("bar")
+      end
+
+      it "converts properly a basic object with a symbol as root name" do
+        json_obj = obj.serialize_to_hash(:foo)
+        json_obj.should be_a_kind_of(Hash)
+        json_obj.should have_key(:foo)
+
+        json_obj = json_obj[:foo]
+        json_obj.should have_key("foo")
+        json_obj.should have_key("bar")
+      end
+    end
+  end
+
+  describe "object with another object as attribute" do
+
+    describe "object to hash extension" do
+      it "converts properly a complex object without root name" do
+
+        json_obj = complex_obj.serialize_to_hash
+
+        ["foo", "bar", "bazz"].each { |key|
+          json_obj.should have_key(key)
+        }
+
+        bazz = json_obj["bazz"]
+        ["foo", "bar"].each { |key|
+          bazz.should have_key(key)
+        }
+      end
+
+      it "converts properly a complex object wit root name" do
+
+        json_obj = complex_obj.serialize_to_hash(:object)
+
+        json_obj.should be_a_kind_of(Hash)
+        json_obj.should have_key(:object)
+        json_obj = json_obj[:object]
+
+        ["foo", "bar", "bazz"].each { |key|
+          json_obj.should have_key(key)
+        }
+
+        bazz = json_obj["bazz"]
+        ["foo", "bar"].each { |key|
+          bazz.should have_key(key)
+        }
+      end
+
+    end
+
+  end
+
+  describe "object with an array as attribute" do
+    describe "object to hash extension" do
+      it "converts properly a complex object without root name" do
+
+        json_obj = complex_obj.serialize_to_hash
+
+        ["foo", "bar", "bazz", "array"].each { |key|
+          json_obj.should have_key(key)
+        }
+
+        array = json_obj["array"]
+        array.length.should be 2
+        elem = array[0]
+        ["foo", "bar"].each { |key|
+          elem.should have_key(key)
+        }
+      end
+    end
+
+    describe "object to json extension" do
+
+      it "converts properly a basic object with root name" do
+        json_obj = complex_obj.serialize_to_json
+        json_obj.should be_a_kind_of(String)
+        json_obj = JSON.parse(json_obj)
+        json_obj.should be_a_kind_of(Hash)
+        ["foo", "bar", "bazz", "array"].each { |key|
+          json_obj.should have_key(key)
+        }
+        array = json_obj["array"]
+        array.length.should be 2
+        elem = array[0]
+        ["foo", "bar"].each { |key|
+          elem.should have_key(key)
+        }
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: hash-serializer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Juan de Bravo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 3
+        version: 1.4.3
+  type: :runtime
+  version_requirements: *id001
+description: "    Some months ago I worked in a project that defined the data serialization using a XSD schema. I used soap4r gem to create\n    ruby objects from the XSD schema, but later I needed to serialize the object value in JSON format. So I defined this\n    this extension that enables an easy way to encode an object attributes in Hash and in JSON format.\n"
+email: 
+- juandebravo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- hash-serializer.gemspec
+- lib/hash-serializer.rb
+- lib/hash-serializer/extensions/object.rb
+- lib/hash-serializer/version.rb
+- spec/hash-serializer-spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: hash-serializer
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This gem provides an easy way to wrap a class attributes in a key-value representation (Hash object in ruby)
+test_files: 
+- spec/hash-serializer-spec.rb