yiffspace-fixers 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0962fcfcb67778679beee76cff32431ba32852874ccdd4af37fa3a69ca892c6f'
-  data.tar.gz: 3673ab0eb37d127da3c6f8eab40a30d75ca69289f6798cc8e6fc7f74caed6f26
+  metadata.gz: 410c5b95f3bf8123d1cb102448230885bfd3f9017fc7b58e9b98a57c744c3e6b
+  data.tar.gz: e1676aa2ef8a186c1886ae40b02354acc6dc1ffe0cb77c272f623ff218c0f5cb
 SHA512:
-  metadata.gz: 124b5ed2aeafa3718e527cec6277e05194fc973365a7ff3b1e60e1b5087708b46ec000f5445e335bec10ecf1c4c50bd8f25b99d813085dc9bdfa30759f040930
-  data.tar.gz: 55343b8a6deaa99c49ca71507937feaa91988c8ce1e04e8d0e089c8533c239734184baca46076189126e3074084cae8c39d3845275fb4a67d9daeeb191566365
+  metadata.gz: 40c9c084ed52eadd521474d6a08f0a96d1dc521ce8746af8d2180ff186a99df2fce72e424672b47b00e42f64bda790f83d5a1cc8202ef0b06646031bd1ce189f
+  data.tar.gz: 876bade619a962e9c7035bb8263f51c4adc977fe0cb2afb6db4625eed7528115d4f24ac785b0fe2eae736594575b808025a46e6baad5bc41daad85e2e41b97ca

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Unreleased
 
+- Migrations can run fixes themselves with `run_fix(id_or_name)`, which runs and records any of
+  them not yet applied, and does nothing on rollback. `fixes:migrate_all` reads these calls out
+  of pending migrations and folds those fixes into the migration's step instead of scheduling
+  them separately. A fix run this way can `requires_migration!` the migration running it.
+- Fixes run through `YiffSpace::FixTracker.run!` (so every `fixes:*` task) can call
+  `requires_migration!` unqualified, via `YiffSpace::Fixers::Script` - each fix is now loaded
+  wrapped in its own module including it, rather than straight into the top level, so it isn't
+  defined anywhere else in the app. Constants a fix defines now land in that wrapper too, instead
+  of on `Object`. `required_migration_for` reads the unqualified form as well.
 - Fixed `lib/yiffspace/fixers.rb` never actually defining `YiffSpace::Fixers` -
   it set up the `for_gem_extension` Zeitwerk loader but skipped the namespace
   module the convention requires the root file to define, so referencing

data/README.md

@@ -32,11 +32,12 @@ $ bin/rails fixes:migrate
 A fix can require that a migration has already been applied, and a migration can require that a
 fix has already been applied - useful when one depends on schema or data the other provides.
 `bin/rails fixes:migrate_all` runs both `db/migrate` and `db/fixes` together, in whichever order
-those requirements demand:
+those requirements demand. `requires_migration!` is available unqualified inside fixes run by the
+`fixes:*` tasks (`YiffSpace::FixTracker.requires_migration!` works too, and anywhere else):
 
 ```ruby
 # db/fixes/12_backfill_widget_type.rb
-YiffSpace::FixTracker.requires_migration!("20260822004454")
+requires_migration!("20260822004454")
 
 # db/migrate/20260901000000_remove_legacy_widget_column.rb
 class RemoveLegacyWidgetColumn < ActiveRecord::Migration[8.1]
@@ -48,6 +49,20 @@ class RemoveLegacyWidgetColumn < ActiveRecord::Migration[8.1]
 end
 ```
 
+A migration can also run a fix itself with `run_fix`, inside its own transaction - skipped if the
+fix is already applied, and when the migration is rolled back. `fixes:migrate_all` leaves those
+fixes to the migration rather than running them on their own, and a fix run this way can
+`requires_migration!` the migration running it:
+
+```ruby
+class AddWidgetType < ActiveRecord::Migration[8.1]
+  def change
+    add_column(:widgets, :type, :string)
+    run_fix(12)
+  end
+end
+```
+
 See `YiffSpace::FixTracker`, `YiffSpace::FixerTemplate`, `YiffSpace::Fixers::RequiresFix`, and
 `YiffSpace::MigrationSync` for the full API.
 

data/lib/yiffspace/fix_tracker.rb

@@ -11,12 +11,14 @@ module YiffSpace
     # A fix script calls this as its first statement to declare that a migration must already be
     # applied before it can run, e.g.:
     #
