Add compatibility with rails 8.1

Author: Taucher2003

.github/workflows/main.yml

@@ -10,20 +10,29 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
+    name: Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
     strategy:
+      fail-fast: false
       matrix:
         ruby:
           - '3.2.2'
           - '3.3.6'
           - '3.4.7'
+        rails:
+          - '~> 8.0.0'
+          - '~> 8.1.0'
+
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
 
     steps:
       - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
+          bundler-cache: false
+      - name: Install gems
+        run: bundle install
       - name: Run the default task
         run: bin/rake

code0-zero_track.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
     Dir['{app,config,db,lib,rubocop}/**/*', 'LICENSE', 'Rakefile', 'README.md']
   end
 
-  spec.add_dependency 'rails', '>= 8.0.1'
+  spec.add_dependency 'rails', ENV.fetch('RAILS_VERSION', '>= 8.0.1')
   spec.add_dependency 'zeitwerk', '~> 2.7'
 
   spec.add_development_dependency 'rake', '~> 13.0'

lib/code0/zero_track.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/module/delegation'
 require 'rails/railtie'
 
 require 'zeitwerk'

lib/code0/zero_track/database/schema_migrations/formatter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Code0
+  module ZeroTrack
+    module Database
+      module SchemaMigrations
+        class Formatter
+          def initialize(connection)
+            @connection = connection
+          end
+
+          def format(_)
+            Database::SchemaMigrations.touch_all(@connection) unless Rails.env.production?
+            nil
+          end
+        end
+      end
+    end
+  end
+end

lib/code0/zero_track/injectors/active_record_schema_migrations.rb

@@ -4,12 +4,17 @@ module Code0
   module ZeroTrack
     module Injectors
       class ActiveRecordSchemaMigrations
-        def self.inject!
-          # Patch to write version information as empty files under the db/schema_migrations directory
-          # This is intended to reduce potential for merge conflicts in db/structure.sql
-          ActiveSupport.on_load(:active_record_postgresqladapter) do
-            prepend Database::PostgresqlAdapter::DumpSchemaVersionsMixin
+        def self.inject!(config)
+          if Rails.gem_version >= Gem::Version.create('8.1')
+            config.active_record.schema_versions_formatter = Database::SchemaMigrations::Formatter
+          else
+            # Patch to write version information as empty files under the db/schema_migrations directory
+            # This is intended to reduce potential for merge conflicts in db/structure.sql
+            ActiveSupport.on_load(:active_record_postgresqladapter) do
+              prepend Database::PostgresqlAdapter::DumpSchemaVersionsMixin
+            end
           end
+
           # Patch to load version information from empty files under the db/schema_migrations directory
           ActiveRecord::Tasks::PostgreSQLDatabaseTasks
             .prepend Database::PostgresqlDatabaseTasks::LoadSchemaVersionsMixin

lib/code0/zero_track/railtie.rb

@@ -16,7 +16,7 @@ class Railtie < ::Rails::Railtie
 
       config.after_initialize do
         Injectors::ActiveRecordTimestamps.inject! if config.zero_track.active_record.timestamps
-        Injectors::ActiveRecordSchemaMigrations.inject! if config.zero_track.active_record.schema_migrations
+        Injectors::ActiveRecordSchemaMigrations.inject!(config) if config.zero_track.active_record.schema_migrations
       end
     end
   end

spec/code0/zero_track/database/postgresql_adapter/dump_schema_versions_mixin_spec.rb

@@ -26,22 +26,24 @@ def original_dump_schema_information; end
 
   let(:instance) { instance_class.new }
 
-  it 'calls SchemaMigrations touch_all and skips original implementation' do
-    allow(Code0::ZeroTrack::Database::SchemaMigrations).to receive(:touch_all)
-    allow(instance).to receive(:original_dump_schema_information)
+  context 'when using Rails < 8.1', if: Rails.gem_version < Gem::Version.create('8.1') do
+    it 'calls SchemaMigrations touch_all and skips original implementation' do
+      allow(Code0::ZeroTrack::Database::SchemaMigrations).to receive(:touch_all)
+      allow(instance).to receive(:original_dump_schema_information)
 
-    instance.dump_schema_information
+      instance.dump_schema_information
 
-    expect(Code0::ZeroTrack::Database::SchemaMigrations).to have_received(:touch_all).with(instance)
-    expect(instance).not_to have_received(:original_dump_schema_information)
-  end
+      expect(Code0::ZeroTrack::Database::SchemaMigrations).to have_received(:touch_all).with(instance)
+      expect(instance).not_to have_received(:original_dump_schema_information)
+    end
 
-  it 'does not call touch_all in production' do
-    allow(Rails).to receive(:env).and_return(ActiveSupport::StringInquirer.new('production'))
-    allow(Code0::ZeroTrack::Database::SchemaMigrations).to receive(:touch_all)
+    it 'does not call touch_all in production' do
+      allow(Rails).to receive(:env).and_return(ActiveSupport::StringInquirer.new('production'))
+      allow(Code0::ZeroTrack::Database::SchemaMigrations).to receive(:touch_all)
 
-    instance.dump_schema_information
+      instance.dump_schema_information
 
-    expect(Code0::ZeroTrack::Database::SchemaMigrations).not_to have_received(:touch_all)
+      expect(Code0::ZeroTrack::Database::SchemaMigrations).not_to have_received(:touch_all)
+    end
   end
 end