good_migrations 0.0.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 05eb20b7481ddae6720347b0c84275997ff53e72
-  data.tar.gz: b7c85f764f8f2c22a3988517f2c272cdb59d0016
+SHA256:
+  metadata.gz: e08c6b787542e1a8881109c1f100e3e98c30a0da7ff9e05a53a1676f4526dd55
+  data.tar.gz: 07deb33dcb07c43abe3083081abaec2c3ffd7790b06032f07834a548e00eb0fc
 SHA512:
-  metadata.gz: b79f08edebb75e97c2358064c31d8c5d2de7e4cb483b5e4f7e61a4fe04b6550156c271995249af7327a66b1f5767269830ec0fe01b7144a4fcaa6a257d244689
-  data.tar.gz: 285bfb5be43c16860c0e6bff42c5e024d24199d4a9a84e9de1f946d04a979bbac87156c0603124c87aac80aecef81f0cd47690daf699bf27c73f2770ad0465fc
+  metadata.gz: 78ee5b98395010837864b20c06f111be13fd276620baf03283eb619028d4e8b585cf90d6e70804c0e32a189465910861aacba2572324181f6a789e126e3fc8f9
+  data.tar.gz: 3afeb8e60d5217df9a4b83069875c5ac52c106229909e1bbf4dccd84339f4911ee37d5c1900226323a2c28067c6a8f4a06e0695e2c5a70a250a3cd6c726eefcc

data/.github/workflows/ruby.yml

