coverband 6.1.4 → 6.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3ffdf0c9a4cefbcbc728967f36ed20a90755074864a2fe858859b739e6912bb
-  data.tar.gz: e853e687820d45bbf414f51efd3a51f996b05f5eff0dcecac95351b076b3300d
+  metadata.gz: '01680ffc24d42fce1b45f90fff31a9d190b029af8a83b0a1405ed81d2785bc10'
+  data.tar.gz: 04daf91b9d7f64849d217075e71ff00d54cac2e64fd1b5c7fdd7e0b27943b56e
 SHA512:
-  metadata.gz: 3f2f69c9de574808771f002af9fc4903fed8ec9af0d52288457759ff21b1c8a3c0e42111a6ea59c8830893fc57acf05e300f8520903dda920a894419710ad386
-  data.tar.gz: 20073041f076062cefeeeb8bcec74d703086d70c86c6f7b0b2511474f5c0cd2b9cb61510245cca49104dff53a8979249a2b4dae2bfad85b09682c9dd56ce5628
+  metadata.gz: 0de107048e072e97c1bded932a59ac9b6be2c6ac94b045118977aae38282a109772b183bed1b7ca99d7867d3fc694f326a53e2e93174bbf372e7f0ba16e8bd13
+  data.tar.gz: 57d8e1921056acb7f13e47b02caeb6207e635984a461c1952aafd0dbf4e445519d99ca8b369b60d11c3121b86da6f5f3d3d2a4e6aaf6d68fd2d3a8aa155d14fb

data/.github/workflows/main.yml

@@ -19,20 +19,39 @@ jobs:
         # truffleruby,
         # truffleruby-head,
         # removing jruby again to flaky
-        gemfile: [ Gemfile.rails6.0, Gemfile.rails6.1, Gemfile.rails7.0, Gemfile.rails7.1 ]
+        gemfile: [ Gemfile.rails7.0, Gemfile.rails7.1, Gemfile.rails7.2, Gemfile.rails8.0 ]
         # need to add support for multiple gemfiles
-        ruby: ["2.7", "3.0", "3.1", "3.2", "3.3"]
+        ruby: ["3.1", "3.2", "3.3", "3.4", "4.0", "ruby-head"]
         redis-version: [4, 5, 6, 7]
+        exclude:
+          # Rails 8 requires ruby 3.2+.
+          - gemfile: 'rails_8.0'
+            ruby: '3.1'
     runs-on: ${{ matrix.os }}-latest
+    services:
+      redis:
+        image: redis:${{ matrix.redis-version }}
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
     steps:
-      - uses: actions/checkout@v4
-      - uses: supercharge/redis-github-action@1.8.0
-        with:
-          redis-version: ${{ matrix.redis-version }}
+      - uses: actions/checkout@v6
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-      - run: bundle exec standardrb
-      - run: bundle exec rake
+      - run: bundle exec rake test:all
       - run: "RUBYOPT='--enable=frozen-string-literal --debug=frozen-string-literal' bundle exec rake"
+  starndardrb:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec standardrb --format github

data/.gitignore

@@ -24,4 +24,6 @@ temp_results
 .env
 log/
 test/unique_files
-test/rails5_dummy/tmp
+test/rails7_dummy/tmp
+CLAUDE.md
+.claude/

data/.rubocop.yml

@@ -2,4 +2,4 @@ require: standard
 
 inherit_gem:
   standard:
-    - config/ruby-2.7.yml
+    - config/ruby-3.1.yml

data/.standard.yml

@@ -1,4 +1,4 @@
-ruby_version: 2.7
+ruby_version: 3.1
 fix: false # default: false
 parallel: true # default: false
 format: progress # default: Standard::Formatter

data/Gemfile

@@ -4,7 +4,10 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
-gem "rails", "~>7"
+gem "rails" # latest
 gem "haml"
 gem "slim"
 gem "webrick"
+
+# Required for Ruby 3.4+ (extracted from stdlib)
+gem "cgi"

data/Gemfile.rails7.0

@@ -8,3 +8,6 @@ gem 'rails', '~>7.0.0'
 gem "haml"
 gem "slim"
 gem "webrick"
+
+# Required for Ruby 3.4+ (extracted from stdlib)
+gem "cgi"

