Merge branch 'master' into resources-0.9.10

Author: tiagopog

jsonapi-utils.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
  spec.add_runtime_dependency 'jsonapi-resources', '0.9.10'
 
  spec.add_development_dependency 'bundler', '~> 1.10'
- spec.add_development_dependency 'rake', '~> 10.0'
+ spec.add_development_dependency 'rake', '~> 12.3.3'
  spec.add_development_dependency 'rails', ENV['RAILS_VERSION'] || '~> 5.1'
  spec.add_development_dependency 'sqlite3', '~> 1.3.6'
  spec.add_development_dependency 'rspec-rails', '~> 3.1'

lib/jsonapi/utils/response/formatters.rb

@@ -120,8 +120,8 @@ def build_response_document(object, options)
  # @option options [JSONAPI::Resource] :resource which resource class to be used
  # rather than using the default one (inferred)
  #
- # @option options [ActiveRecord::Base, JSONAPI::Resource] :source source of related resource,
- # the result should be interpreted as a related resources response
+ # @option options [ActiveRecord::Base, JSONAPI::Resource] :source parent model/resource
+ # of the related resource
  #
  # @option options [String, Symbol] :relationship which relationship the data is from
  #
@@ -136,27 +136,35 @@ def build_collection_result(object, options)
  records = build_collection(object, options)
  result_options = result_options(object, options)
 
- if options[:source].present? && related_resource_operation?
+ if related_resource_operation?(options)
  source_resource = turn_source_into_resource(options[:source])
  relationship_type = get_source_relationship(options)
- JSONAPI::RelatedResourcesOperationResult.new(:ok,
- source_resource,
- relationship_type,
- records,
- result_options
- )
+ JSONAPI::RelatedResourcesOperationResult.new(:ok, source_resource, relationship_type, records, result_options)
  else
  JSONAPI::ResourcesOperationResult.new(:ok, records, result_options)
  end
  end
 
  # Is this a request for related resources?
  #
+ # In order to answer that it needs to check for some {options}
+ # controller params like {params[:source]} and {params[:relationship]}.
+ #
+ # @option options [Boolean] :related when true, jsonapi-utils infers the parent and
+ # related resources from controller's {params} values.
+ #
+ # @option options [ActiveRecord::Base, JSONAPI::Resource] :source parent model/resource
+ # of the related resource
+ #
+ # @option options [String, Symbol] :relationship which relationship the data is from
+ #
  # @return [Boolean]
  #
  # @api private
- def related_resource_operation?
- params[:source].present? && params[:relationship].present?
+ def related_resource_operation?(options)
+ (options[:related] || options[:source].present?) &&
+ params[:source].present? &&
+ params[:relationship].present?
  end
 
  # Apply a proper action setup for custom requests/actions.
@@ -263,16 +271,15 @@ def get_source_relationship(options)
  # @api private
  def result_options(records, options)
  {}.tap do |data|
- if JSONAPI.configuration.default_paginator != :none &&
- JSONAPI.configuration.top_level_links_include_pagination
+ if include_pagination_links?
  data[:pagination_params] = pagination_params(records, options)
  end
 
  if JSONAPI.configuration.top_level_meta_include_record_count
  data[:record_count] = record_count_for(records, options)
  end
 
- if JSONAPI.configuration.top_level_meta_include_page_count
+ if include_page_count?
  data[:page_count] = page_count_for(data[:record_count])
  end
  end

lib/jsonapi/utils/support/pagination.rb

@@ -4,20 +4,40 @@ module Support
  module Pagination
  RecordCountError = Class.new(ArgumentError)
 
+ # Check whether pagination links should be included.
+ #
+ # @api public
+ # @return [Boolean]
+ def include_pagination_links?
+ JSONAPI.configuration.default_paginator != :none &&
+ JSONAPI.configuration.top_level_links_include_pagination
+ end
+
+ # Check whether pagination's page count should be included
+ # on the "meta" key.
+ #
+ # @api public
+ # @return [Boolean]
+ def include_page_count?
+ JSONAPI.configuration.top_level_meta_include_page_count
+ end
+
  # Apply proper pagination to the records.
  #
  # @param records [ActiveRecord::Relation, Array] collection of records
  # e.g.: User.all or [{ id: 1, name: 'Tiago' }, { id: 2, name: 'Doug' }]
  #
- # @param options [Hash] JU's options
+ # @param options [Hash] JSONAPI::Utils' options
  # e.g.: { resource: V2::UserResource, count: 100 }
  #
  # @return [ActiveRecord::Relation, Array]
  #
  # @api public
  def apply_pagination(records, options = {})
- return records unless apply_pagination?(options)
- records.is_a?(Array) ? records[paginate_with(:range)] : paginate_with(:paginator).apply(records, nil)
+ if !apply_pagination?(options) then records
+ elsif records.is_a?(Array) then records[paginate_with(:range)]
+ else paginate_with(:paginator).apply(records, nil)
+ end
  end
 
  # Mount pagination params for JSONAPI::ResourcesOperationResult.
@@ -32,9 +52,10 @@ def apply_pagination(records, options = {})
  # @return [Hash]
  # e.g.: {"first"=>{"number"=>1, "size"=>2}, "next"=>{"number"=>2, "size"=>2}, "last"=>{"number"=>2, "size"=>2}}
  #
+ #
  # @api public
  def pagination_params(records, options)
- return {} unless JSONAPI.configuration.top_level_links_include_pagination
+ return {} unless include_pagination_links?
  paginator.links_page_params(record_count: record_count_for(records, options))
  end
 

spec/features/page_count_spec.rb

@@ -29,7 +29,6 @@ def TestApp.draw_page_count_test_routes
 # Feature Tests
 ##
 
-
 describe PageCountTestController, type: :controller do
  include_context 'JSON API headers'