Support Rails 8.1

mihael · mihael · commit 9a8f584e32db · 2025-11-10T12:39:21.000+01:00
- Expand AR/AS/AM bounds to < 8.3 in gemspec - Normalize cookie SameSite: accept symbols/strings; write symbols to Rails cookie jar; keep strings for test mock - Add Rails 8.1 gemfiles (full and sqlite-only) and 8.2 stubs - Add Rails 8.1 to CI matrix - Update README compatibility and contributing docs - Refactor: use Module#include instead of send(:include) for AR hooks, Sinatra, and TestCase (aligns with upstream PR binarylogic#782) Refs: binarylogic#782
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -60,7 +60,7 @@ jobs:
         # `.rubocop.yml`, set `TargetRubyVersion`, to the lowest ruby version
         # tested here.
         ruby: ["3.1", "3.2", "3.3", "3.4"]
-        rails: ["7.0", "7.1", "7.2", "8.0"]
+        rails: ["7.0", "7.1", "7.2", "8.0", "8.1"]
         exclude:
           # rails 7 requires ruby >= 2.7.0
           - rails: "7.0"
@@ -73,6 +73,8 @@ jobs:
             ruby: "3.4"
           - rails: "8.0"
             ruby: "3.1"
+          - rails: "8.1"
+            ruby: "3.1"
     env:
       BUNDLE_GEMFILE: gemfiles/rails_${{ matrix.rails }}.rb
     steps:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -60,6 +60,10 @@ BUNDLE_GEMFILE=gemfiles/rails_7.2.rb bundle exec rake
 # Rails 8.0
 BUNDLE_GEMFILE=gemfiles/rails_8.0.rb bundle install
 BUNDLE_GEMFILE=gemfiles/rails_8.0.rb bundle exec rake
