json-serializer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39bc95ac73ac44ae7a16dc13bf43d52c48499f97
+  data.tar.gz: 906faca4908b5c2b5a5a780d741f1e8d95201105
+SHA512:
+  metadata.gz: a4bd52faad782b9ade7ef4900547b89d902d3f979f06aa3e5ffce6feae99631b3ff8a3019eb226122057dfc6010f9da7f168756fdc1ba980a57e488fe677866a
+  data.tar.gz: ba0673eb2adbf64b68fb1e65b64f83522a74fcbaee38b1d33025acf736f737c7c3bd195393bafbc494c48dfc5ac94b7625b4e0c0ac73635d484a3de88e73982d

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Francesco Rodríguez
+
+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,6 @@
+json-serializer
+===============
+
+`ActiveModel::Serializers` outside Rails.
+
+Not ready.

data/json-serializer.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name        = 'json-serializer'
+  s.version     = '0.0.1'
+  s.summary     = 'Replaces hash-driven development with object-oriented development'
+  s.description = s.summary
+  s.authors     = ['Francesco Rodríguez']
+  s.email       = ['lrodriguezsanc@gmail.com']
+  s.homepage    = 'https://github.com/frodsan/mocoso'
+  s.license     = 'MIT'
+
+  s.files = Dir[
+    'LICENSE',
+    'README.md',
+    'lib/**/*.rb',
+    '*.gemspec',
+    'test/*.*'
+  ]
+
+  s.add_development_dependency 'cutest'
+end

data/lib/json-serializer.rb

@@ -0,0 +1,86 @@
+require 'json'
+
+class JsonSerializer
+  # Specify which attributes you would like to include in the outputted JSON.
+  #
+  #   class UserSerializer < JsonSerializer
+  #     attribute :id
+  #     attribute :username
+  #   end
+  #
+  #   user = User.create username: 'skrillex', admin: true
+  #
+  #   UserSerializer.new(user).to_json
+  #   # => {"id":1,"username":"skrillex"}
+  #
+  # By default, before looking up the attribute on the object, checks the presence
+  # of a method with the attribute name. This allow serializers to include properties
+  # in addition to the object attributes or customize the result of a specified
+  # attribute. You can access the object being serialized with the +object+ method.
+  #
+  #   class UserSerializer < JsonSerializer
+  #     attribute :id
+  #     attribute :username
+  #     attribute :full_name
+  #
+  #     def full_name
+  #       object.first_name + ' ' + object.last_name
+  #     end
+  #   end
+  #
+  #   user = User.create username: 'skrillex', first_name: 'sonny', last_name: 'moore'
+  #
+  #   UserSerializer.new(user).to_json
+  #   # => {"id":1,"username":"skrillex","full_name":"sonny moore"}
+  #
+  def self.attribute name, serializer = nil
+    attributes[name] ||= serializer
+  end
+
+  # Return an array with the specified attributes by +attribute+.
+  #
+  #   class UserSerializer < JsonSerializer
+  #     attribute :id
+  #     attribute :username
+  #     attribute :github
+  #   end
+  #
+  #   UserSerializer.attributes
+  #   # => [:id, :username, :github]
+  #
+  def self.attributes
+    @attributes ||= {}
+  end
+
+  attr :object
+
+  def initialize object
+    @object = object
+  end
+
+  def to_json options={}
+    if root = options[:root]
+      { root => serializable_object }.to_json
+    else
+      serializable_object.to_json
+    end
+  end
+
+  protected
+
+  def serializable_object # :nodoc:
+    if object.respond_to?(:to_ary)
+      object.to_ary.map { |item| self.class.new(item).attributes }
+    else
+      attributes
+    end
+  end
+
+  def attributes # :nodoc:
+    self.class.attributes.each_with_object({}) do |(name, serializer), hash|
+      data = self.class.method_defined?(name) ? self.send(name) : object.send(name)
+      data = serializer.new(data).serializable_object if serializer
+      hash[name] = data
+    end
+  end
+end

data/lib/json_serializer.rb

@@ -0,0 +1 @@
+require 'json-serializer'

data/test/json_serializer_test.rb

