ivy-serializers 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 965769bbd1ab1c1e7345b7767e4ac2f35ced0890
-  data.tar.gz: 8c8b913128925ad947f0810f05cb47d34d7c1f95
+  metadata.gz: 53cc58ca39399bdcc72ecb47fd0aeecac296be43
+  data.tar.gz: ad5208023b028606b093a3056added2c7574ba82
 SHA512:
-  metadata.gz: 5ccc6afa7b0b08e61cbb53876c8239192c60683fd54bf707e06e02e34bf2ce2b8ea86b0ad8cc40b6d87471b1ff6e531d1f9f5aed5b0ee0303f3a27631d1bbe0d
-  data.tar.gz: 255b0f79b33bec71c516fadcc0d471abec3e4e685a6b520b508076ac39f70033416813a6438fa54d813638dc6511ed492cd6eada2e44a91c0b4d74ff7ec7bf19
+  metadata.gz: 329051d45ee2fbbd118e992ffcd83e69fcac05128e96606ba2fdd64e53ee1b2b74ad75649d1c48c32fddd83fa04c121706b6f0b79b15eb67171f34e368f0cb12
+  data.tar.gz: 6a6540f204ccb754c0c0846924708e4ee0a5caed80827ef1abcea481176c4d7f2a8a3f8c44ed9f45deb93f203d7b450b3098fde5ab003029a75f9445b998880e

data/.travis.yml

@@ -1,10 +1,8 @@
 language: ruby
 
 rvm:
+  - 2.2.2
   - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
 
 cache: bundler
 

data/README.md

