capture_migration_sql 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d363515469587ed28cbf2f3b5e63f62fac816ef666c3068739e0a9daace3ba7d
+  data.tar.gz: 572ae7848eaad194e7785951b8df034be4be5afa1a433257d84b22acd85de512
+SHA512:
+  metadata.gz: eb3f14254f65d4008bc689f4921b85ea8900eef141e0256153419716d276c8d50cddd06881aa8a83d0d92e15311decb46fa8bde7710035fb0a9300328e9ebd6f
+  data.tar.gz: 8b147b725d0e0a1d3962deceb68b077a329639479ac94e6e2ad94177df6de750f056f58eb37990becdab2dcb5e6ae3c7674f5a827bb32032594bb8ce34bffba6

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store
+
+# rspec failure tracking
+.rspec_status

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+rvm:
+  - 2.5
+  - 2.3
+
+cache: bundler
+
+branches:
+  # Only build master and release version tags
+  only:
+    - master
+    - /^v\d+\.\d+(\.\d+)?(-\S*)?$/
+
+gemfile:
+  - Gemfile
+  - gemfiles/activerecord_5.2.gemfile
+  - gemfiles/activerecord_5.1.gemfile
+  - gemfiles/activerecord_5.0.gemfile
+  - gemfiles/activerecord_4.2.gemfile
+
+script:
+  - bundle exec rake spec

data/Appraisals

@@ -0,0 +1,7 @@
+RAILS_MINOR_RELEASES = ["5.2", "5.1", "5.0", "4.2"].freeze
+
+RAILS_MINOR_RELEASES.each do |version|
+  appraise "activerecord-#{version}" do
+    gem "activerecord", "~> #{version}.0"
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 1.0.1
+* Fix SQL for insterting into schema_migrations
+
+# 1.0.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capture_migration_sql.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    capture_migration_sql (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (9.0.0)
+    concurrent-ruby (1.0.5)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 4.2)
+  appraisal
+  bundler (~> 1.16)
+  capture_migration_sql!
+  database_cleaner
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   1.16.5