@@ -0,0 +1,230 @@
+require 'cutest'
+require_relative '../lib/json-serializer'
+
+Post = Struct.new :id, :title, :created_at
+
+class PostSerializer < JsonSerializer
+  attribute :id
+  attribute :title
+  attribute :slug
+
+  def slug
+    "#{ object.id }-#{ object.title }"
+  end
+end
+
+test 'converts defined attributes into json' do
+  post = Post.new 1, 'tsunami'
+
+  result = {
+    id: 1,
+    title: 'tsunami',
+    slug: '1-tsunami'
+  }
+
+  assert_equal result.to_json, PostSerializer.new(post).to_json
+end
+
+class User
+  attr_accessor :id, :name, :lastname, :organization, :organizations
+
+  def initialize attrs={}
+    attrs.each do |name, value|
+      send "#{name}=", value
+    end
+  end
+end
+
+class UserSerializer < JsonSerializer
+  attribute :id
+  attribute :fullname
+
+  def fullname
+    object.name + ' ' + object.lastname
+  end
+end
+
+test 'serializes array' do
+  users = [
+    User.new(id: 1, name: 'sonny', lastname: 'moore'),
+    User.new(id: 2, name: 'anton', lastname: 'zaslavski')
+  ]
+
+  result = [
+    { id: 1, fullname: 'sonny moore' },
+    { id: 2, fullname: 'anton zaslavski' }
+  ].to_json
+
+  assert_equal result, UserSerializer.new(users).to_json
+end
+
+Organization = Struct.new :id, :name, :created_at
+
+class OrganizationSerializer < JsonSerializer
+  attribute :id
+  attribute :name
+end
+
+class UserWithOrganizationSerializer < JsonSerializer
+  attribute :id
+  attribute :name
+  attribute :organization, OrganizationSerializer
+end
+
+test 'serializes object with association' do
+  user = User.new id: 1, name: 'sonny'
+  user.organization = Organization.new 1, 'enterprise'
+
+  result = {
+    id: 1,
+    name: 'sonny',
+    organization: {
+      id: 1,
+      name: 'enterprise'
+    }
+  }.to_json
+
+  assert_equal result, UserWithOrganizationSerializer.new(user).to_json
+end
+
+test 'serializes array with association' do
+  users = [
+    User.new(id: 1, name: 'sonny', organization: Organization.new(1, 'enterprise')),
+    User.new(id: 2, name: 'anton', organization: Organization.new(2, 'evil'))
+  ]
+
+  result = [
+    {
+      id: 1,
+      name: 'sonny',
+      organization: {
+        id: 1,
+        name: 'enterprise'
+      }
+    },
+    {
+      id: 2,
+      name: 'anton',
+      organization: {
+        id: 2,
+        name: 'evil'
+      }
+    }
+  ].to_json
+
+  assert_equal result, UserWithOrganizationSerializer.new(users).to_json
+end
+
+class UserWithOrganizationsSerializer < JsonSerializer
+  attribute :id
+  attribute :name
+  attribute :organizations, OrganizationSerializer
+end
+
+test 'serializes object with collection' do
+  user = User.new id: 1, name: 'sonny'
+  user.organizations = [
+    Organization.new(1, 'enterprise'),
+    Organization.new(2, 'evil')
+  ]
+
+  result = {
+    id: 1,
+    name: 'sonny',
+    organizations: [
+      {
+        id: 1,
+        name: 'enterprise'
+      },
+      {
+        id: 2,
+        name: 'evil'
+      }
+    ]
+  }.to_json
+
+  assert_equal result, UserWithOrganizationsSerializer.new(user).to_json
+end
+
+test 'serializes array with nested collections' do
+  users = [
+    User.new(
+      id: 1,
+      name: 'sonny',
+      organizations: [
+        Organization.new(1, 'enterprise'),
+        Organization.new(2, 'evil'),
+      ]
+    ),
+    User.new(
+      id: 2,
+      name: 'anton',
+      organizations: [
+        Organization.new(3, 'showtek')
+      ]
+    )
+  ]
+
+  result = [
+    {
+      id: 1,
+      name: 'sonny',
+      organizations: [
+        {
+          id: 1,
+          name: 'enterprise'
+        },
+        {
+          id: 2,
+          name: 'evil'
+        }
+      ]
+    },
+    {
+      id: 2,
+      name: 'anton',
+      organizations: [
+        {
+          id: 3,
+          name: 'showtek'
+        }
+      ]
+    }
+  ].to_json
+
+  assert_equal result, UserWithOrganizationsSerializer.new(users).to_json
+end
+
+class UserWithCustomOrganizationSerializer < JsonSerializer
+  attribute :organizations, OrganizationSerializer
+
+  def organizations
+    [ Organization.new(1, 'enterprise') ]
+  end
+end
+
+test 'implements association method and returns different result' do
+  user = User.new
+
+  result = { organizations: [ { id: 1, name: 'enterprise' } ] }.to_json
+
+  assert_equal result, UserWithCustomOrganizationSerializer.new(user).to_json
+end
+
+Person = Struct.new :name
+
+class PersonSerialize < JsonSerializer
+  attribute :name
+end
+
+test 'allows root option' do
+  person = Person.new 'sonny'
+
+  result = { person: person.to_h }.to_json
+
+  assert_equal result, PersonSerialize.new(person).to_json(root: :person)
+
+  result = { people: [person.to_h] }.to_json
+
+  assert_equal result, PersonSerialize.new([person]).to_json(root: :people)
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: json-serializer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Francesco Rodríguez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Replaces hash-driven development with object-oriented development
+email:
+- lrodriguezsanc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/json-serializer.rb
+- lib/json_serializer.rb
+- json-serializer.gemspec
+- test/json_serializer_test.rb
+homepage: https://github.com/frodsan/mocoso
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Replaces hash-driven development with object-oriented development
+test_files: []