@@ -1,13 +1,10 @@
-# Ivy::Serializers
+# ivy-serializers
 
 [![Build Status](https://travis-ci.org/IvyApp/ivy-serializers.svg?branch=master)](https://travis-ci.org/IvyApp/ivy-serializers)
 
-JSON serialization for client-side apps, with multiple output formats. Ships
-with [ActiveModel::Serializers][ams] and [JSON-API][jsonapi] RC3 support
-out of the box.
+JSON serialization for client-side apps, with multiple output formats. Ships with [ActiveModel::Serializers](https://github.com/rails-api/active_model_serializers) and [JSON-API](http://jsonapi.org/) 1.0 support out of the box.
 
-[ams]: https://github.com/rails-api/active_model_serializers
-[jsonapi]: http://jsonapi.org/
+If you're building a Rails project, take a look at [ivy-serializers-rails](https://github.com/IvyApp/ivy-serializers-rails) instead.
 
 ## Installation
 
@@ -45,40 +42,27 @@ class Comment < ActiveRecord::Base
 end
 ```
 
-Define a serializer in `app/serializers/serializer.rb`:
+Define a serializer in `app/serializers/my_serializer.rb`:
 
 ```ruby
-class Serializer < Ivy::Serializers::Serializer
+class MySerializer < Ivy::Serializers::Serializer
   map Post do
-    attributes :id, :title
+    attributes :title
     has_many :comments
   end
 
   map Comment do
-    attributes :id, :body
+    attributes :body
     belongs_to :post
   end
 end
 ```
 
-Then set up your controllers to use the serializer:
-
-```ruby
-class ApplicationController < ActionController::Base
-  self.serializer = Serializer
-end
-```
-
-Note that you're not limited to a single serializer. If you have multiple
-serialization formats, such as one for admin and one for public-facing, you can
-define alternate serializers in `app/serializers` and use them as well.
+**NOTE**: An `id` attribute is automatically defined for you. This is a consequence of supporting JSON-API, which requires all resources to have IDs.
 
 ### Sideloading
 
-The `#belongs_to` and `#has_many` methods support an optional `:embed_in_root`
-option, which will load the associated record into the root of the payload. For
-instance, if we wanted the list of comments to be included when fetching
-a post, we could define the `has_many` relationship like so:
+The `#belongs_to` and `#has_many` methods support an optional `:embed_in_root` option, which will load the associated record into the root of the payload. For instance, if we wanted the list of comments to be included when fetching a post, we could define the `has_many` relationship like so:
 
 ```ruby
 map Post do
@@ -86,8 +70,7 @@ map Post do
 end
 ```
 
-The same thing also works with `belongs_to`, so if we wanted to ensure the post
-was included when fetching a comment:
+The same thing also works with `belongs_to`, so if we wanted to ensure the post was included when fetching a comment:
 
 ```ruby
 map Comment do
@@ -97,8 +80,7 @@ end
 
 ### Polymorphic Associations
 
-There is also support for polymorphic associations. To use it, pass the
-`:polymorphic => true` option to the `#belongs_to` or `#has_many` methods:
+There is also support for polymorphic associations. To use it, pass the `:polymorphic => true` option to the `#belongs_to` or `#has_many` methods:
 
 ```ruby
 map Post do
@@ -112,18 +94,15 @@ end
 
 ### Customizing Attributes
 
-By default, attributes are mapped directly to methods on the record being
-serialized. So defining:
+By default, attributes are mapped directly to methods on the record being serialized. So defining:
 
 ```ruby
 map Post do
-  attributes :id, :title
+  attributes :title
 end
 ```
 
-will read `id` and `title` from the post and write it into the hash under the
-`:id` and `:title` keys. If you want to customize the value, you can use the
-`#attribute` method instead, and pass it a block:
+will read `title` from the post and write it into the hash under the `:title` key. If you want to customize the value, you can use the `#attribute` method instead, and pass it a block:
 
 ```ruby
 map Post do
@@ -131,20 +110,7 @@ map Post do
 end
 ```
 
-In the above example, we read the `headline` attribute from the post and write
-it into the payload under the `:title` key.
-
-### Alternate Output Formats
-
-By default the ActiveModel::Serializers output format is used. If you'd rather
-use JSON-API (or a custom format), you can do so by setting
-`serialization_format` in your controller. For instance, to use JSON-API:
-
-```ruby
-class ApplicationController < ActionController::Base
-  self.serialization_format = Ivy::Serializers::Formats::JSONAPI
-end
-```
+In the above example, we read the `headline` attribute from the post and write it into the payload under the `:title` key.
 
 ## Contributing
 

data/lib/ivy/serializers/attribute.rb

@@ -17,7 +17,7 @@ module Ivy
       end
 
       def get(resource)
-        @getter.call(resource)
+        @getter.call(resource) if resource
       end
     end
   end

data/lib/ivy/serializers/documents/document.rb

@@ -8,46 +8,49 @@ module Ivy
           @serializer = serializer
           @primary_resource_name = primary_resource_name
           @primary_resource = primary_resource
-          @linked_resources = Hash.new { |hash, klass| hash[klass] = Set.new }
+          @included_resources = Hash.new { |hash, klass| hash[klass] = Set.new }
         end
 
         def belongs_to(name, resource, options={})
-          link(resource) if options[:embed_in_root]
+          include_resource(resource) if resource && options[:embed_in_root]
         end
 
         def generate(generator)
           generator.document(self)
         end
 
-        def generate_linked(generator)
-          generator.linked(self) unless @linked_resources.empty?
+        def generate_attributes(generator, resource)
+          @serializer.attributes(generator, resource)
         end
 
-        def generate_linked_resources(generator)
-          @linked_resources.each_pair { |klass, resources| generator.linked_resources(klass, resources) }
+        def generate_included(generator)
+          generator.included(self) unless @included_resources.empty?
         end
 
-        def generate_links(generator, resource)
-          @serializer.links(generator, resource)
+        def generate_included_resources(generator)
+          @included_resources.each_pair { |klass, resources| generator.included_resources(klass, resources) }
+        end
+
+        def generate_relationships(generator, resource)
+          @serializer.relationships(generator, resource)
         end
 
         def generate_resource(generator, resource)
           @serializer.resource(generator, resource)
-          generator.links(resource)
         end
 
         def has_many(name, resources, options={})
-          link_many(resources) if options[:embed_in_root]
+          include_resources(resources) if options[:embed_in_root]
         end
 
         private
 
-        def link(resource)
-          @serializer.links(self, resource) if @linked_resources[resource.class].add?(resource)
+        def include_resource(resource)
+          @serializer.relationships(self, resource) if @included_resources[resource.class].add?(resource)
         end
 
-        def link_many(resources)
-          resources.each { |resource| link(resource) }
+        def include_resources(resources)
+          resources.each { |resource| include_resource(resource) }
         end
       end
     end

data/lib/ivy/serializers/documents/individual_resource.rb

@@ -4,8 +4,8 @@ module Ivy
   module Serializers
     module Documents
       class IndividualResource < Document
-        def generate_linked(generator)
-          @serializer.links(self, @primary_resource)
+        def generate_included(generator)
+          @serializer.relationships(self, @primary_resource)
           super
         end
 

data/lib/ivy/serializers/documents/resource_collection.rb

@@ -4,8 +4,8 @@ module Ivy
   module Serializers
     module Documents
       class ResourceCollection < Document
-        def generate_linked(generator)
-          @primary_resource.each { |resource| @serializer.links(self, resource) }
+        def generate_included(generator)
+          @primary_resource.each { |resource| @serializer.relationships(self, resource) }
           super
         end
 

data/lib/ivy/serializers/formats/active_model_serializers.rb

@@ -29,10 +29,6 @@ module Ivy
           super(singularize(primary_resource_name).to_sym, primary_resource)
         end
 
-        def primary_resources(primary_resources_name, primary_resources)
-          super(primary_resources_name, primary_resources)
-        end
-
         private
 
         def polymorphic_resource(resource)

data/lib/ivy/serializers/formats/json.rb

@@ -19,13 +19,17 @@ module Ivy
           @hash_gen.store(key, value)
         end
 
+        def attributes(resource)
+          @document.generate_attributes(self, resource)
+        end
+
         def belongs_to(name, resource, options={})
           id(name, resource)
         end
 
         def document(document)
           document.generate_primary_resource(self)
-          document.generate_linked(self)
+          document.generate_included(self)
         end
 
         def has_many(name, resources, options={})
@@ -40,19 +44,15 @@ module Ivy
           attribute(key, resources.map { |resource| extract_id(resource) })
         end
 
-        def linked(document)
-          document.generate_linked_resources(self)
+        def included(document)
+          document.generate_included_resources(self)
         end
 
-        def linked_resources(resource_class, resources)
+        def included_resources(resource_class, resources)
           key = key_for_collection(resource_class).to_sym
           @hash_gen.store_array(key) { resources(resources) }
         end
 
-        def links(resource)
-          @document.generate_links(self, resource)
-        end
-
         def primary_resource(primary_resource_name, primary_resource)
           @hash_gen.store_object(primary_resource_name) { resource(primary_resource) }
         end
@@ -61,7 +61,12 @@ module Ivy
           @hash_gen.store_array(primary_resources_name) { resources(primary_resources) }
         end
 
+        def relationships(resource)
+          @document.generate_relationships(self, resource)
+        end
+
         def resource(resource)
+          id(:id, resource)
           @document.generate_resource(self, resource)
         end
 
@@ -76,11 +81,11 @@ module Ivy
         private
 
         def extract_id(resource)
-          resource.id
+          resource.id if resource
         end
 
         def extract_type(resource)
-          ActiveSupport::Inflector.dasherize(ActiveSupport::Inflector.underscore(resource.class.name))
+          ActiveSupport::Inflector.dasherize(key_for_individual(resource.class))
         end
 
         def key_for_collection(resource_class)

data/lib/ivy/serializers/formats/json_api.rb

@@ -4,27 +4,26 @@ module Ivy
   module Serializers
     module Formats
       class JSONAPI < JSON
-        def attribute(key, value)
-          value = coerce_id(value) if key == :id
-          super
+        def attributes(resource)
+          @hash_gen.store_object(:attributes) { super }
         end
 
         def belongs_to(name, resource, options={})
-          @hash_gen.store_object(name) { linkage(resource) }
+          if resource
+            @hash_gen.store_object(name) { linkage(resource) }
+          else
+            @hash_gen.store(name, nil)
+          end
         end
 
         def has_many(name, resources, options={})
           @hash_gen.store_object(name) { linkages(resources) }
         end
 
-        def linked(document)
+        def included(document)
           @hash_gen.store_object(:included) { super }
         end
 
-        def links(document)
-          @hash_gen.store_object(:links) { super }
-        end
-
         def primary_resource(primary_resource_name, primary_resource)
           super(:data, primary_resource)
         end
@@ -33,6 +32,10 @@ module Ivy
           super(:data, primary_resources)
         end
 
+        def relationships(document)
+          @hash_gen.store_object(:relationships) { super }
+        end
+
         def resource(resource)
           super
           type(:type, resource)
@@ -49,7 +52,7 @@ module Ivy
         end
 
         def linkage(resource)
-          @hash_gen.store_object(:linkage) { linkage_object(resource) }
+          @hash_gen.store_object(:data) { linkage_object(resource) }
         end
 
         def linkage_object(resource)
@@ -58,7 +61,7 @@ module Ivy
         end
 
         def linkages(resources)
-          @hash_gen.store_array(:linkage) { linkage_objects(resources) }
+          @hash_gen.store_array(:data) { linkage_objects(resources) }
         end
 
         def linkage_objects(resources)

data/lib/ivy/serializers/mapping.rb

@@ -6,10 +6,8 @@ module Ivy
     class Mapping
       def initialize(klass)
         @attrs = {}
-        @links = {}
+        @relationships = {}
         @klass = klass
-
-        attribute(:id)
       end
 
       def attribute(name, &block)
@@ -21,19 +19,24 @@ module Ivy
       end
 
       def belongs_to(name, options={}, &block)
-        @links[name] = Relationships::BelongsTo.new(name, options, &block)
+        @relationships[name] = Relationships::BelongsTo.new(name, options, &block)
+      end
+
+      def generate_attributes(generator, resource)
+        @attrs.each_value { |attr| attr.generate(generator, resource) }
       end
 
       def has_many(name, options={}, &block)
-        @links[name] = Relationships::HasMany.new(name, options, &block)
+        @relationships[name] = Relationships::HasMany.new(name, options, &block)
       end
 
-      def links(generator, resource)
-        @links.each_value { |link| link.generate(generator, resource) }
+      def relationships(generator, resource)
+        @relationships.each_value { |relationship| relationship.generate(generator, resource) }
       end
 
       def resource(generator, resource)
-        @attrs.each_value { |attr| attr.generate(generator, resource) }
+        generator.attributes(resource) unless @attrs.empty?
+        generator.relationships(resource) unless @relationships.empty?
       end
     end
   end

data/lib/ivy/serializers/registry.rb

@@ -7,14 +7,18 @@ module Ivy
         @mappings = Hash.new { |hash, klass| hash[klass] = new_mapping(klass) }
       end
 
-      def links(generator, resource)
-        mapping_for(resource.class).links(generator, resource)
+      def attributes(generator, resource)
+        mapping_for(resource.class).generate_attributes(generator, resource)
       end
 
       def map(klass, &block)
         mapping_for(klass).instance_eval(&block)
       end
 
+      def relationships(generator, resource)
+        mapping_for(resource.class).relationships(generator, resource)
+      end
+
       def resource(generator, resource)
         mapping_for(resource.class).resource(generator, resource)
       end

data/lib/ivy/serializers/serializer.rb

@@ -6,12 +6,16 @@ module Ivy
       class << self
         attr_accessor :_registry
 
+        def attributes(generator, resource)
+          _registry.attributes(generator, resource)
+        end
+
         def inherited(base)
           base._registry = Registry.new
         end
 
-        def links(generator, resource)
-          _registry.links(generator, resource)
+        def relationships(generator, resource)
+          _registry.relationships(generator, resource)
         end
 
         def map(klass, &block)
@@ -23,8 +27,12 @@ module Ivy
         end
       end
 
-      def links(generator, links)
-        self.class.links(generator, links)
+      def attributes(generator, resource)
+        self.class.attributes(generator, resource)
+      end
+
+      def relationships(generator, resource)
+        self.class.relationships(generator, resource)
       end
 
       def resource(generator, resource)

data/lib/ivy/serializers/version.rb

@@ -1,5 +1,5 @@
 module Ivy
   module Serializers
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/spec/integration/formats/active_model_serializers_spec.rb

@@ -87,6 +87,12 @@ RSpec.describe Ivy::Serializers::Formats::ActiveModelSerializers do
           let(:resource) { post }
 
           it { should eq(:post => {:author_id => 1, :id => 1}) }
+
+          context 'with no related resource' do
+            let(:author) { nil }
+
+            it { should eq(:post => {:author_id => nil, :id => 1}) }
+          end
         end
 
         context 'for a resource collection' do
@@ -107,6 +113,12 @@ RSpec.describe Ivy::Serializers::Formats::ActiveModelSerializers do
           let(:resource) { post }
 
           it { should eq(:post => {:id => 1, :user_id => 1}) }
+
+          context 'with no related resource' do
+            let(:author) { nil }
+
+            it { should eq(:post => {:id => 1, :user_id => nil}) }
+          end
         end
 
         context 'for a resource collection' do
@@ -130,6 +142,12 @@ RSpec.describe Ivy::Serializers::Formats::ActiveModelSerializers do
             :authors => [{:id => 1}],
             :post => {:author_id => 1, :id => 1}
           ) }
+
+          context 'with no related resource' do
+            let(:author) { nil }
+
+            it { should eq(:post => {:author_id => nil, :id => 1}) }
+          end
         end
 
         context 'for a resource collection' do
@@ -153,6 +171,12 @@ RSpec.describe Ivy::Serializers::Formats::ActiveModelSerializers do
           let(:resource) { post }
 
           it { should eq(:post => {:author => {:id => 1, :type => 'author'}, :id => 1}) }
+
+          context 'with no related resource' do
+            let(:author) { nil }
+
+            it { should eq(:post => {:author => nil, :id => 1}) }
+          end
         end
 
         context 'for a resource collection' do

data/spec/integration/formats/json_api_spec.rb

@@ -19,8 +19,7 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         it { should eq({
           :data => {
             :type => 'post',
-            :id => '1',
-            :links => {}
+            :id => '1'
           }
         }) }
       end
@@ -31,8 +30,7 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
         it { should eq({
           :data => [{
             :type => 'post',
-            :id => '1',
-            :links => {}
+            :id => '1'
           }]
         }) }
       end
@@ -56,8 +54,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => {
               :type => 'post',
               :id => '1',
-              :title => 'title',
-              :links => {}
+              :attributes => {
+                :title => 'title'
+              }
             }
           }) }
         end
