Add configurations/hooks for fields, include, and links. (#49)

Author: beauby

CHANGELOG.md

@@ -0,0 +1,45 @@
+### Added
+
+* Default configuration and hooks for the `links` parameter.
+* Default configuration and hooks for the `fields` parameter.
+* Default configuration and hooks for the `include` parameter.
+
+# v0.3.1
+
+### Fixed
+
+* Broken default inferrer.
+* Broken initializer generator.
+
+# v0.3.0
+
+### Added
+
+* Default configuration and hooks for the `class` parameter (for resources and
+    errors).
+* Default configuration and hooks for the `expose` parameter.
+* Default configuration and hooks for the `jsonapi_object` parameter.
+* Default configuration and hooks for pagination links.
+* Support for errors rendering.
+  * Automatic `ActionController::Errors` serialization.
+* Add configuration and initializer generator (`$ rails g jsonapi:initializer`).
+* Fragment caching.
+* Deserialization reverse-mapping available in controller via
+    `jsonapi_pointers`.
+
+### Changed
+
+* `class` renderer parameter now always takes a hash/lambda.
+* Rename `JSONAPI::Rails::ActionController` to `JSONAPI::Rails::Controller`.
+
+### Removed
+
+* `namespace` and `inferrer` renderer parameter.
+
+# v0.2.1
+
+# v0.2.0
+
+# v0.1.2
+
+# v0.1.1

jsonapi-rails.gemspec

@@ -21,5 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'rake',        '~> 11.3'
   spec.add_development_dependency 'rspec-rails', '~> 3.5'
+  spec.add_development_dependency 'with_model',  '~> 2.0'
   spec.add_development_dependency 'simplecov'
 end

lib/generators/jsonapi/initializer/templates/initializer.rb

@@ -27,6 +27,27 @@
   #   { url_helpers: ::Rails.application.routes.url_helpers }
   # }
   #
+  # # Set default fields.
+  # # A lambda/proc that will be eval'd in the controller context.
+  # config.jsonapi_fields = ->() { nil }
+  #
+  # # Uncomment the following to have it default to the `fields` query
+  # #   parameter.
+  # config.jsonapi_fields = lambda {
+  #   fields_param = params.to_unsafe_hash.fetch(:fields, {})
+  #   Hash[fields_param.map { |k, v| [k.to_sym, v.split(',').map!(&:to_sym)] }]
+  # }
+  #
+  # # Set default include.
+  # # A lambda/proc that will be eval'd in the controller context.
+  # config.jsonapi_include = ->() { nil }
+  #
+  # # Uncomment the following to have it default to the `include` query
+  # #   parameter.
+  # config.jsonapi_include = lambda {
+  #   params[:include]
+  # }
+  #
   # # Set a default pagination scheme.
-  # config.jsonapi_pagination = ->(_) { nil }
+  # config.jsonapi_pagination = ->(_) { {} }
 end

lib/jsonapi/rails.rb

@@ -2,3 +2,9 @@
 require 'jsonapi/serializable'
 require 'jsonapi/rails/configuration'
 require 'jsonapi/rails/railtie'
+
+module JSONAPI
+  module Rails
+    extend Configurable
+  end
+end

lib/jsonapi/rails/configuration.rb

@@ -4,42 +4,55 @@
 module JSONAPI
   module Rails
     class Configuration < ActiveSupport::InheritableOptions; end
-    DEFAULT_JSONAPI_CLASS = Hash.new do |h, k|
-      names = k.to_s.split('::')
-      klass = names.pop
-      h[k] = [*names, "Serializable#{klass}"].join('::').safe_constantize
-    end.freeze
-
-    DEFAULT_JSONAPI_ERRORS_CLASS = DEFAULT_JSONAPI_CLASS.dup.merge!(
-      'ActiveModel::Errors'.to_sym =>
+
+    # @private
+    module Configurable
+      DEFAULT_JSONAPI_CLASS = Hash.new do |h, k|
+        names = k.to_s.split('::')
+        klass = names.pop
+        h[k] = [*names, "Serializable#{klass}"].join('::').safe_constantize
+      end.freeze
+
+      DEFAULT_JSONAPI_ERRORS_CLASS = DEFAULT_JSONAPI_CLASS.dup.merge!(
+        'ActiveModel::Errors'.to_sym =>
         JSONAPI::Rails::SerializableActiveModelErrors,
-      'Hash'.to_sym => JSONAPI::Rails::SerializableErrorHash
-    ).freeze
+        'Hash'.to_sym => JSONAPI::Rails::SerializableErrorHash
+      ).freeze
 
-    DEFAULT_JSONAPI_OBJECT = {
-      version: '1.0'
-    }.freeze
+      DEFAULT_JSONAPI_OBJECT = {
+        version: '1.0'
+      }.freeze
 
-    DEFAULT_JSONAPI_EXPOSE = lambda {
-      { url_helpers: ::Rails.application.routes.url_helpers }
-    }.freeze
+      DEFAULT_JSONAPI_EXPOSE = lambda {
+        { url_helpers: ::Rails.application.routes.url_helpers }
+      }
 
-    DEFAULT_JSONAPI_PAGINATION = ->(_) { nil }
+      DEFAULT_JSONAPI_FIELDS = ->() { nil }
 
-    DEFAULT_CONFIG = {
-      jsonapi_class: DEFAULT_JSONAPI_CLASS,
-      jsonapi_errors_class: DEFAULT_JSONAPI_ERRORS_CLASS,
-      jsonapi_object: DEFAULT_JSONAPI_OBJECT,
-      jsonapi_expose: DEFAULT_JSONAPI_EXPOSE,
-      jsonapi_pagination: DEFAULT_JSONAPI_PAGINATION
-    }.freeze
+      DEFAULT_JSONAPI_INCLUDE = ->() { nil }
 
-    def self.configure
-      yield config
-    end
+      DEFAULT_JSONAPI_LINKS = ->() { {} }
+
+      DEFAULT_JSONAPI_PAGINATION = ->(_) { {} }
+
+      DEFAULT_CONFIG = {
+        jsonapi_class: DEFAULT_JSONAPI_CLASS,
+        jsonapi_errors_class: DEFAULT_JSONAPI_ERRORS_CLASS,
+        jsonapi_expose:  DEFAULT_JSONAPI_EXPOSE,
+        jsonapi_fields:  DEFAULT_JSONAPI_FIELDS,
+        jsonapi_include: DEFAULT_JSONAPI_INCLUDE,
+        jsonapi_links:   DEFAULT_JSONAPI_LINKS,
+        jsonapi_object:  DEFAULT_JSONAPI_OBJECT,
+        jsonapi_pagination: DEFAULT_JSONAPI_PAGINATION
+      }.freeze
+
+      def configure
+        yield config
+      end
 
-    def self.config
-      @config ||= JSONAPI::Rails::Configuration.new(DEFAULT_CONFIG)
+      def config
+        @config ||= JSONAPI::Rails::Configuration.new(DEFAULT_CONFIG)
+      end
     end
   end
 end

lib/jsonapi/rails/controller.rb

@@ -110,6 +110,24 @@ def jsonapi_expose
         instance_exec(&JSONAPI::Rails.config[:jsonapi_expose])
       end
 
+      # Hook for default fields.
+      # @return [Hash{Symbol=>Array<Symbol>}]
+      def jsonapi_fields
+        instance_exec(&JSONAPI::Rails.config[:jsonapi_fields])
+      end
+
+      # Hook for default includes.
+      # @return [IncludeDirective]
+      def jsonapi_include
+        instance_exec(&JSONAPI::Rails.config[:jsonapi_include])
+      end
+
+      # Hook for default links.
+      # @return [IncludeDirective]
+      def jsonapi_links
+        instance_exec(&JSONAPI::Rails.config[:jsonapi_links])
+      end
+
       # Hook for pagination scheme.
       # @return [Hash]
       def jsonapi_pagination(resources)

lib/jsonapi/rails/renderer.rb

@@ -18,17 +18,22 @@ def render(resources, options, controller)
 
       private
 
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       def default_options(options, controller, resources)
         options.dup.tap do |opts|
           opts[:class] ||= controller.jsonapi_class
-          if (pagination_links = controller.jsonapi_pagination(resources))
-            opts[:links] = (opts[:links] || {}).merge(pagination_links)
-          end
-          opts[:expose]  = controller.jsonapi_expose.merge(opts[:expose] || {})
+          opts[:links] =
+            controller.jsonapi_links
+                      .merge!(controller.jsonapi_pagination(resources))
+                      .merge!(opts[:links] || {})
+          opts[:expose] = controller.jsonapi_expose.merge!(opts[:expose] || {})
+          opts[:fields] ||= controller.jsonapi_fields
+          opts[:include] ||= controller.jsonapi_include
           opts[:jsonapi] = opts.delete(:jsonapi_object) ||
                            controller.jsonapi_object
         end
       end
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
     end
 
     # @private
@@ -52,6 +57,7 @@ def render(errors, options, controller)
       def default_options(options, controller)
         options.dup.tap do |opts|
           opts[:class] ||= controller.jsonapi_errors_class
+          opts[:links] = controller.jsonapi_links.merge!(opts[:links] || {})
           opts[:expose] =
             controller.jsonapi_expose
                       .merge(opts[:expose] || {})

spec/config_spec.rb

@@ -0,0 +1,94 @@
+require 'rails_helper'
+
+describe ActionController::Base, type: :controller do
+  with_model :User, scope: :all do
+    table do |t|
+      t.string :name
+      t.string :email
+    end
+  end
+
+  with_serializable :SerializableUser, scope: :all do
+    type 'users'
+    attributes :name, :email
+  end
+
+  before :all do
+    User.create(name: 'Lucas', email: 'lucas@jsonapi-rb.org')
+  end
+
+  context 'when using default configuration' do
+    controller do
+      def index
+        render jsonapi: User.all
+      end
+    end
+
+    subject { JSON.parse(response.body) }
+
+    it 'serializes all fields' do
+      get :index
+
+      expect(subject['data'][0]['attributes'].keys)
+        .to match_array(%w[name email])
+    end
+  end
+
+  context 'when using a custom configuration' do
+    controller do
+      def index
+        render jsonapi: User.all
+      end
+    end
+
+    subject { JSON.parse(response.body) }
+
+    it 'modifies serialized fields' do
+      with_config(jsonapi_fields: ->() { { users: [:name] } }) do
+        get :index
+      end
+
+      expect(subject['data'][0]['attributes'].keys)
+        .to match_array(%w[name])
+    end
+  end
+
+  context 'when customizing jsonapi_fields hook' do
+    controller do
+      def index
+        render jsonapi: User.all
+      end
+
+      def jsonapi_fields
+        { users: [:name] }
+      end
+    end
+
+    subject { JSON.parse(response.body) }
+
+    it 'modifies serialized fields' do
+      get :index
+
+      expect(subject['data'][0]['attributes'].keys)
+        .to match_array(%w[name])
+    end
+  end
+
+  context 'when prividing fields renderer option' do
+    controller do
+      def index
+        render jsonapi: User.all,
+               fields: { users: [:email] }
+      end
+    end
+
+    subject { JSON.parse(response.body) }
+
+    it 'modifies serialized fields' do
+      get :index
+
+      expect(subject['data'][0]['attributes'].keys)
+        .to match_array(%w[email])
+    end
+  end
+end