serialize 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+.rvmrc
+.rbenv-version
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  #- jruby-19mode
+  - rbx-19mode
+  - ruby-head
+script: "ruby -Itest:lib test/all.rb"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in serialize.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dane Harrigan
+
+MIT License
+
+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.md

@@ -0,0 +1,90 @@
+# Serialize [![Test Status](https://secure.travis-ci.org/daneharrigan/serialize.png)][1]
+
+Move serialization logic out of your model
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'serialize'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serialize
+
+## Usage
+
+    class UserSerializer < Serialize
+      # create a default serialization structure
+      structure do
+        {
+          :name   => name,
+          :gender => gender,
+          :email  => email
+        }
+      end
+
+      # create a named serialization structure
+      structure :extended do
+        {
+          :name   => name,
+          :gender => gender,
+          :email  => email,
+          :height => height,
+          :eye_color  => eye_color,
+          :hair_color => hair_color
+        }
+      end
+    end
+
+    @app = App.find(params[:id])
+
+    # serialize your @app object with the default structure
+    AppSerializer(@app).to_json
+
+    # serialize your @app with a specified structure
+    AppSerializer.new(@app, :as => :extended)
+
+    # serializers can take an array of objects
+    @collection = App.all
+    AppSerializer.new(@collection, :as => :extended)
+
+## Serialization Formats
+
+The `serialize` gem comes with JSON and XML support, but you can add
+your own.
+
+To do this, you'll have to define a `render` method that accepts
+`*args`. Because JSON and XML parsing pass different arguments `*args`
+keeps the interface generic.
+
+The hash to be serialized will be available as `content`.
+
+Once your serialization format is built register it with by using the
+`Serialize.register` method.
+
+    class Serialize::CSV < Serialize::Format
+      def render(*args)
+        if args.empty?
+          # turn hash into CSV
+        else
+          # do something else because arguments are passed in
+        end
+      end
+    end
+
+    Serialize.register "text/csv", Serialize::CSV
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[1]: https://secure.travis-ci.org/daneharrigan/serialize

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default do
+  exec "ruby -Itest:lib test/all.rb"
+end

data/lib/serialize.rb

@@ -0,0 +1,47 @@
+require "serialize/version"
+require "serialize/generator"
+require "serialize/format"
+require "serialize/json"
+require "serialize/xml"
+require "active_support/core_ext"
+
+class Serialize
+  def initialize(object, options={})
+    key     = options[:as] || :default
+    @object = object
+    @block  = self.class.structures[key]
+  end
+
+  def responses
+    @@serializers.keys
+  end
+
+  def to(content_type)
+    subtype = content_type.split("/").last
+    send("to_#{subtype}")
+  end
+
+  def self.structure(key=nil, &block)
+    key ||= :default
+    structures[key] = block
+  end
+
+  def self.structures
+    @structures ||= {}
+  end
+
+  def self.register(content_type, klass)
+    @@serializers ||= {}
+    @@serializers[content_type] = klass
+    subtype = content_type.split("/").last
+
+    define_method "to_#{subtype}" do |*args|
+      @@serializers[content_type].new(@object, @block).render(*args)
+    end
+
+    send :alias_method, "as_#{subtype}", "to_#{subtype}"
+  end
+end
+
+Serialize.register "application/json", Serialize::Json
+Serialize.register "application/xml",  Serialize::Xml

data/lib/serialize/format.rb

@@ -0,0 +1,21 @@
+class Serialize
+  class Format
+    attr :object
+    private :object
+
+    def initialize(object, block)
+      @object = object
+      @block  = block
+    end
+
+    def content
+      if object.respond_to? :map
+        object.map { |obj| Generator.new(obj, @block).to_hash }
+      else
+        Generator.new(object, @block).to_hash
+      end
+    end
+
+    private :content
+  end
+end

data/lib/serialize/generator.rb

@@ -0,0 +1,22 @@
+class Serialize
+  class Generator
+    def initialize(object, block)
+      @object = object
+      @block  = block
+    end
+
+    def to_hash
+      instance_eval &@block
+    end
+
+    def method_missing(*args, &block)
+      method = args.first
+
+      if @object.respond_to? method
+        @object.send *args, &block
+      else
+        raise NoMethodError
+      end
+    end
+  end
+end

data/lib/serialize/json.rb

@@ -0,0 +1,9 @@
+class Serialize
+  class Json < Format
+    def render(*args)
+      # args are empty unless called through
+      # another to_json call
+      args.empty? ? content.to_json : content
+    end
+  end
+end

data/lib/serialize/version.rb

@@ -0,0 +1,3 @@
+class Serialize
+  VERSION = "0.0.1"
+end

data/lib/serialize/xml.rb

@@ -0,0 +1,26 @@
+class Serialize
+  class Xml < Format
+    def render(*args)
+      # args are empty unless called through
+      # another to_xml call
+      options = unless args.empty?
+        args.first
+      else
+        subject = collection? ? object.first.class.name : object.class.name
+        name = subject.include?("::") ? subject.split("::").last : subject
+        name = name.titleize.downcase
+        name = name.pluralize if collection?
+        { :root => name }
+      end
+
+      content.to_xml(options)
+    end
+
+    def collection?
+      object.respond_to? :map
+    end
+
+    private :collection?
+  end
+end
+

data/serialize.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/serialize/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dane Harrigan"]
+  gem.email         = ["dane.harrigan@gmail.com"]
+  gem.description   = %q{Simple object serialization}
+  gem.summary       = %q{Simple object serialization}
+  gem.homepage      = "https://github.com/daneharrigan/serialize"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "serialize"
+  gem.require_paths = ["lib"]
+  gem.version       = Serialize::VERSION
+
+  gem.add_runtime_dependency "json"
+  gem.add_runtime_dependency "activesupport"
+  gem.add_runtime_dependency "builder"
+end

