rails 8.1 support

Author: dmitry-sinina

.github/workflows/tests.yml

@@ -2,7 +2,7 @@ name: CI
 
 on:
   push:
-    branches: [ 'master', 'release-0-8', 'release-0-9', 'release-0-10' ]
+    branches: [ 'master', 'release-0-8', 'release-0-9', 'release-0-9-rails-8-1', 'release-0-10' ]
   pull_request:
     branches: ['**']
 
@@ -13,34 +13,40 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 2.6.6
-          - 2.7.2
+          - '3.4'
+          - '3.3'
+          - '3.2'
         rails:
-          - 6.1.1
-          - 6.0.3.4
-          - 5.2.4.4
-          - 5.1.7
-          - 5.0.7.2
-          - 4.2.11
+          - '8.1'
+          - '8.0'
+          - '7.2'
+          - '7.1'
+          - '7.0'
+          - '6.1'
         exclude:
-          - ruby: 2.7.2
-            rails: 5.0.7.2
-          - ruby: 2.6.6
-            rails: 5.0.7.2
-          - ruby: 2.7.2
-            rails: 4.2.11
-          - ruby: 2.6.6
-            rails: 4.2.11
+          # Rails 6.1 and 7.0 predate these Rubies and do not run cleanly on them.
+          - rails: '6.1'
+            ruby: '3.4'
+          - rails: '6.1'
+            ruby: '3.3'
+          - rails: '7.0'
+            ruby: '3.4'
+          - rails: '7.0'
+            ruby: '3.3'
+          - rails: '7.1'
+            ruby: '3.4'
     env:
       RAILS_VERSION: ${{ matrix.rails }}
     name: Ruby ${{ matrix.ruby }} Rails ${{ matrix.rails }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - name: Install dependencies
-        run: bundle install --jobs 4 --retry 3
+          bundler-cache: true
+          # The Gemfile is identical across matrix rows and only RAILS_VERSION
+          # changes the resolution, so the cache must be keyed per Rails version.
+          cache-version: rails-${{ matrix.rails }}
       - name: Run tests
         run: bundle exec rake test

Gemfile

@@ -11,15 +11,17 @@ version = ENV['RAILS_VERSION'] || 'default'
 platforms :ruby do
   if version.start_with?('4.2', '5.0')
     gem 'sqlite3', '~> 1.3.13'
-  else
+  elsif version.start_with?('4', '5', '6', '7.0')
     gem 'sqlite3', '~> 1.4'
+  else
+    # Rails 7.1+ supports sqlite3 2.x, Rails 8 requires it.
+    gem 'sqlite3', '>= 1.4'
   end
 end
 
 case version
 when 'master'
   gem 'railties', { git: 'https://github.com/rails/rails.git' }
-  gem 'arel', { git: 'https://github.com/rails/arel.git' }
 when 'default'
   gem 'railties', '>= 6.0'
 else

jsonapi-resources.gemspec

@@ -21,7 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'minitest'
+  # Minitest 6 extracted `minitest/mock` into a separate gem and drops APIs this
+  # suite relies on. Rails supports minitest >= 5.1, so stay on the 5.x line.
+  spec.add_development_dependency 'minitest', '~> 5.1'
   spec.add_development_dependency 'minitest-spec-rails'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'pry'

lib/jsonapi-resources.rb

@@ -1,3 +1,4 @@
+require 'jsonapi/deprecation'
 require 'jsonapi/naive_cache'
 require 'jsonapi/compiled_json'
 require 'jsonapi/resource'

lib/jsonapi/deprecation.rb

@@ -0,0 +1,18 @@
+require 'active_support/deprecation'
+
+module JSONAPI
+  # Rails 7.1 stopped `ActiveSupport::Deprecation` from being a singleton and
+  # Rails 8.0 removed the class-level `.warn` / `.instance` methods entirely, so
+  # each library is expected to own its deprecator instance.
+  #
+  # On Rails < 7.1 `.new` is private (the class still includes Singleton), which
+  # is what we probe for to stay compatible with the older versions this branch
+  # supports.
+  def self.deprecator
+    @deprecator ||= if ActiveSupport::Deprecation.respond_to?(:new)
+                      ActiveSupport::Deprecation.new('0.10', 'jsonapi-resources')
+                    else
+                      ActiveSupport::Deprecation
+                    end
+  end
+end

lib/jsonapi/resource.rb

@@ -1,5 +1,6 @@
 require 'jsonapi/callbacks'
 require 'jsonapi/relationship_builder'
+require 'jsonapi/deprecation'
 
 module JSONAPI
   class Resource
@@ -541,7 +542,7 @@ def attribute(attribute_name, options = {})
         check_reserved_attribute_name(attr)
 
         if (attr == :id) && (options[:format].nil?)
-          ActiveSupport::Deprecation.warn('Id without format is no longer supported. Please remove ids from attributes, or specify a format.')
+          JSONAPI.deprecator.warn('Id without format is no longer supported. Please remove ids from attributes, or specify a format.')
         end
 
         check_duplicate_attribute_name(attr) if options[:format].nil?
@@ -581,7 +582,7 @@ def has_one(*attrs)
       end
 
       def belongs_to(*attrs)
-        ActiveSupport::Deprecation.warn "In #{name} you exposed a `has_one` relationship "\
+        JSONAPI.deprecator.warn "In #{name} you exposed a `has_one` relationship "\
                                         " using the `belongs_to` class method. We think `has_one`" \
                                         " is more appropriate. If you know what you're doing," \
                                         " and don't want to see this warning again, override the" \

lib/jsonapi/routing_ext.rb

@@ -44,7 +44,7 @@ def jsonapi_resource(*resources, &_block)
             options[:except] << :destroy unless options[:except].include?(:destroy) || options[:except].include?('destroy')
           end
 
-          resource @resource_type, options do
+          resource @resource_type, **options do
             # :nocov:
             if @scope.respond_to? :[]=
               # Rails 4
@@ -56,8 +56,8 @@ def jsonapi_resource(*resources, &_block)
                 jsonapi_relationships
               end
             else
-              # Rails 5
-              jsonapi_resource_scope(SingletonResource.new(@resource_type, api_only?, @scope[:shallow], options), @resource_type) do
+              # Rails 5+
+              jsonapi_resource_scope(SingletonResource.new(@resource_type, api_only?, @scope[:shallow], **options), @resource_type) do
                 if block_given?
                   yield
                 else
@@ -119,7 +119,7 @@ def jsonapi_resources(*resources, &_block)
             options[:except] << :destroy unless options[:except].include?(:destroy) || options[:except].include?('destroy')
           end
 
-          resources @resource_type, options do
+          resources @resource_type, **options do
             # :nocov:
             if @scope.respond_to? :[]=
               # Rails 4
@@ -130,8 +130,8 @@ def jsonapi_resources(*resources, &_block)
                 jsonapi_relationships
               end
             else
-              # Rails 5
-              jsonapi_resource_scope(Resource.new(@resource_type, api_only?, @scope[:shallow], options), @resource_type) do
+              # Rails 5+
+              jsonapi_resource_scope(Resource.new(@resource_type, api_only?, @scope[:shallow], **options), @resource_type) do
                 if block_given?
                   yield
                 else

test/fixtures/active_record.rb

@@ -287,8 +287,8 @@
 
   create_table :related_things, force: true  do |t|
     t.string :name
-    t.references :from, references: :thing
-    t.references :to, references: :thing
+    t.references :from
+    t.references :to
 
     t.timestamps null: false
   end

test/integration/requests/request_test.rb

@@ -477,7 +477,10 @@ def test_put_invalid_json
 
     assert_equal 400, status
     assert_equal 'Bad Request', json_response['errors'][0]['title']
-    assert_match 'unexpected token at', json_response['errors'][0]['detail']
+    # The detail is JSON::ParserError's message verbatim, and its wording changed
+    # in newer json gem versions ("unexpected token at ..." became
+    # "expected ',' or '}' after object value, got: ...").
+    assert_match(/unexpected token at|expected ',' or '}'/, json_response['errors'][0]['detail'])
   end
 
   def test_put_valid_json_but_array

test/test_helper.rb

@@ -1,3 +1,7 @@
+# Ruby 3.1+ moved Logger to a separate gem and concurrent-ruby no longer requires
+# it, so it must be loaded before ActiveSupport or ActiveSupport::LoggerThreadSafeLevel
+# raises `uninitialized constant Logger` on Rails < 7.1.
+require 'logger'
 require 'simplecov'
 require 'database_cleaner'
 
@@ -20,7 +24,10 @@
 end
 
 require 'active_record/railtie'
-require 'rails/test_help'
+require 'action_controller/railtie'
+# NOTE: `rails/test_help` is required after `TestApp.initialize!` (below). Since
+# Rails 8.1 it reads `Rails.application.config` at load time, so it cannot be
+# required before an application exists.
 require 'minitest/mock'
 require 'jsonapi-resources'
 require 'pry'
@@ -52,14 +59,18 @@ class TestApp < Rails::Application
   config.action_controller.action_on_unpermitted_parameters = :raise
 
   ActiveRecord::Schema.verbose = false
-  config.active_record.schema_format = :none
+  # The test schema is defined in test/fixtures/active_record.rb and loaded by
+  # hand, so Rails must not try to maintain or verify it. This used to be spelled
+  # `schema_format = :none`, but Rails 8.1 rejects anything but :ruby / :sql.
+  config.active_record.maintain_test_schema = false
   config.active_support.test_order = :random
 
   if Rails::VERSION::MAJOR >= 5
     config.active_support.halt_callback_chains_on_return_false = false
     config.active_record.time_zone_aware_types = [:time, :datetime]
     config.active_record.belongs_to_required_by_default = false
-    if Rails::VERSION::MINOR >= 2
+    # Removed in Rails 6.1; only ever needed on 5.2.
+    if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR >= 2
       config.active_record.sqlite3.represent_boolean_as_integer = true
     end
   end
@@ -80,7 +91,10 @@ class Engine < ::Rails::Engine
 # Monkeypatch ActionController::TestCase to delete the RAW_POST_DATA on subsequent calls in the same test.
 if Rails::VERSION::MAJOR >= 5
   module ClearRawPostHeader
-    def process(action, *args)
+    # `process` takes keyword arguments (method:, params:, ...), so they must be
+    # captured and forwarded as keywords rather than collapsed into a positional
+    # hash by `*args`.
+    def process(action, *args, **kwargs)
       @request.delete_header 'RAW_POST_DATA'
       super
     end
@@ -210,6 +224,8 @@ def show_queries
 
 TestApp.initialize!
 
+require 'rails/test_help'
+
 require File.expand_path('../fixtures/active_record', __FILE__)
 
 module Pets
@@ -443,6 +459,17 @@ class CatResource < JSONAPI::Resource
 # Ensure backward compatibility with Minitest 4
 Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
 
+# `fixture_path` (singular) was deprecated in Rails 7.1 and removed in Rails 8.0
+# in favour of `fixture_paths` (plural, an array).
+def set_fixture_path(klass)
+  path = "#{Rails.root}/fixtures"
+  if klass.respond_to?(:fixture_paths=)
+    klass.fixture_paths = [path]
+  else
+    klass.fixture_path = path
+  end
+end
+
 class Minitest::Test
   include Helpers::Assertions
   include Helpers::ValueMatchers
@@ -454,20 +481,20 @@ def run_in_transaction?
     true
   end
 
-  self.fixture_path = "#{Rails.root}/fixtures"
+  set_fixture_path(self)
   fixtures :all
 end
 
 class ActiveSupport::TestCase
-  self.fixture_path = "#{Rails.root}/fixtures"
+  set_fixture_path(self)
   fixtures :all
   setup do
     @routes = TestApp.routes
   end
 end
 
 class ActionDispatch::IntegrationTest
-  self.fixture_path = "#{Rails.root}/fixtures"
+  set_fixture_path(self)
   fixtures :all
 
   def assert_jsonapi_response(expected_status, msg = nil)
@@ -519,13 +546,16 @@ def assert_cacheable_jsonapi_get(url, cached_classes = :all)
 end
 
 class ActionController::TestCase
-  def assert_cacheable_get(action, *args)
+  # `get` takes keyword arguments (params:, headers:, ...), so they must be
+  # captured and forwarded as keywords rather than collapsed into a positional
+  # hash by `*args`.
+  def assert_cacheable_get(action, *args, **kwargs)
     assert_nil JSONAPI.configuration.resource_cache
 
     normal_queries = []
     normal_query_callback = lambda {|_, _, _, _, payload| normal_queries.push payload[:sql] }
     ActiveSupport::Notifications.subscribed(normal_query_callback, 'sql.active_record') do
-      get action, *args
+      get action, *args, **kwargs
     end
     non_caching_response = json_response_sans_backtraces
     non_caching_status = response.status
@@ -559,7 +589,7 @@ def assert_cacheable_get(action, *args)
               @controller = nil
               setup_controller_request_and_response
               @request.headers.merge!(orig_request_headers.dup)
-              get action, *args
+              get action, *args, **kwargs
             end
           end
         rescue Exception