@@ -69,8 +68,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => [{
               :type => 'post',
               :id => '1',
-              :title => 'title',
-              :links => {}
+              :attributes => {
+                :title => 'title'
+              }
             }]
           }) }
         end
@@ -90,8 +90,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => {
               :type => 'post',
               :id => '1',
-              :headline => 'title',
-              :links => {}
+              :attributes => {
+                :headline => 'title'
+              }
             }
           }) }
         end
@@ -103,8 +104,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => [{
               :type => 'post',
               :id => '1',
-              :headline => 'title',
-              :links => {}
+              :attributes => {
+                :headline => 'title'
+              }
             }]
           }) }
         end
@@ -131,13 +133,27 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => {
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :author => {
-                  :linkage => {:id => '1', :type => 'author'}
+                  :data => {:id => '1', :type => 'author'}
                 }
               }
             }
           }) }
+
+          context 'with no related resource' do
+            let(:author) { nil }
+
+            it { should eq({
+              :data => {
+                :type => 'post',
+                :id => '1',
+                :relationships => {
+                  :author => nil
+                }
+              }
+            }) }
+          end
         end
 
         context 'for a resource collection' do
@@ -147,9 +163,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => [{
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :author => {
-                  :linkage => {:id => '1', :type => 'author'}
+                  :data => {:id => '1', :type => 'author'}
                 }
               }
             }]
