capture_migration_sql 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9d0592f093cdbe9554321bc75518d3af78810d3ed24b96c2f4914d326e5c991
-  data.tar.gz: 0ab138c8d223536e39724814947a4ddccee7dac377ec14b9544aed4d759a77c0
+  metadata.gz: 244ae0fce5c5654d09321b61daea560a442e213b395fb532145f611f8622f873
+  data.tar.gz: 3bb661d211e3a5bf357cdcd447f7b8516ae48e5a7a3c0b27810bc67db388b5c7
 SHA512:
-  metadata.gz: 48a1b618e0815a6e7644435e277b935a2e5bf65d0bb6188d7126404a83dd0cad90e17b1c1d9de675c01bae1a7119f5ab68772fb0e662dbd57e63ac8f517070b7
-  data.tar.gz: 9d311ca2aed3e266723741e5b95970fba37a3c9f133a4315b6e45d063991dd4411355a3f508f8cb3eb85527df6e179b0de177a21de9de9220f18f1981f6e6d9c
+  metadata.gz: df54712d0d2471fe64222635299652c816cee27309ce42cb4a7d783975cac9e6485fcb3aef192e0cd3403e813992117d1a42eb361668c786a622c23322b992f6
+  data.tar.gz: b130cec56900275e6e2da6771814fba7cc0f9ce4fc0d87c5f2303980031a8c67085c2200f87f9741ff92f345ef797b3b0b8b53964a38041b6ec5f8e98ea080c7

data/CHANGELOG.md

@@ -4,22 +4,48 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.5
+
+### Fixed
+
+- SQL files are no longer deleted before a down migration runs; if the down migration fails, the SQL file is kept since the migration is still applied.
+- SQL files are now written to a temporary file and atomically renamed into place, so a process killed mid-migration can no longer leave a permanent, truncated SQL file behind.
+- The migration SQL directory is now created with `FileUtils.mkdir_p`, eliminating a race condition between concurrent migration processes and supporting nested custom directories.
+- Attaching the SQL subscriber is now thread safe, preventing duplicate subscribers (and duplicated SQL output) when migrations run in parallel threads.
+- Ignored statement filters are now applied after stripping leading whitespace, so statements with leading whitespace no longer bypass them.
+- The `INSERT INTO schema_migrations` statement written to SQL files now honors custom schema migrations table names and table name prefixes and suffixes.
+- Connection labels from `using_connection` are no longer written to the SQL file when SQL logging is disabled.
+
+### Changed
+
+- Rails 5.2 and Ruby 2.6 are the minimum supported versions.
+
+## 1.0.4
+
+### Fixed
+
+- SQL files are now removed when they were created from a failed migration.
+
 ## 1.0.3
 
 ### Changed
-* SQL files will not be changed if they already exist.
+
+- SQL files will not be changed if they already exist.
 
 ## 1.0.2
 
 ### Changed
-* Fix data type for insterting into schema_migrations
+
+- Fix data type for insterting into schema_migrations
 
 ## 1.0.1
 
 ### Changed
-* Fix SQL for insterting into schema_migrations
+
+- Fix SQL for insterting into schema_migrations
 
 ## 1.0.0
 
 ### Added
-* Initial release
+
+- Initial release

data/README.md

@@ -1,7 +1,8 @@
-# CaptureMigrationSql
+# Capture Migration SQL
 
 [![Continuous Integration](https://github.com/bdurand/capture_migration_sql/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/capture_migration_sql/actions/workflows/continuous_integration.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Gem Version](https://badge.fury.io/rb/capture_migration_sql.svg)](https://badge.fury.io/rb/capture_migration_sql)
 
 This gem adds the ability to capture and persist the SQL statements executed by migrations. There are a couple of reasons why you may want to do this.
 

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.0.5

data/capture_migration_sql.gemspec

@@ -10,6 +10,12 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/bdurand/capture_migration_sql"
   spec.license = "MIT"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md"
+  }
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   ignore_files = %w[
@@ -21,13 +27,13 @@ Gem::Specification.new do |spec|
     gemfiles/
     spec/
   ]
-  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+  spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }
   end
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 4.2"
+  spec.add_dependency "activerecord", ">= 5.2"
 
