nandi 1.0.0 → 2.0.0

data/lib/nandi/safe_migration_enforcer.rb

@@ -7,6 +7,7 @@ require "rails/generators"
 require "nandi/file_diff"
 require "nandi/file_matcher"
 require "nandi/lockfile"
+require "nandi/migration_violations"
 
 module Nandi
   class SafeMigrationEnforcer
@@ -16,128 +17,123 @@ module Nandi
     DEFAULT_AR_MIGRATION_DIR = "db/migrate"
     DEFAULT_FILE_SPEC = "all"
 
+    attr_reader :violations
+
     def initialize(require_path: nil,
                    safe_migration_dir: DEFAULT_SAFE_MIGRATION_DIR,
                    ar_migration_dir: DEFAULT_AR_MIGRATION_DIR,
                    files: DEFAULT_FILE_SPEC)
-      @safe_migration_dir = safe_migration_dir
-      @ar_migration_dir = ar_migration_dir
       @files = files
 
       require require_path unless require_path.nil?
 
-      Nandi.configure do |c|
-        c.migration_directory = @safe_migration_dir
-        c.output_directory = @ar_migration_dir
-      end
+      configure_legacy_mode_if_needed(safe_migration_dir, ar_migration_dir)
+      @violations = MigrationViolations.new
     end
 
     def run
-      safe_migrations = matching_migrations(@safe_migration_dir)
-      ar_migrations = matching_migrations(@ar_migration_dir)
+      collect_violations
 
-      return true if safe_migrations.none? && ar_migrations.none?
-
-      enforce_no_ungenerated_migrations!(safe_migrations, ar_migrations)
-      enforce_no_hand_written_migrations!(safe_migrations, ar_migrations)
-      enforce_no_hand_edited_migrations!(ar_migrations)
-      enforce_no_out_of_date_migrations!(safe_migrations)
+      if violations.any?
+        raise MigrationLintingFailed, violations.to_error_message
+      end
 
       true
     end
 
     private
 
-    def matching_migrations(dir)
-      names = Dir.glob(File.join(dir, "*.rb")).map { |path| File.basename(path) }
-      FileMatcher.call(files: names, spec: @files)
-    end
-
-    def enforce_no_ungenerated_migrations!(safe_migrations, ar_migrations)
-      ungenerated_migrations = safe_migrations - ar_migrations
-      if ungenerated_migrations.any?
-        error = <<~ERROR
-          The following migrations are pending generation:
+    def configure_legacy_mode_if_needed(safe_dir, ar_dir)
+      legacy_mode = safe_dir != DEFAULT_SAFE_MIGRATION_DIR ||
+        ar_dir != DEFAULT_AR_MIGRATION_DIR
 
-            - #{ungenerated_migrations.sort.join("\n  - ")}
+      return unless legacy_mode
 
-          Please run `rails generate nandi:compile` to generate your migrations.
-        ERROR
+      Nandi.configure do |c|
+        c.migration_directory = safe_dir
+        c.output_directory = ar_dir
+      end
+    end
 
-        raise MigrationLintingFailed, error
+    def collect_violations
+      Nandi.config.databases.each do |_, database|
+        check_database_violations(database)
       end
     end
 
-    def enforce_no_hand_written_migrations!(safe_migrations, ar_migrations)
-      handwritten_migrations = ar_migrations - safe_migrations
-      handwritten_migration_paths = names_to_paths(handwritten_migrations)
+    def check_database_violations(database)
+      safe_migrations = matching_migrations(database.migration_directory)
+      ar_migrations = matching_migrations(database.output_directory)
 
-      if handwritten_migration_paths.any?
-        error = <<~ERROR
-          The following migrations have been written by hand, not generated:
+      # Check ungenerated migrations and get remaining files
+      remaining_safe, remaining_ar = check_ungenerated_migrations(
+        safe_migrations, ar_migrations, database
+      )
 
-            - #{handwritten_migration_paths.sort.join("\n  - ")}
+      # Check handwritten migrations and get remaining files
+      remaining_safe, remaining_ar = check_handwritten_migrations(
+        remaining_safe, remaining_ar, database
+      )
 
-          Please use Nandi to generate your migrations. In exeptional cases, hand-written
-          ActiveRecord migrations can be added to the .nandiignore file. Doing so will
-          require additional review that will slow your PR down.
-        ERROR
+      # Check out-of-date migrations
+      check_out_of_date_migrations(remaining_safe, database)
 
-        raise MigrationLintingFailed, error
-      end
+      # Check hand-edited migrations
+      check_hand_edited_migrations(remaining_ar, database)
     end
 
