json-serializer 0.0.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76888e2b15ca5525cbdd7f61258c324970c927f8
-  data.tar.gz: 5efc3b4502238c316a99aa9dc8ec879b3298017f
+  metadata.gz: ab535952b239a5ac4719d466197e12030773fddf
+  data.tar.gz: 4ecfc2356129405540b9f22ac43e4da2f8de6358
 SHA512:
-  metadata.gz: 3cd2636c9670d3a11dbad89dfa7aacb7d236dca3967794457048cec2d56e2ce3e89e63c10ea243ba853e5f19bf8c6a21141ae812e284632f4ec3b4225724f7c9
-  data.tar.gz: cb7d1fd32e48bdadd5cc628d21aeb89f17fe2c50e4bfdfa305f444c0fba20132cf8ac9943e5e0d76f529e04201d18442bab50bf5ce8a0f33f73bc72ba1ee1c65
+  metadata.gz: fede701fc5c873531b15c0b2501983843032082f9eb3629644612124b8a98937707bea26d38fcaa57def76a7318666aa9ad724e4f134a0e46bbb169b53e3cbcd
+  data.tar.gz: 644198f622a0b6b90353c568ec7436fc5610a52c1ab20b819a6fb23cb38d7fca50a93f2a788f0d90e896f4ac93d48499f053bf4894f9f4947cc37b0e33ef8fdc

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-Present Harmoni LLC
+Copyright (c) 2014-2016 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

data/README.md