data/MIT_LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Brian Durand
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# CaptureMigrationSql
+
+[![Build Status](https://travis-ci.com/bdurand/capture_migration_sql.svg?branch=master)](https://travis-ci.com/bdurand/capture_migration_sql)
+[![Maintainability](https://api.codeclimate.com/v1/badges/17bbf5cb6eda022028fe/maintainability)](https://codeclimate.com/github/bdurand/capture_migration_sql/maintainability)
+
+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.
+
+1. Having a list of SQL changes in a migration can allow a more thorough review of database changes during a code review. The Ruby schema directives in Rails are nice for simple tables and for documentation purposes, but if you need to tune your database for performance or data integrity, seeing the raw SQL can give you a better idea of exactly what each change involves.
+
+2. Not everyone gets to run database migrations in production. If you have a DBA who needs to approve and run all changes for security and performance reasons, you'll probably need to give them the individual SQL changes. This gem logs all those changes for you in a consistent place so you don't have to hunt for them in your development logs or reverse engineer them from the Ruby code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capture_migration_sql'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capture_migration_sql
+
+## Usage
+
+Add this to a file in `config/initializers` in your Rails application:
+
+```ruby
+CaptureMigrationSql.capture
+```
+
+This will log each migration to a file in the `db/migration_sql` directory. You can also specify a different directory by passing the path the the `capture` method. Additionally, you can specify a first migration to start with. This will avoid generating files for all previous versions.
+
+```ruby
+# Create all files in the directory 'tmp/migration_sql'
+CaptureMigrationSql.capture(directory: "tmp/migration_sql")
+
+# Only capture migrations starting with version 20181010081254
+CaptureMigrationSql.capture(starting_with: 20181010081254)
+```
+
+Within a migration, you can enable and disable capturing SQL within a block:
+
+```ruby
+def up
+  disable_sql_logging do
+    # SQL will not be logged here
+
+    enable_sql_logging do
+      # SQL will be logged here
+    end
+
+    # SQL will not be logged here
+  end
+end
+```
+
+You should disable SQL logging in migration logic that generate queries to clean up or move data that may result in different results per environment. For instance a block of code that selects rows from an existing table and munges the data for an update would result in different queries for each developer that ran the migration if they had different data in their local database.
+
+Finally, if you application uses multiple databases, you can specify which database connection to use for schema statements within a block. You can also specify an optional label that will be added as a comment in the SQL file.
+
+```ruby
+def up
+  using_connection(other_database_connection, label: "Comment for file") do
+    # schema statements here will use other_database_connection instead of ActiveRecord::Base.connection
+  end
+end
+```
+
+You can either pass in a database connection object or a class that extends from `ActiveRecord::Base`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bdurand/capture_migration_sql.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :appraisals
+
+desc "run the specs using appraisal"
+task :appraisals do
+  exec "bundle exec appraisal rake spec"
+end
+
+namespace :appraisals do
+  desc "install all the appraisal gemspecs"
+  task :install do
+    exec "bundle exec appraisal install"
+  end
+end

data/capture_migration_sql.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capture_migration_sql/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capture_migration_sql"
+  spec.version       = CaptureMigrationSql::VERSION
+  spec.authors       = ["Brian Durand"]
+  spec.email         = ["bbdurand@gmail.com"]
+
+  spec.summary       = %q{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.}
+  spec.homepage      = "https://github.com/bdurand/capture_migration_sql"
+  spec.license       = "MIT"
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activerecord", ">= 4.2"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "appraisal"
+end

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/activerecord_4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0"
+
+gemspec path: "../"

data/gemfiles/activerecord_4.2.gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: ..
+  specs:
+    capture_migration_sql (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.10)
+      activesupport (= 4.2.10)
+      builder (~> 3.1)
+    activerecord (4.2.10)
+      activemodel (= 4.2.10)
+      activesupport (= 4.2.10)
+      arel (~> 6.0)
+    activesupport (4.2.10)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.4)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.2.0)
+  appraisal
+  bundler (~> 1.16)
+  capture_migration_sql!
+  database_cleaner
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   1.16.5

data/gemfiles/activerecord_5.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.0.gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: ..
+  specs:
+    capture_migration_sql (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.0.7)
+      activesupport (= 5.0.7)
+    activerecord (5.0.7)
+      activemodel (= 5.0.7)
+      activesupport (= 5.0.7)
+      arel (~> 7.0)
+    activesupport (5.0.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (7.1.4)
+    concurrent-ruby (1.0.5)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.0.0)
+  appraisal
+  bundler (~> 1.16)
+  capture_migration_sql!
+  database_cleaner
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   1.16.5

data/gemfiles/activerecord_5.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.1.gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: ..
+  specs:
+    capture_migration_sql (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.6)
+      activesupport (= 5.1.6)
+    activerecord (5.1.6)
+      activemodel (= 5.1.6)
+      activesupport (= 5.1.6)
+      arel (~> 8.0)
+    activesupport (5.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (8.0.0)
+    concurrent-ruby (1.0.5)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.1.0)
+  appraisal
+  bundler (~> 1.16)
+  capture_migration_sql!
+  database_cleaner
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   1.16.5

data/gemfiles/activerecord_5.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.2.gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: ..
+  specs:
+    capture_migration_sql (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (9.0.0)
+    concurrent-ruby (1.0.5)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.2.0)
+  appraisal
+  bundler (~> 1.16)
+  capture_migration_sql!
+  database_cleaner
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   1.16.5

data/lib/capture_migration_sql/migration_extension.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+# Extension methods for ActiveRecord::Migration class.
+module CaptureMigrationSql
+  module MigrationExtension
+    # Monkey patch to public but internal ActiveRecord method to pass
+    # a connection that will log SQL statements.
+    def exec_migration(conn, direction)
+      log_migration_sql(direction) do
+        super(conn, direction)
+      end
+    end
+
+    # Disable SQL logging. You can use this method to turn off logging SQL
+    # when the migration is munging data that may vary between environments.
+    def disable_sql_logging(&block)
+      sql_logging(enabled: false, &block)
+    end
+
+    # Enable SQL logging. You can call this method within a block where SQL
+    # logging was disabled to renable it.
+    def enable_sql_logging(&block)
+      sql_logging(enabled: true, &block)
+    end
+
+    # Use a different database connection for the block. You can use this
+    # if your application has multiple databases to swap connections for
+    # the migration. You can pass in either a database connection or an
+    # ActiveRecord::Base class to use the connection used by that class.
+    #
+    # The label argument will be added to the logged SQL as a comment.
+    def using_connection(connection_or_class, label: nil, &block)
+      if connection_or_class.is_a?(Class) && connection_or_class < ActiveRecord::Base
+        label ||= connection_or_class.name
+        connection_or_class.connection_pool.with_connection do |connection|
+          switch_connection_in_block(connection, label: label, &block)
+        end
+      else
+        switch_connection_in_block(connection_or_class, label: label, &block)
+      end
+    end
+
+    private
+
+    def switch_connection_in_block(connection, label:, &block)
+      save_connection = @connection
+      begin
+        @connection = connection
+        stream = CaptureMigrationSql.capture_stream
+        stream.write("-- BEGIN #{label}\n\n") if label && stream
+        retval = yield
+        stream.write("-- END #{label}\n\n") if label && stream
+        retval
+      ensure
+        @connection = save_connection
+      end
+    end
+
+    def sql_logging(enabled:, &block)
+      save_val = Thread.current[:capture_migration_sql_enabled]
+      begin
+        Thread.current[:capture_migration_sql_enabled] = enabled
+        yield
+      ensure
+        Thread.current[:capture_migration_sql_enabled] = save_val
+      end
+    end
+
+    def log_migration_sql(direction, &block)
+      migration_sql_dir = CaptureMigrationSql.directory
+      output_file = File.join(migration_sql_dir, "#{version}_#{name.underscore}.sql") if version && name
+      if output_file && direction == :up && version.to_i >= CaptureMigrationSql.starting_with_version
+        Dir.mkdir(migration_sql_dir) unless File.exist?(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
+          end
+          f.write("INSERT INTO schema_migrations (version) VALUES #{version.to_i};\n")
+        end
+      else
+        File.unlink(output_file) if output_file && File.exist?(output_file)
+        yield
+      end
+    end
+  end
+end

data/lib/capture_migration_sql/sql_subscriber.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'active_support/subscriber'
+
+# Subscriber that is attached to ActiveRecord and will handle writing
+# migration SQL to the output stream.
+module CaptureMigrationSql
+  class SqlSubscriber < ::ActiveSupport::Subscriber
+    IGNORE_PAYLOAD_NAMES = ["SCHEMA", "EXPLAIN"]
+
+    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)
+
+    class << self
+      def attach_if_necessary
+        unless defined?(@attached) && @attached
+          attach_to(:active_record)
+          @attached = true
+        end
+      end
+    end
+
+    def sql(event)
+      stream = CaptureMigrationSql.capture_stream
+      return unless stream && CaptureMigrationSql.capture_enabled?
+
+      payload = event.payload
+      return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+      sql = payload[:sql]
+      return if sql.nil? || IGNORE_STATEMENTS.match(sql)
+
+      sql = sql.strip
+      sql = "#{sql};" unless sql.end_with?(";")
+      stream.write("#{sql}\n\n")
+    end
+  end
+end

data/lib/capture_migration_sql/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CaptureMigrationSql
+  VERSION = "1.0.1"
+end

data/lib/capture_migration_sql.rb

@@ -0,0 +1,46 @@
+require_relative "capture_migration_sql/migration_extension"
+require_relative "capture_migration_sql/sql_subscriber"
+require_relative "capture_migration_sql/version"
+
+module CaptureMigrationSql
+
+  class << self
+    # Call this method in an initializer to invoke dumping the SQL executed
+    # during migrations in to a file.
+    #
+    # The `directory` argument indicates the directory where the files should be stored.
+    # If the directory is not specified, the files will be stored in `db/migration_sql/`.
+    #
+    # The `starting_with` argument can be used to specify which migration you
+    # wish to start capturing SQL with. This can be useful if you are adding
+    # this gem to an existing project with a history of migrations that you
+    # don't want to go back and edit.
+    def capture(directory: nil, starting_with: 0)
+      unless ::ActiveRecord::Migration.include?(MigrationExtension)
+        ::ActiveRecord::Migration.prepend(MigrationExtension)
+      end
+      @sql_directory = (directory || Rails.root + "db" + "migration_sql")
+      @starting_with_version = starting_with.to_i
+    end
+
+    # Return the directory set by `capture_sql` for storing migration SQL.
+    def directory
+      @sql_directory if defined?(@sql_directory)
+    end
+
+    # Return the migration version number to start capaturing SQL.
+    def starting_with_version
+      @starting_with_version if defined?(@starting_with_version)
+    end
+
+    # Return true if capturing SQL is enabled for migrations.
+    def capture_enabled?
+      !!Thread.current[:capture_migration_sql_enabled]
+    end
+
+    # Return the strema migration SQL is being written to.
+    def capture_stream
+      Thread.current[:capture_migration_sql_stream]
+    end
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: capture_migration_sql
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Brian Durand
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: 
+email:
+- bbdurand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- MIT_LICENSE.txt
+- README.md
+- Rakefile
+- capture_migration_sql.gemspec
+- gemfiles/.bundle/config
+- gemfiles/activerecord_4.2.gemfile
+- gemfiles/activerecord_4.2.gemfile.lock
+- gemfiles/activerecord_5.0.gemfile
+- gemfiles/activerecord_5.0.gemfile.lock
+- gemfiles/activerecord_5.1.gemfile
+- gemfiles/activerecord_5.1.gemfile.lock
+- gemfiles/activerecord_5.2.gemfile
+- gemfiles/activerecord_5.2.gemfile.lock
+- lib/capture_migration_sql.rb
+- lib/capture_migration_sql/migration_extension.rb
+- lib/capture_migration_sql/sql_subscriber.rb
+- lib/capture_migration_sql/version.rb
+homepage: https://github.com/bdurand/capture_migration_sql
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+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.
+test_files: []