Conditional relationships should be removed from included when proc evaluates to false

Author: TrevorHinesley

lib/fast_jsonapi/serialization_core.rb

@@ -146,6 +146,8 @@ def get_included_records(record, includes_list, known_included_objects, params =
           items = parse_include_item(include_item)
           items.each do |item|
             next unless relationships_to_serialize && relationships_to_serialize[item]
+            conditional_proc = relationships_to_serialize[item][:conditional_proc]
+            next if conditional_proc && !conditional_proc.call(record, params)
             raise NotImplementedError if @relationships_to_serialize[item][:polymorphic].is_a?(Hash)
             record_type = @relationships_to_serialize[item][:record_type]
             serializer = @relationships_to_serialize[item][:serializer].to_s.constantize

spec/lib/object_serializer_spec.rb

@@ -349,11 +349,27 @@ class BlahSerializer
       expect(serializable_hash['data']['relationships'].has_key?('actors')).to be_truthy
     end
 
-    it "doesn't return optional relationship when relationship is not included" do
-      movie.actor_ids = []
-      json = MovieOptionalRelationshipSerializer.new(movie).serialized_json
-      serializable_hash = JSON.parse(json)
-      expect(serializable_hash['data']['relationships'].has_key?('actors')).to be_falsey
+    context "when relationship is not included" do
+      let(:json) {
+        MovieOptionalRelationshipSerializer.new(movie, options).serialized_json
+      }
+      let(:options) {
+        {}
+      }
+      let(:serializable_hash) {
+        JSON.parse(json)
+      }
+
+      it "doesn't return optional relationship" do
+        movie.actor_ids = []
+        expect(serializable_hash['data']['relationships'].has_key?('actors')).to be_falsey
+      end
+
+      it "doesn't include optional relationship" do
+        movie.actor_ids = []
+        options[:include] = [:actors]
+        expect(serializable_hash['included']).to be_blank
+      end
     end
   end
 
@@ -364,10 +380,25 @@ class BlahSerializer
       expect(serializable_hash['data']['relationships'].has_key?('owner')).to be_truthy
     end
 
-    it "doesn't return optional relationship when relationship is not included" do
-      json = MovieOptionalRelationshipWithParamsSerializer.new(movie, { params: { admin: false }}).serialized_json
-      serializable_hash = JSON.parse(json)
-      expect(serializable_hash['data']['relationships'].has_key?('owner')).to be_falsey
+    context "when relationship is not included" do
+      let(:json) {
+        MovieOptionalRelationshipWithParamsSerializer.new(movie, options).serialized_json
+      }
+      let(:options) {
+        { params: { admin: false }}
+      }
+      let(:serializable_hash) {
+        JSON.parse(json)
+      }
+
+      it "doesn't return optional relationship" do
+        expect(serializable_hash['data']['relationships'].has_key?('owner')).to be_falsey
+      end
+
+      it "doesn't include optional relationship" do
+        options[:include] = [:owner]
+        expect(serializable_hash['included']).to be_blank
+      end
     end
   end
 end