Allow using sparse fieldsets and extra fields (#77)

- Modifies the RenderOptions class to support using both sparse fieldsets
  and extra fields by merging the two when both present

Author: aribouius

lib/jsonapi_compliable/util/render_options.rb

@@ -12,15 +12,22 @@ def self.generate(object, query_hash, overrides = {})
           h[k] = [*names, "Serializable#{klass}"].join('::').safe_constantize
         end
 
+        fields = query_hash[:fields].dup
+        extra_fields = query_hash[:extra_fields]
+
+        if extra_fields.any? && fields.any?
+          extra_fields.each { |k,v| fields[k] = fields[k].to_a + v }
+        end
+
         options            = {}
         options[:class]    = inferrer
         options[:include]  = query_hash[:include]
         options[:jsonapi]  = resolved
-        options[:fields]   = query_hash[:fields]
+        options[:fields]   = fields
         options.merge!(overrides)
         options[:meta]   ||= {}
         options[:expose] ||= {}
-        options[:expose][:extra_fields] = query_hash[:extra_fields]
+        options[:expose][:extra_fields] = extra_fields
 
         if object.respond_to?(:resolve_stats)
           stats = object.resolve_stats

spec/integration/rails/finders_spec.rb

@@ -207,6 +207,14 @@ def json
         expect(book).to_not have_key('alternate_title')
         expect(book['pages']).to eq(500)
       end
+
+      it 'allows extra fields and sparse fieldsets for the sideloaded resource' do
+        get :index, params: { include: 'books', fields: { books: 'pages' }, extra_fields: { books: 'alternate_title' } }
+        book = json_includes('books')[0]['attributes']
+        expect(book).to have_key('pages')
+        expect(book).to have_key('alternate_title')
+        expect(book).to_not have_key('title')
+      end
     end
 
     context 'sideloading belongs_to' do
@@ -225,6 +233,14 @@ def json
         expect(state).to_not have_key('abbreviation')
         expect(state).to_not have_key('population')
       end
+
+      it 'allows extra fields and sparse fieldsets for the sideloaded resource' do
+        get :index, params: { include: 'state', fields: { states: 'name' }, extra_fields: { states: 'population' } }
+        state = json_includes('states')[0]['attributes']
+        expect(state).to have_key('name')
+        expect(state).to have_key('population')
+        expect(state).to_not have_key('abbreviation')
+      end
     end
 
     context 'sideloading has_one' do
@@ -243,6 +259,14 @@ def json
         expect(bio).to_not have_key('created_at')
         expect(bio).to_not have_key('picture')
       end
+
+      it 'allows extra fields and sparse fieldsets for the sideloaded resource' do
+        get :index, params: { include: 'bio', fields: { bios: 'description' }, extra_fields: { bios: 'created_at' } }
+        bio = json_includes('bios')[0]['attributes']
+        expect(bio).to have_key('description')
+        expect(bio).to have_key('created_at')
+        expect(bio).to_not have_key('picture')
+      end
     end
 
     context 'sideloading has_and_belongs_to_many' do
@@ -272,6 +296,14 @@ def json
         expect(hobby).to_not have_key('reason')
       end
 
+      it 'allows extra fields and sparse fieldsets for the sideloaded resource' do
+        get :index, params: { include: 'hobbies', fields: { hobbies: 'name' }, extra_fields: { hobbies: 'reason' } }
+        hobby = json_includes('hobbies')[0]['attributes']
+        expect(hobby).to have_key('name')
+        expect(hobby).to have_key('reason')
+        expect(hobby).to_not have_key('description')
+      end
+
       it 'does not duplicate results' do
         get :index, params: { include: 'hobbies' }
         author1_relationships = json['data'][0]['relationships']
@@ -355,6 +387,22 @@ def json
         expect(condo).to_not have_key('condo_price')
       end
 
+      it 'allows extra fields and sparse fieldsets for the sideloaded resource' do
+        get :index, params: {
+          include: 'dwelling',
+          fields: { houses: 'name', condos: 'condo_description' },
+          extra_fields: { houses: 'house_price', condos: 'condo_price' }
+        }
+        house = json_includes('houses')[0]['attributes']
+        condo = json_includes('condos')[0]['attributes']
+        expect(house).to have_key('name')
+        expect(house).to have_key('house_price')
+        expect(house).to_not have_key('house_description')
+        expect(condo).to have_key('condo_description')
+        expect(condo).to have_key('condo_price')
+        expect(condo).to_not have_key('name')
+      end
+
       it 'allows additional levels of nesting' do
         get :index, params: { include: 'dwelling.state' }
         expect(json_includes('states').length).to eq(1)