Merge pull request #304 from cerebris/resource_linkage

Resource linkage

Author: dgeb

README.md

@@ -1277,6 +1277,11 @@ JSONAPI.configure do |config|
   # catch this error and render a 403 status code, you should add
   # the `Pundit::NotAuthorizedError` to the `exception_class_whitelist`.
   config.exception_class_whitelist = []
+  
+  # Resource Linkage
+  # Controls the serialization of resource linkage for non compound documents
+  # NOTE: always_include_has_many_linkage_data is not currently implemented
+  config.always_include_has_one_linkage_data = false  
 end
 ```
 

lib/jsonapi/configuration.rb

@@ -17,7 +17,9 @@ class Configuration
                 :top_level_links_include_pagination,
                 :top_level_meta_include_record_count,
                 :top_level_meta_record_count_key,
-                :exception_class_whitelist
+                :exception_class_whitelist,
+                :always_include_to_one_linkage_data,
+                :always_include_to_many_linkage_data
 
     def initialize
       #:underscored_key, :camelized_key, :dasherized_key, or custom
@@ -54,6 +56,12 @@ def initialize
       # catch this error and render a 403 status code, you should add
       # the `Pundit::NotAuthorizedError` to the `exception_class_whitelist`.
       self.exception_class_whitelist = []
+
+      # Resource Linkage
+      # Controls the serialization of resource linkage for non compound documents
+      # NOTE: always_include_to_many_linkage_data is not currently implemented
+      self.always_include_to_one_linkage_data = false
+      self.always_include_to_many_linkage_data = false
     end
 
     def json_key_format=(format)
@@ -88,6 +96,10 @@ def operations_processor=(operations_processor)
     attr_writer :top_level_meta_record_count_key
 
     attr_writer :exception_class_whitelist
+
+    attr_writer :always_include_to_one_linkage_data
+
+    attr_writer :always_include_to_many_linkage_data
   end
 
   class << self

lib/jsonapi/relationship.rb

@@ -1,7 +1,7 @@
 module JSONAPI
   class Relationship
     attr_reader :acts_as_set, :foreign_key, :type, :options, :name,
-                :class_name, :polymorphic
+                :class_name, :polymorphic, :always_include_linkage_data
 
     def initialize(name, options = {})
       @name = name.to_s
@@ -11,6 +11,7 @@ def initialize(name, options = {})
       @module_path = options[:module_path] || ''
       @relation_name = options.fetch(:relation_name, @name)
       @polymorphic = options.fetch(:polymorphic, false) == true
+      @always_include_linkage_data = options.fetch(:always_include_linkage_data, false) == true
     end
 
     alias_method :polymorphic?, :polymorphic

lib/jsonapi/resource.rb

@@ -653,7 +653,7 @@ def check_reserved_resource_name(type, name)
       def check_reserved_attribute_name(name)
         # Allow :id since it can be used to specify the format. Since it is a method on the base Resource
         # an attribute method won't be created for it.
-        if [:type, :href, :links].include?(name.to_sym)
+        if [:type, :href, :links, :model].include?(name.to_sym)
           warn "[NAME COLLISION] `#{name}` is a reserved key in #{@@resource_types[_type]}."
         end
       end

lib/jsonapi/resource_serializer.rb

@@ -21,6 +21,10 @@ def initialize(primary_resource_klass, options = {})
       @include_directives = options[:include_directives]
       @key_formatter      = options.fetch(:key_formatter, JSONAPI.configuration.key_formatter)
       @url_generator      = generate_link_builder(primary_resource_klass, options)
+      @always_include_to_one_linkage_data = options.fetch(:always_include_to_one_linkage_data,
+                                                          JSONAPI.configuration.always_include_to_one_linkage_data)
+      @always_include_to_many_linkage_data = options.fetch(:always_include_to_many_linkage_data,
+                                                           JSONAPI.configuration.always_include_to_many_linkage_data)
     end
 
     # Converts a single resource, or an array of resources to a hash, conforming to the JSONAPI structure
@@ -80,18 +84,18 @@ def process_primary(source, include_directives)
       if source.respond_to?(:to_ary)
         source.each do |resource|
           id = resource.id
-          if already_serialized?(@primary_class_name, id)
+          if already_serialized?(resource.class._type, id)
             set_primary(@primary_class_name, id)
           end
 
-          add_included_object(@primary_class_name, id, object_hash(resource,  include_directives), true)
+          add_included_object(id, object_hash(resource,  include_directives), true)
         end
       else
         return {} if source.nil?
 
         resource = source
         id = resource.id
-        add_included_object(@primary_class_name, id, object_hash(source,  include_directives), true)
+        add_included_object(id, object_hash(source, include_directives), true)
       end
     end
 
@@ -171,7 +175,7 @@ def relationship_data(source, include_directives)
                 type = relationship.type_for_source(source)
                 relationships_only = already_serialized?(type, id)
                 if include_linkage && !relationships_only
