[HOLD] [FCM-8671] Rails 8 update

.github/workflows/ci.yml

@@ -14,13 +14,25 @@ jobs:
       fail-fast: false
       matrix:
         gemfile:
-          - Gemfile.rails-6.1-stable
           - Gemfile.rails-7.0-stable
           - Gemfile.rails-7.2-stable
-        ruby-version: ['3.1', '3.0']
+          - Gemfile.rails-8.0-stable
+          - Gemfile.rails-8.1-stable
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
         exclude:
+          # Rails 7.2 doesn't work with Ruby 3.0 (requires Ruby 3.1+)
           - gemfile: Gemfile.rails-7.2-stable
-            ruby-version: "3.0"
+            ruby-version: '3.0'
+          # Rails 8.0 doesn't work with Ruby 3.0 or 3.1 (requires Ruby 3.2+)
+          - gemfile: Gemfile.rails-8.0-stable
+            ruby-version: '3.0'
+          - gemfile: Gemfile.rails-8.0-stable
+            ruby-version: '3.1'
+          # Rails 8.1 requires Ruby 3.2+
+          - gemfile: Gemfile.rails-8.1-stable
+            ruby-version: '3.0'
+          - gemfile: Gemfile.rails-8.1-stable
+            ruby-version: '3.1'
     env:
       BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}
     steps:

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v3.5.0 (2026-04-30)
+
+### Added
+
+- Add Rails 8.1 compatibility. Rails 8.1 changed `PredicateBuilder::PolymorphicArrayValue#initialize` from `(associated_table, values)` to `(reflection, values)`, dropping the `@associated_table` ivar. `type_to_ids_mapping` now reads `@reflection` when available and falls back to `@associated_table.send(:reflection)` for older Rails versions.
+
 ## v3.2.1 (2023-12-14)
 
 ### Fixed
@@ -26,3 +32,11 @@
 
 - Remove unsupported rails versions(5.0, 5.2, 6.0) and ruby version(2.7)
 
+## v3.4.0 (2024-XX-XX)
+
+### Added
+
+- Add Rails 8.0 compatibility (requires Ruby 3.2+)
+
+### Removed 
+- Remove unsupported rails versions 6.x

README.md

@@ -138,20 +138,37 @@ Lastly, you will need to be careful of any place where you are doing raw SQL que
 
 ## Setup
 
-You'll need to have git, Ruby, and MySQL. Then get up and running with a few commands:
+You'll need to have git and Ruby. Then get up and running with a few commands:
 
 ```bash
 $ git clone ...
 $ bundle install
 $ vim spec/support/database.yml # Update username and password
-$ bin/setup
+$ bin/setup # Uses SQLite3 for testing (no additional setup required)
 $ bundle exec rspec
 ```
 
+## Database Compatibility
+
+This gem works with any database supported by ActiveRecord (SQLite3, MySQL, PostgreSQL, etc.). 
+The gem extends ActiveRecord's polymorphic associations and doesn't use database-specific features.
+
+Development and testing uses SQLite3 for simplicity.
+
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+# FCM Annotations
+
+This fork of `clio/polymorphic_integer_type` should stay in sync with upstream. As of the Rails 8 upgrade (FCM-8671) it is based on upstream **v3.5.0** with a single intentional difference.
+
+**The only change from the fork** is a guard in `lib/polymorphic_integer_type/belongs_to_polymorphic_association_extension.rb`. Upstream unconditionally rewrites a polymorphic association's stored `_type` to the target's `base_class`, which clobbers a model's custom `polymorphic_name` on plain `polymorphic: true` associations. We scope that rewrite to this gem's integer-type associations only, so plain polymorphic associations respect `polymorphic_name` (the `rma` app relies on this, for example: `Enrollment.polymorphic_name => 'Patient::Segment'`).
+
+Regression coverage is in `spec/fcm_polymorphic_name_guard_spec.rb`, along with the `Country` / `legacy_source` test fixtures.
+
+**When re-syncing with upstream, re-apply the guard after merging.**

Rakefile

@@ -1,53 +1,52 @@
-require "bundler/gem_tasks"
-require "yaml"
-require "active_record"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'yaml'
+require 'active_record'
 
 namespace :test do
   task :all do
-    Dir.glob("./gemfiles/Gemfile*").each do |gemfile|
-      next if gemfile.end_with?(".lock")
+    Dir.glob('./gemfiles/Gemfile*').each do |gemfile|
+      next if gemfile.end_with?('.lock')
+
       puts "Running specs for #{Pathname.new(gemfile).basename}"
       system("BUNDLE_GEMFILE=#{gemfile} bundle install > /dev/null && BUNDLE_GEMFILE=#{gemfile} bundle exec rspec")