-  spec.add_development_dependency "bundler"
+  spec.required_ruby_version = ">= 2.6"
 end

data/lib/capture_migration_sql/migration_extension.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "fileutils"
+
 # Extension methods for ActiveRecord::Migration class.
 module CaptureMigrationSql
   module MigrationExtension
@@ -18,7 +20,7 @@ module CaptureMigrationSql
     end
 
     # Enable SQL logging. You can call this method within a block where SQL
-    # logging was disabled to renable it.
+    # logging was disabled to re-enable it.
     def enable_sql_logging(&block)
       sql_logging(enabled: true, &block)
     end
@@ -46,7 +48,7 @@ module CaptureMigrationSql
       save_connection = @connection
       begin
         @connection = connection
-        stream = CaptureMigrationSql.capture_stream
+        stream = CaptureMigrationSql.capture_stream if CaptureMigrationSql.capture_enabled?
         stream.write("-- BEGIN #{label}\n\n") if label && stream
         retval = yield
         stream.write("-- END #{label}\n\n") if label && stream
@@ -73,24 +75,37 @@ module CaptureMigrationSql
         if File.exist?(output_file)
           yield
         else
-          Dir.mkdir(migration_sql_dir) unless File.exist?(migration_sql_dir)
+          FileUtils.mkdir_p(migration_sql_dir)
           SqlSubscriber.attach_if_necessary
-          File.open(output_file, "w") do |f|
-            f.write("--\n-- #{name} : #{version}\n--\n\n")
-            save_stream = Thread.current[:capture_migration_sql_stream]
-            begin
-              Thread.current[:capture_migration_sql_stream] = f
-              sql_logging(enabled: true, &block)
-            ensure
-              Thread.current[:capture_migration_sql_stream] = save_stream
+          temp_file = "#{output_file}.tmp.#{Process.pid}.#{Thread.current.object_id}"
+          begin
+            retval = File.open(temp_file, "w") do |f|
+              capture_migration_sql(f, &block)
             end
-            f.write("INSERT INTO schema_migrations (version) VALUES ('#{version.to_i}');\n")
+            File.rename(temp_file, output_file)
+            retval
+          ensure
+            File.unlink(temp_file) if File.exist?(temp_file)
           end
         end
       else
+        retval = yield
         File.unlink(output_file) if output_file && File.exist?(output_file)
-        yield
+        retval
+      end
+    end
+
+    def capture_migration_sql(f, &block)
+      f.write("--\n-- #{name} : #{version}\n--\n\n")
+      save_stream = Thread.current[:capture_migration_sql_stream]
+      begin
+        Thread.current[:capture_migration_sql_stream] = f
+        retval = sql_logging(enabled: true, &block)
+      ensure
+        Thread.current[:capture_migration_sql_stream] = save_stream
       end
+      f.write("INSERT INTO #{CaptureMigrationSql.schema_migrations_table_name} (version) VALUES ('#{version.to_i}');\n")
+      retval
     end
   end
 end

data/lib/capture_migration_sql/sql_subscriber.rb

@@ -10,16 +10,19 @@ module CaptureMigrationSql
 
     SHOW_STATEMENT = /\ASHOW\b/i
     EXPLAIN_STATEMENT = /\AEXPLAIN\b/i