@@ -171,13 +187,27 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => {
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :user => {
-                  :linkage => {:id => '1', :type => 'author'}
+                  :data => {:id => '1', :type => 'author'}
                 }
               }
             }
           }) }
+
+          context 'with no related resource' do
+            let(:author) { nil }
+
+            it { should eq({
+              :data => {
+                :type => 'post',
+                :id => '1',
+                :relationships => {
+                  :user => nil
+                }
+              }
+            }) }
+          end
         end
 
         context 'for a resource collection' do
@@ -187,9 +217,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => [{
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :user => {
-                  :linkage => {:id => '1', :type => 'author'}
+                  :data => {:id => '1', :type => 'author'}
                 }
               }
             }]
@@ -211,9 +241,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => {
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :author => {
-                  :linkage => {:id => '1', :type => 'author'}
+                  :data => {:id => '1', :type => 'author'}
                 }
               }
             },
@@ -221,11 +251,24 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :included => {
               :authors => [{
                 :id => '1',
-                :links => {},
                 :type => 'author'
               }]
             }
           }) }
+
+          context 'with no related resource' do
+            let(:author) { nil }
+
+            it { should eq({
+              :data => {
+                :type => 'post',
+                :id => '1',
+                :relationships => {
+                  :author => nil
+                }
+              }
+            }) }
+          end
         end
 
         context 'for a resource collection' do