-    #   YiffSpace::FixTracker.requires_migration!("20260822004454")
+    #   requires_migration!("20260822004454")
+    #
+    # (unqualified via YiffSpace::Fixers::Script, or as YiffSpace::FixTracker.requires_migration!)
     #
     # Written as a literal string call like that (not built dynamically) so YiffSpace::MigrationSync
     # can also read it back out of the file with #required_migration_for, without loading/running
     # the fix, to order `fixes:migrate_all` correctly.
-    REQUIRES_MIGRATION_PATTERN = /^\s*YiffSpace::FixTracker\.requires_migration!\(\s*["']([^"']+)["']\s*\)/
+    REQUIRES_MIGRATION_PATTERN = /^\s*(?:YiffSpace::FixTracker\.)?requires_migration!\(\s*["']([^"']+)["']\s*\)/
 
     module_function
 
@@ -25,7 +27,7 @@ module YiffSpace
     end
 
     def requires_migration!(version)
-      return if migration_applied?(version)
+      return if migration_applied?(version) || migration_running?(version)
 
       raise(MigrationRequired, "migration #{version} must be applied before this fix can run")
     end
@@ -34,6 +36,23 @@ module YiffSpace
       migration_context.get_all_versions.include?(version.to_i)
     end
 
+    # A migration isn't recorded as applied until it finishes, so a fix it runs with
+    # YiffSpace::Fixers::RequiresFix#run_fix is let through requires_migration! for it via this.
+    def running_migration(version)
+      running_migrations << version.to_i
+      yield
+    ensure
+      running_migrations.pop
+    end
+
+    def migration_running?(version)
+      running_migrations.include?(version.to_i)
+    end
+
+    def running_migrations
+      @running_migrations ||= []
+    end
+
     # Statically reads a fix script's declared requires_migration! version, if any, without
     # loading/running it - nil if the fix has no such call.
     def required_migration_for(name)
@@ -108,7 +127,8 @@ module YiffSpace
 
     def run!(path)
       name = File.basename(path, ".rb")
-      load(File.expand_path(path))
+      # A fresh wrapper per fix, so any constants a script defines don't carry over to the next one.
+      load(File.expand_path(path), Module.new.include(Fixers::Script))
       record!(name)
       name
     end

data/lib/yiffspace/fixers/requires_fix.rb

@@ -18,10 +18,32 @@ module YiffSpace
     # out of order), and read back ahead of time by YiffSpace::MigrationSync to order
     # `fixes:migrate_all` correctly. Included into ActiveRecord::Migration by
     # YiffSpace::Fixers::Engine.
+    #
+    # A migration can also run a fix itself, as part of migrating, with `run_fix`:
+    #
+    #   def change
+    #     add_column(:widgets, :type, :string)
+    #     run_fix(3)
+    #   end
+    #
+    # Each fix it covers is run and recorded the same as YiffSpace::FixTracker.run!, unless it's
+    # already applied, and inside the migration's transaction. Fixes can't be undone, so it does
+    # nothing when the migration is rolled back. A fix run this way can requires_migration! the
+    # migration running it.
     module RequiresFix
       # Raised when a migration runs before one of its required fixes has been applied.
       class FixRequired < StandardError; end
 
+      # Same idea as YiffSpace::FixTracker::REQUIRES_MIGRATION_PATTERN - lets
+      # YiffSpace::MigrationSync read the fixes a migration runs out of its file, so
+      # `fixes:migrate_all` leaves them to the migration instead of running them on their own.
+      RUN_FIX_PATTERN = /^\s*run_fix\(\s*(?:(\d+)|["']([^"']+)["'])\s*\)/
+
+      # The id_or_name of every run_fix call in a migration file.
+      def self.fixes_run_by(path)
+        File.read(path).scan(RUN_FIX_PATTERN).map { |id, name| id ? id.to_i : name }
+      end
+
       def self.included(base)
         base.extend(ClassMethods)
         base.prepend(InstanceMethods)
@@ -46,6 +68,24 @@ module YiffSpace
           super
         end
 
+        # id_or_name: same as requires_fix.
+        def run_fix(id_or_name)
+          return if reverting?
+
+          names = YiffSpace::FixTracker.resolve(id_or_name)
+          raise(ArgumentError, "#{self.class.name} runs fix #{id_or_name.inspect}, which does not exist") if names.empty?
+
+          names.each do |name|
+            if YiffSpace::FixTracker.applied?(name)
+              say("#{name} already applied, skipping")
+            else
+              say_with_time("run_fix(#{name.inspect})") do
+                YiffSpace::FixTracker.running_migration(version) { YiffSpace::FixTracker.run!(YiffSpace::FixTracker.fix_path(name)) }
+              end
+            end
+          end
+        end
+
         private
 
         def check_required_fixes!

