Merge upstream master into master

.github/dependabot.yml

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

.github/workflows/ci.yml

@@ -4,23 +4,26 @@ on: [push, pull_request]
 
 jobs:
   ruby_rails_test_matrix:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
 
     strategy:
       matrix:
-        ruby: [2.4, 2.6]
-        rails: [4, 5, 6]
-        exclude:
-          - ruby: 2.4
-            rails: 6
+        ruby: ['3.3', '3.3', '3.4', '4']
+        rails: ['7.2', '8.0', '8']
+        experimental: [false]
+        include:
+          - rails: '7.1'
+            ruby: '3.3'
+            experimental: true
 
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v6
 
-    - name: Sets up the environment
-      uses: actions/setup-ruby@v1
+    - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
 
     - name: Runs code QA and tests
       env:
@@ -29,8 +32,5 @@ jobs:
         rm -rf Gemfile.lock
         sudo apt-get update
         sudo apt-get install libsqlite3-dev
-        gem uninstall bundler -a --force
-        gem install bundler -v '~> 1'
-        echo $RAILS_VERSION | grep -q '4' && export SQLITE3_VERSION='~> 1.3.6'
         bundle
-        rake
+        bundle exec rake

.rubocop.yml

@@ -4,12 +4,21 @@ inherit_gem:
 
 require: rubocop-performance
 
+AllCops:
+  NewCops: enable
+
 Performance:
   Enabled: true
 
 Rails:
   Enabled: true
 
+Rails/Pluck:
+  Enabled: false
+
+Rails/NegateInclude:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: single_quotes

Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in jsonapi.gemspec
 gemspec
-
-gem 'jsonapi-rspec', git: 'https://github.com/jsonapi-rb/jsonapi-rspec.git'

README.md

@@ -31,24 +31,33 @@ Main goals:
 
 The available features include:
 
