Merge pull request #2 from stas/master

pull in upstream

Author: tatthurs

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+

.github/workflows/ci.yml

@@ -8,16 +8,14 @@ jobs:
 
     strategy:
       matrix:
-        ruby: [2.4, 2.7, '3.0']
-        rails: ['5', '6.0', '6']
+        ruby: ['3.0', '3.1', '3.2', '3.3']
+        rails: ['6.1', '7.0', '7.1']
         exclude:
-          - ruby: 2.4
+          - ruby: 3.2
             rails: 6
-          - ruby: '3.0'
-            rails: 5
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - uses: ruby/setup-ruby@v1
       with:
@@ -31,7 +29,6 @@ jobs:
         rm -rf Gemfile.lock
         sudo apt-get update
         sudo apt-get install libsqlite3-dev
-        echo $RAILS_VERSION | grep -q '4' && export SQLITE3_VERSION='~> 1.3.6'
-        echo $RAILS_VERSION | grep -q '4' && RUBOCOP_VERSION='~> 0.77'
+        echo $RAILS_VERSION | grep -q '5' && export SQLITE3_VERSION='~> 1.3.6'
         bundle
         bundle exec rake

README.md

@@ -39,7 +39,7 @@ The available features include:
    [sparse fields](https://jsonapi.org/format/#fetching-sparse-fieldsets))
  * [filtering](https://jsonapi.org/format/#fetching-filtering) and
    [sorting](https://jsonapi.org/format/#fetching-sorting) of the data
-   (powered by Ransack)
+   (powered by Ransack, soft-dependency)
  * [pagination](https://jsonapi.org/format/#fetching-pagination) support
 
 ## But how?
@@ -49,6 +49,16 @@ and [Ransack](https://github.com/activerecord-hackery/ransack).
 
 Thanks to everyone who worked on these amazing projects!
 
+## Sponsors
+
+I'm grateful for the following companies for supporting this project!
+
+<p align="center">
+<a href="https://www.luneteyewear.com"><img src="https://user-images.githubusercontent.com/112147/136836142-2bfba96e-447f-4eb6-b137-2445aee81b37.png"/></a>
+<a href="https://www.startuplandia.io"><img src="https://user-images.githubusercontent.com/112147/136836147-93f8ab17-2465-4477-a7ab-e38255483c66.png"/></a>
+</p>
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -223,6 +233,12 @@ class MyController < ActionController::Base
 end
 ```
 
+This allows you to run queries like:
+
+```bash
+$ curl -X GET /api/resources?fields[model]=model_attr,relationship
+```
+
 ### Filtering and sorting
 
 `JSONAPI::Filtering` uses the power of
@@ -231,6 +247,8 @@ to filter and sort over a collection of records.
 The support is pretty extended and covers also relationships and composite
 matchers.
 
+Please add `ransack` to your `Gemfile` in order to benefit from this functionality!
+
 Here's an example:
 
 ```ruby
@@ -264,7 +282,7 @@ grouping. To enable expressions along with filters, use the option flags:
 ```ruby
 options = { sort_with_expressions: true }
 jsonapi_filter(User.all, allowed_fields, options) do |filtered|
-  render jsonapi: result.group('id').to_a
+  render jsonapi: filtered.result.group('id').to_a
 end
 ```
 
@@ -314,7 +332,7 @@ If you want to change the default number of items per page or define a custom lo
 ```ruby
   def jsonapi_page_size(pagination_params)
     per_page = pagination_params[:size].to_f.to_i
-    per_page = 30 if per_page > 30
+    per_page = 30 if per_page > 30 || per_page < 1
     per_page
   end
 ```

Rakefile

@@ -4,6 +4,7 @@ require 'rubocop/rake_task'
 require 'yaml'
 require 'yardstick'
 
+# rubocop:disable Rails/RakeEnvironment
 desc('Documentation stats and measurements')
 task('qa:docs') do
   yaml = YAML.load_file(File.expand_path('../.yardstick.yml', __FILE__))
@@ -13,6 +14,7 @@ task('qa:docs') do
   coverage = Yardstick.round_percentage(measure.coverage * 100)
   exit(1) if coverage < config.threshold
 end
+# rubocop:enable Rails/RakeEnvironment
 
 desc('Codestyle check and linter')
 RuboCop::RakeTask.new('qa:code') do |task|
@@ -30,5 +32,5 @@ else
   task(qa: ['qa:docs', 'qa:code'])
 end
 
-RSpec::Core::RakeTask.new(spec: :qa)
-task(default: :spec)
+RSpec::Core::RakeTask.new(:spec)
+task(default: %w[qa spec])

jsonapi.rb.gemspec

@@ -20,12 +20,17 @@ Gem::Specification.new do |spec|
   spec.files        += %w(LICENSE.txt README.md)
   spec.require_paths = ['lib']
 
+  spec.post_install_message = (
+    'Install manually `ransack` gem before using `JSONAPI::Filtering`!'
+  )
+
   spec.add_dependency 'jsonapi-serializer'
-  spec.add_dependency 'ransack'
   spec.add_dependency 'rack'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rails', ENV['RAILS_VERSION']
+  spec.add_development_dependency 'ransack'
+  spec.add_development_dependency 'railties', ENV['RAILS_VERSION']
+  spec.add_development_dependency 'activerecord', ENV['RAILS_VERSION']
   spec.add_development_dependency 'sqlite3', ENV['SQLITE3_VERSION']
   spec.add_development_dependency 'ffaker'
   spec.add_development_dependency 'rspec', '~> 3.0'

lib/jsonapi/deserialization.rb

@@ -65,7 +65,7 @@ def jsonapi_deserialize(document, options = {})
         rel_name = jsonapi_inflector.singularize(assoc_name)
 
         if assoc_data.is_a?(Array)
-          parsed["#{rel_name}_ids"] = assoc_data.map { |ri| ri['id'] }.compact
+          parsed["#{rel_name}_ids"] = assoc_data.filter_map { |ri| ri['id'] }
           next
         end
 

lib/jsonapi/error_serializer.rb

@@ -8,7 +8,7 @@ class ErrorSerializer
     set_type :error
 
     # Object/Hash attribute helpers.
-    [:status, :source, :title, :detail].each do |attr_name|
+    [:status, :source, :title, :detail, :code].each do |attr_name|
       attribute attr_name do |object|
         object.try(attr_name) || object.try(:fetch, attr_name, nil)
       end

lib/jsonapi/fetching.rb

@@ -17,7 +17,7 @@ def jsonapi_fields
       end
 
       params[:fields].each do |k, v|
-        extracted[k] = v.to_s.split(',').map(&:strip).compact
+        extracted[k] = v.to_s.split(',').filter_map(&:strip)
       end
 
       extracted
@@ -29,7 +29,7 @@ def jsonapi_fields
     #
     # @return [Array]
     def jsonapi_include
-      params['include'].to_s.split(',').map(&:strip).compact
+      params['include'].to_s.split(',').filter_map(&:strip)
     end
   end
 end

lib/jsonapi/filtering.rb

@@ -1,5 +1,9 @@
-require 'ransack/predicate'
-require_relative 'patches'
+begin
+  require 'active_record'
+  require 'ransack'
+  require_relative 'patches'
+rescue LoadError
+end
 
 # Filtering and sorting support
 module JSONAPI

lib/jsonapi/rails.rb

@@ -37,7 +37,7 @@ def self.install!
     # @return [NilClass]
     def self.add_errors_renderer!
       ActionController::Renderers.add(:jsonapi_errors) do |resource, options|
-        self.content_type ||= Mime[:jsonapi]
+        self.content_type = Mime[:jsonapi] if self.media_type.nil?
 
         many = JSONAPI::Rails.is_collection?(resource, options[:is_collection])
         resource = [resource] unless many
@@ -47,7 +47,7 @@ def self.add_errors_renderer!
         ) unless resource.is_a?(ActiveModel::Errors)
 
         errors = []
-        model = resource.instance_variable_get('@base')
+        model = resource.instance_variable_get(:@base)
 
         if respond_to?(:jsonapi_serializer_class, true)
           model_serializer = jsonapi_serializer_class(model, false)
@@ -56,8 +56,8 @@ def self.add_errors_renderer!
         end
 
         details = {}
-        if ::Rails::VERSION::MAJOR >= 6 && ::Rails::VERSION::MINOR >= 1
-          resource.map do |error|
+        if ::Rails.gem_version >= Gem::Version.new('6.1')
+          resource.each do |error|
             attr = error.attribute
             details[attr] ||= []
             details[attr] << error.detail.merge(message: error.message)
@@ -90,7 +90,7 @@ def self.add_errors_renderer!
     # @return [NilClass]
     def self.add_renderer!
       ActionController::Renderers.add(:jsonapi) do |resource, options|
-        self.content_type ||= Mime[:jsonapi]
+        self.content_type = Mime[:jsonapi] if self.media_type.nil?
 
         JSONAPI_METHODS_MAPPING.to_a[0..1].each do |opt, method_name|
           next unless respond_to?(method_name, true)
@@ -100,7 +100,7 @@ def self.add_renderer!
         # If it's an empty collection, return it directly.
         many = JSONAPI::Rails.is_collection?(resource, options[:is_collection])
         if many && !resource.any?
-          return options.slice(:meta, :links).merge(data: []).to_json
+          return options.slice(:meta, :links).compact.merge(data: []).to_json
         end
 
         JSONAPI_METHODS_MAPPING.to_a[2..-1].each do |opt, method_name|
@@ -121,15 +121,13 @@ def self.add_renderer!
 
     # Checks if an object is a collection
     #
-    # Stolen from [JSONAPI::Serializer], instance method.
+    # Basically forwards it to a [JSONAPI::Serializer] as there's no public API
     #
     # @param resource [Object] to check
     # @param force_is_collection [NilClass] flag to overwrite
     # @return [TrueClass] upon success
     def self.is_collection?(resource, force_is_collection = nil)
-      return force_is_collection unless force_is_collection.nil?
-
-      resource.respond_to?(:size) && !resource.respond_to?(:each_pair)
+      JSONAPI::ErrorSerializer.is_collection?(resource, force_is_collection)
     end
 
     # Resolves resource serializer class