rails-rebase-migrations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 308418a394a967adb56ba7e5a4826f1e23b139e9250a219ced47ea195e65e9e8
+  data.tar.gz: 04f7d242120998f9632ba540fd3b2ffaa06b8cc5a6537275ed37c33f808c478f
+SHA512:
+  metadata.gz: f547e60c2d6b62b5173b9b1ab136b6d4951a4c8e91202d61b3d6c871587a43a2884bfb6c1f19d260c9831cbdc9dbb1e220760497ad9c0d6fdc9e2cecf4fd2108
+  data.tar.gz: dc692ba49d38af2f21ae9ab6b88fc3f91e0c0865ea30816206deb475fbf8544beafbbce206cfb509f4c11ecd3b3565529c460b916b6ee481a4afd69a52f6b074

data/bin/rebase-migrations

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rails_rebase_migrations'
+
+RebaseMigrations.new.main

data/lib/rebase_migrations.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'open3'
+require 'optparse'
+require 'shellwords'
+
+class RebaseMigrations
+  SKIP_REBASE = '_skip_rebase_'
+
+  MIGRATIONS_DIR = 'db/migrate/'
+  MIGRATION_NAME_RE = /^(\d+)(.*)$/
+
+  def main
+    ref, options = parse_args
+
+    out = subprocess('git', 'ls-files', '--', MIGRATIONS_DIR)
+    all_migrations = out.split("\n").to_a.sort
+
+    out = subprocess('git', 'diff', '--diff-filter=A', '--name-only', ref, '--', MIGRATIONS_DIR)
+    new_migrations = out.split("\n").to_a.sort
+
+    starting_index = all_migrations.length - new_migrations.length
+
+    now = Time.now.to_i
+
+    return if new_migrations.empty?
+
+    new_migrations.each do |path|
+      basename = File.basename(path)
+      match = MIGRATION_NAME_RE.match(File.basename(path))
+      migration_timestamp = match[1]
+      migration_name_base = match[2]
+      next if migration_name_base.start_with?(SKIP_REBASE)
+
+      if options[:check]
+        index = all_migrations.index(path)
+        if index < starting_index
+          skip_migration_name = "#{migration_timestamp}#{SKIP_REBASE}#{migration_name_base[1..]}"
+
+          warn <<~MSG
+            Migration #{basename} is out of order. It should come after
+            pre-existing migrations. To fix, run the command:
+
+              $ ./tools/rebase-migrations
+
+            If the migration is intentionally out of order, add the magic
+            string "#{SKIP_REBASE}" to the beginning of the migration name:
+
+              $ git mv #{path} #{MIGRATIONS_DIR}#{skip_migration_name}
+
+            If this pull request is merging across branches prod, staging, or
+            main, then add the "review-merge" label.
+          MSG
+
+          exit 1
+        end
+      else
+        new_timestamp = Time.at(now).utc.strftime('%Y%m%d%H%M%S')
+        new_migration_name = "#{new_timestamp}#{migration_name_base}"
+        subprocess('git', 'mv', path, "#{MIGRATIONS_DIR}#{new_migration_name}")
+        # Add 120s so the new migrations maintain the same order and provides
+        # room between the migrations to inject new ones.
+        now += 120
+      end
+    end
+
+    return if options[:check]
+
+    # Regenerate db/schema.rb
+    system('rails', 'db:drop', 'db:create', 'db:migrate', exception: true)
+    subprocess('git', 'add', 'db/schema.rb')
+  end
+
+  private
+
+  def parse_args
+    options = {}
+
+    parser = OptionParser.new do |opts|
+      opts.banner = "Usage: #{opts.program_name} [--check] [REF]"
+
+      opts.on('--check', 'Check new migrations are ordered last. Exit with status code 1 if they are not.')
+
+      opts.on('--help', '-h', 'Print this help') do
+        puts opts
+        exit
+      end
+    end
+
+    args = parser.parse(ARGV, into: options)
+    if args.length > 1
+      warn "Expected 0 or 1 positional arguments but found #{args.length}."
+      exit 2
+    end
+    ref = args.first || 'main'
+
+    [ref, options]
+  end
+
+  def subprocess(*args)
+    stdin, stdout, wait_thr = Open3.popen2(*args)
+    stdin.close
+    out = stdout.read
+    stdout.close
+    status = wait_thr.value
+
+    raise "Command failed: #{status}\n\n  #{Shellwords.join(args)}\n" if status != 0
+
+    out
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rails-rebase-migrations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pioneer Valley Books
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+description: |
+  # Rebase Migrations
+
+  Rebase Migrations is a library and command line tool to rebase Rails migrations
+  to have the latest timestamp.
+
+  ## Installation
+
+  ```console
+  $ bundle add rebase-migrations --group=development,test
+  ```
+
+  ## Scenario
+
+  Two team members, Alice and Bob, are working on the same Rails project and both
+  are adding new database migrations. Alice realizes her migration depends on
+  Bob's, but the migration timestamps are out of order. The `rebase-migration`
+  command line tool can be used to reorder Alice's new migrations to have the
+  latest timestamp in the sequence.
+
+  ## Usage
+
+  To rebase all new migrations with respect to the `main` git branch:
+
+  ```console
+  $ bundle exec rebase-migrations
+  ```
+
+  To rebase all new migrations with respect to a different branch:
+
+  ```console
+  $ bundle exec rebase-migrations my-branch
+  ```
+
+  The command has a `--check` argument that is useful for CI. To check that all
+  new migrations are the latest in the sequence:
+
+  ```console
+  $ bundle exec rebase-migrations --check
+  ```
+
+  It will exit with status code 1 if the check fails. The `--check` form also
+  accepts a branch argument.
+
+  ### Skipping Migrations
+
+  To skip a specific migration files from the `--check` include `_skip_rebase` in
+  its filename.
+email: 
+executables:
+- rebase-migrations
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/rebase-migrations
+- lib/rebase_migrations.rb
+homepage: https://github.com/Pioneer-Valley-Books/rebase-migrations
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Rebase Rails migrations to be the latest
+test_files: []