Rails 8_1 Compatibility

Fixes #1479

Rails 8.1 changed `ActionDispatch::Routing::Mapper::Resources::Resource#initialize`
to require keyword args (only:, except:, **options). The JSONAPI‑Resources
DSL still passes a positional options hash, so jsonapi_relationships never
runs and relationship routes are missing.

Adding the ** operator to `**options` converts the hash into keyword args.

Tests that fail without this change: `test/controllers/controller_test.rb`

I ran into several other deprecations.
* `ActiveSupport::Deprecation.silenced`
  will not work the way it was set up in the tests because `#silenced` now
  works on an instance of `Deprecators` instead of globally. I created a
  module `JSONAPI.deprecator` so that the gem can use its own instance
  of Deprecator and the tests can work as designed.
* `:unprocessable_entity` was deprecated in favor of `:unprocessable_content`
* Used lazy method evaluation for `Configuration` because Rails 8.1 does
  not guarantee class-body initialization order, so @configuration was returning
  `nil`.
* My team uses an active_record oracle adapter. Oracle unquoted identifiers
  are automatically stored as UPPERCASE. Rails 8.1 no longer normalizes
  the case automatically for queries, so I added a condition for using the
  oracle adapter.
* `length` is no longer a valid column constraint. Used `limit` instead
* `references:` is not a valid option key for ActiveRecord migrations.
  Excplicitly pass a foreign_key to the things table instead.
* `:none` is not a valid active_record schema format in Rails 8.1
* Disabled foreign key constraints for SQLite tests
* Use `ActiveRecord::Base.connection.quoted_true` as it is database agnostic

There are a few warnings in the test suite that I did not address because
they were unrelated to this change.

Author: simps614

Gemfile

@@ -11,10 +11,10 @@ version = ENV['RAILS_VERSION'] || 'default'
 platforms :ruby do
   gem 'pg'
 
-  if version.start_with?('4.2', '5.0')
-    gem 'sqlite3', '~> 1.3.13'
+  if version.start_with?('8.1')
+    gem 'sqlite3', '>= 2.1'
   else
-    gem 'sqlite3', '~> 1.4'
+    gem 'sqlite3', '~> 1.3.13'
   end
 end
 
@@ -24,6 +24,7 @@ when 'master'
   gem 'arel', { git: 'https://github.com/rails/arel.git' }
 when 'default'
   gem 'railties', '>= 6.0'
+  gem 'csv'
 else
   gem 'railties', "~> #{version}"
-end
+end

lib/jsonapi-resources.rb

@@ -43,3 +43,4 @@
 require 'jsonapi/resource_set'
 require 'jsonapi/path'
 require 'jsonapi/path_segment'
+require 'jsonapi/deprecator'

lib/jsonapi/active_relation_resource.rb

@@ -847,7 +847,16 @@ def alias_table_field(table, field, quoted = false)
       end
 
       def quote(field)
-        "\"#{field.to_s}\""
+        if oracle?
+          "\"#{field.to_s.upcase}\""
+        else
+          "\"#{field.to_s}\""
+        end
+      end
+
+      def oracle?
+        defined?(ActiveRecord::Base.connection) &&
+          ActiveRecord::Base.connection.adapter_name =~ /oracle/i
       end
 
       def apply_filters(records, filters, options = {})

lib/jsonapi/basic_resource.rb

@@ -547,7 +547,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?
@@ -609,7 +609,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/configuration.rb

@@ -241,18 +241,18 @@ def default_processor_klass_name=(default_processor_klass_name)
     end
 
     def allow_include=(allow_include)
-      ActiveSupport::Deprecation.warn('`allow_include` has been replaced by `default_allow_include_to_one` and `default_allow_include_to_many` options.')
+      JSONAPI.deprecator.warn('`allow_include` has been replaced by `default_allow_include_to_one` and `default_allow_include_to_many` options.')
       @default_allow_include_to_one = allow_include
       @default_allow_include_to_many = allow_include
     end
 
     def whitelist_all_exceptions=(allow_all_exceptions)
-      ActiveSupport::Deprecation.warn('`whitelist_all_exceptions` has been replaced by `allow_all_exceptions`')
+      JSONAPI.deprecator.warn('`whitelist_all_exceptions` has been replaced by `allow_all_exceptions`')
       @allow_all_exceptions = allow_all_exceptions
     end
 
     def exception_class_whitelist=(exception_class_allowlist)
-      ActiveSupport::Deprecation.warn('`exception_class_whitelist` has been replaced by `exception_class_allowlist`')
+      JSONAPI.deprecator.warn('`exception_class_whitelist` has been replaced by `exception_class_allowlist`')
       @exception_class_allowlist = exception_class_allowlist
     end
 
@@ -315,11 +315,13 @@ def exception_class_whitelist=(exception_class_allowlist)
 
   class << self
     attr_accessor :configuration
-  end
 
-  @configuration ||= Configuration.new
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
 
   def self.configure
-    yield(@configuration)
+    yield(configuration)
   end
 end

lib/jsonapi/deprecator.rb

@@ -0,0 +1,5 @@
+module JSONAPI
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new('1.0', 'jsonapi-resources')
+  end
+end

lib/jsonapi/exceptions.rb

@@ -498,7 +498,7 @@ def errors
 
       def json_api_error(attr_key, message)
         create_error_object(code: JSONAPI::VALIDATION_ERROR,
-                            status: :unprocessable_entity,
+                            status: :unprocessable_content,
                             title: message,
                             detail: detail(attr_key, message),
                             source: { pointer: pointer(attr_key) },
@@ -532,7 +532,7 @@ def general_error?(attr_key)
     class SaveFailed < Error
       def errors
         [create_error_object(code: JSONAPI::SAVE_FAILED,
-                             status: :unprocessable_entity,
+                             status: :unprocessable_content,
                              title: I18n.translate('jsonapi-resources.exceptions.save_failed.title',
                                                    default: 'Save failed or was cancelled'),
                              detail: I18n.translate('jsonapi-resources.exceptions.save_failed.detail',

lib/jsonapi/routing_ext.rb

@@ -46,7 +46,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
@@ -59,7 +59,7 @@ def jsonapi_resource(*resources, &_block)
               end
             else
               # Rails 5
-              jsonapi_resource_scope(SingletonResource.new(@resource_type, api_only?, @scope[:shallow], options), @resource_type) do
+              jsonapi_resource_scope(SingletonResource.new(@resource_type, api_only?, @scope[:shallow], **options), @resource_type) do
                 if block_given?
                   yield
                 else
@@ -121,7 +121,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
@@ -133,7 +133,7 @@ def jsonapi_resources(*resources, &_block)
               end
             else
               # Rails 5
-              jsonapi_resource_scope(Resource.new(@resource_type, api_only?, @scope[:shallow], options), @resource_type) do
+              jsonapi_resource_scope(Resource.new(@resource_type, api_only?, @scope[:shallow], **options), @resource_type) do
                 if block_given?
                   yield
                 else

test/controllers/controller_test.rb

@@ -761,7 +761,7 @@ def test_create_link_to_missing_object
         }
       }
 
-    assert_response :unprocessable_entity
+    assert_response :unprocessable_content
     # TODO: check if this validation is working
     assert_match /author - can't be blank/, response.body
     assert_nil response.location
@@ -864,7 +864,7 @@ def test_create_with_invalid_data
         }
       }
 
-    assert_response :unprocessable_entity
+    assert_response :unprocessable_content
 
     assert_equal "/data/relationships/author", json_response['errors'][0]['source']['pointer']
     assert_equal "can't be blank", json_response['errors'][0]['title']
@@ -2019,7 +2019,7 @@ def test_delete_with_validation_error_base
 
     assert_equal "can't destroy me", json_response['errors'][0]['title']
     assert_equal "/data", json_response['errors'][0]['source']['pointer']
-    assert_response :unprocessable_entity
+    assert_response :unprocessable_content
   end
 
   def test_delete_with_validation_error_attr
@@ -2028,7 +2028,7 @@ def test_delete_with_validation_error_attr
 
     assert_equal "is locked", json_response['errors'][0]['title']
     assert_equal "/data/attributes/title", json_response['errors'][0]['source']['pointer']
-    assert_response :unprocessable_entity
+    assert_response :unprocessable_content
   end
 
   def test_delete_single
@@ -2631,7 +2631,7 @@ def test_create_validations_missing_attribute
         }
       }
 
-    assert_response :unprocessable_entity
+    assert_response :unprocessable_content
     assert_equal 2, json_response['errors'].size
     assert_equal JSONAPI::VALIDATION_ERROR, json_response['errors'][0]['code']
     assert_equal JSONAPI::VALIDATION_ERROR, json_response['errors'][1]['code']
@@ -2653,7 +2653,7 @@ def test_update_validations_missing_attribute
         }
       }
 
-    assert_response :unprocessable_entity
+    assert_response :unprocessable_content
     assert_equal 1, json_response['errors'].size
     assert_equal JSONAPI::VALIDATION_ERROR, json_response['errors'][0]['code']
     assert_match /name - can't be blank/, response.body
@@ -3183,7 +3183,7 @@ def test_create_with_invalid_data
         }
       }
 
-    assert_response :unprocessable_entity
+    assert_response :unprocessable_content
 
     assert_equal "/data/attributes/spouse-name", json_response['errors'][0]['source']['pointer']
     assert_equal "can't be blank", json_response['errors'][0]['title']
@@ -3779,7 +3779,7 @@ def test_save_model_callbacks_fail
         }
       }
 
-    assert_response :unprocessable_entity
+    assert_response :unprocessable_content
     assert_match /Save failed or was cancelled/, json_response['errors'][0]['detail']
   end
 end
@@ -4077,7 +4077,7 @@ def test_delete_with_validation_error_base_on_resource
 
     assert_equal "can't destroy me", json_response['errors'][0]['title']
     assert_equal "/data/attributes/base", json_response['errors'][0]['source']['pointer']
-    assert_response :unprocessable_entity
+    assert_response :unprocessable_content
   end
 end
 

test/fixtures/active_record.rb

@@ -52,7 +52,7 @@
   end
 
   create_table :posts, force: true do |t|
-    t.string     :title, length: 255
+    t.string     :title, limit: 255
     t.text       :body
     t.integer    :author_id
     t.integer    :parent_post_id
@@ -324,8 +324,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, foreign_key: { to_table: :things }
+    t.references :to, foreign_key: { to_table: :things }
 
     t.timestamps null: false
   end