data/test/all.rb

@@ -0,0 +1,3 @@
+require 'test_helper'
+
+Dir["**/*_test.rb"].each { |path| require File.expand_path(path) }

data/test/serialize/generator_test.rb

@@ -0,0 +1,17 @@
+require "test_helper"
+
+class Serialize::GeneratorTest < MiniTest::Unit::TestCase
+  def setup
+    object = MockUser.new
+    block = proc do
+      { name: name, age: age }
+    end
+
+    @generator = Serialize::Generator.new(object, block)
+    @hash = { name: object.name, age: object.age }
+  end
+
+  def test_hash_creation_from_block
+    assert_equal @hash, @generator.to_hash
+  end
+end

data/test/serialize_test.rb

@@ -0,0 +1,64 @@
+require "test_helper"
+
+class SerializeTest < MiniTest::Unit::TestCase
+  def setup
+    @user       = MockUser.new
+    @resource   = MockResource.new
+    @user_hash  = { name: @user.name, age: @user.age }
+    @collection = [@user, @user, @user]
+    @hash_collection = [@user_hash, @user_hash, @user_hash]
+    @nested_hash = { name: @resource.name, type: @resource.type, users: @hash_collection }
+  end
+
+  def test_default_serialization
+    serializer = UserSerializer.new(@user)
+    assert_equal @user_hash.to_json, serializer.to_json
+  end
+
+  def test_named_json_serialization
+    @user_hash[:email] = @user.email
+    serializer = UserSerializer.new(@user, as: :extended)
+    assert_equal @user_hash.to_json, serializer.to_json
+  end
+
+  def test_collection_json_serialization
+    serializer = UserSerializer.new(@collection)
+    assert_equal @hash_collection.to_json, serializer.to_json
+  end
+
+  def test_named_collection_json_serialization
+    @hash_collection.each_with_index do |value, index|
+      @hash_collection[index][:email] = @user.email
+    end
+
+    serializer = UserSerializer.new(@collection, as: :extended)
+    assert_equal @hash_collection.to_json, serializer.to_json
+  end
+
+  def test_nested_json_serialization
+    serializer = ResourceSerializer.new(@resource)
+    assert_equal @nested_hash.to_json, serializer.to_json
+  end
+
+  def test_xml_serialization
+    serializer = UserSerializer.new(@user)
+    xml = @user_hash.to_xml(root: "mock-user")
+
+    assert_equal xml, serializer.to_xml
+  end
+
+  def test_nested_xml_serialization
+    serializer = ResourceSerializer.new(@resource)
+    assert_equal @nested_hash.to_xml(root: "mock-resource"), serializer.to_xml
+  end
+
+  def test_default_responses
+    serializer = UserSerializer.new(@user)
+    assert_equal ["application/json", "application/xml"], serializer.responses
+  end
+
+  def test_to_content_type
+    serializer = UserSerializer.new(@user)
+    assert_equal serializer.to("application/json"), serializer.to_json
+  end
+end

data/test/support/mock_resource.rb

@@ -0,0 +1,11 @@
+class MockResource
+  attr :name
+  attr :type
+  attr :users
+
+  def initialize
+    @name  = "Resource Item"
+    @type  = "dedicated"
+    @users = [MockUser.new, MockUser.new, MockUser.new]
+  end
+end

data/test/support/mock_user.rb

@@ -0,0 +1,11 @@
+class MockUser
+  attr :name
+  attr :age
+  attr :email
+
+  def initialize
+    @name  = "John Smith"
+    @age   = 26
+    @email = "jsmith@example.com"
+  end
+end

data/test/support/resource_serializer.rb

@@ -0,0 +1,9 @@
+class ResourceSerializer < Serialize
+  structure do
+    {
+      name:  name,
+      type:  type,
+      users: UserSerializer.new(users)
+    }
+  end
+end

data/test/support/user_serializer.rb

@@ -0,0 +1,16 @@
+class UserSerializer < Serialize
+	structure do
+		{
+		  name: name,
+		  age:  age
+		}
+	end
+
+	structure :extended do
+		{
+		  name:  name,
+		  age:   age,
+		  email: email
+		}
+	end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require "minitest/autorun"
+require "serialize"
+require "support/mock_user"
+require "support/mock_resource"
+require "support/user_serializer"
+require "support/resource_serializer"

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: serialize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dane Harrigan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70363930730240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70363930730240
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70363930729820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70363930729820
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &70363930729380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70363930729380
+description: Simple object serialization
+email:
+- dane.harrigan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/serialize.rb
+- lib/serialize/format.rb
+- lib/serialize/generator.rb
+- lib/serialize/json.rb
+- lib/serialize/version.rb
+- lib/serialize/xml.rb
+- serialize.gemspec
+- test/all.rb
+- test/serialize/generator_test.rb
+- test/serialize_test.rb
+- test/support/mock_resource.rb
+- test/support/mock_user.rb
+- test/support/resource_serializer.rb
+- test/support/user_serializer.rb
+- test/test_helper.rb
+homepage: https://github.com/daneharrigan/serialize
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Simple object serialization
+test_files:
+- test/all.rb
+- test/serialize/generator_test.rb
+- test/serialize_test.rb
+- test/support/mock_resource.rb
+- test/support/mock_user.rb
+- test/support/resource_serializer.rb
+- test/support/user_serializer.rb
+- test/test_helper.rb