database_cleaner-active_record 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85e54fe3fd85573506fd946df28f0ba19101ca6d854317ea38596e42d7d3e2c8
-  data.tar.gz: 746f002f2a5b7fe97b39550db8d5ac945cc9e7d0ae46a04aafd2001eb214a226
+  metadata.gz: f4009a9e2733cc775473d2357dedf4005e14abc0be5a1b2841241dc9ac0a8afd
+  data.tar.gz: 89a9750d057f21fb543f2f7ca93926c48df4e2b08fec1276589063ca42254146
 SHA512:
-  metadata.gz: e823f4e8874d3369dcbce8f3e626cacac42cca7270544a91afda9b8bda3927577c1c85e50d57bf3ec21bce8c7443c65a845c364e404c04a8b3983678cb2e3bfd
-  data.tar.gz: 538b0e24fc2ff9f1756defdac05ce7290e3c2d24bd42f3d6f59c0001364976a183b42fafba7c847c1113f31265889b79614ab00da4c793abcc12d85bea9d4070
+  metadata.gz: 0daef1af314e3a7f432257e7b6051076d7963e685861b5b232811bcb9bcc6cdf0d9a020b980536ca9533c804c0aebe258dbaf6ef642a96c56950be6faf50ce3a
+  data.tar.gz: 3166ab8f41926b33a005f458ad601de7f2cc0fff3c2a36151a5c217271fe3dd84a7db332c448ece8aafab396d5e730c3b4760acfc5b56edd6129201e12977f86

data/.github/workflows/ci.yml

@@ -9,14 +9,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.3', '3.2', '3.1']
-        rails: ['6.1', '7.0', '7.1', '7.2']
+        ruby: ['3.4', '3.3', '3.2', '3.1']
+        rails: ['6.1', '7.0', '7.1', '7.2', '8.0']
         channel: ['stable']
 
         include:
           - ruby: 'ruby-head'
             rails: 'edge'
             channel: 'experimental'
+          - ruby: 'ruby-head'
+            rails: '8.0'
+            channel: 'experimental'
           - ruby: 'ruby-head'
             rails: '7.2'
             channel: 'experimental'
@@ -24,25 +27,29 @@ jobs:
             rails: '7.1'
             channel: 'experimental'
 
-          - ruby: '3.3'
+          - ruby: '3.4'
             rails: 'edge'
             channel: 'experimental'
-          - ruby: '3.2'
+          - ruby: '3.3'
             rails: 'edge'
             channel: 'experimental'
-          - ruby: '3.1'
+          - ruby: '3.2'
             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.4'
+            rails: '6.1'
+
           - ruby: '3.3'
             rails: '6.1'
 
           - ruby: '3.2'
             rails: '6.1'
 
+          - ruby: '3.1'
+            rails: '8.0'
+
     continue-on-error: ${{ matrix.channel != 'stable' }}
 
     env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps

data/Appraisals

@@ -1,16 +1,3 @@
-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"
-  gem "sqlite3", "~> 1.5"
-end
-
 appraise "rails-6.1" do
   gem "rails", "~> 6.1.0"
   gem "sqlite3", "~> 1.5"

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Development (unreleased)
 
+## v2.2.2 2025-07-30
+
+* Release database connections after cleaning: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/122
+* Provide a 'Changelog' link on Rubygems: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/114
+* Fix bundling and CONTRIBUTE.md instructions: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/123
+* https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/121 by @etagwerker
+* Fix order of arguments in `truncate_tables` expectation https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/124
+* Add Docker to make it easier to run tests locally for maintainers and contributors https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/109
+* Allow truncation option https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/121 by @etagwerker
+
+## 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
@@ -19,4 +35,4 @@
 
 * Add Ruby 3.2 to CI matrix: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/79
 * Add Rails 7.1 support: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/78
-* Add WHERE clause to make `ruby-spanner-activerecord` happy: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/77
+* Add WHERE clause to make `ruby-spanner-activerecord` happy: https://github.com/DatabaseCleaner/database_cleaner-active_record/pull/77

