good_migrations 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 957989ed1010171743f14af193d62b5bfbb820e59ad79b42ca16d6b8b51ca948
-  data.tar.gz: 89dc256beca58029d4de2c142834a3069b7b165959055bc4f7ab1721ffea6c82
+  metadata.gz: 9dee0175ec6d3a50dfbf5b22591311fb571d718c5f7d5fa56ddaa3e07a95860a
+  data.tar.gz: 0c483eb30524bbe3a426f197d40dbb7de049db96b8db30d7835ad97f36e23c86
 SHA512:
-  metadata.gz: 5a2e09ff0b2bf6473ececfa8ca0905eae9a974cd81ff5ea76626e7b5e56693169040472a577551aa44976e2d412e957043a31d47e0ca12b405c8b30a16f506cc
-  data.tar.gz: f2b50907f8826e6c76c03b933a1571b5b523ebb7087ab4854fddb300c27d5ba64d5f75e53f2d5639234bd8de07adff2702ceb0ae61d37744fcd7737ccb0c3323
+  metadata.gz: 91d8a48741dd67c0163e5ad85958f6f623be07d36273aa8df78d94cc55a419bd72498dfb34501b7ecbdfba931ce1a20e3ce16c85c84ddb2b2905e5850152a3a5
+  data.tar.gz: 55774f660e0aa7b9671dbcf4d734a1266515e37718045ac561ac076d0c9f8ca8a722b0e1c03e88498f848e3db980a7821bef31c298f14bcece1d300b29484b2a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.2.0
+
+* Add `permit_autoloading_before` configuration
+
 ## 0.1.0
 
 * Add support for zeitwerk@2.5 & higher

data/Gemfile.lock

@@ -1,32 +1,32 @@
 PATH
   remote: .
   specs:
-    good_migrations (0.1.0)
+    good_migrations (0.2.0)
       activerecord (>= 3.1)
       railties (>= 3.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.4)
-      actionview (= 6.1.4)
-      activesupport (= 6.1.4)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.4)
-      activesupport (= 6.1.4)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.1.4)
-      activesupport (= 6.1.4)
-    activerecord (6.1.4)
-      activemodel (= 6.1.4)
-      activesupport (= 6.1.4)
-    activesupport (6.1.4)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -38,16 +38,16 @@ GEM
     concurrent-ruby (1.1.9)
     crass (1.0.6)
     erubi (1.10.0)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    loofah (2.10.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.5.3)
+    mini_portile2 (2.6.1)
     minitest (5.14.4)
-    nokogiri (1.11.7)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
     parallel (1.20.1)
     parser (3.0.1.1)
@@ -55,18 +55,18 @@ GEM
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.5.2)
+    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.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.1.4)
-      actionpack (= 6.1.4)
-      activesupport (= 6.1.4)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       method_source
       rake (>= 0.13)
       thor (~> 1.0)
@@ -96,7 +96,7 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -110,4 +110,4 @@ DEPENDENCIES
   standard
 
 BUNDLED WITH
-   2.2.15
+   2.2.30

data/README.md

@@ -6,11 +6,7 @@ code.
 
 ## Usage
 
-**HEADS UP: zeitwerk 2.5.0 is not yet released, so if you're using zeitwerk at
-all, the gem won't be able to ensure your migrations are safe and you'll see a
-warning to that effect**
-
-Add good_migrations to your Gemfile:
+Add `good_migrations` to your Gemfile:
 
 ``` ruby
 gem 'good_migrations'
@@ -24,7 +20,7 @@ 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 =
+* **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
 
@@ -60,24 +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
+```
+
+## Working around good_migrations
 
-There's no public API to this gem. If you want to work around its behavior, you
-have a few options:
+The gem only prevents auto-loading, so you can always can explicitly `require`
+the app code that you need in your migration.
 
-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
+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 monkey-patching the ActiveSupport auto-loader, it will
-not work if your Rails environment (development, by default) is configured to
-eager load your application's classes (see:
+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/example/Gemfile

@@ -7,3 +7,5 @@ gem "good_migrations", path: ".."
 gem "sqlite3"
 
 gem "zeitwerk", github: "fxn/zeitwerk"
+
+gem "bootsnap", require: false

data/example/app/models/shirt.rb

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

data/example/config/boot.rb

@@ -13,3 +13,4 @@ if File.exist?(gemfile)
     exit!
   end
 end
+require "bootsnap/setup"

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/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/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/migration_details.rb

@@ -0,0 +1,29 @@
+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
+
+      loc = caller.detect { |loc| loc.start_with?(migrate_dir_path) }
+      return if loc.nil?
+      new(loc.partition(":").first)
+    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

@@ -5,11 +5,16 @@ module GoodMigrations
     end
 
     def initialize
+      @permits_autoload = PermitsAutoload.new
+      @raises_load_error = RaisesLoadError.new
+
       @disabled = false
     end
 
-    def disabled?
-      @disabled
+    def prevent_autoload_if_necessary!(path)
+      return if @disabled || @permits_autoload.permit?(path)
+
+      @raises_load_error.raise!(path)
     end
 
     def patch!
@@ -20,14 +25,11 @@ module GoodMigrations
           @disabled = false
           Rails.autoloaders.each do |loader|
             loader.on_load do |_, _, path|
-              if GoodMigrations::PreventsAppLoad.app_path?(path) &&
-                  !GoodMigrations::PatchesAutoloader.instance.disabled?
-                GoodMigrations::PreventsAppLoad.prevent_load!(path)
-              end
+              GoodMigrations::PatchesAutoloader.instance.prevent_autoload_if_necessary!(path)
             end
           end
         else
-          warn <<~UNSUPPORTED
+          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
@@ -44,12 +46,8 @@ module GoodMigrations
         ActiveSupport::Dependencies.class_eval do
           extend Module.new {
             def load_file(path, const_paths = loadable_constants_for_path(path))
-              if GoodMigrations::PreventsAppLoad.app_path?(path) &&
-                  !GoodMigrations::PatchesAutoloader.instance.disabled?
-                GoodMigrations::PreventsAppLoad.prevent_load!(path)
-              else
-                super
-              end
+              GoodMigrations::PatchesAutoloader.instance.prevent_autoload_if_necessary!(path)
+              super
             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/{prevents_app_load.rb → raises_load_error.rb}

@@ -1,11 +1,7 @@
 module GoodMigrations
-  class PreventsAppLoad
-    def self.app_path?(path)
-      path.starts_with? File.join(Rails.application.root, "app")
-    end
-
-    def self.prevent_load!(path)
-      raise GoodMigrations::LoadError, <<~ERROR
+  class RaisesLoadError
+    def raise!(path)
+      raise GoodMigrations::LoadError, <<-ERROR.strip_heredoc
         Rails attempted to auto-load:
 
         #{path}

data/lib/good_migrations/version.rb

@@ -1,3 +1,3 @@
 module GoodMigrations
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/good_migrations.rb

@@ -1,5 +1,10 @@
-require "good_migrations/version"
-require "good_migrations/load_error"
-require "good_migrations/patches_autoloader"
-require "good_migrations/prevents_app_load"
-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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: good_migrations
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Searls
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -136,6 +136,7 @@ files:
 - 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
@@ -148,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
@@ -157,6 +159,8 @@ 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
@@ -181,10 +185,13 @@ 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/prevents_app_load.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
@@ -206,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Prevents Rails from auto-loading app code in database migrations