jsonapi-serializers 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ecd4a38af955857a58bcadcdf88ef7e2f658f82
-  data.tar.gz: b47bc0a6ce3a5732d3f76bea5f87d425664afc9c
+  metadata.gz: 96dd9615a9ec47ce6f61ba580121e59c363f9ecb
+  data.tar.gz: c73a9d9a8562c78be05103036321ccd65beb6000
 SHA512:
-  metadata.gz: 84839b9fa483ad6cff15f7c152045ba5e78c0aed12e354898b80d1532350b4d5eefa05d45ee686ac402adf8c7e613fcb7cbb96aadd80b8d0c6b50b498e0ce6e7
-  data.tar.gz: afe84502165a840780bd94f54974a41a568f13e1c55efce92d21f7accb26c7aa07fbe30b2badff09eba60e4ca0b63637daa5864c4360fac3e8dfbdefe6b253e6
+  metadata.gz: fbe1da4cf4f43dc2a65aa4e7961a51f93a36e4df79c2c40cfd954d21dff648bce5f7ded25a963cc116cbba65d6e6c883d68524f0b79179642fb825024cfba7c7
+  data.tar.gz: e3c49d17d6cfbc2560369f2aec9f045d568daf78a63234d914979e5d56fb1deb2858bf8a52cf7994bb5a1978799f18f706f22ce38c0ec59fb0974e46ad8dc5c7

data/README.md

@@ -149,12 +149,20 @@ Note that the JSON:API spec distinguishes in how null/empty is handled for singl
 
 ### Custom attributes
 
-By default the serializer looks for the same name of the attribute on the object it is given. You can customize this behavior by providing a block to the attribute:
+By default the serializer looks for the same name of the attribute on the object it is given. You can customize this behavior by providing a block to `attribute`, `has_one`, or `has_many`:
 
 ```ruby
   attribute :content do
     object.body
   end
+
+  has_one :comment do
+    Comment.where(post: object).take!
+  end
+
+  has_many :authors do
+    Author.where(post: object)
+  end
 ```
 
 The block is evaluated within the serializer instance, so it has access to the `object` and `context` instance variables.
@@ -215,6 +223,8 @@ def relationship_related_link(attribute_name)
 end
 ```
 
+If you override `self_link`, `relationship_self_link`, or `relationship_related_link` to return `nil`, the link will be excluded from the serialized object.
+
 ## Relationships
 
 You can easily specify relationships with the `has_one` and `has_many` directives.
@@ -409,7 +419,7 @@ class Api::V1::ReposController < Api::V1::BaseController
   end
 end
 
-# lib/jsonapi_mimetypes.rb
+# config/initializers/jsonapi_mimetypes.rb
 # Without this mimetype registration, controllers will not automatically parse JSON API params.
 module JSONAPI
   MIMETYPE = "application/vnd.api+json"

data/lib/jsonapi-serializers/serializer.rb

@@ -86,12 +86,14 @@ module JSONAPI
         # Merge in data for has_one relationships.
         has_one_relationships.each do |attribute_name, object|
           formatted_attribute_name = format_name(attribute_name)
-          data[formatted_attribute_name] = {
-            'links' => {
-              'self' => relationship_self_link(attribute_name),
-              'related' => relationship_related_link(attribute_name),
-            },
-          }
+
+          data[formatted_attribute_name] = {}
+          links_self = relationship_self_link(attribute_name)
+          links_related = relationship_related_link(attribute_name)
+          data[formatted_attribute_name]['links'] = {} if links_self || links_related
+          data[formatted_attribute_name]['links']['self'] = links_self if links_self
+          data[formatted_attribute_name]['links']['related'] = links_related if links_related
+
           if @_include_linkages.include?(formatted_attribute_name)
             if object.nil?
               # Spec: Resource linkage MUST be represented as one of the following:
@@ -113,12 +115,14 @@ module JSONAPI
         # Merge in data for has_many relationships.
         has_many_relationships.each do |attribute_name, objects|
           formatted_attribute_name = format_name(attribute_name)
-          data[formatted_attribute_name] = {
-            'links' => {
-              'self' => relationship_self_link(attribute_name),
-              'related' => relationship_related_link(attribute_name),
-            },
-          }
+
+          data[formatted_attribute_name] = {}
+          links_self = relationship_self_link(attribute_name)
+          links_related = relationship_related_link(attribute_name)
+          data[formatted_attribute_name]['links'] = {} if links_self || links_related
+          data[formatted_attribute_name]['links']['self'] = links_self if links_self
+          data[formatted_attribute_name]['links']['related'] = links_related if links_related
+
           # Spec: Resource linkage MUST be represented as one of the following:
           # - an empty array ([]) for empty to-many relationships.
           # - an array of linkage objects for non-empty to-many relationships.

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.2.3'
+    VERSION = '0.2.4'
   end
 end

data/spec/serializer_spec.rb

@@ -107,6 +107,27 @@ describe JSONAPI::Serializer do
           },
         })
       end
+      it 'does not include links if relationship_self_link and relationship_related_link are nil' do
+        post = create(:post)
+        primary_data = serialize_primary(post, {serializer: MyApp::PostSerializerWithoutLinks})
+        expect(primary_data).to eq({
+          'id' => '1',
+          'type' => 'posts',
+          'attributes' => {
+            'title' => 'Title for Post 1',
+            'long-content' => 'Body for Post 1',
+          },
+          'links' => {
+            'self' => '/posts/1',
+          },
+          # This is technically invalid since relationships MUST contain at least one of links,
+          # data, or meta, but we leave that up to the user.
+          'relationships' => {
+            'author' => {},
+            'long-comments' => {},
+          },
+        })
+      end
     end
     context 'with linkage includes' do
       it 'can serialize primary data for a null to-one relationship' do

data/spec/support/serializers.rb

@@ -64,6 +64,7 @@ module MyApp
 
   class PostSerializerWithMetadata
     include JSONAPI::Serializer
+    include JSONAPI::Serializer
 
     attribute :title
     attribute :long_content do
@@ -83,8 +84,6 @@ module MyApp
   end
 
   class PostSerializerWithContextHandling < SimplestPostSerializer
-    include JSONAPI::Serializer
-
     attribute :body, if: :show_body?, unless: :hide_body?
 
     def show_body?
@@ -96,6 +95,26 @@ module MyApp
     end
   end
 
+  class PostSerializerWithoutLinks
+    include JSONAPI::Serializer
+
+    attribute :title
+    attribute :long_content do
+      object.body
+    end
+
+    has_one :author
+    has_many :long_comments
+
+    def relationship_self_link(attribute_name)
+      nil
+    end
+
+    def relationship_related_link(attribute_name)
+      nil
+    end
+  end
+
   class EmptySerializer
     include JSONAPI::Serializer
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Pure Ruby readonly serializers for the JSON:API spec.
@@ -132,4 +132,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/factory.rb
 - spec/support/serializers.rb
-has_rdoc: