Refactor deprecation warnings to use CompatibilityHelper and ensure consistent require statements

Author: seenanair

lib/jsonapi/acts_as_resource_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'csv'
-
+require_relative 'compatibility_helper'
 module JSONAPI
   module ActsAsResourceController
     MEDIA_TYPE_MATCHER = /.+".+"[^,]*|[^,]+/
@@ -63,16 +63,16 @@ def index_related_resources
 
     def get_related_resource
       # :nocov:
-    ActiveSupport::Deprecation.warn "In #{self.class.name} you exposed a `get_related_resource`"\
-                                      " action. Please use `show_related_resource` instead."
+      JSONAPI::CompatibilityHelper.deprecation_warn("In #{self.class.name} you exposed a `get_related_resource`"\
+                                      " action. Please use `show_related_resource` instead.")
       show_related_resource
       # :nocov:
     end
 
     def get_related_resources
       # :nocov:
-      ActiveSupport::Deprecation.warn "In #{self.class.name} you exposed a `get_related_resources`"\
-                                      " action. Please use `index_related_resources` instead."
+      JSONAPI::CompatibilityHelper.deprecation_warn("In #{self.class.name} you exposed a `get_related_resources`"\
+                                      " action. Please use `index_related_resources` instead.")
       index_related_resources
       # :nocov:
     end

lib/jsonapi/basic_resource.rb

@@ -2,7 +2,7 @@
 
 require 'jsonapi/callbacks'
 require 'jsonapi/configuration'
-
+require_relative 'compatibility_helper'
 module JSONAPI
   class BasicResource
     include Callbacks
@@ -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::CompatibilityHelper.deprecation_warn('Id without format is deprecated. Please specify a format for the id attribute.')
         end
 
         check_duplicate_attribute_name(attr) if options[:format].nil?
@@ -609,11 +609,12 @@ def has_one(*attrs)
       end
 
       def belongs_to(*attrs)
-        ActiveSupport::Deprecation.warn "In #{name} you exposed a `has_one` relationship "\
+
+        JSONAPI::CompatibilityHelper.deprecation_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" \
-                                        " `belongs_to` class method on your resource."
+                                        " `belongs_to` class method on your resource.")
         _add_relationship(Relationship::ToOne, *attrs)
       end
 

lib/jsonapi/configuration.rb

@@ -3,7 +3,7 @@
 require 'jsonapi/formatter'
 require 'jsonapi/processor'
 require 'concurrent'
-
+require_relative 'compatibility_helper'
 module JSONAPI
   class Configuration
     attr_reader :json_key_format,
@@ -227,7 +227,7 @@ def exception_class_allowed?(e)
     end
 
     def default_processor_klass=(default_processor_klass)
-      ActiveSupport::Deprecation.warn('`default_processor_klass` has been replaced by `default_processor_klass_name`.')
+      JSONAPI::CompatibilityHelper.deprecation_warn('`default_processor_klass` has been replaced by `default_processor_klass_name`.')
       @default_processor_klass = default_processor_klass
     end
 
@@ -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::CompatibilityHelper.deprecation_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::CompatibilityHelper.deprecation_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::CompatibilityHelper.deprecation_warn('`exception_class_whitelist` has been replaced by `exception_class_allowlist`')
       @exception_class_allowlist = exception_class_allowlist
     end
 

lib/jsonapi/relationship.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-
+require_relative 'compatibility_helper'
 module JSONAPI
   class Relationship
     attr_reader :acts_as_set, :foreign_key, :options, :name,
@@ -21,7 +21,7 @@ def initialize(name, options = {})
       @polymorphic = options.fetch(:polymorphic, false) == true
       @polymorphic_types = options[:polymorphic_types]
       if options[:polymorphic_relations]
-        ActiveSupport::Deprecation.warn('Use polymorphic_types instead of polymorphic_relations')
+        JSONAPI::CompatibilityHelper.deprecation_warn('Use polymorphic_types instead of polymorphic_relations')
         @polymorphic_types ||= options[:polymorphic_relations]
       end
 

lib/jsonapi/resource.rb

@@ -4,4 +4,4 @@ module JSONAPI
   class Resource < ActiveRelationResource
     root_resource
   end
-end
+end