-      puts ""
+      puts ''
     end
   end
 end
 
 namespace :db do
-  database_config = YAML.load(File.open("./spec/support/database.yml"))
-  admin_database_config = database_config.merge(database: "mysql")
-  migration_path = File.expand_path("./spec/support/migrations")
+  database_config = YAML.load(File.open('./spec/support/database.yml'))
+  migration_path = File.expand_path('./spec/support/migrations')
 
-  desc "Create the database"
+  desc 'Create the database'
   task :create do
-    ActiveRecord::Base.establish_connection(admin_database_config)
-    puts "Database created."
+    # SQLite3 creates the database file automatically, just ensure directory exists
+    db_file = database_config.fetch(:database)
+    FileUtils.mkdir_p(File.dirname(db_file)) unless File.dirname(db_file) == '.'
+    puts 'Database ready (SQLite3).'
   end
 
-  desc "Migrate the database"
+  desc 'Migrate the database'
   task :migrate do
     ActiveRecord::Base.establish_connection(database_config)
-    if defined?(ActiveRecord::MigrationContext)
-      migration_context = ActiveRecord::MigrationContext.new(migration_path, ActiveRecord::SchemaMigration)
-      migration_context.migrate
-    else
-      ActiveRecord::Migrator.migrate(migration_path)
-    end
-    Rake::Task["db:schema"].invoke
-    puts "Database migrated."
+    ActiveRecord::MigrationContext.new(migration_path).migrate
+    Rake::Task['db:schema'].invoke
+    puts 'Database migrated.'
   end
 
-  desc "Drop the database"
+  desc 'Drop the database'
   task :drop do
-    ActiveRecord::Base.establish_connection(admin_database_config)
+    # For SQLite3, just delete the file
     db_file = database_config.fetch(:database)
     File.delete(db_file) if File.exist?(db_file)
-    puts "Database deleted."
+    puts 'Database deleted.'
   end
 
-  desc "Reset the database"
+  desc 'Reset the database'
   task reset: [:drop, :create, :migrate]
-    desc 'Create a db/schema.rb file that is portable against any DB supported by AR'
+  desc 'Create a db/schema.rb file that is portable against any DB supported by AR'
 
   task :schema do
     # Noop to make ActiveRecord happy

gemfiles/Gemfile.rails-8.0-stable

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activerecord", github: "rails/rails", branch: "8-0-stable"

gemfiles/Gemfile.rails-8.1-stable

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activerecord", github: "rails/rails", branch: "8-1-stable"

lib/polymorphic_integer_type.rb

@@ -4,7 +4,6 @@
 require "polymorphic_integer_type/extensions"
 require "polymorphic_integer_type/mapping"
 require "polymorphic_integer_type/module_generator"
-require "polymorphic_integer_type/belongs_to_valid_options_extension"
 require "polymorphic_integer_type/belongs_to_polymorphic_association_extension"
 require "polymorphic_integer_type/activerecord_5_0_0/polymorphic_array_value_extension"
 require "polymorphic_integer_type/polymorphic_foreign_association_extension"

lib/polymorphic_integer_type/activerecord_5_0_0/polymorphic_array_value_extension.rb

@@ -10,10 +10,14 @@ module PolymorphicArrayValueExtension
     # end
 
     def type_to_ids_mapping
-      if ACTIVE_RECORD_VERSION < Gem::Version.new("6.1")
-        association = @associated_table.send(:association)
+      # Rails 8.1 changed `PredicateBuilder::PolymorphicArrayValue#initialize`
+      # from `(associated_table, values)` to `(reflection, values)`, dropping
+      # the `@associated_table` ivar. Read whichever ivar is available so this
+      # gem works across Rails 6.1–8.1.
+      association = if instance_variable_defined?(:@reflection) && @reflection
+        @reflection
       else
-        association = @associated_table.send(:reflection)
+        @associated_table.send(:reflection)
       end
 
       name = association.name

lib/polymorphic_integer_type/belongs_to_polymorphic_association_extension.rb

@@ -1,25 +1,37 @@
-module PolymorphicIntegerType
-  module BelongsToPolymorphicAssociationExtension
-    private
+module ActiveRecord
+  module Associations
+    class BelongsToPolymorphicAssociation < BelongsToAssociation
+      private
 
