Add hook for default jsonapi object. (#37)

* Add hook for default jsonapi object.

* Refactor renderers.

Author: beauby

lib/jsonapi/rails/action_controller.rb

@@ -42,6 +42,10 @@ def deserializable_resource(key, options = {}, &block)
         end
       end
 
+      def jsonapi_object
+        nil
+      end
+
       def jsonapi_expose
         {
           url_helpers: ::Rails.application.routes.url_helpers

lib/jsonapi/rails/railtie.rb

@@ -27,24 +27,13 @@ class Railtie < ::Rails::Railtie
             ::ActionDispatch::ParamsParser::DEFAULT_PARSERS[Mime[:jsonapi]] = PARSER
           end
 
-          ::ActionController::Renderers.add(:jsonapi) do |resources, options|
-            self.content_type ||= Mime[:jsonapi]
+          RENDERERS.each do |name, renderer|
+            ::ActionController::Renderers.add(name) do |resources, options|
+              # Renderer proc is evaluated in the controller context.
+              self.content_type ||= Mime[:jsonapi]
 
-            # Renderer proc is evaluated in the controller context.
-            if (pagination_links = jsonapi_pagination(resources))
-              (options[:links] ||= {}).merge!(pagination_links)
+              renderer.render(resources, options, self).to_json
             end
-            options[:expose] = jsonapi_expose.merge!(options[:expose] || {})
-
-            RENDERERS[:jsonapi].render(resources, options).to_json
-          end
-
-          ::ActionController::Renderers.add(:jsonapi_error) do |errors, options|
-            # Renderer proc is evaluated in the controller context.
-            options = options.merge(_jsonapi_pointers: jsonapi_pointers)
-            self.content_type ||= Mime[:jsonapi]
-
-            RENDERERS[:jsonapi_error].render(errors, options).to_json
           end
         end
       end

lib/jsonapi/rails/renderer.rb

@@ -9,11 +9,18 @@ def initialize(renderer = JSONAPI::Serializable::SuccessRenderer.new)
         freeze
       end
 
-      def render(resources, options)
-        opts = options.dup
-        opts[:jsonapi] = opts.delete(:jsonapi_object)
+      def render(resources, options, controller)
+        options = options.dup
 
-        @renderer.render(resources, opts)
+        if (pagination_links = controller.jsonapi_pagination(resources))
+          (options[:links] ||= {}).merge!(pagination_links)
+        end
+        options[:expose]  =
+          controller.jsonapi_expose.merge!(options[:expose] || {})
+        options[:jsonapi] =
+          options[:jsonapi_object] || controller.jsonapi_object
+
+        @renderer.render(resources, options)
       end
     end
 
@@ -24,8 +31,10 @@ def initialize(renderer = JSONAPI::Serializable::ErrorsRenderer.new)
         freeze
       end
 
-      def render(errors, options)
+      def render(errors, options, controller)
+        options = options.merge(_jsonapi_pointers: controller.jsonapi_pointers)
         # TODO(beauby): SerializableError inference on AR validation errors.
+
         @renderer.render(errors, options)
       end
     end

spec/action_controller_spec.rb

@@ -95,35 +95,64 @@ def create
     end
   end
 
-  describe '#render jsonapi:' do
-    controller do
-      def index
-        serializer = Class.new(JSONAPI::Serializable::Resource) do
-          type :users
-          attribute :name
+  describe '#render' do
+    context 'when calling render jsonapi: user' do
+      controller do
+        def index
+          serializer = Class.new(JSONAPI::Serializable::Resource) do
+            type :users
+            attribute :name
+          end
+          user = OpenStruct.new(id: 1, name: 'Lucas')
+
+          render jsonapi: user, class: serializer
         end
-        user = OpenStruct.new(id: 1, name: 'Lucas')
+      end
+
+      subject { JSON.parse(response.body) }
+      let(:serialized_user) do
+        {
+          'data' => {
+            'id' => '1',
+            'type' => 'users',
+            'attributes' => { 'name' => 'Lucas' }
+          }
+        }
+      end
+
+      it 'renders a JSON API success document' do
+        get :index
 
-        render jsonapi: user, class: serializer
+        expect(response.content_type).to eq('application/vnd.api+json')
+        is_expected.to eq(serialized_user)
       end
     end
 
-    subject { JSON.parse(response.body) }
-    let(:serialized_user) do
-      {
-        'data' => {
-          'id' => '1',
-          'type' => 'users',
-          'attributes' => { 'name' => 'Lucas' }
+    context 'when specifying a default jsonapi object' do
+      controller do
+        def index
+          render jsonapi: nil
+        end
+
+        def jsonapi_object
+          { version: '1.0' }
+        end
+      end
+
+      subject { JSON.parse(response.body) }
+      let(:document) do
+        {
+          'data' => nil,
+          'jsonapi' => { 'version' => '1.0' }
         }
-      }
-    end
+      end
 
-    it 'renders a JSON API document' do
-      get :index
+      it 'renders a JSON API success document' do
+        get :index
 
-      expect(response.content_type).to eq('application/vnd.api+json')
-      is_expected.to eq(serialized_user)
+        expect(response.content_type).to eq('application/vnd.api+json')
+        is_expected.to eq(document)
+      end
     end
   end
 end