@@ -235,9 +278,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => [{
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :author => {
-                  :linkage => {:id => '1', :type => 'author'}
+                  :data => {:id => '1', :type => 'author'}
                 }
               }
             }],
@@ -245,7 +288,6 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :included => {
               :authors => [{
                 :id => '1',
-                :links => {},
                 :type => 'author'
               }]
             }
@@ -267,13 +309,27 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => {
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :author => {
-                  :linkage => {:id => '1', :type => 'author'}
+                  :data => {:id => '1', :type => 'author'}
                 }
               }
             }
           }) }
+
+          context 'with no related resource' do
+            let(:author) { nil }
+
+            it { should eq({
+              :data => {
+                :type => 'post',
+                :id => '1',
+                :relationships => {
+                  :author => nil
+                }
+              }
+            }) }
+          end
         end
 
         context 'for a resource collection' do
@@ -283,9 +339,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => [{
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :author => {
-                  :linkage => {:id => '1', :type => 'author'}
+                  :data => {:id => '1', :type => 'author'}
                 }
               }
             }]
@@ -314,9 +370,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => {
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :comments => {
-                  :linkage => [{:id => '1', :type => 'comment'}]
+                  :data => [{:id => '1', :type => 'comment'}]
                 }
               }
             }
@@ -330,9 +386,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => [{
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :comments => {
-                  :linkage => [{:id => '1', :type => 'comment'}]
+                  :data => [{:id => '1', :type => 'comment'}]
                 }
               }
             }]