data/Gemfile.rails7.1

@@ -7,4 +7,7 @@ gemspec
 gem 'rails', '~>7.1.0'
 gem "haml"
 gem "slim"
-gem "webrick"
+gem "webrick"
+
+# Required for Ruby 3.4+ (extracted from stdlib)
+gem "cgi"

data/{Gemfile.rails7 → Gemfile.rails7.2}

@@ -4,7 +4,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
-gem 'rails', '~>7'
+gem 'rails', '~>7.2.0'
 gem "haml"
 gem "slim"
-gem "webrick"
+gem "webrick"
+
+# Required for Ruby 3.4+ (extracted from stdlib)
+gem "cgi"

data/{Gemfile.rails6.0 → Gemfile.rails8.0}

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
-gem "rails", "~>6.0.0"
+gem 'rails', '~>8.0.0'
 gem "haml"
 gem "slim"
 gem "webrick"
+
+# Required for Ruby 3.4+ (extracted from stdlib)
+gem "cgi"

data/README.md

@@ -116,6 +116,39 @@ The columns in the web UI are as follows:
 When viewing an individual file, a line of code such as a class or method definition may appear green because it is eager loaded by the application, but still not be hit at all in runtime by actual users.  
 
 ![example of a file with lines not hit at runtime](https://user-images.githubusercontent.com/96786/63541229-aa98a580-c4eb-11e9-8eb8-c004fe1369db.png)
+#### Coverage first seen and Last activity recorded
+In the context of Coverband, a file is considered relevant for monitoring if it is located within certain specified project paths. Specifically, Coverband monitors all *.rb files located in the following paths:
+
+- app/
+
+- lib/
+
+- config/
+
+This applies as long as these files are not included in the list of exclusions defined in "config.ignore".
+
+#### Coverage first seen
+This attribute shows the exact date and time when Coverband first detected the file. This detection happens when:
+
+- The file is loaded by Ruby (e.g., during application startup in Rails via autoload or require).
+
+- The file becomes relevant for monitoring, even if no lines within it have been executed yet.
+
+- By default, Coverband resets a file’s coverage data and updates its “Coverage first seen” timestamp whenever the file changes, ensuring the coverage reflects the file’s new state.
+
+#### Last activity recorded
+This attribute shows the most recent time when any line in the file was executed at runtime. It specifically reflects runtime execution and does not include the file’s load time.
+
+- When any line in the file is executed at runtime (e.g., a method is called, a route is triggered, or a conditional is evaluated), Coverband updates the “Last activity recorded” timestamp.
+
+- This only occurs when the file’s lines are actually executed. If a file is loaded but none of its lines are executed, the “Last activity recorded” timestamp will not be updated.
+
+- It helps determine if a file is actively being used in the application. If a file has no recent activity, it may be a candidate for review or removal.
+
+#### Example
+- If a file has a “Coverage first seen” timestamp but no “Last activity recorded”, this indicates that the file is being loaded but no runtime activity is occurring (e.g., it contains unused methods or classes).
+
+- If both attributes are populated and the “Last activity recorded” timestamp is recent, the file is actively used in the application.
 
 ### Mounting as a Rack App
 
@@ -305,12 +338,10 @@ Now that Coverband uses MD5 hashes there should be no reason to manually clear c
 
 `rake coverband:clear`
 
-This can also be done through the web if `config.web_enable_clear` is enabled.
-
-**NOTE**: The previous task does not clear the trackers data (views, routes, translations, etc).
-To clear trackers data, run
+This will clear both the coverage and trackers data. It can also be done through the web if `config.web_enable_clear` is enabled.
 
-`rake coverband:clear_tracker`
+To clear only coverage data, run `rake coverband:clear_coverage`.
+To clear only trackers data, run `rake coverband:clear_tracker`.
 
 ### Adding Rake Tasks outside of Rails
 
@@ -375,6 +406,129 @@ A few folks have asked about what size of Redis is needed to run Coverband. I ha
 
 # Newer Features
 
+### MCP Server for AI Assistants
+
+Coverband includes an optional MCP (Model Context Protocol) server that allows AI assistants like Claude to query your production coverage data directly. This enables AI-powered code analysis, dead code detection, and coverage insights.
+
+#### Installation
+
+Add the MCP gem to your Gemfile:
+
+```ruby
+gem 'mcp'
+```
+
+#### Available Tools
+
+The MCP server provides the following tools:
+
+| Tool | Description |
+|------|-------------|
+| `get_coverage_summary` | Get overall coverage statistics |
+| `get_file_coverage` | Get detailed coverage for a specific file |
+| `get_uncovered_files` | List files with no coverage data |
+| `get_dead_methods` | Find methods that are never called |
+| `get_view_tracker_data` | Get view/template usage data |
+| `get_route_tracker_data` | Get route usage statistics |
+| `get_translation_tracker_data` | Get translation key usage data |
+
+#### Running the MCP Server
+
+**Standalone (stdio transport):**
+
+```bash
+bundle exec coverband-mcp
+```
+
+**With a rake task:**
+
+```bash
+bundle exec rake coverband:mcp
+```
+
+**HTTP mode (for remote access):**
+
+```bash
+COVERBAND_MCP_HTTP=true COVERBAND_MCP_PORT=9023 bundle exec rake coverband:mcp
+```
+
+#### Configuring Claude Desktop
+
+Add to your Claude Desktop configuration (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
+
+**Option 1: Stdio transport (recommended for local development)**
+
+```json
+{
+  "mcpServers": {
+    "coverband": {
+      "command": "bundle",
+      "args": ["exec", "coverband-mcp"],
+      "cwd": "/path/to/your/rails/app"
+    }
+  }
+}
+```
+
+**Option 2: HTTP transport (for remote access or shared servers)**
+
+First, start the MCP server in HTTP mode:
+
+```bash
+COVERBAND_MCP_HTTP=true bundle exec rake coverband:mcp
+```
+
+Then configure Claude Desktop to connect via `mcp-remote`:
+
+```json
+{
+  "mcpServers": {
+    "coverband": {
+      "command": "npx",
+      "args": ["mcp-remote", "http://localhost:9023"]
+    }
+  }
+}
+```
+
+#### Configuring Claude Code
+
+Add a `.mcp.json` file to your project root:
+
+**Option 1: Stdio transport (recommended)**
+
+```json
+{
+  "mcpServers": {
+    "coverband": {
+      "command": "bundle",
+      "args": ["exec", "coverband-mcp"]
+    }
+  }
+}
+```
+
+**Option 2: HTTP transport**
+
+```json
+{
+  "mcpServers": {
+    "coverband": {
+      "command": "npx",
+      "args": ["mcp-remote", "http://localhost:9023"]
+    }
+  }
+}
+```
+
+#### Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `COVERBAND_MCP_HTTP` | Enable HTTP transport instead of stdio | `false` |
+| `COVERBAND_MCP_PORT` | Port for HTTP server | `9023` |
+| `COVERBAND_REDIS_URL` | Redis URL for coverage data | `localhost:6379` |
+
 ### Dead Method Scanning (ruby 2.6+)
 
 Rake task that outputs dead methods based on current coverage data:
@@ -399,14 +553,14 @@ Outputs:
 
 # Prerequisites
 
-- Coverband 3.0.X+ requires Ruby 2.3+
+- Ruby 3.1+
 - Coverband currently requires Redis for production usage
 
 ### Ruby and Rails Version Support
 
 We will match Heroku & Ruby's support lifetime, supporting the last 3 major Ruby releases. For details see [supported runtimes](https://devcenter.heroku.com/articles/ruby-support#supported-runtimes).
 
-For Rails, we will follow the policy of the [Rails team maintenance policy](https://guides.rubyonrails.org/maintenance_policy.html). We officially support the last two major release versions, while providing minimal support (major bugs / security fixes) for an additional version. This means at the moment we primarily target Rails 6.x, 5.x, and will try to keep current functionality working for Rails 4.x but may release new features that do not work on that target.
+For Rails, we will follow the policy of the [Rails team maintenance policy](https://guides.rubyonrails.org/maintenance_policy.html). We officially support the last two major release versions, while providing minimal support (major bugs / security fixes) for an additional version. At the moment we primarily target Rails 7.0+.
 
 ### JRuby Support
 

data/Rakefile

@@ -8,7 +8,7 @@ RuboCop::RakeTask.new
 
 task default: %i[test]
 
-task "test:all": %i[rubocop test forked_tests benchmarks:memory benchmarks]
+task "test:all": %i[test forked_tests benchmarks:memory benchmarks]
 
 task :test
 require "rake/testtask"

data/agents.md

@@ -0,0 +1,217 @@
+# AI Agent Guidelines for Coverband Development
+
+This document provides guidance for AI coding agents working on the Coverband project. Following these guidelines ensures code quality and consistency.
+
+## Project Overview
+
+Coverband is a Ruby gem that provides rack middleware to measure production code usage (LOC runtime usage). The project uses:
+- **Ruby**: >= 3.1
+- **Test Framework**: Minitest (version ~> 5.0)
+- **Code Style**: StandardRB
+- **CI/CD**: GitHub Actions
+
+## Testing Requirements
+
+### Running Tests
+
+All code changes MUST pass the test suite before considering work complete. The project has multiple test targets:
+
+#### Standard Test Suite
+```bash
+bundle exec rake test
+```
+This runs the main integration and unit tests located in:
+- `test/integration/**/*_test.rb`
+- `test/coverband/**/*_test.rb`
+
+#### Forked Tests
+```bash
+bundle exec rake forked_tests
+```
+Runs tests that require forked processes (Rails integration tests):
+- `test/forked/**/*_test.rb`
+
+Note: Forked tests are not supported on JRuby.
+
+#### Full Test Suite
+```bash
+bundle exec rake test:all
+```
+Runs all tests including benchmarks and memory tests.
+
+#### Default Task
+```bash
+bundle exec rake
+```
+Equivalent to `bundle exec rake test`
+
+### Test Framework Details
+
+- Uses **Minitest** with **Mocha** for mocking
+- Test files follow the pattern `*_test.rb`
+- Rails integration tests use **Capybara** for browser testing
+- Forked tests use `minitest-fork_executor` for parallel execution
+
+### Test Configuration
+
+Key test dependencies:
+- `minitest ~> 5.0` (pinned for compatibility with minitest-fork_executor)
+- `mocha` for mocking/stubbing
+- `minitest-stub-const` for constant stubbing
+- `capybara` for integration testing
+- `rack-test` for Rack testing
+
+## Code Style Requirements
+
+### StandardRB
+
+All code MUST pass StandardRB linting before considering work complete.
+
+```bash
+bundle exec standardrb --format github
+```
+
+#### Auto-fix Style Issues
+```bash
+bundle exec standardrb --fix
+```
+
+### Configuration
+
+StandardRB configuration is in `.standard.yml`:
+- Ruby version: 3.1
+- Parallel execution enabled
+- Some rules are disabled for compatibility with older Ruby versions
+- Test files have relaxed rules (see `.standard.yml` for specifics)
+
+### Common Style Requirements
+
+1. **Module Inclusions**: Add an empty line after `extend` or `include` statements
+2. **Frozen String Literals**: All Ruby files should start with `# frozen_string_literal: true`
+3. **Line Length**: Follow StandardRB defaults (no manual line length configuration needed)
+
+## AI Agent Workflow
+
+When making code changes, follow this workflow:
+
+### 1. Make Code Changes
+Implement the requested feature or bug fix.
+
+### 2. Run Tests
+```bash
+bundle exec rake test
+```
+
+If working on Rails integration or forked features:
+```bash
+bundle exec rake test:all
+```
+
+### 3. Fix Any Test Failures
+- Read test output carefully
+- Fix issues in the code
+- Re-run tests until all pass
+
+### 4. Check Code Style
+```bash
+bundle exec standardrb --format github
+```
+
+### 5. Auto-fix Style Issues (if any)
+```bash
+bundle exec standardrb --fix
+```
+
+### 6. Verify Everything Passes
+```bash
+bundle exec rake test
+bundle exec standardrb --format github
+```
+
+### 7. Only Then Consider Work Complete
+Do NOT mark work as complete or hand back to the user until:
+- ✅ All tests pass
+- ✅ StandardRB reports no violations
+
+## Common Issues and Solutions
+
+### Mocha Configuration
+- Use only Mocha 3.x compatible configuration options
+- Valid options: `stubbing_method_unnecessarily`, `stubbing_non_public_method`
+- Invalid options (removed): `stubbing_method_on_nil`, `stubbing_method_on_non_mock_object`, `stubbing_non_existent_method`
+
+### Rails Constant Checks
+When checking if Rails is defined:
+```ruby
+# ✅ Correct
+if defined?(Rails) && Rails.respond_to?(:version)
+  # ...
+end
+
+# ❌ Wrong (doesn't protect against undefined constant)
+if Rails&.respond_to?(:version)
+  # ...
+end
+```
+
+### Minitest Version
+- Must use Minitest ~> 5.0 for compatibility with `minitest-fork_executor`
+- Minitest 6.0+ is not compatible with the fork executor
+
+## CI/CD
+
+The project uses GitHub Actions for CI. On every push/PR:
+1. Tests run against multiple Ruby versions (3.1, 3.2, 3.3, 3.4, ruby-head)
+2. Tests run against multiple Rails versions (7.0, 7.1, 7.2, 8.0)
+3. Tests run against multiple Redis versions (4, 5, 6, 7)
+4. StandardRB runs separately to check code style
+
+Your local testing should match CI requirements:
+- All tests must pass
+- StandardRB must report no violations
+
+## Additional Notes
+
+- The project uses Redis as the default storage backend
+- Rails 8.0 requires Ruby 3.2+
+- Test coverage data is stored in `/tmp` during tests
+- Use `test_helper.rb` for common test setup
+- Use `rails_test_helper.rb` for Rails-specific test setup
+
+## Example Complete Workflow
+
+```bash
+# 1. Make changes to code
+vim lib/coverband/some_file.rb
+
+# 2. Run tests
+bundle exec rake test
+
+# 3. Fix any failures, re-run until passing
+bundle exec rake test
+
+# 4. Check style
+bundle exec standardrb --format github
+
+# 5. Auto-fix any style issues
+bundle exec standardrb --fix
+
+# 6. Final verification
+bundle exec rake test
+bundle exec standardrb --format github
+
+# 7. All green? Work is complete! ✅
+```
+
+## Quick Reference
+
+| Command | Purpose |
+|---------|---------|
+| `bundle exec rake` | Run main test suite (default) |
+| `bundle exec rake test` | Run main test suite |
+| `bundle exec rake forked_tests` | Run forked/Rails integration tests |
+| `bundle exec rake test:all` | Run all tests including benchmarks |
+| `bundle exec standardrb --format github` | Check code style |
+| `bundle exec standardrb --fix` | Auto-fix style issues |
+
+Remember: **Tests and style checks must pass before work is considered complete!**

data/bin/coverband-mcp

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "coverband/mcp"
+
+# Ensure Coverband is configured
+Coverband.configure unless Coverband.configured?
+
+# Security check and warning
+unless Coverband.configuration.mcp_enabled?
+  puts "❌ ERROR: MCP is not enabled for security reasons."
+  puts "To enable MCP access, configure Coverband with:"
+  puts
+  puts "Coverband.configure do |config|"
+  puts "  config.mcp_enabled = true"
+  puts "  config.mcp_password = 'your-secure-password'  # Recommended"
+  puts "  config.mcp_allowed_environments = %w[development staging production]  # As needed"
+  puts "end"
+  puts
+  puts "Or set environment variables:"
+  puts "  COVERBAND_MCP_PASSWORD=your-secure-password"
+  puts
+  puts "Current environment: #{(defined?(Rails) && Rails.respond_to?(:env) && Rails.env) || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"}"
+  exit 1
+end
+
+# Display security status
+puts "🔐 SECURITY STATUS:"
+if Coverband.configuration.mcp_password
+  puts "  ✅ Authentication: Enabled (password protected)"
+else
+  puts "  ⚠️  Authentication: DISABLED - Consider setting mcp_password for production use"
+end
+env = (defined?(Rails) && Rails.respond_to?(:env) && Rails.env) || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+puts "  📍 Environment: #{env}"
+puts "  🌍 Allowed environments: #{Coverband.configuration.mcp_allowed_environments.join(", ")}"
+puts
+
+# Start the MCP server with stdio transport
+server = Coverband::MCP::Server.new
+server.run_stdio