-    SELECT_SCHEMA_MIGRATIONS = /\ASELECT.*FROM.*schema_migrations/i
     SELECT_INFORMATION_SCHEMA = /\ASELECT.*information_schema/im
     SQLLITE_VERSION = /\ASELECT sqlite_version\(/i
-    IGNORE_STATEMENTS = Regexp.union(SHOW_STATEMENT, EXPLAIN_STATEMENT, SELECT_SCHEMA_MIGRATIONS, SELECT_INFORMATION_SCHEMA, SQLLITE_VERSION)
+    IGNORE_STATEMENTS = Regexp.union(SHOW_STATEMENT, EXPLAIN_STATEMENT, SELECT_INFORMATION_SCHEMA, SQLLITE_VERSION)
+
+    ATTACH_MUTEX = Mutex.new
 
     class << self
       def attach_if_necessary
-        unless defined?(@attached) && @attached
-          attach_to(:active_record)
-          @attached = true
+        ATTACH_MUTEX.synchronize do
+          unless defined?(@attached) && @attached
+            attach_to(:active_record)
+            @attached = true
+          end
         end
       end
     end
@@ -31,11 +34,26 @@ module CaptureMigrationSql
       payload = event.payload
       return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
       sql = payload[:sql]
-      return if sql.nil? || IGNORE_STATEMENTS.match(sql)
+      return if sql.nil?
 
       sql = sql.strip
+      return if IGNORE_STATEMENTS.match(sql)
+      return if schema_migrations_query?(sql)
+
       sql = "#{sql};" unless sql.end_with?(";")
       stream.write("#{sql}\n\n")
     end
+
+    private
+
+    # Ignore ActiveRecord's own reads of the schema migrations table. The
+    # table name is resolved at runtime so that custom table names and any
+    # table name prefix or suffix are matched, staying consistent with the
+    # name written to the SQL file.
+    def schema_migrations_query?(sql)
+      table_name = CaptureMigrationSql.schema_migrations_table_name
+      return false if table_name.nil? || table_name.empty?
+      /\ASELECT.*FROM.*#{Regexp.escape(table_name)}/im.match?(sql)
+    end
   end
 end

data/lib/capture_migration_sql.rb

@@ -18,7 +18,7 @@ module CaptureMigrationSql
       unless ::ActiveRecord::Migration.include?(MigrationExtension)
         ::ActiveRecord::Migration.prepend(MigrationExtension)
       end
-      @sql_directory = (directory || Rails.root + "db" + "migration_sql")
+      @sql_directory = directory || Rails.root + "db" + "migration_sql"
       @starting_with_version = starting_with.to_i
     end
 
@@ -27,7 +27,7 @@ module CaptureMigrationSql
       @sql_directory if defined?(@sql_directory)
     end
 
-    # Return the migration version number to start capaturing SQL.
+    # Return the migration version number to start capturing SQL.
     def starting_with_version
       @starting_with_version if defined?(@starting_with_version)
     end
@@ -37,9 +37,27 @@ module CaptureMigrationSql
       !!Thread.current[:capture_migration_sql_enabled]
     end
 
-    # Return the strema migration SQL is being written to.
+    # Return the stream migration SQL is being written to.
     def capture_stream
       Thread.current[:capture_migration_sql_stream]
     end
+
+    # Resolve the schema migrations table name so that both the SQL that is
+    # written to the file and the statement filter honor custom table names
+    # and any table name prefix or suffix. Falls back to "schema_migrations"
+    # if the name cannot be determined.
+    def schema_migrations_table_name
+      if defined?(ActiveRecord::SchemaMigration) && ActiveRecord::SchemaMigration.respond_to?(:table_name)
+        ActiveRecord::SchemaMigration.table_name
+      else
+        connection = ActiveRecord::Base.connection
+        schema_migration = if connection.respond_to?(:schema_migration)
+          connection.schema_migration
+        elsif connection.pool.respond_to?(:schema_migration)
+          connection.pool.schema_migration
+        end
+        schema_migration ? schema_migration.table_name : "schema_migrations"
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: capture_migration_sql
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Brian Durand
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,29 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: 
+        version: '5.2'
 email:
 - bbdurand@gmail.com
 executables: []
@@ -57,8 +41,10 @@ files:
 homepage: https://github.com/bdurand/capture_migration_sql
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/bdurand/capture_migration_sql
+  source_code_uri: https://github.com/bdurand/capture_migration_sql
+  changelog_uri: https://github.com/bdurand/capture_migration_sql/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -66,15 +52,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Capture the SQL that is executed when running ActiveRecord migrations so
   that it can be run in in other environments that don't support migrations.