@@ -354,9 +410,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => {
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :replies => {
-                  :linkage => [{:id => '1', :type => 'comment'}]
+                  :data => [{:id => '1', :type => 'comment'}]
                 }
               }
             }
@@ -370,9 +426,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => [{
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :replies => {
-                  :linkage => [{:id => '1', :type => 'comment'}]
+                  :data => [{:id => '1', :type => 'comment'}]
                 }
               }
             }]
@@ -394,9 +450,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => {
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :comments => {
-                  :linkage => [{:id => '1', :type => 'comment'}]
+                  :data => [{:id => '1', :type => 'comment'}]
                 }
               }
             },
@@ -404,8 +460,7 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :included => {
               :comments => [{
                 :type => 'comment',
-                :id => '1',
-                :links => {}
+                :id => '1'
               }]
             }
           }) }
@@ -418,9 +473,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => [{
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :comments => {
-                  :linkage => [{:id => '1', :type => 'comment'}]
+                  :data => [{:id => '1', :type => 'comment'}]
                 }
               }
             }],
@@ -428,8 +483,7 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :included => {
               :comments => [{
                 :type => 'comment',
-                :id => '1',
-                :links => {}
+                :id => '1'
               }]
             }
           }) }
@@ -450,9 +504,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => {
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :comments => {
-                  :linkage => [{:id => '1', :type => 'comment'}]
+                  :data => [{:id => '1', :type => 'comment'}]
                 }
               }
             }