@@ -1,22 +1,32 @@
-json-serializer
+json-serializer [![Build Status](https://travis-ci.org/frodsan/json-serializer.svg)](https://travis-ci.org/frodsan/json-serializer)
 ===============
 
 Customizes JSON output through serializer objects.
 
-A minimal implementation of [active_model_serializers][active_model_serializers] gem.
-
 Installation
 ------------
 
+Add this line to your application's Gemfile:
+
+```ruby
+gem "json-serializer"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
 ```
-gem install json-serializer
+$ gem install json-serializer
 ```
 
 Usage
 -----
 
-### Basics
-
 Here's a simple example:
 
 ```ruby
@@ -48,7 +58,8 @@ UserSerializer.new(user).to_json(root: :user)
 # => "{\"user\":{\"id\":1,\"first_name\":\"Sonny\",\"last_name\":\"Moore\"}}"
 ```
 
-### Arrays
+Arrays
+------
 
 A serializer can be used for objects contained in an array:
 
@@ -77,7 +88,8 @@ Given the example above, it will return a json output like:
 ]
 ```
 
-### Attributes
+Attributes
+----------
 
 By default, before looking up the attribute on the object, it checks the presence
 of a method with the name of the attribute. This allow serializes to include
@@ -116,7 +128,7 @@ class UserSerializer < JsonSerializer
   attribute :first_name
   attribute :last_name
 
-  attr :current_user
+  attr_reader :current_user
 
   def initialize(object, current_user)
     super(object)
@@ -131,7 +143,8 @@ class UserSerializer < JsonSerializer
 end
 ```
 
-### Attributes with Custom Serializer
+Attributes with Custom Serializer
+---------------------------------
 
 You can specify a serializer class for a defined attribute. This is very useful
 for serializing each element of an association.
@@ -192,4 +205,34 @@ The example above returns the following json output:
 }
 ```
 
+Contributing
+------------
+
+Fork the project with:
+
+```
+$ git clone git@github.com:frodsan/json-serializer.git
+```
+
+To install dependencies, use:
+
+```
+$ bundle install
+```
+
+To run the test suite, do:
+
+```
+$ rake test
+```
+
+For bug reports and pull requests use [GitHub][issues].
+
+License
+-------
+
+This gem is released under the [MIT License][mit].
+
 [active_model_serializers]: https://github.com/rails-api/active_model_serializers
+[mit]: http://www.opensource.org/licenses/MIT
+[issues]: https://github.com/frodsan/json-serializer/issues

data/lib/json_serializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 
 class JsonSerializer
@@ -25,37 +27,41 @@ class JsonSerializer
     @attributes ||= {}
   end
 
-  attr :object
+  attr_reader :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
+  def to_json(root: nil)
+    result = decorate
+    result = { root => result } if root
 
-  protected
+    result.to_json
+  end
 
-  def serializable_object
-    return nil unless @object
+  def decorate
+    return nil unless object
 
-    if @object.respond_to?(:to_a)
-      @object.to_a.map { |item| self.class.new(item).to_hash }
+    if object.respond_to?(:to_a)
+      to_arry
     else
       to_hash
     end
   end
 
+  protected
+
+  def to_arry
+    object.to_a.map { |o| self.class.new(o).to_hash }
+  end
+
   def to_hash
     self.class.attributes.each_with_object({}) do |(name, serializer), hash|
-      data = self.class.method_defined?(name) ? self.send(name) : @object.send(name)
-      data = Utils.const(self.class, serializer).new(data).serializable_object if serializer
-      hash[name] = data
+      res = self.class.method_defined?(name) ? send(name) : object.send(name)
+      res = Utils.const(self.class, serializer).new(res).decorate if serializer
+
+      hash[name] = res
     end
   end
 end

data/test/association_test.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require_relative "helper"
+
+class OrganizationSerializer < JsonSerializer
+  attribute :id
+  attribute :name
+end
+
+class UserWithOrganizationSerializer < JsonSerializer
+  attribute :id
+  attribute :name
+  attribute :organization, :OrganizationSerializer
+end
+
+class UserWithCustomOrganizationSerializer < JsonSerializer
+  attribute :organizations, :OrganizationSerializer
+
+  def organizations
+    [Organization.new(id: 1, name: "enterprise")]
+  end
+end
+
+# rubocop:disable ClassLength
+class AssociationTest < Minitest::Test
+  test "serializes object with association" do
+    user = User.new(id: 1, name: "sonny")
+    user.organization = Organization.new(id: 1, name: "enterprise")
+
+    result = {
+      id: 1,
+      name: "sonny",
+      organization: {
+        id: 1,
+        name: "enterprise"
+      }
+    }.to_json
+
+    assert_equal result, UserWithOrganizationSerializer.new(user).to_json
+  end
+
+  test "serializes object with a nil association" do
+    user = User.new(id: 1, name: "sonny")
+    user.organization = nil
+
+    result = {
+      id: 1,
+      name: "sonny",
+      organization: nil
+    }.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(id: 1, name: "enterprise")
+      ),
+      User.new(
+        id: 2,
+        name: "anton",
+        organization: Organization.new(id: 2, name: "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(id: 1, name: "enterprise"),
+      Organization.new(id: 2, name: "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(id: 1, name: "enterprise"),
+          Organization.new(id: 2, name: "evil")
+        ]
+      ),
+      User.new(
+        id: 2,
+        name: "anton",
+        organizations: [
+          Organization.new(id: 3, name: "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
+
+  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
+end

data/test/attribute_test.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "helper"
+
+class PostSerializer < JsonSerializer
+  attribute :id
+  attribute :title
+  attribute :slug
+
+  def slug
+    "#{ object.id }-#{ object.title }"
+  end
+end
+
+class ParentSerializer < JsonSerializer
+  attribute :parent
+end
+
+class ChildSerializer < ParentSerializer
+  attribute :child
+end
+
+class UserSerializer < JsonSerializer
+  attribute :id
+  attribute :fullname
+
+  def fullname
+    object.name + " " + object.lastname
+  end
+end
+
+class AttributeTest < Minitest::Test
+  test "converts defined attributes into json" do
+    post = Post.new(id: 1, title: "tsunami")
+
+    result = {
+      id: 1,
+      title: "tsunami",
+      slug: "1-tsunami"
+    }.to_json
+
+    assert_equal result, PostSerializer.new(post).to_json
+  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
+
+  test "inheritance" do
+    parent = ParentSerializer.attributes
+    child = ChildSerializer.attributes
+
+    assert_equal(parent.merge(child: nil), child)
+  end
+end

data/test/helper.rb

@@ -1,3 +1,13 @@
-require "cutest"
-require_relative "../lib/json_serializer"
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest/sugar"
 require "ostruct"
+require_relative "../lib/json_serializer"
+
+User = OpenStruct
+Organization = OpenStruct
+Person = OpenStruct
+Post = OpenStruct

data/test/root_test.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "helper"
+
+class PersonSerializer < JsonSerializer
+  attribute :name
+end
+
+class RootTest < Minitest::Test
+  setup do
+    @person = Person.new(name: "sonny")
+  end
+
+  test "serialized object includes root" do
+    result = { person: @person.to_h }.to_json
+
+    assert_equal result, PersonSerializer.new(@person).to_json(root: :person)
+  end
+
+  test "serialized array includes root" do
+    result = { people: [@person.to_h] }.to_json
+
+    assert_equal result, PersonSerializer.new([@person]).to_json(root: :people)
+  end
+end

metadata

@@ -1,49 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: json-serializer
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Francesco Rodríguez
-- Mayn Kjær
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-02 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: cutest
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Customize JSON ouput through serializer objects.
-email:
-- frodsan@me.com
-- mayn.kjaer@gmail.com
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-sugar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+description: Customize JSON ouput through serializer objects
+email: hello@frodsan.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gems"
 - LICENSE
 - README.md
-- json-serializer.gemspec
 - lib/json_serializer.rb
-- makefile
-- test/association.rb
-- test/attribute.rb
+- test/association_test.rb
+- test/attribute_test.rb
 - test/helper.rb
-- test/root.rb
-homepage: https://github.com/harmoni/json-serializer
+- test/root_test.rb
+homepage: https://github.com/frodsan/json-serializer
 licenses:
 - MIT
 metadata: {}
@@ -63,8 +99,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Customize JSON ouput through serializer objects.
-test_files: []
+summary: Customize JSON ouput through serializer objects
+test_files:
+- test/association_test.rb
+- test/attribute_test.rb
+- test/helper.rb
+- test/root_test.rb

data/.gems

@@ -1 +0,0 @@
-cutest -v 1.2.2

data/json-serializer.gemspec

@@ -1,14 +0,0 @@
-Gem::Specification.new do |s|
-  s.name        = "json-serializer"
-  s.version     = "0.0.9"
-  s.summary     = "Customize JSON ouput through serializer objects."
-  s.description = s.summary
-  s.authors     = ["Francesco Rodríguez", "Mayn Kjær"]
-  s.email       = ["frodsan@me.com", "mayn.kjaer@gmail.com"]
-  s.homepage    = "https://github.com/harmoni/json-serializer"
-  s.license     = "MIT"
-
-  s.files = `git ls-files`.split("\n")
-
-  s.add_development_dependency "cutest"
-end

data/makefile

@@ -1,8 +0,0 @@
-.DEFAULT_GOAL := test
-.PHONY: test
-
-gem:
-	gem build *.gemspec
-
-test:
-	cutest test/*.rb

data/test/association.rb

@@ -1,168 +0,0 @@
-require_relative "helper"
-
-User = OpenStruct
-Organization = OpenStruct
-
-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(id: 1, name: "enterprise")
-
-  result = {
-    id: 1,
-    name: "sonny",
-    organization: {
-      id: 1,
-      name: "enterprise"
-    }
-  }.to_json
-
-  assert_equal result, UserWithOrganizationSerializer.new(user).to_json
-end
-
-test "serializes object with a nil association" do
-  user = User.new(id: 1, name: "sonny")
-  user.organization = nil
-
-  result = {
-    id: 1,
-    name: "sonny",
-    organization: nil
-  }.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(id: 1, name: "enterprise")),
-    User.new(id: 2, name: "anton", organization: Organization.new(id: 2, name: "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(id: 1, name: "enterprise"),
-    Organization.new(id: 2, name: "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(id: 1, name: "enterprise"),
-        Organization.new(id: 2, name: "evil"),
-      ]
-    ),
-    User.new(
-      id: 2,
-      name: "anton",
-      organizations: [
-        Organization.new(id: 3, name: "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(id: 1, name: "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

data/test/attribute.rb

@@ -1,64 +0,0 @@
-require_relative "helper"
-
-Post = OpenStruct
-User = OpenStruct
-
-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(id: 1, title: "tsunami")
-
-  result = {
-    id: 1,
-    title: "tsunami",
-    slug: "1-tsunami"
-  }.to_json
-
-  assert_equal result, PostSerializer.new(post).to_json
-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
-
-class ParentSerializer < JsonSerializer
-  attribute :parent
-end
-
-class ChildSerializer < ParentSerializer
-  attribute :child
-end
-
-test "inheritance" do
-  parent = ParentSerializer.attributes
-  child = ChildSerializer.attributes
-
-  assert_equal(parent.merge(child: nil), child)
-end

data/test/root.rb

@@ -1,23 +0,0 @@
-require_relative "helper"
-
-Person = OpenStruct
-
-class PersonSerializer < JsonSerializer
-  attribute :name
-end
-
-setup do
-  Person.new(name: "sonny")
-end
-
-test "serialized object includes root" do |person|
-  result = { person: person.to_h }.to_json
-
-  assert_equal result, PersonSerializer.new(person).to_json(root: :person)
-end
-
-test "serialized array includes root" do |person|
-  result = { people: [person.to_h] }.to_json
-
-  assert_equal result, PersonSerializer.new([person]).to_json(root: :people)
-end