-    if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new("6.1")
-      def replace_keys(record)
-        super
-
-        if reflection.options[:integer_type] || reflection.options[:polymorphic].is_a?(Hash)
-          owner[reflection.foreign_type] = record.class.base_class unless record.nil?
-        end
-      end
-    else
       def replace_keys(record, force: false)
         super
+        return if record.nil?
 
-        if reflection.options[:integer_type] || reflection.options[:polymorphic].is_a?(Hash)
-          owner[reflection.foreign_type] = record.class.base_class unless record.nil?
-        end
+        # FCM fork delta -- RE-APPLY after any upstream sync!
+        #
+        # This gem *reopens* (does not prepend) `BelongsToPolymorphicAssociation`,
+        # so the `super` above is BelongsToAssociation#replace_keys, which sets
+        # the foreign key but NOT the polymorphic type, so this method is
+        # responsible for the `_type`.
+        #
+        # Upstream sets it unconditionally to the target's `base_class`, which
+        # clobbers a model's custom `polymorphic_name` on plain `polymorphic: true`
+        # associations.
+        # 
+        # The rma app relies on custom `polymorphic_name` (e.g.
+        # Enrollment => 'Patient::Segment'), so use `base_class` ONLY for this
+        # gem's integer-type associations (detected via the generated
+        # `<foreign_type>_mapping` class method) and fall back to Rails'
+        # `polymorphic_name` for plain polymorphic associations.
+        # 
+        # Regression is tested in spec/fcm_polymorphic_name_guard_spec.rb.
+        owner[reflection.foreign_type] =
+          if owner.class.respond_to?("#{reflection.foreign_type}_mapping")
+            record.class.base_class
+          else
+            record.class.polymorphic_name
+          end
       end
     end
   end
 end
-
-ActiveRecord::Associations::BelongsToPolymorphicAssociation.prepend(PolymorphicIntegerType::BelongsToPolymorphicAssociationExtension)

lib/polymorphic_integer_type/extensions.rb

@@ -9,14 +9,15 @@ module ClassMethods
 
       def belongs_to(name, scope = nil, **options)
         options = scope if scope.kind_of? Hash
+        integer_type = options.delete :integer_type
         super
-        if options[:polymorphic] && (options[:integer_type] || options[:polymorphic].is_a?(Hash))
+        if options[:polymorphic] && (integer_type || options[:polymorphic].is_a?(Hash))
           mapping =
-            case options[:integer_type]
+            case integer_type
             when true then PolymorphicIntegerType::Mapping[name]
             when nil then options[:polymorphic]
             else
-              raise ArgumentError, "Unknown integer_type value: #{options[:integer_type].inspect}"
+              raise ArgumentError, "Unknown integer_type value: #{integer_type.inspect}"
             end.dup
 
           foreign_type = reflections[name.to_s].foreign_type
@@ -117,12 +118,7 @@ def remove_integer_type_and_set_attributes_and_extension(integer_type_values, re
         if is_polymorphic_integer
           reflection.foreign_integer_type = foreign_integer_type
           reflection.integer_type = integer_type
-
-          if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new("6.1")
-            ActiveRecord::Associations::Association.prepend(PolymorphicIntegerType::PolymorphicForeignAssociationExtension)
-          else
-            ActiveRecord::Associations::ForeignAssociation.prepend(PolymorphicIntegerType::PolymorphicForeignAssociationExtension)
-          end
+          ActiveRecord::Associations::ForeignAssociation.prepend(PolymorphicIntegerType::PolymorphicForeignAssociationExtension)
         end
       end
 

lib/polymorphic_integer_type/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PolymorphicIntegerType
-  VERSION = "3.3.0"
+  VERSION = '3.5.0'
 end

polymorphic_integer_type.gemspec

@@ -1,27 +1,30 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'polymorphic_integer_type/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "polymorphic_integer_type"
+  spec.name          = 'polymorphic_integer_type'
   spec.version       = PolymorphicIntegerType::VERSION
-  spec.authors       = ["Kyle d'Oliveira"]
-  spec.email         = ["kyle@goclio.com"]
-  spec.description   = %q{Allows the *_type field in the DB to be an integer rather than a string}
-  spec.summary       = %q{Use integers rather than strings for the _type field}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Kyle d\'Oliveira']
+  spec.email         = ['kyle@goclio.com']
+  spec.description   = 'Allows the *_type field in the DB to be an integer rather than a string'
+  spec.summary       = 'Use integers rather than strings for the _type field'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 3.0'
 
   spec.files         = `git ls-files -- . ':!.github/'`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "activerecord", "< 8"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "pry-byebug"
+  spec.add_dependency 'activerecord', '< 9.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
 end