-                  add_included_object(type, id, object_hash(resource, ia))
+                  add_included_object(id, object_hash(resource, ia))
                 elsif include_linked_children || relationships_only
                   relationship_data(resource, ia)
                 end
@@ -182,7 +186,7 @@ def relationship_data(source, include_directives)
                 id = resource.id
                 relationships_only = already_serialized?(type, id)
                 if include_linkage && !relationships_only
-                  add_included_object(type, id, object_hash(resource, ia))
+                  add_included_object(id, object_hash(resource, ia))
                 elsif include_linked_children || relationships_only
                   relationship_data(resource, ia)
                 end
@@ -236,12 +240,13 @@ def to_many_linkage(source, relationship)
       linkage
     end
 
-    def link_object_to_one(source, relationship)
+    def link_object_to_one(source, relationship, include_linkage)
+      include_linkage = include_linkage | @always_include_to_one_linkage_data | relationship.always_include_linkage_data
       link_object_hash = {}
       link_object_hash[:links] = {}
       link_object_hash[:links][:self] = self_link(source, relationship)
       link_object_hash[:links][:related] = related_link(source, relationship)
-      link_object_hash[:data] = to_one_linkage(source, relationship)
+      link_object_hash[:data] = to_one_linkage(source, relationship) if include_linkage
       link_object_hash
     end
 
@@ -256,7 +261,7 @@ def link_object_to_many(source, relationship, include_linkage)
 
     def link_object(source, relationship, include_linkage = false)
       if relationship.is_a?(JSONAPI::Relationship::ToOne)
-        link_object_to_one(source, relationship)
+        link_object_to_one(source, relationship, include_linkage)
       elsif relationship.is_a?(JSONAPI::Relationship::ToMany)
         link_object_to_many(source, relationship, include_linkage)
       end
@@ -290,12 +295,13 @@ def set_primary(type, id)
     end
 
     # Collects the hashes for all objects processed by the serializer
-    def add_included_object(type, id, object_hash, primary = false)
-      type = format_key(type)
+    def add_included_object(id, object_hash, primary = false)
+      type = object_hash['type']
 
       @included_objects[type] = {} unless @included_objects.key?(type)
 
       if already_serialized?(type, id)
+        @included_objects[type][id][:object_hash].merge!(object_hash)
         set_primary(type, id) if primary
       else
         @included_objects[type].store(id, primary: primary, object_hash: object_hash)

test/controllers/controller_test.rb

@@ -275,7 +275,6 @@ def test_show_single_with_fields
     assert_response :success
     assert json_response['data'].is_a?(Hash)
     assert_nil json_response['data']['attributes']
-    assert_equal '1', json_response['data']['relationships']['author']['data']['id']
   end
 
   def test_show_single_with_fields_string
@@ -326,7 +325,6 @@ def test_create_simple
 
     assert_response :created
     assert json_response['data'].is_a?(Hash)
-    assert_equal '3', json_response['data']['relationships']['author']['data']['id']
     assert_equal 'JR is Great', json_response['data']['attributes']['title']
     assert_equal 'JSONAPIResources is the greatest thing since unsliced bread.', json_response['data']['attributes']['body']
   end
@@ -431,7 +429,7 @@ def test_create_multiple
     assert_response :created
     assert json_response['data'].is_a?(Array)
     assert_equal json_response['data'].size, 2
-    assert_equal json_response['data'][0]['relationships']['author']['data']['id'], '3'
+    assert_nil json_response['data'][0]['relationships']['author']['data']
     assert_match /JR is Great/, response.body
     assert_match /Ember is Great/, response.body
   end
@@ -561,7 +559,8 @@ def test_create_with_links_to_many_type_ids
                author: {data: {type: 'people', id: '3'}},
                tags: {data: [{type: 'tags', id: 3}, {type: 'tags', id: 4}]}
              }
-           }
+           },
+           include: 'author'
          }
 
     assert_response :created
@@ -585,7 +584,8 @@ def test_create_with_links_to_many_array
                author: {data: {type: 'people', id: '3'}},
                tags: {data: [{type: 'tags', id: 3}, {type: 'tags', id: 4}]}
              }
-           }
+           },
+           include: 'author'
          }
 
     assert_response :created
@@ -639,7 +639,7 @@ def test_update_with_links
               tags: {data: [{type: 'tags', id: 3}, {type: 'tags', id: 4}]}
             }
           },
-          include: 'tags'
+          include: 'tags,author,section'
         }
 
     assert_response :success
@@ -709,7 +709,7 @@ def test_update_remove_links
               tags: []
             }
           },
-          include: 'tags'
+          include: 'tags,author,section'
         }
 
     assert_response :success