+
+# Rails 8.1
+BUNDLE_GEMFILE=gemfiles/rails_8.1.rb bundle install
+BUNDLE_GEMFILE=gemfiles/rails_8.1.rb bundle exec rake
 ```
 
 To run a single test:
diff --git a/README.md b/README.md
@@ -489,17 +489,18 @@ in `authlogic/session/base.rb`.
 
 ## 90. Compatibility
 
-| Version | branch     | ruby     | activerecord  |
-| ------- | ---------- | -------- | ------------- |
-| 6.5.0   | 6-5-stable | >= 2.4.0 | >= 5.2, < 8.0 |
-| 6.4.3   | 6-4-stable | >= 2.4.0 | >= 5.2, < 7.1 |
-| 5.2     | 5-2-stable | >= 2.3.0 | >= 5.2, < 6.1 |
-| 4.5     | 4-5-stable | >= 2.3.0 | >= 4.2, < 5.3 |
-| 4.3     | 4-3-stable | >= 2.3.0 | >= 4.2, < 5.3 |
-| 4.2     | 4-2-stable | >= 2.2.0 | >= 4.2, < 5.3 |
-| 3       | 3-stable   | >= 1.9.3 | >= 3.2, < 5.3 |
-| 2       | rails2     | >= 1.9.3 | ~> 2.3.0      |
-| 1       | ?          | ?        | ?             |
+| Version    | branch     | ruby     | activerecord   |
+| ---------- | ---------- | -------- | -------------- |
+| Unreleased | master     | >= 2.6.0 | >= 5.2, < 8.3  |
+| 6.5.0      | 6-5-stable | >= 2.4.0 | >= 5.2, < 8.0  |
+| 6.4.3      | 6-4-stable | >= 2.4.0 | >= 5.2, < 7.1  |
+| 5.2        | 5-2-stable | >= 2.3.0 | >= 5.2, < 6.1  |
+| 4.5        | 4-5-stable | >= 2.3.0 | >= 4.2, < 5.3  |
+| 4.3        | 4-3-stable | >= 2.3.0 | >= 4.2, < 5.3  |
+| 4.2        | 4-2-stable | >= 2.2.0 | >= 4.2, < 5.3  |
+| 3          | 3-stable   | >= 1.9.3 | >= 3.2, < 5.3  |
+| 2          | rails2     | >= 1.9.3 | ~> 2.3.0       |
+| 1          | ?          | ?        | ?              |
 
 Under SemVer, [changes to dependencies][10] do not require a major release.
 
diff --git a/authlogic.gemspec b/authlogic.gemspec
@@ -25,9 +25,10 @@ require_relative "lib/authlogic/version"
   s.required_ruby_version = ">= 2.6.0"
 
   # See doc/rails_support_in_authlogic_5.0.md
-  s.add_dependency "activemodel", [">= 5.2", "< 8.1"]
-  s.add_dependency "activerecord", [">= 5.2", "< 8.1"]
-  s.add_dependency "activesupport", [">= 5.2", "< 8.1"]
+  # Expand upper bound to support Rails 8.1/8.2 (Active Model/Record/Support 8.1/8.2)
+  s.add_dependency "activemodel", ">= 5.2", "< 8.3"
+  s.add_dependency "activerecord", ">= 5.2", "< 8.3"
+  s.add_dependency "activesupport", ">= 5.2", "< 8.3"
   s.add_dependency "request_store", "~> 1.0"
   s.add_development_dependency "bcrypt", "~> 3.1"
   s.add_development_dependency "byebug", "~> 11.1.3"
diff --git a/gemfiles/rails_8.1.rb b/gemfiles/rails_8.1.rb
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec path: ".."
+
+gem "activerecord", "~> 8.1.0"
+gem "activesupport", "~> 8.1.0"
+gem "mysql2", "~> 0.5.6"
+gem "pg", "~> 1.5.8"
+gem "sqlite3", "~> 2.1.0"
diff --git a/gemfiles/rails_8.1_sqlite.rb b/gemfiles/rails_8.1_sqlite.rb
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec path: ".."
+
+gem "activerecord", "~> 8.1.0"
+gem "activesupport", "~> 8.1.0"
+gem "sqlite3", "~> 2.1.0"
diff --git a/gemfiles/rails_8.2.rb b/gemfiles/rails_8.2.rb
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec path: ".."
+
+gem "activerecord", "~> 8.2.0"
+gem "activesupport", "~> 8.2.0"
+gem "mysql2", "~> 0.5.6"
+gem "pg", "~> 1.5.8"
+gem "sqlite3", "~> 2.1.0"
diff --git a/gemfiles/rails_8.2_sqlite.rb b/gemfiles/rails_8.2_sqlite.rb
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec path: ".."
+
+gem "activerecord", "~> 8.2.0"
+gem "activesupport", "~> 8.2.0"
+gem "sqlite3", "~> 2.1.0"
diff --git a/lib/authlogic/acts_as_authentic/base.rb b/lib/authlogic/acts_as_authentic/base.rb
@@ -105,14 +105,14 @@ def first_column_to_exist(*columns_to_check)
 end
 
 ActiveSupport.on_load :active_record do
-  ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::Base
-  ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::Email
-  ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::LoggedInStatus
-  ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::Login
-  ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::MagicColumns
-  ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::Password
-  ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::PerishableToken
-  ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::PersistenceToken
-  ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::SessionMaintenance
-  ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::SingleAccessToken
+  ActiveRecord::Base.include Authlogic::ActsAsAuthentic::Base
+  ActiveRecord::Base.include Authlogic::ActsAsAuthentic::Email
+  ActiveRecord::Base.include Authlogic::ActsAsAuthentic::LoggedInStatus
+  ActiveRecord::Base.include Authlogic::ActsAsAuthentic::Login
+  ActiveRecord::Base.include Authlogic::ActsAsAuthentic::MagicColumns
+  ActiveRecord::Base.include Authlogic::ActsAsAuthentic::Password
+  ActiveRecord::Base.include Authlogic::ActsAsAuthentic::PerishableToken
+  ActiveRecord::Base.include Authlogic::ActsAsAuthentic::PersistenceToken
+  ActiveRecord::Base.include Authlogic::ActsAsAuthentic::SessionMaintenance
+  ActiveRecord::Base.include Authlogic::ActsAsAuthentic::SingleAccessToken
 end
diff --git a/lib/authlogic/controller_adapters/sinatra_adapter.rb b/lib/authlogic/controller_adapters/sinatra_adapter.rb
@@ -64,4 +64,4 @@ def self.included(klass)
   end
 end
 
-Sinatra::Base.send(:include, Authlogic::ControllerAdapters::SinatraAdapter::Adapter::Implementation)
+Sinatra::Base.include(Authlogic::ControllerAdapters::SinatraAdapter::Adapter::Implementation)
diff --git a/lib/authlogic/session/base.rb b/lib/authlogic/session/base.rb
@@ -358,7 +358,13 @@ class Base
         For example, rubocop-rails is confused by the deprecated method.
         (https://github.com/rubocop-hq/rubocop-rails/blob/master/lib/rubocop/cop/rails/dynamic_find_by.rb)
       EOS
-      VALID_SAME_SITE_VALUES = [nil, "Lax", "Strict", "None"].freeze
+      # Accept legacy string values and modern symbol values.
+      VALID_SAME_SITE_VALUES = [
+        nil,
+        :lax, :strict, :none,
+        "Lax", "Strict", "None",
+        "lax", "strict", "none"
+      ].freeze
 
       # Callbacks
       # =========
@@ -952,11 +958,16 @@ def remember_me_for(value = nil)
         # requests?
         #
         # * <tt>Default:</tt> nil
-        # * <tt>Accepts:</tt> String, one of nil, 'Lax' or 'Strict'
+        # * <tt>Accepts:</tt> Symbol or String, one of nil,
+        #   :lax/:strict/:none (or 'Lax'/'Strict'/'None')
         def same_site(value = nil)
-          unless VALID_SAME_SITE_VALUES.include?(value)
-            msg = "Invalid same_site value: #{value}. Valid: #{VALID_SAME_SITE_VALUES.inspect}"
-            raise ArgumentError, msg
+          unless value.nil?
+            normalized = normalize_same_site_to_string(value)
+            unless VALID_SAME_SITE_VALUES.include?(value) || !normalized.nil?
+              msg = "Invalid same_site value: #{value}. Valid: #{VALID_SAME_SITE_VALUES.inspect}"
+              raise ArgumentError, msg
+            end
+            return rw_config(:same_site, normalized)
           end
           rw_config(:same_site, value)
         end
@@ -1489,13 +1500,14 @@ def same_site
         @same_site = self.class.same_site(nil)
       end
 
-      # Accepts nil, 'Lax' or 'Strict' as possible flags.
+      # Accepts nil, :lax/:strict/:none, or the legacy 'Lax'/'Strict'/'None'.
       def same_site=(value)
-        unless VALID_SAME_SITE_VALUES.include?(value)
+        normalized = normalize_same_site_to_string(value)
+        if !value.nil? && normalized.nil?
           msg = "Invalid same_site value: #{value}. Valid: #{VALID_SAME_SITE_VALUES.inspect}"
           raise ArgumentError, msg
         end
-        @same_site = value
+        @same_site = normalized
       end
 
       # If the cookie should be signed
@@ -1806,7 +1818,7 @@ def generate_cookie_for_saving
           expires: remember_me_until,
           secure: secure,
           httponly: httponly,
-          same_site: same_site,
+          same_site: coerce_same_site_for_cookie_jar(same_site, cookie_jar),
           domain: controller.cookie_domain
         }
       end
@@ -1839,6 +1851,43 @@ def failed_login_ban_for
         self.class.failed_login_ban_for
       end
 
+      # Normalize same_site to canonical String form: "Lax", "Strict", "None" or nil.
+      def normalize_same_site_to_string(value)
+        return nil if value.nil?
+        v = value.is_a?(String) ? value.downcase : value
+        case v
+        when :lax, "lax" then "Lax"
+        when :strict, "strict" then "Strict"
+        when :none, "none" then "None"
+        end
+      end
+
+      class << self
+        # Class-level normalizer for use in class configuration writers.
+        def normalize_same_site_to_string(value)
+          return nil if value.nil?
+          v = value.is_a?(String) ? value.downcase : value
+          case v
+          when :lax, "lax" then "Lax"
+          when :strict, "strict" then "Strict"
+          when :none, "none" then "None"
+          end
+        end
+      end
+
+      # Coerce same_site to symbol for ActionDispatch cookie jars (Rails 7.1+),
+      # otherwise return the string as-is (for test mocks and non-Rails envs).
+      def coerce_same_site_for_cookie_jar(value, jar)
+        return nil if value.nil?
+        if defined?(ActionDispatch) && jar.class.name.start_with?("ActionDispatch")
+          # Rails expects symbols like :lax/:strict/:none
+          value.downcase.to_sym
+        else
+          # Preserve string form for mocks and other adapters
+          value
+        end
+      end
+
       def increase_failed_login_count
         if invalid_password? && attempted_record.respond_to?(:failed_login_count)
           attempted_record.failed_login_count ||= 0
diff --git a/lib/authlogic/test_case.rb b/lib/authlogic/test_case.rb
@@ -209,7 +209,7 @@ def controller
   end
 
   # TODO: Why are these lines inside the `Authlogic` module? Should be outside?
-  ::Test::Unit::TestCase.send(:include, TestCase) if defined?(::Test::Unit::TestCase)
-  ::MiniTest::Unit::TestCase.send(:include, TestCase) if defined?(::MiniTest::Unit::TestCase)
-  ::MiniTest::Test.send(:include, TestCase) if defined?(::MiniTest::Test)
+  ::Test::Unit::TestCase.include(TestCase) if defined?(::Test::Unit::TestCase)
+  ::MiniTest::Unit::TestCase.include(TestCase) if defined?(::MiniTest::Unit::TestCase)
+  ::MiniTest::Test.include(TestCase) if defined?(::MiniTest::Test)
 end