data/CONTRIBUTE.md

@@ -0,0 +1,45 @@
+# Guidelines for contributing
+
+## 1. Fork & Clone
+
+Since you probably don't have rights to the main repo, you should Fork it (big
+button up top). After that, clone your fork locally and optionally add an
+upstream:
+
+    git remote add upstream git@github.com:DatabaseCleaner/database_cleaner-active_record.git
+
+## 2. Make sure the tests run fine
+
+The gem uses Appraisal to configure different Gemfiles to test different Rails versions.
+
+### Run tests without Docker (or using Docker only for the databases)
+
+- You can run all the databases through docker if needed with `docker compose -f docker-compose.db.yml up` (you can also have them running on your system, just comment out the ones you don't need from the `docker-compose.db.yml` file)
+- Copy `spec/support/sample.config.yml` to `spec/support/config.yml` and edit it as needed
+- `BUNDLE_GEMFILE=gemfiles/rails_6.1.gemfile bundle install` (change `6.1` with any version from the `gemfiles` directory)
+- `BUNDLE_GEMFILE=gemfiles/rails_6.1.gemfile bundle exec rake`
+
+Note that if you don't have all the supported databases installed and running,
+some tests will fail.
+
+> Check the `.github/workflows/ci.yml` file for different combinations of Ruby and Rails that are expected to work
+
+### Run tests with Docker
+
+- Open `docker-compose.yml` and configure the Ruby version and Gemfile file to use
+- Copy `spec/support/sample.docker.config.yml` to `spec/support/config.yml` (not this config file is specific for the Docker setup)
+- Run `docker compose up` to start the container, run the tests, and exit
+- Run `docker compose run ruby bash` to open `bash` inside the container for more control, run `rake` to run the tests
+
+> Note that the code is mounted inside the docker container, so changes in the container will reflect in the code. There's no need to re-build the container for code changes, but changing the Ruby version or Gemfile in the docker-compose.yml will require a container re-build with `docker compose build --no-cache`
+
+> Check the `.github/workflows/ci.yml` file for different combinations of Ruby and Rails that are expected to work
+
+## 3. Prepare your contribution
+
+This is all up to you but a few points should be kept in mind:
+
+- Please write tests for your contribution
+- Make sure that previous tests still pass
+- Push it to a branch of your fork
+- Submit a pull request

data/Dockerfile

@@ -0,0 +1,19 @@
+ARG RUBY_VERSION=3.3
+FROM ruby:${RUBY_VERSION}
+
+# Set the working directory in the container
+WORKDIR /app
+
+# Copy the current directory contents into the container at /app
+# This is copied so we can bundle the application, but it's replaced
+# by a mounted volume with the current code when executed with docker compose
+COPY . /app
+
+ARG BUNDLE_GEMFILE=Gemfile
+ENV BUNDLE_GEMFILE=${BUNDLE_GEMFILE}
+
+# Install any needed packages specified in Gemfile
+RUN ./bin/setup
+
+# Command to run the application
+CMD ["bash"]

data/README.md

@@ -63,6 +63,8 @@ DatabaseCleaner[:active_record].strategy = DatabaseCleaner::ActiveRecord::Deleti
 
 * `: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:
@@ -100,6 +102,10 @@ test:
   min_messages: WARNING
 </pre>
 
+## Development
+
+Check the CONTRIBUTE.md file for instructions running tests with and withour Docker.
+
 ## COPYRIGHT
 
 See [LICENSE](LICENSE) for details.

data/database_cleaner-active_record.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "database_cleaner-core", "~>2.0.0"
+  spec.add_dependency "database_cleaner-core", "~>2.0"
   spec.add_dependency "activerecord", ">= 5.a"
 
   spec.add_development_dependency "bundler"
@@ -29,4 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pg"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "trilogy"
+
+  spec.metadata["changelog_uri"] = spec.homepage + "/blob/main/CHANGELOG.md"
 end

data/docker-compose.db.yml

@@ -0,0 +1,19 @@
+services:
+  postgres:
+    image: postgres:16 # specify the version needed for a given app
+    environment:
+      - POSTGRES_PASSWORD=postgres # this is required
+    ports:
+      - "127.0.0.1:5432:5432" # so we can use `localhost` as the host
+  mysql:
+    image: mysql:5.7
+    environment:
+      - MYSQL_ROOT_PASSWORD=mysql
+    ports:
+      - "127.0.0.1:3306:3306"
+  redis:
+    image: redis:6.2-alpine
+    restart: always
+    ports:
+      - "127.0.0.1:6379:6379"
+    command: redis-server --save 20 1 --loglevel warning

data/docker-compose.yml

@@ -0,0 +1,26 @@
+services:
+  postgres:
+    image: postgres:16 # specify the version needed for a given app
+    environment:
+      - POSTGRES_PASSWORD=postgres # this is required
+  mysql:
+    image: mysql:5.7
+    environment:
+      - MYSQL_ROOT_PASSWORD=mysql
+  redis:
+    image: redis:6.2-alpine
+    restart: always
+    command: redis-server --save 20 1 --loglevel warning
+  ruby:
+    build:
+      context: .
+      args:
+        BUNDLE_GEMFILE: gemfiles/rails_7.2.gemfile # Manually change this based on the desired Rails version
+        RUBY_VERSION: 3.3 # Manually change this based on the desired Ruby version
+    volumes:
+      - ".:/app:delegated"
+    command: rake
+    depends_on:
+      - mysql
+      - postgres
+      - redis

data/gemfiles/rails_6.1.gemfile

@@ -5,6 +5,10 @@ source "https://rubygems.org"
 gem "database_cleaner-core", git: "https://github.com/DatabaseCleaner/database_cleaner"
 gem "rails", "~> 6.1.0"
 gem "sqlite3", "~> 1.5"
+gem "concurrent-ruby", "1.3.4"
+gem "logger"
+gem "mutex_m"
+gem "bigdecimal"
 
 group :test do
   gem "simplecov", require: false

data/gemfiles/rails_7.0.gemfile

@@ -5,6 +5,10 @@ source "https://rubygems.org"
 gem "database_cleaner-core", git: "https://github.com/DatabaseCleaner/database_cleaner"
 gem "rails", "~> 7.0.0"
 gem "sqlite3", "~> 1.7"
+gem "concurrent-ruby", "1.3.4"
+gem "logger"
+gem "mutex_m"
+gem "bigdecimal"
 
 group :test do
   gem "simplecov", require: false

data/gemfiles/rails_7.1.gemfile

@@ -5,6 +5,9 @@ source "https://rubygems.org"
 gem "database_cleaner-core", git: "https://github.com/DatabaseCleaner/database_cleaner"
 gem "rails", "~> 7.1.0"
 gem "sqlite3", "~> 1.7"
+gem "logger"
+gem "mutex_m"
+gem "bigdecimal"
 
 group :test do
   gem "simplecov", require: false

data/gemfiles/rails_7.2.gemfile

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

data/gemfiles/rails_8.0.gemfile

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

data/gemfiles/rails_edge.gemfile

@@ -4,6 +4,9 @@ source "https://rubygems.org"
 
 gem "database_cleaner-core", git: "https://github.com/DatabaseCleaner/database_cleaner"
 gem "rails", github: "rails/rails"
+gem "logger"
+gem "mutex_m"
+gem "bigdecimal"
 
 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'

data/lib/database_cleaner/active_record/deletion.rb

@@ -1,6 +1,3 @@
-require 'active_record'
-require 'database_cleaner/active_record/truncation'
-
 module DatabaseCleaner
   module ActiveRecord
     class Deletion < Truncation
@@ -12,6 +9,8 @@ module DatabaseCleaner
             delete_tables(connection, tables_to_clean(connection))
           end
         end
+
+        connection_class.connection_pool.release_connection
       end
 
       private

data/lib/database_cleaner/active_record/transaction.rb

@@ -1,5 +1,3 @@
-require 'database_cleaner/active_record/base'
-
 module DatabaseCleaner
   module ActiveRecord
     class Transaction < Base
@@ -24,6 +22,8 @@ module DatabaseCleaner
             connection.rollback_transaction
           end
         end
+
+        connection_class.connection_pool.release_connection
       end
     end
   end

data/lib/database_cleaner/active_record/truncation.rb

@@ -5,8 +5,8 @@ module DatabaseCleaner
   module ActiveRecord
     class Truncation < Base
       def initialize(opts={})
-        if !opts.empty? && !(opts.keys - [:only, :except, :pre_count, :cache_tables, :reset_ids]).empty?
-          raise ArgumentError, "The only valid options are :only, :except, :pre_count, :reset_ids, 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
@@ -14,17 +14,20 @@ module DatabaseCleaner
 
         @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_clean(connection))
+            connection.pre_count_truncate_tables(tables_to_clean(connection), { truncate_option: @truncate_option })
           else
-            connection.truncate_tables(tables_to_clean(connection))
+            connection.truncate_tables(tables_to_clean(connection), { truncate_option: @truncate_option })
           end
         end
+
+        connection_class.connection_pool.release_connection
       end
 
       private
@@ -102,14 +105,14 @@ 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
 
       module AbstractMysqlAdapter
-        def pre_count_truncate_tables(tables)
-          truncate_tables(pre_count_tables(tables))
+        def pre_count_truncate_tables(tables, opts = {})
+          truncate_tables(pre_count_tables(tables), opts)
         end
 
         def pre_count_tables(tables)
@@ -152,12 +155,12 @@ module DatabaseCleaner
           end
         end
 
-        def truncate_tables(tables)
+        def truncate_tables(tables, opts)
           tables.each { |t| truncate_table(t) }
         end
 
-        def pre_count_truncate_tables(tables)
-          truncate_tables(pre_count_tables(tables))
+        def pre_count_truncate_tables(tables, opts = {})
+          truncate_tables(pre_count_tables(tables), opts)
         end
 
         def pre_count_tables(tables)
@@ -193,13 +196,14 @@ 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)
-          truncate_tables(pre_count_tables(tables))
+        def pre_count_truncate_tables(tables, opts = {})
+          truncate_tables(pre_count_tables(tables), opts)
         end
 
         def pre_count_tables(tables)

data/lib/database_cleaner/active_record/version.rb

@@ -1,5 +1,5 @@
 module DatabaseCleaner
   module ActiveRecord
-    VERSION = "2.2.0"
+    VERSION = "2.2.2"
   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.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Ernesto Tagwerker
 - Micah Geisel
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-12 00:00:00.000000000 Z
+date: 2025-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_cleaner-core
@@ -17,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +163,8 @@ files:
 - ".rspec"
 - Appraisals
 - CHANGELOG.md
+- CONTRIBUTE.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -171,11 +172,14 @@ files:
 - bin/console
 - bin/setup
 - database_cleaner-active_record.gemspec
+- docker-compose.db.yml
+- docker-compose.yml
 - gemfiles/.bundle/config
 - gemfiles/rails_6.1.gemfile
 - gemfiles/rails_7.0.gemfile
 - gemfiles/rails_7.1.gemfile
 - gemfiles/rails_7.2.gemfile
+- gemfiles/rails_8.0.gemfile
 - gemfiles/rails_edge.gemfile
 - lib/database_cleaner-active_record.rb
 - lib/database_cleaner/active_record.rb
@@ -188,8 +192,8 @@ files:
 homepage: https://github.com/DatabaseCleaner/database_cleaner-active_record
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  changelog_uri: https://github.com/DatabaseCleaner/database_cleaner-active_record/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -204,8 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
-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.