data/lib/yiffspace/fixers/script.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module YiffSpace
+  module Fixers
+    # Helpers available unqualified at the top level of a db/fixes/*.rb script when it's run
+    # through YiffSpace::FixTracker.run! - the script is loaded wrapped in a module including
+    # this, so they never leak onto Object for the rest of the app.
+    module Script
+      delegate(:requires_migration!, to: "YiffSpace::FixTracker")
+    end
+  end
+end

data/lib/yiffspace/fixers/version.rb

@@ -2,6 +2,6 @@
 
 module YiffSpace
   module Fixers
-    VERSION = "0.0.2"
+    VERSION = "0.0.4"
   end
 end

data/lib/yiffspace/migration_sync.rb

@@ -4,8 +4,9 @@ module YiffSpace
   # Computes and applies pending db/migrate/*.rb migrations and db/fixes/*.rb fixes together, in
   # whichever order their cross requirements demand - a fix can require a migration
   # (YiffSpace::FixTracker.requires_migration!) and a migration can require a fix
-  # (YiffSpace::Fixers::RequiresFix#requires_fix). Migrations stay ordered among themselves by
-  # version, fixes among themselves by YiffSpace::FixTracker.sort_key, and those cross
+  # (YiffSpace::Fixers::RequiresFix#requires_fix), or run it itself (RequiresFix#run_fix).
+  # Migrations stay ordered among themselves by version, fixes among themselves by
+  # YiffSpace::FixTracker.sort_key, and those cross
   # requirements are woven in via a topological sort. #plan/#apply are used by `rake
   # fixes:migrate_all` (see lib/tasks/fixes.rake).
   module MigrationSync
@@ -24,15 +25,22 @@ module YiffSpace
     def plan
       migrations = pending_migrations
       fixes = FixTracker.pending
+      run_by = fixes_run_by(migrations)
 
       steps = {}
       migrations.each { |m| steps[[:migration, m.version]] = Step.new(:migration, m, [:migration, m.version]) }
-      fixes.each { |f| steps[[:fix, f]] = Step.new(:fix, f, [:fix, f]) }
+      fixes.each { |f| steps[[:fix, f]] = Step.new(:fix, f, [:fix, f]) unless run_by.key?([:fix, f]) }
 
       edges = Hash.new { |h, k| h[k] = [] }
       indegree = steps.each_key.index_with(0)
 
       link = lambda do |before, after|
+        # A fix a migration runs (see #fixes_run_by) has no step of its own, its requirements and
+        # ordering carry over to that migration instead. One requiring that same migration links
+        # it to itself, which needs nothing - FixTracker.running_migration covers it at runtime.
+        before = run_by.fetch(before, before)
+        after = run_by.fetch(after, after)
+        next if before == after
         next unless steps.key?(before) && steps.key?(after)
 
         edges[before] << after
@@ -70,6 +78,19 @@ module YiffSpace
       end
     end
 
+    # Maps [:fix, name] => [:migration, version] for every pending fix a pending migration runs
+    # itself with YiffSpace::Fixers::RequiresFix#run_fix.
+    def fixes_run_by(migrations)
+      migrations.each_with_object({}) do |m, run_by|
+        Fixers::RequiresFix.fixes_run_by(m.filename).each do |id_or_name|
+          names = FixTracker.resolve(id_or_name)
+          raise(UnresolvableOrder, "#{m.name} runs fix #{id_or_name.inspect}, which does not exist") if names.empty?
+
+          names.each { |name| run_by[[:fix, name]] ||= [:migration, m.version] }
+        end
+      end
+    end
+
     # Kahn's algorithm - ready nodes are processed FIFO in `steps`' insertion order (migrations
     # before fixes when both are ready at once), so requirements only ever reorder things when
     # they actually have to.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: yiffspace-fixers
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Donovan_DMC
 bindir: bin
 cert_chain: []
-date: 2026-09-04 00:00:00.000000000 Z
+date: 2026-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -75,6 +75,7 @@ files:
 - lib/yiffspace/fixers.rb
 - lib/yiffspace/fixers/engine.rb
 - lib/yiffspace/fixers/requires_fix.rb
+- lib/yiffspace/fixers/script.rb
 - lib/yiffspace/fixers/version.rb
 - lib/yiffspace/migration_sync.rb
 homepage: https://yiff.space