@@ -0,0 +1,32 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# CHANGELOG
+
+## 0.2.1
+
+* Fix Windows paths [#31](https://github.com/testdouble/good-migrations/pull/31)
+  by [@MaxLap](https://github.com/MaxLap)
+
+## 0.2.0
+
+* Add `permit_autoloading_before` configuration
+
+## 0.1.0
+
+* Add support for zeitwerk@2.5 & higher
+* Disable the autoloader patch after migrations finish
+
+## 0.0.2
+
+* Support classic autoloader

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in good_migrations.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    good_migrations (0.2.1)
+      activerecord (>= 3.1)
+      railties (>= 3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.2.3)
+      actionview (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    erubi (1.10.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.16.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    nokogiri (1.13.4)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.0)
+    rexml (3.2.5)
+    rubocop (1.27.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.10.0)
+      rubocop (= 1.27.0)
+      rubocop-performance (= 1.13.3)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  good_migrations!
+  minitest
+  pry
+  rake
+  standard
+
+BUNDLED WITH
+   2.3.11

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Test Double, LLC
+Copyright (c) 2016-2021 Test Double, Inc.
 
 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

data/README.md

@@ -1,14 +1,12 @@
 # good_migrations
 
-[![Build Status](https://travis-ci.org/testdouble/good-migrations.svg?branch=master)](https://travis-ci.org/testdouble/good-migrations)
-
 This gem prevents Rails from auto-loading app code while it's running migrations,
 preventing the common mistake of referencing ActiveRecord models from migration
 code.
 
 ## Usage
 
-Add good_migrations to your gemfile:
+Add `good_migrations` to your Gemfile:
 
 ``` ruby
 gem 'good_migrations'
@@ -16,6 +14,15 @@ gem 'good_migrations'
 
 And you're done! That's it.
 
+## Prerequisites
+
+This gem requires that your app uses either of these autoloader strategies:
+
+* The classic `ActiveSupport::Dependencies` autoloader (e.g. `config.autoloader
+  = :classic`), which is going away with Rails 7
+* **Version 2.5 or higher** of the Zeitwerk autoloader (e.g. `config.autoloader =
+  :zeitwerk`) If your app uses an earlier version of zeitwerk, you'll see a
+  warning every time `db:migrate` is run
 
 ## Background
 
@@ -49,17 +56,70 @@ good!
 For more background, see the last section of this blog post on [healthy migration
 habits](http://blog.testdouble.com/posts/2014-11-04-healthy-migration-habits.html)
 
-## Options
+## Adding to an existing app
+
+If you add `good_migrations` to an existing application **and** any of those
+migrations relied on auto-loading code from `app/`, then you'll see errors
+raised whenever those migrations are run.
+
+You have several options if this happens:
+
+* If you're confident that every long-lasting environment has run the latest
+  migrations, you could consider squashing your existing migrations into a
+  single migration file that reflects the current state of your schema. This is
+  a tricky procedure to pull off in complex apps, and can require extra
+  coordination in cases where a high number of contributors are working on the
+  application simultaneously. The
+  [squasher](https://github.com/jalkoby/squasher) gem may be able to help.
+* You can rewrite those past migrations to inline any application code inside
+  the migration's namespace. One way to do this is to run migrations until they
+  fail, check out the git ref of the failing migration so the codebase is
+  rewound to where it was at the time the migration was written, and finally
+  inline the necessary app code to get the migration passing before checking out
+  your primary branch. Rewriting any migration introduces risk of the resulting
+  schema diverging from production, so this requires significant care and
+  attention
+* If neither of the above options are feasible, you can configure the
+  `good_migrations` gem to ignore migrations prior to a specified date with the
+  [permit_autoloading_before](#permit_autoloading_before-configuration)
+  option, which will effectively disable the gem's auto-loading prevention for
+  all migrations prior to a specified time
+
+## Configuration
+
+To configure the gem, call `GoodMigrations.config` at some point as Rails is
+loading (a good idea would be an initializer like
+`config/initializers/good_migrations.rb`)
+
+```ruby
+GoodMigrations.config do |config|
+  # Setting `permit_autoloading_before` will DISABLE good_migrations for
+  # any migrations before the given time. Don't set this unless you need to!
+  #
+  # Accepts parseable time strings as well as `Date` & `Time` objects
+  # config.permit_autoloading_before = "20140728132502"
+end
+```
 
-There's no public API to this gem. If you want to work around its behavior, you
-have a few options:
+## Working around good_migrations
 
-1. Run the command with the env var `GOOD_MIGRATIONS=skip`
-2. Explicitly `require` the app code you need in your migration
-3. Remove the gem from your project
+The gem only prevents auto-loading, so you can always can explicitly `require`
+the app code that you need in your migration.
+
+If needed, it is possible to run a command with `good_migrations` disabled by
+running the command with the env var `GOOD_MIGRATIONS=skip`.
 
 ## Acknowledgements
 
 Credit for figuring out where to hook into the ActiveSupport autoloader goes
 to [@tenderlove](https://github.com/tenderlove) for [this
-gist](https://gist.github.com/tenderlove/44447d1b1e466a28eb3f).
+gist](https://gist.github.com/tenderlove/44447d1b1e466a28eb3f). And thanks to
+[@fxn](https://github.com/fxn) for implementing the hook necessary for zeitwerk
+support to be possible.
+
+## Caveats
+
+Because this gem works by augmenting the auto-loader, it will not work if your
+Rails environment (development, by default) is configured to eager load your
+application's classes (see:
+[config.eager_load](http://edgeguides.rubyonrails.org/configuring.html#rails-general-configuration)).

data/Rakefile

@@ -1,10 +1,11 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "standard/rake"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: [:test, "standard:fix"]

data/example/Gemfile

@@ -1,9 +1,11 @@
-source 'http://rubygems.org'
+source "https://rubygems.org"
 
-rails_version = ENV['RAILS_VERSION'] || '3.1.0'
-gem 'rails', rails_version
+gem "rails", "~> 6.1"
 
-gem 'good_migrations', :path => '..'
+gem "good_migrations", path: ".."
 
-gem 'sqlite3-ruby', :require => 'sqlite3'
+gem "sqlite3"
 
+gem "zeitwerk", github: "fxn/zeitwerk"
+
+gem "bootsnap", require: false

data/example/Rakefile

@@ -1,7 +1,7 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
-require 'rake'
+require File.expand_path("../config/application", __FILE__)
+require "rake"
 
 Example::Application.load_tasks

data/example/app/models/pant.rb

@@ -1,3 +1,2 @@
 class Pant < ActiveRecord::Base
 end
-

data/example/app/models/shirt.rb

@@ -0,0 +1,2 @@
+class Shirt < ActiveRecord::Base
+end

data/example/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/example/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/example/config/application.rb

@@ -1,6 +1,6 @@
-require File.expand_path('../boot', __FILE__)
+require File.expand_path("../boot", __FILE__)
 
-require 'rails/all'
+require "rails/all"
 
 # If you have a Gemfile, require the gems listed there, including any gems
 # you've limited to :test, :development, or :production.
@@ -8,6 +8,9 @@ Bundler.require(:default, Rails.env) if defined?(Bundler)
 
 module Example
   class Application < Rails::Application
+    if config.respond_to?(:eager_load=)
+      config.eager_load = false
+    end
     # Settings in config/environments/* take precedence over those specified here.
     # Application configuration should go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded.
@@ -38,5 +41,7 @@ module Example
 
     # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]
+
+    config.autoloader = ENV["AUTOLOADER"] == "zeitwerk" ? :zeitwerk : :classic
   end
 end

data/example/config/boot.rb

@@ -1,13 +1,16 @@
-require 'rubygems'
+require "rubygems"
 
 # Set up gems listed in the Gemfile.
-gemfile = File.expand_path('../../Gemfile', __FILE__)
-begin
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-rescue Bundler::GemNotFound => e
-  STDERR.puts e.message
-  STDERR.puts "Try running `bundle install`."
-  exit!
-end if File.exist?(gemfile)
+gemfile = File.expand_path("../../Gemfile", __FILE__)
+if File.exist?(gemfile)
+  begin
+    ENV["BUNDLE_GEMFILE"] = gemfile
+    require "bundler"
+    Bundler.setup
+  rescue Bundler::GemNotFound => e
+    warn e.message
+    warn "Try running `bundle install`."
+    exit!
+  end
+end
+require "bootsnap/setup"

data/example/config/environment.rb

@@ -1,5 +1,5 @@
 # Load the rails application
-require File.expand_path('../application', __FILE__)
+require File.expand_path("../application", __FILE__)
 
 # Initialize the rails application
 Example::Application.initialize!

data/example/config/environments/development.rb

@@ -10,8 +10,7 @@ Example::Application.configure do
   config.whiny_nils = true
 
   # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
-  config.action_view.debug_rjs             = true
+  config.consider_all_requests_local = true
   config.action_controller.perform_caching = false
 
   # Don't care if the mailer can't send
@@ -22,5 +21,6 @@ Example::Application.configure do
 
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
-end
 
+  config.active_record.migration_error = false
+end

data/example/config/environments/production.rb

@@ -6,7 +6,7 @@ Example::Application.configure do
   config.cache_classes = true
 
   # Full error reports are disabled and caching is turned on
-  config.consider_all_requests_local       = false
+  config.consider_all_requests_local = false
   config.action_controller.perform_caching = true
 
   # Specifies the header that your server uses for sending files

data/example/config/environments/test.rb

@@ -11,14 +11,14 @@ Example::Application.configure do
   config.whiny_nils = true
 
   # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
+  config.consider_all_requests_local = true
   config.action_controller.perform_caching = false
 
   # Raise exceptions instead of rendering exception templates
   config.action_dispatch.show_exceptions = false
 
   # Disable request forgery protection in test environment
-  config.action_controller.allow_forgery_protection    = false
+  config.action_controller.allow_forgery_protection = false
 
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the

data/example/config/initializers/good_migrations.rb

@@ -0,0 +1,7 @@
+GoodMigrations.config do |config|
+  # Setting `permit_autoloading_before` will DISABLE good_migrations for
+  # any migrations before the given time. Don't set this unless you need to!
+  #
+  # Accepts parseable time strings as well as `Date` & `Time` objects
+  config.permit_autoloading_before = ENV["PERMIT_AUTOLOADING_BEFORE"]
+end

data/example/config/initializers/secret_token.rb

@@ -4,4 +4,4 @@
 # If you change this key, all old signed cookies will become invalid!
 # Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
-Example::Application.config.secret_token = '5b687ab969ef4f33a41125ae95e73c368d1c391045639df9a1690221b13f8b8cbeb515db9cf5990548af5c309b8d3ab206648837001866cdf854278030285e3c'
+Example::Application.config.secret_token = "5b687ab969ef4f33a41125ae95e73c368d1c391045639df9a1690221b13f8b8cbeb515db9cf5990548af5c309b8d3ab206648837001866cdf854278030285e3c"

data/example/config/initializers/session_store.rb

@@ -1,6 +1,6 @@
 # Be sure to restart your server when you modify this file.
 
-Example::Application.config.session_store :cookie_store, :key => '_example_session'
+Example::Application.config.session_store :cookie_store, key: "_example_session"
 
 # Use the database for sessions instead of the cookie-based default,
 # which shouldn't be used to store highly confidential information

data/example/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path("../config/environment", __FILE__)
 run Example::Application

data/example/db/migrate/20160202162849_create_pants.rb

@@ -1,4 +1,4 @@
-class CreatePants < ActiveRecord::Migration
+class CreatePants < ActiveRecord::Migration[4.2]
   def change
     create_table :pants do |t|
       t.integer :length

data/example/db/migrate/20160202163803_change_pants.rb

@@ -1,6 +1,7 @@
-class ChangePants < ActiveRecord::Migration
+class ChangePants < ActiveRecord::Migration[4.2]
   class Pant < ActiveRecord::Base
   end
+
   def change
     Pant.all.each do |pant|
       # do a migration depending on the redefined Pant model

data/example/db/migrate/20160202182520_change_pants_dangerously.rb

@@ -1,4 +1,4 @@
-class ChangePantsDangerously < ActiveRecord::Migration
+class ChangePantsDangerously < ActiveRecord::Migration[4.2]
   def up
     Pant.find_each do |pant|
       # uh oh!

data/example/db/migrate/20170101150000_create_shirts.rb

@@ -0,0 +1,8 @@
+class CreateShirts < ActiveRecord::Migration[4.2]
+  def change
+    create_table :shirts do |t|
+      t.integer :size
+      t.integer :color
+    end
+  end
+end

data/example/db/migrate/20170102150000_change_shirts_dangerously.rb

@@ -0,0 +1,10 @@
+class ChangeShirtsDangerously < ActiveRecord::Migration[4.2]
+  def up
+    Shirt.find_each do |shirt|
+      # uh oh!
+    end
+  end
+
+  def down
+  end
+end

data/example/lib/tasks/load_pants.rake

@@ -0,0 +1,5 @@
+# Imagine this being run immediately after a migrate, and SHOULD be allowed
+# to load from app/ because it's not a migration
+task load_pants: :environment do
+  puts "This many pants: #{Pant.count} pants"
+end

data/example/script/rails

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
 
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
-require File.expand_path('../../config/boot',  __FILE__)
-require 'rails/commands'
+APP_PATH = File.expand_path("../../config/application", __FILE__)
+require File.expand_path("../../config/boot", __FILE__)
+require "rails/commands"

data/example/test/performance/browsing_test.rb

@@ -1,9 +1,9 @@
-require 'test_helper'
-require 'rails/performance_test_help'
+require "test_helper"
+require "rails/performance_test_help"
 
 # Profiling results for each test method are written to tmp/performance.
 class BrowsingTest < ActionDispatch::PerformanceTest
   def test_homepage
-    get '/'
+    get "/"
   end
 end

data/example/test/test_helper.rb

@@ -1,6 +1,6 @@
 ENV["RAILS_ENV"] = "test"
-require File.expand_path('../../config/environment', __FILE__)
-require 'rails/test_help'
+require File.expand_path("../../config/environment", __FILE__)
+require "rails/test_help"
 
 class ActiveSupport::TestCase
   # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.

data/good_migrations.gemspec

@@ -1,28 +1,30 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'good_migrations/version'
+require "good_migrations/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "good_migrations"
-  spec.version       = GoodMigrations::VERSION
-  spec.authors       = ["Justin Searls", "Kevin Baribeau"]
-  spec.email         = ["searls@gmail.com", "kevin.baribeau@gmail.com"]
+  spec.name = "good_migrations"
+  spec.version = GoodMigrations::VERSION
+  spec.authors = ["Justin Searls", "Kevin Baribeau"]
+  spec.email = ["searls@gmail.com", "kevin.baribeau@gmail.com"]
 
-  spec.summary       = %q{Prevents Rails from auto-loading app code in database migrations}
-  spec.description   = %q{Referencing code in app/ from a database migration risks breaking the migration when your app code changes; this gem prevents that mistake}
-  spec.homepage      = "https://github.com/testdouble/good-migrations"
+  spec.summary = "Prevents Rails from auto-loading app code in database migrations"
+  spec.description = "Referencing code in app/ from a database migration risks breaking the migration when your app code changes; this gem prevents that mistake"
+  spec.homepage = "https://github.com/testdouble/good-migrations"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.3.0"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 3.1"
   spec.add_dependency "activerecord", ">= 3.1"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "standard"
 end

data/lib/good_migrations/configuration.rb

@@ -0,0 +1,38 @@
+module GoodMigrations
+  def self.config(&blk)
+    @configuration ||= Configuration.new
+
+    @configuration.tap do |config|
+      blk&.call(config)
+    end
+  end
+
+  class Configuration
+    # Migrations with timestamps (the numbers at the beginning of the file name) from
+    # before this configured time will be allowed to perform autoloading, bypassing the
+    # mechanism of this gem. Accepts:
+    #   nil (default): never permit autoload
+    #   String accepted by `Time.parse`, such as: 20211103150610 or 20211103_150610
+    #   object responding to `to_time`, such as Date and Time
+    attr_reader :permit_autoloading_before
+    def permit_autoloading_before=(value)
+      case value
+      when nil
+        # Stay nil
+      when String
+        value = Time.parse(value)
+      else
+        if value.respond_to?(:to_time)
+          value = value.to_time
+        else
+          raise "Received an invalid value for permit_autoloading_before: #{value.inspect}"
+        end
+      end
+      @permit_autoloading_before = value
+    end
+
+    def initialize
+      @permit_autoloading_before = nil
+    end
+  end
+end

data/lib/good_migrations/load_error.rb

@@ -1,4 +1,4 @@
 module GoodMigrations
-  class LoadError < ::LoadError
+  class LoadError < RuntimeError
   end
 end

data/lib/good_migrations/migration_details.rb

@@ -0,0 +1,30 @@
+module GoodMigrations
+  class MigrationDetails
+    attr_reader :path
+    def initialize(path)
+      @path = path
+    end
+
+    def self.currently_executing
+      migrate_dir_path = Rails.root.join("db/migrate/").to_s
+
+      if (loc = caller.detect { |loc| loc.start_with?(migrate_dir_path) })
+        line_number_index = loc.index(":", migrate_dir_path.size)
+        new(loc[0...line_number_index])
+      end
+    end
+
+    def associated_time
+      timestamp_string = File.basename(@path).partition("_").first
+      return if timestamp_string.size != 14
+      Time.parse(timestamp_string)
+    end
+
+    def considered_before?(time)
+      return false if time.nil?
+      my_time = associated_time
+      return false if my_time.nil?
+      my_time < time
+    end
+  end
+end

data/lib/good_migrations/patches_autoloader.rb

@@ -0,0 +1,61 @@
+module GoodMigrations
+  class PatchesAutoloader
+    def self.instance
+      @instance ||= new
+    end
+
+    def initialize
+      @permits_autoload = PermitsAutoload.new
+      @raises_load_error = RaisesLoadError.new
+
+      @disabled = false
+    end
+
+    def prevent_autoload_if_necessary!(path)
+      return if @disabled || @permits_autoload.permit?(path)
+
+      @raises_load_error.raise!(path)
+    end
+
+    def patch!
+      if Rails.singleton_class.method_defined?(:autoloaders) &&
+          Rails.autoloaders.zeitwerk_enabled?
+        if Rails.autoloaders.main.respond_to?(:on_load) &&
+            Rails.autoloaders.main.method(:on_load).arity <= 0
+          @disabled = false
+          Rails.autoloaders.each do |loader|
+            loader.on_load do |_, _, path|
+              GoodMigrations::PatchesAutoloader.instance.prevent_autoload_if_necessary!(path)
+            end
+          end
+        else
+          warn <<-UNSUPPORTED.strip_heredoc
+            WARNING: good_migrations is unable to ensure that your migrations are
+              not inadvertently loading application code, because your application
+              uses the zeitwerk autoloader (`config.autoloader = :zeitwerk`), but
+              is using a version prior to zeitwerk 2.5.0, which adds an on_load
+              hook that good_migrations can latch onto.
+
+            Solution: Ensure that zeitwerk isn't pinned below 2.5.0 in your
+              Gemfile and try running `bundle update zeitwerk`.
+
+          UNSUPPORTED
+        end
+      else
+        @disabled = false
+        ActiveSupport::Dependencies.class_eval do
+          extend Module.new {
+            def load_file(path, const_paths = loadable_constants_for_path(path))
+              GoodMigrations::PatchesAutoloader.instance.prevent_autoload_if_necessary!(path)
+              super
+            end
+          }
+        end
+      end
+    end
+
+    def unpatch!
+      @disabled = true
+    end
+  end
+end

data/lib/good_migrations/permits_autoload.rb

@@ -0,0 +1,19 @@
+module GoodMigrations
+  class PermitsAutoload
+    def permit?(path)
+      !app_path?(path) || permit_autoloading_based_on_migration_time?
+    end
+
+    private
+
+    def permit_autoloading_based_on_migration_time?
+      permit_before_date = GoodMigrations.config.permit_autoloading_before
+      migration_details = GoodMigrations::MigrationDetails.currently_executing
+      migration_details.considered_before?(permit_before_date)
+    end
+
+    def app_path?(path)
+      path.starts_with? File.join(Rails.application.root, "app")
+    end
+  end
+end

data/lib/good_migrations/railtie.rb

@@ -3,7 +3,7 @@ require "active_record/railtie"
 module GoodMigrations
   class Railtie < Rails::Railtie
     rake_tasks do
-      Dir[File.join(File.dirname(__FILE__), '../../tasks/*.rake')].each do |file|
+      Dir[File.join(File.dirname(__FILE__), "../../tasks/*.rake")].each do |file|
         load file
       end
     end

data/lib/good_migrations/raises_load_error.rb

@@ -0,0 +1,44 @@
+module GoodMigrations
+  class RaisesLoadError
+    def raise!(path)
+      raise GoodMigrations::LoadError, <<-ERROR.strip_heredoc
+        Rails attempted to auto-load:
+
+        #{path}
+
+        Which is in your project's `app/` directory. The good_migrations
+        gem was designed to prevent this, because migrations are intended
+        to be immutable and safe-to-run for the life of your project, but
+        code in `app/` is liable to change at any time.
+
+        The most common reason for this error is that you may be referencing an
+        ActiveRecord model inside the migration in order to use the ActiveRecord API
+        to implement a data migration by querying and updating objects.
+
+        For instance, if you want to access a model "User" in your migration, it's safer
+        to redefine the class inside the migration instead, like this:
+
+        class MakeUsersOlder < ActiveRecord::Migration
+          class User < ActiveRecord::Base
+            # Define whatever you need on the User beyond what AR adds automatically
+          end
+
+          def up
+            User.find_each do |user|
+              user.update!(:age => user.age + 1)
+            end
+          end
+
+          def down
+            #...
+          end
+        end
+
+        For more information, visit:
+
+        https://github.com/testdouble/good-migrations
+
+      ERROR
+    end
+  end
+end

data/lib/good_migrations/version.rb

@@ -1,3 +1,3 @@
 module GoodMigrations
-  VERSION = "0.0.2"
+  VERSION = "0.2.1"
 end

data/lib/good_migrations.rb

@@ -1,3 +1,10 @@
-require "good_migrations/version"
-require "good_migrations/load_error"
-require "good_migrations/railtie" if defined?(Rails)
+require "time"
+
+require_relative "good_migrations/version"
+require_relative "good_migrations/load_error"
+require_relative "good_migrations/migration_details"
+require_relative "good_migrations/configuration"
+require_relative "good_migrations/patches_autoloader"
+require_relative "good_migrations/permits_autoload"
+require_relative "good_migrations/raises_load_error"
+require_relative "good_migrations/railtie" if defined?(Rails)

data/tasks/good_migrations.rake

@@ -1,63 +1,18 @@
-require 'active_support/dependencies'
-require 'good_migrations'
+require "active_support/dependencies"
+require "good_migrations"
 
 namespace :good_migrations do
   task :disable_autoload do
-    next if ENV['GOOD_MIGRATIONS'] == "skip"
-    ActiveSupport::Dependencies.class_eval do
-      extend Module.new {
-        def load_file(path, const_paths = loadable_constants_for_path(path))
-          if path.starts_with? File.join(Rails.application.root, 'app')
-            raise GoodMigrations::LoadError, <<-ERROR
-Rails attempted to auto-load:
-
-#{path}
-
-Which is in your project's `app/` directory. The good_migrations
-gem was designed to prevent this, because migrations are intended
-to be immutable and safe-to-run for the life of your project, but
-code in `app/` is liable to change at any time.
-
-The most common reason for this error is that you may be referencing an
-ActiveRecord model inside the migration in order to use the ActiveRecord API
-to implement a data migration by querying and updating objects.
-
-For instance, if you want to access a model "User" in your migration, it's safer
-to redefine the class inside the migration instead, like this:
-
-class MakeUsersOlder < ActiveRecord::Migration
-  class User < ActiveRecord::Base
-    # Define whatever you need on the User beyond what AR adds automatically
-  end
-
-  def up
-    User.find_each do |user|
-      user.update!(:age => user.age + 1)
-    end
+    next if ENV["GOOD_MIGRATIONS"] == "skip"
+    GoodMigrations::PatchesAutoloader.instance.patch!
   end
 
-  def down
-    #...
+  task :reenable_autoload do
+    next if ENV["GOOD_MIGRATIONS"] == "skip"
+    GoodMigrations::PatchesAutoloader.instance.unpatch!
   end
 end
 
-For more information, visit:
-
-https://github.com/testdouble/good-migrations
-
-ERROR
-          else
-            super
-          end
-        end
-      }
-    end
-  end
+Rake::Task["db:migrate"].enhance(["good_migrations:disable_autoload"]) do
+  Rake::Task["good_migrations:reenable_autoload"].invoke
 end
-
-Rake.application.in_namespace('db:migrate') do |namespace|
-  ([Rake::Task['db:migrate']] + namespace.tasks).each do |task|
-    task.prerequisites << "good_migrations:disable_autoload"
-  end
-end
-

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: good_migrations
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Justin Searls
 - Kevin Baribeau
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -43,30 +43,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  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: Referencing code in app/ from a database migration risks breaking the
   migration when your app code changes; this gem prevents that mistake
 email:
@@ -104,9 +118,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -116,10 +132,14 @@ files:
 - example/Gemfile
 - example/README
 - example/Rakefile
+- example/app/assets/config/manifest.js
 - example/app/controllers/application_controller.rb
 - example/app/helpers/application_helper.rb
 - example/app/models/pant.rb
+- example/app/models/shirt.rb
 - example/app/views/layouts/application.html.erb
+- example/bin/rails
+- example/bin/rake
 - example/config.ru
 - example/config/application.rb
 - example/config/boot.rb
@@ -129,6 +149,7 @@ files:
 - example/config/environments/production.rb
 - example/config/environments/test.rb
 - example/config/initializers/backtrace_silencers.rb
+- example/config/initializers/good_migrations.rb
 - example/config/initializers/inflections.rb
 - example/config/initializers/mime_types.rb
 - example/config/initializers/secret_token.rb
@@ -138,9 +159,12 @@ files:
 - example/db/migrate/20160202162849_create_pants.rb
 - example/db/migrate/20160202163803_change_pants.rb
 - example/db/migrate/20160202182520_change_pants_dangerously.rb
+- example/db/migrate/20170101150000_create_shirts.rb
+- example/db/migrate/20170102150000_change_shirts_dangerously.rb
 - example/db/seeds.rb
 - example/doc/README_FOR_APP
 - example/lib/tasks/.gitkeep
+- example/lib/tasks/load_pants.rake
 - example/public/404.html
 - example/public/422.html
 - example/public/500.html
@@ -161,14 +185,20 @@ files:
 - example/vendor/plugins/.gitkeep
 - good_migrations.gemspec
 - lib/good_migrations.rb
+- lib/good_migrations/configuration.rb
 - lib/good_migrations/load_error.rb
+- lib/good_migrations/migration_details.rb
+- lib/good_migrations/patches_autoloader.rb
+- lib/good_migrations/permits_autoload.rb
 - lib/good_migrations/railtie.rb
+- lib/good_migrations/raises_load_error.rb
 - lib/good_migrations/version.rb
 - tasks/good_migrations.rake
 homepage: https://github.com/testdouble/good-migrations
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -176,16 +206,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.3.6
+signing_key:
 specification_version: 4
 summary: Prevents Rails from auto-loading app code in database migrations
 test_files: []

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 2.2.3
-before_script:
-  - cd example && bundle install
-env:
-  - RAILS_ENV=3.1.0
-  - RAILS_ENV=4.0.0
-  - RAILS_ENV=4.2.0
-  - RAILS_ENV=5.0.0.beta2