jsonapi-serializers 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9cf46e555c07d0768d46875258efd3ca3dbb900
-  data.tar.gz: 7f0939ef5407ab803142ebe688e534efecf4514b
+  metadata.gz: adb7f4634374e6733cd5a2e1dee11e7863b64922
+  data.tar.gz: 3d3d1a0225b0a96d681918dcc4fefde4e3df9668
 SHA512:
-  metadata.gz: df2806a436090f5e99edfbca11524aa142b378e05b89c4977d916a5c77580baf9f91aeec957565e4320414ce462a9a048e60907a26d6035fc04a85342a143e7b
-  data.tar.gz: 394f4d441286ee6ab265c41be01937664ebee6c7541ebfc47d8f1f888f6fc51e8a223ad5d67ca4287bab6d185c26a556a94221264535eabcd0e892eb9c2d0238
+  metadata.gz: fe35e4ad8cfa091a813fb5e30542482c5b4c9214b068cd5f490d4b71c4e155794c12d05be0ab17b95fc4c8ec7bd2f088c240c25727fc938c75df583596709791
+  data.tar.gz: 176d36a30d6165a1a7463d0cf87e36349fabb64bfdbeb09b7e67d5f86a1d3052610b8b870883426622a00e9018aabd47765bfc8546e6270a67e2be2e67f9567d

data/README.md

@@ -17,6 +17,7 @@ This library is up-to-date with the finalized v1 JSON API spec.
   * [Custom attributes](#custom-attributes)
   * [More customizations](#more-customizations)
   * [Base URL](#base-url)
+  * [Root metadata](#root-metadata)
 * [Relationships](#relationships)
   * [Compound documents and includes](#compound-documents-and-includes)
   * [Relationship path handling](#relationship-path-handling)
@@ -296,7 +297,7 @@ JSONAPI::Serializer.serialize(post, base_url: 'http://example.com')
 
 Note: if you override `self_link` in your serializer and leave out `base_url`, it will not be included.
 
-### Top-level metadata
+### Root metadata
 
 You can pass a `meta` argument to specify top-level metadata:
 
@@ -518,6 +519,7 @@ end
 
 ## Release notes
 
+* v0.3.1: Improve performance of loading included relationships.
 * v0.3.0: Add top-level `meta` support.
 * v0.2.6: Add `base_url` support.
 * v0.2.5: Allow disabling ambiguous collection checks for Sequel support.

data/lib/jsonapi-serializers/serializer.rb

@@ -91,7 +91,7 @@ module JSONAPI
       def relationships
         data = {}
         # Merge in data for has_one relationships.
-        has_one_relationships.each do |attribute_name, object|
+        has_one_relationships.each do |attribute_name, attr_data|
           formatted_attribute_name = format_name(attribute_name)
 
           data[formatted_attribute_name] = {}
@@ -102,6 +102,7 @@ module JSONAPI
           data[formatted_attribute_name]['links']['related'] = links_related if links_related
 
           if @_include_linkages.include?(formatted_attribute_name)
+            object = has_one_relationship(attribute_name, attr_data)
             if object.nil?
               # Spec: Resource linkage MUST be represented as one of the following:
               # - null for empty to-one relationships.
@@ -120,7 +121,7 @@ module JSONAPI
         end
 
         # Merge in data for has_many relationships.
-        has_many_relationships.each do |attribute_name, objects|
+        has_many_relationships.each do |attribute_name, attr_data|
           formatted_attribute_name = format_name(attribute_name)
 
           data[formatted_attribute_name] = {}
@@ -136,7 +137,7 @@ module JSONAPI
           # http://jsonapi.org/format/#document-structure-resource-relationships
           if @_include_linkages.include?(formatted_attribute_name)
             data[formatted_attribute_name].merge!({'data' => []})
-            objects = objects || []
+            objects = has_many_relationship(attribute_name, attr_data) || []
             objects.each do |obj|
               related_object_serializer = JSONAPI::Serializer.find_serializer(obj)
               data[formatted_attribute_name]['data'] << {
@@ -165,21 +166,29 @@ module JSONAPI
         data = {}
         self.class.to_one_associations.each do |attribute_name, attr_data|
           next if !should_include_attr?(attr_data[:options][:if], attr_data[:options][:unless])
-          data[attribute_name] = evaluate_attr_or_block(attribute_name, attr_data[:attr_or_block])
+          data[attribute_name] = attr_data
         end
         data
       end
 
+      def has_one_relationship(attribute_name, attr_data)
+        evaluate_attr_or_block(attribute_name, attr_data[:attr_or_block])
+      end
+
       def has_many_relationships
         return {} if self.class.to_many_associations.nil?
         data = {}
         self.class.to_many_associations.each do |attribute_name, attr_data|
           next if !should_include_attr?(attr_data[:options][:if], attr_data[:options][:unless])
-          data[attribute_name] = evaluate_attr_or_block(attribute_name, attr_data[:attr_or_block])
+          data[attribute_name] = attr_data
         end
         data
       end
 
+      def has_many_relationship(attribute_name, attr_data)
+        evaluate_attr_or_block(attribute_name, attr_data[:attr_or_block])
+      end
+
       def should_include_attr?(if_method_name, unless_method_name)
         # Allow "if: :show_title?" and "unless: :hide_title?" attribute options.
         show_attr = true
@@ -358,17 +367,28 @@ module JSONAPI
         is_valid_attr = false
         if serializer.has_one_relationships.has_key?(unformatted_attr_name)
           is_valid_attr = true
-          object = serializer.has_one_relationships[unformatted_attr_name]
+          attr_data = serializer.has_one_relationships[unformatted_attr_name]
+          object = serializer.has_one_relationship(unformatted_attr_name, attr_data)
         elsif serializer.has_many_relationships.has_key?(unformatted_attr_name)
           is_valid_attr = true
           is_collection = true
-          object = serializer.has_many_relationships[unformatted_attr_name]
+          attr_data = serializer.has_many_relationships[unformatted_attr_name]
+          object = serializer.has_many_relationship(unformatted_attr_name, attr_data)
         end
+
         if !is_valid_attr
           raise JSONAPI::Serializer::InvalidIncludeError.new(
             "'#{attribute_name}' is not a valid include.")
         end
 
+        if attribute_name.include?('_')
+          expected_name = serializer.format_name(attribute_name)
+
+          raise JSONAPI::Serializer::InvalidIncludeError.new(
+            "'#{attribute_name}' is not a valid include.  Did you mean '#{expected_name}' ?"
+          )
+        end
+
         # We're finding relationships for compound documents, so skip anything that doesn't exist.
         next if object.nil?
 

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
   end
 end

data/spec/serializer_spec.rb

@@ -364,6 +364,13 @@ describe JSONAPI::Serializer do
       error = JSONAPI::Serializer::AmbiguousCollectionError
       expect { JSONAPI::Serializer.serialize(posts) }.to raise_error(error)
     end
+
+    it 'raises error if include is not named correctly' do
+      post = create(:post)
+      error = JSONAPI::Serializer::InvalidIncludeError
+      expect { JSONAPI::Serializer.serialize(post, include: ['long_comments']) }.to raise_error(error)
+    end
+
     it 'can serialize a nil object when given serializer' do
       options = {serializer: MyApp::PostSerializer}
       expect(JSONAPI::Serializer.serialize(nil, options)).to eq({'data' => nil})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2015-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport