database_cleaner-active_record 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 997c59d22ce3ef9178c0b69c3d30b98d2e1126ddf099b5630bf0fbc272c76280
-  data.tar.gz: c8fc2baa15ceb2d6efb1b6b3a0890868dad0b5b51c78929b39564cc6e2be0c0f
+  metadata.gz: 1c30dde1a5104c77a1bf907b7d5d5bb8aa187776246b8b02639d0ea8e352fd1d
+  data.tar.gz: 982552da4f5c169ddf5a0d16c9703eb2b73623e1330c476dd8116683409951fd
 SHA512:
-  metadata.gz: 6ddd99b203a2a712c8adbf01de42dbc751894ffe52f61cc540ebc116ceb9efc0ad8bb7cdeba08630d77b6754ac81fcad19adb1031d9c84bb4d7cbfcddd250675
-  data.tar.gz: fd9f66f85aa80d0247f9bbb753aad05d58b129723d36676ef09927091630a6e65025180dbb01fb7e9d31f4180933df5f98103c98ba71b0f4f2ff9ea639e31916
+  metadata.gz: 9d46caf98521a0a53b67655e1eb55947108b13cf37b2ce8398fcdc53f34b334c51fa34acf65135c04689a1022394a396dc0648c0406d2d92a147c005bf488551
+  data.tar.gz: fd15224bc593acc67996d9a2c04840df1e95d3eafb49a68ba6d73dd64c0e92cd6984d9bb7b972ed7d6ef6063d67cd918ba1474630c8675520e932ef57c267108

data/.github/workflows/ci.yml

@@ -4,44 +4,51 @@ on: [push, pull_request]
 
 jobs:
   test:
-    name: 'Ruby: ${{ matrix.ruby }}, Rails: ${{ matrix.rails }}'
+    name: 'Ruby: ${{ matrix.ruby }}, Rails: ${{ matrix.rails }}, Channel: ${{ matrix.channel }}'
     runs-on: 'ubuntu-22.04'
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.2', '3.1', '3.0', '2.7', '2.6', '2.5']
-        rails: ['5.1', '5.2', '6.0', '6.1', '7.0', '7.1']
-        exclude:
-          - ruby: '3.2'
-            rails: '5.1'
-          - ruby: '3.2'
-            rails: '5.2'
+        ruby: ['3.3', '3.2', '3.1']
+        rails: ['6.1', '7.0', '7.1', '7.2']
+        channel: ['stable']
+
+        include:
+          - ruby: 'ruby-head'
+            rails: 'edge'
+            channel: 'experimental'
+          - ruby: 'ruby-head'
+            rails: '7.2'
+            channel: 'experimental'
+          - ruby: 'ruby-head'
+            rails: '7.1'
+            channel: 'experimental'
+
+          - ruby: '3.3'
+            rails: 'edge'
+            channel: 'experimental'
           - ruby: '3.2'
-            rails: '6.0'
+            rails: 'edge'
+            channel: 'experimental'
+          - ruby: '3.1'
+            rails: 'edge'
+            channel: 'experimental'
+
+        exclude:
+          - ruby: '3.3'
+            rails: '7.0' # TODO: works on 7-0-stable branch, remove after a 7.0.x patch release
+          - ruby: '3.3'
+            rails: '6.1'
+
           - ruby: '3.2'
             rails: '6.1'
-          - ruby: '3.1'
-            rails: '5.1'
-          - ruby: '3.1'
-            rails: '5.2'
-          - ruby: '3.1'
-            rails: '6.0'
-          - ruby: '3.0'
-            rails: '5.1'
-          - ruby: '3.0'
-            rails: '5.2'
-          - ruby: '2.6'
-            rails: '7.0'
-          - ruby: '2.5'
-            rails: '7.0'
-          - ruby: '2.5'
-            rails: '7.1'
-          - ruby: '2.6'
-            rails: '7.1'
+
+    continue-on-error: ${{ matrix.channel != 'stable' }}
+
     env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
       BUNDLE_GEMFILE: gemfiles/rails_${{ matrix.rails }}.gemfile
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:

data/Appraisals

@@ -1,23 +1,22 @@
-appraise "rails-5.1" do
-  gem "rails", "~> 5.1.0"
-end
-
-appraise "rails-5.2" do
-  gem "rails", "~> 5.2.0"
-end
-
-appraise "rails-6.0" do
-  gem "rails", "~> 6.0.0"
-end
-
 appraise "rails-6.1" do
   gem "rails", "~> 6.1.0"
+  gem "sqlite3", "~> 1.5"
 end
 
 appraise "rails-7.0" do
   gem "rails", "~> 7.0.0"
+  gem "sqlite3", "~> 1.7"
 end
 
 appraise "rails-7.1" do
   gem "rails", "~> 7.1.0"
+  gem "sqlite3", "~> 1.7" # FIXME: remove after rails/rails#51592
+end
+
+appraise "rails-7.2" do
+  gem "rails", "~> 7.2.0.beta2"
+end
+
+appraise "rails-edge" do
+  gem "rails", github: "rails/rails"
 end

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Development (unreleased)
 
+## v2.2.1 2025-05-13
+
+* https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/111 by @tagliala
+* https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/104 by @fatkodima
+* https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/118 by @pat, @thegeorgeous, and @nnishimura
+
+## v2.2.0 2024-07-12
+
+* Fix "ERROR:  currval of sequence" in Postgres adapter: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/103
+* Use lock synchronize on transaction callback: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/73
+* Stop testing with EOLed Ruby & Rails versions: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/105
+* Fix compatibility issue with Rails 7.2: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/107
+* Fix typo in truncation methods: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/94/files
+* Address deprecation of ActiveRecord::Base.connection in Rails 7.2: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/102
+* Support Rails 7.2+: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/101
+* Fix reset_ids test with Trilogy adapter: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/93
+* Implement resetting ids for deletion strategy: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/71
+* Avoid loading ActiveRecord::Base early: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/91
+* Fix specs to account for trilogy: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/88
+* Add basic support for trilogy: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/85
+
 ## v2.1.0 2023-02-17
 
 * Add Ruby 3.2 to CI matrix: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/79

data/README.md

@@ -8,7 +8,7 @@ Clean your ActiveRecord databases with Database Cleaner.
 
 See https://github.com/DatabaseCleaner/database_cleaner for more information.
 
