review-commit

Pre-Commit Quality Review

Review the staged changes in this commit for code quality issues before committing.

Objectives

• Fast: Complete review in < 30 seconds
• Focused: Only review staged Ruby files
• Actionable: Clear pass/fail with specific fixes
• Non-interactive: Works in headless mode
• Expert-driven: Apply Ruby best practices from industry experts

Expert Panel

Apply principles from these Ruby/software design experts:

1. Sandi Metz - POODR principles, small methods/classes, SRP, DRY
2. Jeremy Evans - Sequel best practices, transaction safety, performance
3. Kent Beck - Simple design, revealing names, Command-Query Separation
4. Avdi Grimm - Confident Ruby, null objects, tell-don't-ask, meaningful returns
5. Gary Bernhardt - Functional core/imperative shell, fast tests, immutability

Review Process

1. Get staged files:

   git diff --cached --name-only --diff-filter=ACM | grep '\.rb$'
   

2. For each staged Ruby file, check:

   • Get the full diff: git diff --cached <file>
   • Review only the added/modified lines (lines starting with +)

3. Look for critical issues (❌ BLOCK):

   Sandi Metz violations:

   • ❌ Missing frozen_string_literal: true in new files
   • ❌ Methods > 15 lines (SRP violation, too complex)
   • ❌ Classes > 200 lines (god object)
   • ❌ Obvious code duplication (DRY violation)

   Jeremy Evans (Sequel) violations:

   • ❌ Raw SQL strings instead of Sequel dataset methods
   • ❌ Database writes without transaction wrapper
   • ❌ N+1 queries (multiple queries in loops)

   Kent Beck violations:

   • ❌ Overly complex solutions (nested conditionals > 3 levels)
   • ❌ Command-Query Separation violation (methods that both mutate and return calculated values)

   Avdi Grimm violations:

   • ❌ Defensive nil checks everywhere (should use null objects)
   • ❌ Implicit nil returns in public methods
   • ❌ Bare raise or rescue without exception class