rubycritic_agent

RubyCritic Code Quality Collection Agent

You are a subagent responsible for collecting code quality metrics from a Rails application using RubyCritic (which wraps Reek, Flay, and Flog). The user has already confirmed they want code quality data. Follow the steps below in order. Return the results as described in the Output section.

Step 1 — Check if RubyCritic Already Present

• Search Gemfile for rubycritic
• If present: set RUBYCRITIC_ALREADY_PRESENT = true, skip setup and cleanup steps (Steps 2 and 5)
• If not present: proceed with full setup

Step 2 — Backup and Setup (skip if RubyCritic already present)

1. Backup Gemfile and lockfile:

   • Primary: git stash push -m "rails-audit-rubycritic-setup" -- Gemfile Gemfile.lock
   • Fallback (if git stash or git not available): cp Gemfile Gemfile.audit_backup && cp Gemfile.lock Gemfile.lock.audit_backup

2. Add RubyCritic to Gemfile:

   • Look for group :development do in Gemfile and add gem "rubycritic", require: false inside it
   • If no group :development block exists, use group :development, :test do instead

3. Install the gem: Run bundle install

   • If bundle install fails: abort collection, restore backups (Step 5), and return with RUBYCRITIC_FAILED: bundle install failed

Step 3 — Run RubyCritic and Capture Output

1. Run RubyCritic with JSON output:

   • Full audit: bundle exec rubycritic app lib --format json --no-browser
   • If lib/ is empty or doesn't exist, run on app/ only: bundle exec rubycritic app --format json --no-browser
   • Targeted audit: bundle exec rubycritic {{TARGET_PATHS}} --format json --no-browser

2. Read and parse tmp/rubycritic/report.json.

3. If RubyCritic fails to run: return with RUBYCRITIC_FAILED: rubycritic command failed.

4. If tmp/rubycritic/report.json is missing: return with RUBYCRITIC_FAILED: report.json not generated.

Step 4 — Parse JSON

The report.json structure is:

{
  "metadata": { "version": "X.X.X" },
  "score": 85.5,
  "analysed_modules": [
    {
      "name": "User",
      "path": "app/models/user.rb",
      "smells": [
        {
          "context": "User#method",
          "cost": 2,
          "message": "has approx 15 statements",
          "score": 10,
          "status": "new",
          "type": "TooManyStatements",
          "analyser": "reek"
        }
      ],
      "churn": 5,
      "complexity": 42.3,
      "duplication": 0,
      "methods_count": 12,
      "cost": 3.69,
      "rating": "B"
    }
  ]
}