Links within data (#161)

Author: jshow

lib/fast_jsonapi/object_serializer.rb

@@ -38,7 +38,7 @@ def hash_for_one_record
 
       return serializable_hash unless @resource
 
-      serializable_hash[:data] = self.class.record_hash(@resource, @params)
+      serializable_hash[:data] = self.class.record_hash(@resource, @params, self)
       serializable_hash[:included] = self.class.get_included_records(@resource, @includes, @known_included_objects, @params) if @includes.present?
       serializable_hash
     end
@@ -49,7 +49,7 @@ def hash_for_collection
       data = []
       included = []
       @resource.each do |record|
-        data << self.class.record_hash(record, @params)
+        data << self.class.record_hash(record, @params, self)
         included.concat self.class.get_included_records(record, @includes, @known_included_objects, @params) if @includes.present?
       end
 
@@ -72,6 +72,7 @@ def process_options(options)
       @known_included_objects = {}
       @meta = options[:meta]
       @links = options[:links]
+      @data_links = {}
       @params = options[:params] || {}
       raise ArgumentError.new("`params` option passed to serializer must be a hash") unless @params.is_a?(Hash)
 
@@ -228,6 +229,11 @@ def fetch_polymorphic_option(options)
         {}
       end
 
+      def link(name, value = nil, &block)
+        self.data_links = {} unless data_links
+        self.data_links[name] = block || value
+      end
+
       def validate_includes!(includes)
         return if includes.blank?
 

lib/fast_jsonapi/serialization_core.rb

@@ -20,7 +20,8 @@ class << self
                       :record_id,
                       :cache_length,
                       :race_condition_ttl,
-                      :cached
+                      :cached,
+                      :data_links
       end
     end
 
@@ -61,6 +62,12 @@ def ids_hash_from_record_and_relationship(record, relationship, params = {})
         id_hash_from_record associated_object, polymorphic
       end
 
+      def links_hash(record, serializer_instance)
+        @data_links.each_with_object({}) do |(key, method), link_hash|
+          link_hash[key] = method.is_a?(Proc) ? serializer_instance.instance_exec(record, &method) : record.public_send(method)
+        end
+      end
+
       def attributes_hash(record, params = {})
         attributes_to_serialize.each_with_object({}) do |(key, method), attr_hash|
           attr_hash[key] = if method.is_a?(Proc)
@@ -83,13 +90,17 @@ def relationships_hash(record, relationships = nil, params = {})
         end
       end
 
-      def record_hash(record, params = {})
+      def record_hash(record, params = {}, serializer_instance)
         if cached
           record_hash = Rails.cache.fetch(record.cache_key, expires_in: cache_length, race_condition_ttl: race_condition_ttl) do
             temp_hash = id_hash(id_from_record(record), record_type, true)
             temp_hash[:attributes] = attributes_hash(record, params) if attributes_to_serialize.present?
             temp_hash[:relationships] = {}
             temp_hash[:relationships] = relationships_hash(record, cachable_relationships_to_serialize, params) if cachable_relationships_to_serialize.present?
+            if @data_links.present?
+              temp_links_hash = links_hash(record, serializer_instance)
+              temp_hash[:links] = temp_links_hash if temp_links_hash
+            end
             temp_hash
           end
           record_hash[:relationships] = record_hash[:relationships].merge(relationships_hash(record, uncachable_relationships_to_serialize, params)) if uncachable_relationships_to_serialize.present?
@@ -98,6 +109,10 @@ def record_hash(record, params = {})
           record_hash = id_hash(id_from_record(record), record_type, true)
           record_hash[:attributes] = attributes_hash(record, params) if attributes_to_serialize.present?
           record_hash[:relationships] = relationships_hash(record, nil, params) if relationships_to_serialize.present?
+          if @data_links.present?
+            temp_links_hash = links_hash(record, serializer_instance)
+            record_hash[:links] = temp_links_hash if temp_links_hash
+          end
           record_hash
         end
       end
@@ -153,7 +168,7 @@ def get_included_records(record, includes_list, known_included_objects, params =
               next if known_included_objects.key?(code)
 
               known_included_objects[code] = inc_obj
-              included_records << serializer.record_hash(inc_obj, params)
+              included_records << serializer.record_hash(inc_obj, params, serializer.new(record))
             end
           end
         end

spec/lib/object_serializer_class_methods_spec.rb

@@ -232,6 +232,51 @@
     end
   end
 
+  describe '#link' do
+    subject(:serializable_hash) { MovieSerializer.new(movie).serializable_hash }
+
+    after do
+      MovieSerializer.data_links = {}
+      ActorSerializer.data_links = {}
+    end
+
+    context 'with block calling instance method on serializer' do
+      before do
+        MovieSerializer.link(:self) do |movie_object|
+          movie_url(movie_object)
+        end
+      end
+      let(:url) { "http://movies.com/#{movie.id}" }
+
+      it 'returns correct hash when serializable_hash is called' do
+        expect(serializable_hash[:data][:links][:self]).to eq url
+      end
+    end
+
+    context 'with block and param' do
+      before do
+        MovieSerializer.link(:public_url) do |movie_object|
+          "http://movies.com/#{movie_object.id}"
+        end
+      end
+      let(:url) { "http://movies.com/#{movie.id}" }
+
+      it 'returns correct hash when serializable_hash is called' do
+        expect(serializable_hash[:data][:links][:public_url]).to eq url
+      end
+    end
+
+    context 'with method' do
+      before do
+        MovieSerializer.link(:object_id, :id)
+      end
+
+      it 'returns correct hash when serializable_hash is called' do
+        expect(serializable_hash[:data][:links][:object_id]).to eq movie.id
+      end
+    end
+  end
+
   describe '#key_transform' do
     subject(:hash) { movie_serializer_class.new([movie, movie], include: [:movie_type]).serializable_hash }
 

spec/lib/object_serializer_spec.rb

@@ -31,6 +31,30 @@
       expect(serializable_hash[:included]).to be nil
     end
 
+    it 'returns correct nested includes when serializable_hash is called' do
+      # 3 actors, 3 agencies
+      include_object_total = 6
+
+      options = {}
+      options[:include] = [:actors, :'actors.agency']
+      serializable_hash = MovieSerializer.new([movie], options).serializable_hash
+
+      expect(serializable_hash[:included]).to be_instance_of(Array)
+      expect(serializable_hash[:included].length).to eq include_object_total
+      (0..include_object_total-1).each do |include|
+        expect(serializable_hash[:included][include]).to be_instance_of(Hash)
+      end
+
+      options[:include] = [:'actors.agency']
+      serializable_hash = MovieSerializer.new([movie], options).serializable_hash
+
+      expect(serializable_hash[:included]).to be_instance_of(Array)
+      expect(serializable_hash[:included].length).to eq include_object_total
+      (0..include_object_total-1).each do |include|
+        expect(serializable_hash[:included][include]).to be_instance_of(Hash)
+      end
+    end
+
     it 'returns correct number of records when serialized_json is called for an array' do
       options = {}
       options[:meta] = { total: 2 }
@@ -259,4 +283,23 @@ class BlahSerializer
       expect(V1::BlahSerializer.record_type).to be :blah
     end
   end
+
+  context 'when serializing included, serialize any links' do
+    before do
+      ActorSerializer.link(:self) do |actor_object|
+        actor_url(actor_object)
+      end
+    end
+    subject(:serializable_hash) do
+      options = {}
+      options[:include] = [:actors]
+      MovieSerializer.new(movie, options).serializable_hash
+    end
+    let(:actor) { movie.actors.first }
+    let(:url) { "http://movies.com/actors/#{actor.id}" }
+
+    it 'returns correct hash when serializable_hash is called' do
+      expect(serializable_hash[:included][0][:links][:self]).to eq url
+    end
+  end
 end

spec/lib/serialization_core_spec.rb

@@ -70,7 +70,7 @@
     end
 
     it 'returns correct hash when record_hash is called' do
-      record_hash = MovieSerializer.send(:record_hash, movie)
+      record_hash = MovieSerializer.send(:record_hash, movie, nil)
       expect(record_hash[:id]).to eq movie.id.to_s
       expect(record_hash[:type]).to eq MovieSerializer.record_type
       expect(record_hash).to have_key(:attributes) if MovieSerializer.attributes_to_serialize.present?
@@ -82,7 +82,7 @@
       known_included_objects = {}
       included_records = []
       [movie, movie].each do |record|
-        included_records.concat MovieSerializer.send(:get_included_records, record, includes_list, known_included_objects)
+        included_records.concat MovieSerializer.send(:get_included_records, record, includes_list, known_included_objects, nil)
       end
       expect(included_records.size).to eq 3
     end

spec/shared/contexts/movie_context.rb

@@ -114,6 +114,10 @@ class Agency
       attr_accessor :id, :name, :actor_ids
     end
 
+    class Agency
+      attr_accessor :id, :name, :actor_ids
+    end
+
     class Supplier
       attr_accessor :id, :account_id
 
@@ -140,6 +144,10 @@ class MovieSerializer
       belongs_to :owner, record_type: :user
       belongs_to :movie_type
       has_one :advertising_campaign
+
+      def movie_url(movie)
+        "http://movies.com/#{movie.id}"
+      end
     end
 
     class MovieWithoutIdStructSerializer
@@ -176,6 +184,10 @@ class ActorSerializer
       belongs_to :agency
       has_many :awards
       belongs_to :agency
+
+      def actor_url(actor)
+        "http://movies.com/actors/#{actor.id}"
+      end
     end
 
     class AgencySerializer
@@ -219,6 +231,21 @@ class MovieSerializerWithAttributeBlock
       end
     end
 
+    class MovieSerializerWithAttributeBlock
+      include FastJsonapi::ObjectSerializer
+      set_type :movie
+      attributes :name, :release_year
+      attribute :title_with_year do |record|
+        "#{record.name} (#{record.release_year})"
+      end
+    end
+
+    class AgencySerializer
+      include FastJsonapi::ObjectSerializer
+      attributes :id, :name
+      has_many :actors
+    end
+
     class SupplierSerializer
       include FastJsonapi::ObjectSerializer
       set_type :supplier