- * object serialization (powered by Fast JSON API)
+ * object serialization (powered by JSON:API Serializer, was `fast_jsonapi`)
  * [error handling](https://jsonapi.org/format/#errors) (parameters,
    validation, generic errors)
  * fetching of the data (support for
    [includes](https://jsonapi.org/format/#fetching-includes) and
    [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?
 
-Mainly by leveraging [Fast JSON API](https://github.com/Netflix/fast_jsonapi)
+Mainly by leveraging [JSON:API Serializer](https://github.com/jsonapi-serializer/jsonapi-serializer)
 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>
+</p>
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -100,7 +109,7 @@ The naming scheme follows the `ModuleName::ClassNameSerializer` for an instance
 of the `ModuleName::ClassName`.
 
 Please follow the
-[Fast JSON API guide](https://github.com/Netflix/fast_jsonapi#serializer-definition)
+[JSON:API Serializer guide](https://github.com/jsonapi-serializer/jsonapi-serializer#serializer-definition)
 on how to define a serializer.
 
 To provide a different naming scheme implement the `jsonapi_serializer_class`
@@ -223,6 +232,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 +246,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 +281,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
 ```
 
@@ -290,6 +307,7 @@ class MyController < ActionController::Base
       render jsonapi: paginated
     end
   end
+
 end
 ```
 
@@ -306,6 +324,17 @@ use the `jsonapi_pagination_meta` method:
   end
 
 ```
+
+If you want to change the default number of items per page or define a custom logic to handle page size, use the
+`jsonapi_page_size` method:
+
+```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 < 1
+    per_page
+  end
+```
 ### Deserialization
 
 `JSONAPI::Deserialization` provides a helper to transform a `JSONAPI` document

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|
@@ -24,7 +26,11 @@ RuboCop::RakeTask.new('qa:code') do |task|
 end
 
 desc('Run CI QA tasks')
-task(qa: ['qa:docs', 'qa:code'])
+if ENV['RAILS_VERSION'].to_s.include?('4')
+  task(qa: ['qa:docs'])
+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

@@ -16,25 +16,29 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/stas/jsonapi.rb'
   spec.license       = 'MIT'
 
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
-  end
+  spec.files         = Dir.glob('{lib,spec}/**/*', File::FNM_DOTMATCH)
+  spec.files        += %w(LICENSE.txt README.md)
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'fast_jsonapi', '~> 1.5'
-  spec.add_dependency 'ransack'
+  spec.post_install_message = (
+    'Install manually `ransack` gem before using `JSONAPI::Filtering`!'
+  )
+
+  spec.add_dependency 'jsonapi-serializer'
   spec.add_dependency 'rack'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rails', ENV['RAILS_VERSION']
-  spec.add_development_dependency 'sqlite3', ENV['SQLITE3_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', '~> 2.1'
   spec.add_development_dependency 'ffaker'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'jsonapi-rspec'
   spec.add_development_dependency 'yardstick'
   spec.add_development_dependency 'rubocop-rails_config'
-  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop', ENV['RUBOCOP_VERSION']
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'rubocop-performance'
 end

lib/jsonapi/active_model_error_serializer.rb

@@ -3,9 +3,6 @@
 module JSONAPI
   # [ActiveModel::Errors] serializer
   class ActiveModelErrorSerializer < ErrorSerializer
-    set_id :object_id
-    set_type :error
-
     attribute :status do
       '422'
     end
@@ -15,35 +12,15 @@ class ActiveModelErrorSerializer < ErrorSerializer
     end
 
     attribute :code do |object|
-      _, error_hash = object
-      code = error_hash[:error] unless error_hash[:error].is_a?(Hash)
-      code ||= error_hash[:message] || :invalid
-      # `parameterize` separator arguments are different on Rails 4 vs 5...
-      code.to_s.delete("''").parameterize.tr('-', '_')
+      object.type.to_s.delete("''").parameterize.tr('-', '_')
     end
 
-    attribute :detail do |object, params|
-      error_key, error_hash = object
-      errors_object = params[:model].errors
-
-      # Rails 4 provides just the message.
-      if error_hash[:error].present? && error_hash[:error].is_a?(Hash)
-        message = errors_object.generate_message(
-          error_key, nil, error_hash[:error]
-        )
-      elsif error_hash[:error].present?
-        message = errors_object.generate_message(
-          error_key, error_hash[:error], error_hash
-        )
-      else
-        message = error_hash[:message]
-      end
-
-      errors_object.full_message(error_key, message)
+    attribute :detail do |object, _params|
+      object.full_message
     end
 
     attribute :source do |object, params|
-      error_key, _ = object
+      error_key = object.attribute
       model_serializer = params[:model_serializer]
       attrs = (model_serializer.attributes_to_serialize || {}).keys
       rels = (model_serializer.relationships_to_serialize || {}).keys

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

@@ -1,20 +1,25 @@
-require 'fast_jsonapi'
+require 'jsonapi/serializer'
 
 module JSONAPI
   # A simple error serializer
   class ErrorSerializer
-    include FastJsonapi::ObjectSerializer
+    include JSONAPI::Serializer
 
-    set_id :object_id
     set_type :error
 
     # Object/Hash attribute helpers.
-    [:status, :source, :title, :detail].each do |attr_name|
+    [:status, :source, :title, :detail, :code, :meta].each do |attr_name|
       attribute attr_name do |object|
         object.try(attr_name) || object.try(:fetch, attr_name, nil)
       end
     end
 
+    # Overwrite the ID extraction method, to skip validations
+    #
+    # @return [NilClass]
+    def self.id_from_record(_record, _params)
+    end
+
     # Remap the root key to `errors`
     #
     # @return [Hash]

lib/jsonapi/errors.rb

@@ -47,7 +47,7 @@ def render_jsonapi_not_found(exception)
       render jsonapi_errors: [error], status: :not_found
     end
 
-    # Unprocessable entity (422) error handler callback
+    # Unprocessable Content (422) error handler callback
     #
     # @param exception [Exception] instance to handle
     # @return [String] JSONAPI error response

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,8 @@
-require 'ransack/predicate'
-require_relative 'patches'
+begin
+  require 'ransack/predicate'
+  require_relative 'patches'
+rescue LoadError
+end
 
 # Filtering and sorting support
 module JSONAPI