-    def enforce_no_out_of_date_migrations!(safe_migrations)
-      out_of_date_migrations = safe_migrations.
-        map { |m| [m, Nandi::Lockfile.get(m)] }.
-        select do |filename, digests|
-          Nandi::FileDiff.new(
-            file_path: File.join(@safe_migration_dir, filename),
-            known_digest: digests[:source_digest],
-          ).changed?
-        end
-
-      if out_of_date_migrations.any?
-        error = <<~ERROR
-          The following migrations have changed but not been recompiled:
-
-            - #{out_of_date_migrations.sort.join("\n  - ")}
+    def check_ungenerated_migrations(safe_migrations, ar_migrations, database)
+      missing_files = safe_migrations - ar_migrations
+      violations.add_ungenerated(missing_files, database.migration_directory)
 
-          Please recompile your migrations to make sure that the changes you expect are
-          applied.
-        ERROR
-
-        raise MigrationLintingFailed, error
-      end
+      # Return remaining files after removing processed ones
+      [safe_migrations - missing_files, ar_migrations]
     end
 
-    def enforce_no_hand_edited_migrations!(ar_migrations)
-      hand_altered_migrations = ar_migrations.
-        map { |m| [m, Nandi::Lockfile.get(m)] }.
-        select do |filename, digests|
-          Nandi::FileDiff.new(
-            file_path: File.join(@ar_migration_dir, filename),
-            known_digest: digests[:compiled_digest],
-          ).changed?
-        end
+    def check_handwritten_migrations(safe_migrations, ar_migrations, database)
+      handwritten_files = ar_migrations - safe_migrations
+      violations.add_handwritten(handwritten_files, database.output_directory)
 
-      if hand_altered_migrations.any?
-        error = <<~ERROR
-          The following migrations have had their generated content altered:
+      # Return remaining files after removing processed ones
+      [safe_migrations, ar_migrations - handwritten_files]
+    end
 
-            - #{hand_altered_migrations.sort.join("\n  - ")}
+    def check_out_of_date_migrations(safe_migrations, database)
+      out_of_date_files = find_changed_files(
+        safe_migrations,
+        database,
+        :source_digest,
+        database.migration_directory,
+      )
+      violations.add_out_of_date(out_of_date_files, database.migration_directory)
+    end
 
-          Please don't hand-edit generated migrations. If you want to write a regular
-          ActiveRecord::Migration, please do so and add it to .nandiignore. Note that
-          this will require additional review that will slow your PR down.
-        ERROR
+    def check_hand_edited_migrations(ar_migrations, database)
+      hand_edited_files = find_changed_files(
+        ar_migrations,
+        database,
+        :compiled_digest,
+        database.output_directory,
+      )
+      violations.add_hand_edited(hand_edited_files, database.output_directory)
+    end
 
-        raise MigrationLintingFailed, error
+    def find_changed_files(filenames, database, digest_key, directory)
+      filenames.filter_map do |filename|
+        digests = Nandi::Lockfile.for(database.name).get(filename)
+        file_diff = Nandi::FileDiff.new(
+          file_path: File.join(directory, filename),
+          known_digest: digests[digest_key],
+        )
+        filename if file_diff.changed?
       end
     end
 
-    def names_to_paths(names)
-      names.map { |name| File.join(@ar_migration_dir, name) }
+    def matching_migrations(directory)
+      return Set.new unless Dir.exist?(directory)
+
+      filenames = Dir.glob(File.join(directory, "*.rb")).map { |path| File.basename(path) }
+      FileMatcher.call(files: filenames, spec: @files)
     end
   end
 end

data/lib/nandi/validation.rb

@@ -2,6 +2,7 @@
 
 require "nandi/validation/add_column_validator"
 require "nandi/validation/add_reference_validator"
+require "nandi/validation/add_index_validator"
 require "nandi/validation/remove_index_validator"
 require "nandi/validation/each_validator"
 require "nandi/validation/result"

data/lib/nandi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nandi
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/lib/nandi.rb

@@ -9,15 +9,16 @@ module Nandi
   class Error < StandardError; end
 
   class << self
-    def compile(files:)
+    def compile(files:, db_name: nil)
       compiled = files.
-        map { |f| CompiledMigration.build(f) }
+        map { |f| CompiledMigration.build(file_name: f, db_name: db_name) }
 
       yield compiled
     end
 
     def configure
       yield config
+      config.validate!
     end
 
     def validator
@@ -27,9 +28,5 @@ module Nandi
     def config
       @config ||= Config.new
     end
-
-    def compiled_output_directory
-      Nandi.config.output_directory || "db/migrate"
-    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: nandi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - GoCardless Engineering
 bindir: exe
 cert_chain: []
-date: 2025-03-21 00:00:00.000000000 Z
+date: 2025-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -120,6 +120,9 @@ files:
 - lib/nandi/instructions/validate_constraint.rb
 - lib/nandi/lockfile.rb
 - lib/nandi/migration.rb
+- lib/nandi/migration_violations.rb
+- lib/nandi/multi_database.rb
+- lib/nandi/multi_db_generator.rb
 - lib/nandi/renderers.rb
 - lib/nandi/renderers/active_record.rb
 - lib/nandi/renderers/active_record/generate.rb