-For support or to discuss development please use the [Google Group](https://groups.google.com/group/database_cleaner).
+For support or to discuss development please use GitHub Issues.
 
 ## Installation
 
@@ -61,6 +61,10 @@ DatabaseCleaner[:active_record].strategy = DatabaseCleaner::ActiveRecord::Deleti
 
 * `:cache_tables` - When set to `true` the list of tables to truncate or delete from will only be read from the DB once, otherwise it will be read before each cleanup run. Set this to `false` if (1) you create and drop tables in your tests, or (2) you change Postgres schemas (`ActiveRecord::Base.connection.schema_search_path`) in your tests (for example, in a multitenancy setup with each tenant in a different Postgres schema). Defaults to `true`.
 
+* `:reset_ids` - Only valid for deletion strategy, when set to `true` resets ids to 1 after each table is cleaned.
+
+* `:truncate_option` - Only valid for PostgreSQL. Acceptable values are `:restrict` and `:cascade`. Default is `:restrict`
+
 ## Adapter configuration options
 
 `#db` defaults to the default ActiveRecord database, but can be specified manually in a few ways:
@@ -95,7 +99,7 @@ You can also add this parameter to your database.yml file:
 test:
   adapter: postgresql
   # ...
-  min_messages: WARNING  
+  min_messages: WARNING
 </pre>
 
 ## COPYRIGHT

data/database_cleaner-active_record.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "mysql2"
   spec.add_development_dependency "pg"
   spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "trilogy"
 end

data/gemfiles/rails_6.1.gemfile

@@ -4,17 +4,11 @@ source "https://rubygems.org"
 
 gem "database_cleaner-core", git: "https://github.com/DatabaseCleaner/database_cleaner"
 gem "rails", "~> 6.1.0"
+gem "sqlite3", "~> 1.5"
 
 group :test do
   gem "simplecov", require: false
   gem "codecov", require: false
 end
 
-if RUBY_VERSION >= '3.1'
-  gem 'net-smtp', require: false
-  gem 'net-imap', require: false
-  gem 'net-pop', require: false
-end
-
-
 gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 
 gem "database_cleaner-core", git: "https://github.com/DatabaseCleaner/database_cleaner"
 gem "rails", "~> 7.0.0"
+gem "sqlite3", "~> 1.7"
 
 group :test do
   gem "simplecov", require: false

data/gemfiles/rails_7.1.gemfile

@@ -3,7 +3,8 @@
 source "https://rubygems.org"
 
 gem "database_cleaner-core", git: "https://github.com/DatabaseCleaner/database_cleaner"
-gem "rails", github: 'rails/rails' # "~> 7.1.0"
+gem "rails", "~> 7.1.0"
+gem "sqlite3", "~> 1.7"
 
 group :test do
   gem "simplecov", require: false

data/gemfiles/{rails_5.1.gemfile → rails_7.2.gemfile}

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 
 gem "database_cleaner-core", git: "https://github.com/DatabaseCleaner/database_cleaner"
-gem "rails", "~> 5.1.0"
+gem "rails", "~> 7.2.0.beta2"
 
 group :test do
   gem "simplecov", require: false

data/gemfiles/{rails_5.2.gemfile → rails_edge.gemfile}

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 
 gem "database_cleaner-core", git: "https://github.com/DatabaseCleaner/database_cleaner"
-gem "rails", "~> 5.2.0"
+gem "rails", github: "rails/rails"
 
 group :test do
   gem "simplecov", require: false

data/lib/database_cleaner/active_record/base.rb

@@ -1,4 +1,3 @@
-require 'active_record'
 require 'database_cleaner/strategy'
 require 'erb'
 require 'yaml'
@@ -15,7 +14,9 @@ module DatabaseCleaner
 
     class Base < DatabaseCleaner::Strategy
       def self.migration_table_name
-        if Gem::Version.new("6.0.0") <= ::ActiveRecord.version
+        if ::ActiveRecord::Base.connection_pool.respond_to?(:schema_migration) # Rails >= 7.2
+          ::ActiveRecord::Base.connection_pool.schema_migration.table_name
+        elsif ::ActiveRecord::Base.connection.respond_to?(:schema_migration) # Rails >= 6.0
           ::ActiveRecord::Base.connection.schema_migration.table_name
         else
           ::ActiveRecord::SchemaMigration.table_name

data/lib/database_cleaner/active_record/deletion.rb

@@ -1,15 +1,12 @@
-require 'active_record'
-require 'database_cleaner/active_record/truncation'
-
 module DatabaseCleaner
   module ActiveRecord
     class Deletion < Truncation
       def clean
         connection.disable_referential_integrity do
           if pre_count? && connection.respond_to?(:pre_count_tables)
-            delete_tables(connection, connection.pre_count_tables(tables_to_truncate(connection)))
+            delete_tables(connection, connection.pre_count_tables(tables_to_clean(connection)))
           else
-            delete_tables(connection, tables_to_truncate(connection))
+            delete_tables(connection, tables_to_clean(connection))
           end
         end
       end
@@ -19,6 +16,7 @@ module DatabaseCleaner
       def delete_tables(connection, table_names)
         table_names.each do |table_name|
           delete_table(connection, table_name)
+          reset_id_sequence(connection, table_name) if @reset_ids
         end
       end
 
@@ -26,7 +24,20 @@ module DatabaseCleaner
         connection.execute("DELETE FROM #{connection.quote_table_name(table_name)} WHERE 1=1")
       end
 
-      def tables_to_truncate(connection)
+      def reset_id_sequence connection, table_name
+        case connection.adapter_name
+        when 'Mysql2', 'Trilogy'
+          connection.execute("ALTER TABLE #{table_name} AUTO_INCREMENT = 1;")
+        when 'SQLite'
+          connection.execute("delete from sqlite_sequence where name='#{table_name}';")
+        when 'PostgreSQL'
+          connection.reset_pk_sequence!(table_name)
+        else
+          raise "reset_id option not supported for #{connection.adapter_name}"
+        end
+      end
+
+      def tables_to_clean(connection)
         if information_schema_exists?(connection)
           @except += connection.database_cleaner_view_cache + migration_storage_names
           (@only.any? ? @only : tables_with_new_rows(connection)) - @except
@@ -64,7 +75,7 @@ module DatabaseCleaner
       end
 
       def information_schema_exists? connection
-        connection.adapter_name == "Mysql2"
+        ["Mysql2", "Trilogy"].include?(connection.adapter_name)
       end
     end
   end

data/lib/database_cleaner/active_record/transaction.rb

@@ -1,20 +1,26 @@
-require 'database_cleaner/active_record/base'
-
 module DatabaseCleaner
   module ActiveRecord
     class Transaction < Base
       def start
+        connection = if ::ActiveRecord.version >= Gem::Version.new("7.2")
+          connection_class.lease_connection
+        else
+          connection_class.connection
+        end
+
         # Hack to make sure that the connection is properly set up before cleaning
-        connection_class.connection.transaction {}
+        connection.transaction {}
 
-        connection_class.connection.begin_transaction joinable: false
+        connection.begin_transaction joinable: false
       end
 
 
       def clean
         connection_class.connection_pool.connections.each do |connection|
-          next unless connection.open_transactions > 0
-          connection.rollback_transaction
+          connection.lock.synchronize do
+            next unless connection.open_transactions > 0
+            connection.rollback_transaction
+          end
         end
       end
     end

data/lib/database_cleaner/active_record/truncation.rb

@@ -1,28 +1,29 @@
 require "delegate"
-require 'active_record/base'
 require 'database_cleaner/active_record/base'
 
 module DatabaseCleaner
   module ActiveRecord
     class Truncation < Base
       def initialize(opts={})
-        if !opts.empty? && !(opts.keys - [:only, :except, :pre_count, :cache_tables]).empty?
-          raise ArgumentError, "The only valid options are :only, :except, :pre_count, and :cache_tables. You specified #{opts.keys.join(',')}."
+        if !opts.empty? && !(opts.keys - [:only, :except, :pre_count, :cache_tables, :reset_ids, :truncate_option]).empty?
+          raise ArgumentError, "The only valid options are :only, :except, :pre_count, :reset_ids, :cache_tables and :truncate_option. You specified #{opts.keys.join(',')}."
         end
 
         @only = Array(opts[:only]).dup
         @except = Array(opts[:except]).dup
 
+        @reset_ids = opts[:reset_ids]
         @pre_count = opts[:pre_count]
+        @truncate_option = opts[:truncate_option] || :restrict
         @cache_tables = opts.has_key?(:cache_tables) ? !!opts[:cache_tables] : true
       end
 
       def clean
         connection.disable_referential_integrity do
           if pre_count? && connection.respond_to?(:pre_count_truncate_tables)
-            connection.pre_count_truncate_tables(tables_to_truncate(connection))
+            connection.pre_count_truncate_tables(tables_to_clean(connection))
           else
-            connection.truncate_tables(tables_to_truncate(connection))
+            connection.truncate_tables(tables_to_clean(connection), { truncate_option: @truncate_option })
           end
         end
       end
@@ -30,10 +31,16 @@ module DatabaseCleaner
       private
 
       def connection
-        @connection ||= ConnectionWrapper.new(connection_class.connection)
+        @connection ||= ConnectionWrapper.new(
+          if ::ActiveRecord.version >= Gem::Version.new("7.2")
+            connection_class.lease_connection
+          else
+            connection_class.connection
+          end
+        )
       end
 
-      def tables_to_truncate(connection)
+      def tables_to_clean(connection)
         if @only.none?
           all_tables = cache_tables? ? connection.database_cleaner_table_cache : connection.database_tables
           @only = all_tables.map { |table| table.split(".").last }
@@ -62,7 +69,7 @@ module DatabaseCleaner
       def initialize(connection)
         extend AbstractAdapter
         case connection.adapter_name
-        when "Mysql2"
+        when "Mysql2", "Trilogy"
           extend AbstractMysqlAdapter
         when "SQLite"
           extend AbstractMysqlAdapter
@@ -96,7 +103,7 @@ module DatabaseCleaner
           execute("DELETE FROM #{quote_table_name(table_name)}")
         end
 
-        def truncate_tables(tables)
+        def truncate_tables(tables, opts)
           tables.each { |t| truncate_table(t) }
         end
       end
@@ -146,7 +153,7 @@ module DatabaseCleaner
           end
         end
 
-        def truncate_tables(tables)
+        def truncate_tables(tables, opts)
           tables.each { |t| truncate_table(t) }
         end
 
@@ -187,9 +194,10 @@ module DatabaseCleaner
           tables_with_schema
         end
 
-        def truncate_tables(table_names)
+        def truncate_tables(table_names, opts)
           return if table_names.nil? || table_names.empty?
-          execute("TRUNCATE TABLE #{table_names.map{|name| quote_table_name(name)}.join(', ')} RESTART IDENTITY RESTRICT;")
+
+          execute("TRUNCATE TABLE #{table_names.map{|name| quote_table_name(name)}.join(', ')} RESTART IDENTITY #{opts[:truncate_option]};")
         end
 
         def pre_count_truncate_tables(tables)
@@ -218,7 +226,7 @@ module DatabaseCleaner
         def has_been_used?(table)
           return has_rows?(table) unless has_sequence?(table)
 
-          cur_val = select_value("SELECT currval('#{table}_id_seq');").to_i rescue 0
+          cur_val = select_value("SELECT last_value from #{table}_id_seq;").to_i
           cur_val > 0
         end
 
@@ -246,4 +254,3 @@ module DatabaseCleaner
     private_constant :ConnectionWrapper
   end
 end
-

data/lib/database_cleaner/active_record/version.rb

@@ -1,5 +1,5 @@
 module DatabaseCleaner
   module ActiveRecord
-    VERSION = "2.1.0"
+    VERSION = "2.2.1"
   end
 end

data/lib/database_cleaner/active_record.rb

@@ -1,7 +1,11 @@
-require 'database_cleaner/active_record/version'
+require 'active_record'
 require 'database_cleaner/core'
-require 'database_cleaner/active_record/transaction'
-require 'database_cleaner/active_record/truncation'
-require 'database_cleaner/active_record/deletion'
 
-DatabaseCleaner[:active_record].strategy = :transaction
+ActiveSupport.on_load(:active_record) do
+  require 'database_cleaner/active_record/base'
+  require 'database_cleaner/active_record/transaction'
+  require 'database_cleaner/active_record/truncation'
+  require 'database_cleaner/active_record/deletion'
+
+  DatabaseCleaner[:active_record].strategy = :transaction
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_cleaner-active_record
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Ernesto Tagwerker
 - Micah Geisel
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2025-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_cleaner-core
@@ -137,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: trilogy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Strategies for cleaning databases using ActiveRecord. Can be used to
   ensure a clean state for testing.
 email:
@@ -148,7 +161,6 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -159,12 +171,11 @@ files:
 - bin/setup
 - database_cleaner-active_record.gemspec
 - gemfiles/.bundle/config
-- gemfiles/rails_5.1.gemfile
-- gemfiles/rails_5.2.gemfile
-- gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
 - gemfiles/rails_7.0.gemfile
 - gemfiles/rails_7.1.gemfile
+- gemfiles/rails_7.2.gemfile
+- gemfiles/rails_edge.gemfile
 - lib/database_cleaner-active_record.rb
 - lib/database_cleaner/active_record.rb
 - lib/database_cleaner/active_record/base.rb
@@ -177,7 +188,6 @@ homepage: https://github.com/DatabaseCleaner/database_cleaner-active_record
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -192,8 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Strategies for cleaning databases using ActiveRecord. Can be used to ensure
   a clean state for testing.

data/.travis.yml

@@ -1,25 +0,0 @@
-language: ruby
-services:
-  - mysql
-  - postgresql
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-  - 3.0
-gemfile:
-  - gemfiles/rails_5.1.gemfile
-  - gemfiles/rails_5.2.gemfile
-  - gemfiles/rails_6.0.gemfile
-  - gemfiles/rails_6.1.gemfile
-jobs:
-  exclude: # Unsupported combos: https://www.fastruby.io/blog/ruby/rails/versions/compatibility-table.html
-  - rvm: 3.0
-    gemfile: gemfiles/rails_5.1.gemfile
-  - rvm: 3.0
-    gemfile: gemfiles/rails_5.2.gemfile
-
-before_install:
-  - bin/setup
-cache:
-  bundler: true

data/gemfiles/rails_6.0.gemfile

@@ -1,13 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "database_cleaner-core", git: "https://github.com/DatabaseCleaner/database_cleaner"
-gem "rails", "~> 6.0.0"
-
-group :test do
-  gem "simplecov", require: false
-  gem "codecov", require: false
-end
-
-gemspec path: "../"