Documentation

# Create a reporter instance
reporter = MigrationGuard::Reporter.new

# Get status report data
report = reporter.status_report
# Returns: { current_branch:, main_branch:, synced_count:, orphaned_count:, orphaned_migrations:, missing_migrations: }

# Get formatted output
output = reporter.format_status_output
puts output

# Create a tracker instance
tracker = MigrationGuard::Tracker.new

# Track a migration manually
tracker.track_migration('20240116123456', :up)

# Check if migration exists
tracker.migration_tracked?('20240116123456')

# Clean up old records
tracker.cleanup_old_records
# Returns: number of records cleaned

# Create git integration instance
git = MigrationGuard::GitIntegration.new

# Get current branch
current_branch = git.current_branch

# Get main branch name
main_branch = git.main_branch

# Get migration versions in trunk
trunk_migrations = git.migration_versions_in_trunk
# Returns: Array of migration version strings

# Create analyzer instance
analyzer = MigrationGuard::RecoveryAnalyzer.new

# Analyze migration inconsistencies
issues = analyzer.analyze
# Returns: Array of issue hashes with :type, :version, :severity, :recovery_options

# Check if there are issues
if analyzer.issues?
  # Get formatted report
  report = analyzer.format_analysis_report
  Rails.logger.info report
end

# Issue types detected:
# - :partial_rollback (stuck in rolling_back state)
# - :orphaned_schema (in schema_migrations but not tracked)
# - :missing_file (tracked but file missing)
# - :version_conflict (duplicate tracking records)

# Create executor instance
executor = MigrationGuard::RecoveryExecutor.new(interactive: false)

# Execute recovery for an issue
issue = analyzer.analyze.first
success = executor.execute_recovery(issue, :complete_rollback)

# Recovery options include:
# - :complete_rollback - Finish incomplete rollback
# - :restore_migration - Re-apply migration
# - :mark_as_rolled_back - Update status only
# - :track_migration - Create tracking record
# - :remove_from_schema - Delete schema entry
# - :consolidate_records - Merge duplicate records

# Access backup path after recovery
backup_path = executor.backup_path if executor.backup_path

# Create rollbacker instance
rollbacker = MigrationGuard::Rollbacker.new

# Get orphaned migrations
orphaned = rollbacker.orphaned_migrations

# Rollback a specific migration
success = rollbacker.rollback_migration('20240116123456')

# Rollback all orphaned migrations
rollbacker.rollback_all_orphaned(force: true)

# Interactive rollback (prompts for each)
rollbacker.rollback_orphaned_interactively

# Create author reporter instance
author_reporter = MigrationGuard::AuthorReporter.new

# Get author statistics
stats = author_reporter.authors_summary
# Returns: { total_authors:, total_migrations:, most_active:, average_per_author:, current_user: }

# Get per-author breakdown
authors = author_reporter.authors_report
# Returns: Array of author data with counts by status

# Get formatted report
output = author_reporter.format_authors_report
puts output