@@ -1246,15 +1246,11 @@ def test_update_multiple
 
     assert_response :success
     assert_equal json_response['data'].size, 2
-    assert_equal json_response['data'][0]['relationships']['author']['data']['id'], '3'
-    assert_equal json_response['data'][0]['relationships']['section']['data']['id'], javascript.id.to_s
     assert_equal json_response['data'][0]['attributes']['title'], 'A great new Post QWERTY'
     assert_equal json_response['data'][0]['attributes']['body'], 'AAAA'
     assert matches_array?([{'type' => 'tags', 'id' => '3'}, {'type' => 'tags', 'id' => '4'}],
                           json_response['data'][0]['relationships']['tags']['data'])
 
-    assert_equal json_response['data'][1]['relationships']['author']['data']['id'], '3'
-    assert_equal json_response['data'][1]['relationships']['section']['data']['id'], javascript.id.to_s
     assert_equal json_response['data'][1]['attributes']['title'], 'A great new Post ASDFG'
     assert_equal json_response['data'][1]['attributes']['body'], 'Not First!!!!'
     assert matches_array?([{'type' => 'tags', 'id' => '3'}, {'type' => 'tags', 'id' => '4'}],
@@ -1601,7 +1597,7 @@ def test_create_expense_entries_underscored
                iso_currency: {data: {type: 'iso_currencies', id: 'USD'}}
              }
            },
-           include: 'iso_currency',
+           include: 'iso_currency,employee',
            fields: {expense_entries: 'id,transaction_date,iso_currency,cost,employee'}
          }
 
@@ -1632,7 +1628,7 @@ def test_create_expense_entries_camelized_key
                isoCurrency: {data: {type: 'iso_currencies', id: 'USD'}}
              }
            },
-           include: 'isoCurrency',
+           include: 'isoCurrency,employee',
            fields: {expenseEntries: 'id,transactionDate,isoCurrency,cost,employee'}
          }
 
@@ -1663,7 +1659,7 @@ def test_create_expense_entries_dasherized_key
                'iso-currency' => {data: {type: 'iso_currencies', id: 'USD'}}
              }
            },
-           include: 'iso-currency',
+           include: 'iso-currency,employee',
            fields: {'expense-entries' => 'id,transaction-date,iso-currency,cost,employee'}
          }
 
@@ -1948,18 +1944,13 @@ def test_get_related_resource
              links: {
                self: 'http://test.host/people/1/relationships/preferences',
                related: 'http://test.host/people/1/preferences'
-             },
-             data: {
-               type: 'preferences',
-               id: '1'
              }
            },
            "hair-cut" => {
              "links" => {
                "self" => "http://test.host/people/1/relationships/hair_cut",
                "related" => "http://test.host/people/1/hair_cut"
-             },
-             "data" => nil
+             }
            },
            vehicles: {
              links: {
@@ -2160,7 +2151,6 @@ def test_create_simple_namespaced
 
     assert_response :created
     assert json_response['data'].is_a?(Hash)
-    assert_equal '3', json_response['data']['relationships']['writer']['data']['id']
     assert_equal 'JR - now with Namespacing', json_response['data']['attributes']['title']
     assert_equal 'JSONAPIResources is the greatest thing since unsliced bread now that it has namespaced resources.',
                  json_response['data']['attributes']['body']

test/fixtures/active_record.rb

@@ -195,6 +195,11 @@
 
   create_table :vehicles, force: true do |t|
     t.string :type
+    t.string :make
+    t.string :vehicle_model
+    t.string :length_at_water_line
+    t.string :drive_layout
+    t.string :serial_number
     t.integer :person_id
   end
 end
@@ -644,12 +649,15 @@ def self.verify_custom_filter(filter, values, context)
 
 class VehicleResource < JSONAPI::Resource
   has_one :person
+  attributes :make, :vehicle_model, :serial_number
 end
 
 class CarResource < VehicleResource
+  attributes :drive_layout
 end
 
 class BoatResource < VehicleResource
+  attributes :length_at_water_line
 end
 
 class CommentResource < JSONAPI::Resource
@@ -893,7 +901,7 @@ class DocumentResource < JSONAPI::Resource
 
 class ProductResource < JSONAPI::Resource
   attribute :name
-  has_one :picture
+  has_one :picture, always_include_linkage_data: true
 
   def picture_id
     model.picture.id

test/fixtures/vehicles.yml

@@ -1,8 +1,16 @@
-car:
+Miata:
   id: 1
   type: Car
+  make: Mazda
+  vehicle_model: Miata MX5
+  drive_layout: Front Engine RWD
+  serial_number: 32432adfsfdysua
   person_id: 1
-boat:
+Launch20:
   id: 2
   type: Boat
+  make: Chris-Craft
+  vehicle_model: Launch 20
+  length_at_water_line: 15.5ft
+  serial_number: 434253JJJSD
   person_id: 1