@@ -466,9 +520,9 @@ RSpec.describe Ivy::Serializers::Formats::JSONAPI do
             :data => [{
               :type => 'post',
               :id => '1',
-              :links => {
+              :relationships => {
                 :comments => {
-                  :linkage => [{:id => '1', :type => 'comment'}]
+                  :data => [{:id => '1', :type => 'comment'}]
                 }
               }
             }]

data/spec/integration/formats/json_spec.rb

@@ -0,0 +1,283 @@
+require 'ivy/serializers'
+
+RSpec.describe Ivy::Serializers::Formats::JSON do
+  let(:format) { described_class.new(document) }
+
+  describe '#as_json' do
+    let(:registry) { Ivy::Serializers::Registry.new }
+    let(:document) { Ivy::Serializers::Documents.create(registry, :posts, resource) }
+
+    subject { format.as_json }
+
+    context 'with default mapping' do
+      let(:post) { double('post', :id => 1) }
+
+      context 'for an individual resource' do
+        let(:resource) { post }
+
+        it { should eq(:posts => {:id => 1}) }
+      end
+
+      context 'for a resource collection' do
+        let(:resource) { [post] }
+
+        it { should eq(:posts => [{:id => 1}]) }
+      end
+    end
+
+    context 'with an attribute' do
+      let(:post_class) { double('Post') }
+      let(:post) { double('post', :class => post_class, :id => 1, :title => 'title') }
+
+      context 'with default options' do
+        before do
+          registry.map post_class do
+            attribute :title
+          end
+        end
+
+        context 'for an individual resource' do
+          let(:resource) { post }
+
+          it { should eq(:posts => {:id => 1, :title => 'title'}) }
+        end
+
+        context 'for a resource collection' do
+          let(:resource) { [post] }
+
+          it { should eq(:posts => [{:id => 1, :title => 'title'}]) }
+        end
+      end
+
+      context 'with a block provided' do
+        before do
+          registry.map post_class do
+            attribute(:headline) { |post| post.title }
+          end
+        end
+
+        context 'for an individual resource' do
+          let(:resource) { post }
+
+          it { should eq(:posts => {:id => 1, :headline => 'title'}) }
+        end
+
+        context 'for a resource collection' do
+          let(:resource) { [post] }
+
+          it { should eq(:posts => [{:id => 1, :headline => 'title'}]) }
+        end
+      end
+    end
+
+    context 'with a belongs_to relationship' do
+      let(:author_class) { double('Author', :name => 'Author') }
+      let(:author) { double('author', :class => author_class, :id => 1) }
+      let(:post_class) { double('Post') }
+      let(:post) { double('post', :author => author, :class => post_class, :id => 1) }
+
+      context 'with default options' do
+        before do
+          registry.map post_class do
+            belongs_to :author
+          end
+        end
+
+        context 'for an individual resource' do
+          let(:resource) { post }
+
+          it { should eq(:posts => {:author => 1, :id => 1}) }
+
+          context 'with no related resource' do
+            let(:author) { nil }
+
+            it { should eq(:posts => {:author => nil, :id => 1}) }
+          end
+        end
+
+        context 'for a resource collection' do
+          let(:resource) { [post] }
+
+          it { should eq(:posts => [{:author => 1, :id => 1}]) }
+        end
+      end
+
+      context 'with a block provided' do
+        before do
+          registry.map post_class do
+            belongs_to(:user) { |post| post.author }
+          end
+        end
+
+        context 'for an individual resource' do
+          let(:resource) { post }
+
+          it { should eq(:posts => {:id => 1, :user => 1}) }
+
+          context 'with no related resource' do
+            let(:author) { nil }
+
+            it { should eq(:posts => {:id => 1, :user => nil}) }
+          end
+        end
+
+        context 'for a resource collection' do
+          let(:resource) { [post] }
+
+          it { should eq(:posts => [{:id => 1, :user => 1}]) }
+        end
+      end
+
+      context 'with the :embed_in_root option' do
+        before do
+          registry.map post_class do
+            belongs_to :author, :embed_in_root => true
+          end
+        end
+
+        context 'for an individual resource' do
+          let(:resource) { post }
+
+          it { should eq(
+            :authors => [{:id => 1}],
+            :posts => {:author => 1, :id => 1}
+          ) }
+
+          context 'with no related resource' do
+            let(:author) { nil }
+
+            it { should eq(:posts => {:author => nil, :id => 1}) }
+          end
+        end
+
+        context 'for a resource collection' do
+          let(:resource) { [post] }
+
+          it { should eq(
+            :authors => [{:id => 1}],
+            :posts => [{:author => 1, :id => 1}]
+          ) }
+        end
+      end
+
+      context 'with the :polymorphic option' do
+        before do
+          registry.map post_class do
+            belongs_to :author, :polymorphic => true
+          end
+        end
+
+        context 'for an individual resource' do
+          let(:resource) { post }
+
+          it { should eq(:posts => {:author => 1, :id => 1}) }
+
+          context 'with no related resource' do
+            let(:author) { nil }
+
+            it { should eq(:posts => {:author => nil, :id => 1}) }
+          end
+        end
+
+        context 'for a resource collection' do
+          let(:resource) { [post] }
+
+          it { should eq(:posts => [{:author => 1, :id => 1}]) }
+        end
+      end
+    end
+
+    context 'with a has_many relationship' do
+      let(:comment_class) { double('Comment', :name => 'Comment') }
+      let(:comment) { double('comment', :class => comment_class, :id => 1) }
+      let(:post_class) { double('Post') }
+      let(:post) { double('post', :class => post_class, :comments => [comment], :id => 1) }
+
+      context 'with default options' do
+        before do
+          registry.map post_class do
+            has_many :comments
+          end
+        end
+
+        context 'for an individual resource' do
+          let(:resource) { post }
+
+          it { should eq(:posts => {:comments => [1], :id => 1}) }
+        end
+
+        context 'for a resource collection' do
+          let(:resource) { [post] }
+
+          it { should eq(:posts => [{:comments => [1], :id => 1}]) }
+        end
+      end
+
+      context 'with a block provided' do
+        before do
+          registry.map post_class do
+            has_many(:replies) { |post| post.comments }
+          end
+        end
+
+        context 'for an individual resource' do
+          let(:resource) { post }
+
+          it { should eq(:posts => {:id => 1, :replies => [1]}) }
+        end
+
+        context 'for a resource collection' do
+          let(:resource) { [post] }
+
+          it { should eq(:posts => [{:id => 1, :replies => [1]}]) }
+        end
+      end
+
+      context 'with the :embed_in_root option' do
+        before do
+          registry.map post_class do
+            has_many :comments, :embed_in_root => true
+          end
+        end
+
+        context 'for an individual resource' do
+          let(:resource) { post }
+
+          it { should eq(
+            :comments => [{:id => 1}],
+            :posts => {:comments => [1], :id => 1}
+          ) }
+        end
+
+        context 'for a resource collection' do
+          let(:resource) { [post] }
+
+          it { should eq(
+            :comments => [{:id => 1}],
+            :posts => [{:comments => [1], :id => 1}]
+          ) }
+        end
+      end
+
+      context 'with the :polymorphic option' do
+        before do
+          registry.map post_class do
+            has_many :comments, :polymorphic => true
+          end
+        end
+
+        context 'for an individual resource' do
+          let(:resource) { post }
+
+          it { should eq(:posts => {:comments => [1], :id => 1}) }
+        end
+
+        context 'for a resource collection' do
+          let(:resource) { [post] }
+
+          it { should eq(:posts => [{:comments => [1], :id => 1}]) }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ivy-serializers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Dray Lacy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -130,6 +130,7 @@ files:
 - lib/ivy/serializers/version.rb
 - spec/integration/formats/active_model_serializers_spec.rb
 - spec/integration/formats/json_api_spec.rb
+- spec/integration/formats/json_spec.rb
 - spec/integration/serializer_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -159,5 +160,6 @@ summary: JSON serialization for client-side apps.
 test_files:
 - spec/integration/formats/active_model_serializers_spec.rb
 - spec/integration/formats/json_api_spec.rb
+- spec/integration/formats/json_spec.rb
 - spec/integration/serializer_spec.rb
 - spec/spec_helper.rb