getcov 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d05ca227c84cbbabe0b4988f9e05c32421c9264de47645135a594abea611be3
+  data.tar.gz: e4c472974841b668a70bc39bd73c7496917b8cdf059d8d862fa1fc4623265def
+SHA512:
+  metadata.gz: 4fd45e4fd86b3b9deb0c49fa2d8e6a5cbfebefeaa8db230f286ee5f015b3bdcdf012e9781a80fef7b5e69f853e156b658b6ee96e586b6972c0a15dae582e4676
+  data.tar.gz: fb6dcd4d57cf7bd706b4ad085ad0652efa27d4731cf31758ee167bf8e4fe3eaadc27a27e5ca3b771df8fbf22016cbf2367436729d861787d4e18dd4e77219481

data/.github/workflows/pages.yml

@@ -0,0 +1,54 @@
+name: Publish Coverage to Pages
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ main, master ]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+      - run: bundle install --jobs 4 --retry 3
+      - name: Configure getcov (HTML only)
+        run: |
+          cat > getcov.rb <<'RUBY'
+          Getcov.configure do |c|
+            c.output_dir = 'coverage'
+            c.enable_html!
+          end
+          RUBY
+      - name: Run tests with coverage
+        env:
+          RUBYOPT: -rgetcov/auto
+        run: bundle exec rake test
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: coverage
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

data/.github/workflows/pr_coverage.yml

@@ -0,0 +1,94 @@
+name: PR Coverage
+
+on:
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  coverage-diff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Configure getcov (HTML + JSON + PR comment)
+        run: |
+          cat > getcov.rb <<'RUBY'
+          require 'getcov/formatter/summary_json'
+          require 'getcov/formatter/pr_comment'
+          Getcov.configure do |c|
+            c.output_dir = 'coverage'
+            c.enable_html!
+            c.add_formatter(Getcov::Formatter::SummaryJSON)
+            c.add_formatter(Getcov::Formatter::PRComment)
+          end
+          RUBY
+
+      - name: Run tests on HEAD with coverage
+        env:
+          RUBYOPT: -rgetcov/auto
+        run: bundle exec rake test
+
+      - name: Move HEAD coverage aside
+        run: |
+          mkdir -p .cov/head
+          cp coverage/summary.json .cov/head/summary.json
+          cp -r coverage .cov/head/html || true
+
+      - name: Compute BASE ref
+        id: base
+        run: |
+          echo "ref=${{ github.base_ref }}" >> "$GITHUB_OUTPUT"
+
+      - name: Checkout BASE
+        run: |
+          git checkout ${{ steps.base.outputs.ref }}
+
+      - name: Install deps for BASE
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Configure getcov (JSON only for baseline)
+        run: |
+          cat > getcov.rb <<'RUBY'
+          require 'getcov/formatter/summary_json'
+          Getcov.configure do |c|
+            c.output_dir = 'coverage'
+            c.add_formatter(Getcov::Formatter::SummaryJSON)
+          end
+          RUBY
+
+      - name: Run tests on BASE with coverage
+        env:
+          RUBYOPT: -rgetcov/auto
+        run: bundle exec rake test
+
+      - name: Move BASE coverage aside
+        run: |
+          mkdir -p .cov/base
+          cp coverage/summary.json .cov/base/summary.json || echo '{}' > .cov/base/summary.json
+
+      - name: Coverage diff
+        id: diff
+        run: |
+          ruby .github/scripts/coverage_diff.rb             --base ./.cov/base/summary.json             --head ./.cov/head/summary.json             --fail-drop ${FAIL_DROP:-1.0} > coverage_diff.md
+        env:
+          FAIL_DROP: "1.0"  # fail if total coverage drops by >= 1.0%
+
+      - name: Append to step summary
+        run: cat coverage_diff.md >> "$GITHUB_STEP_SUMMARY"
+
+      - name: Upload coverage HTML (HEAD) as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-html
+          path: .cov/head/html

data/.github/workflows/release.yml

@@ -0,0 +1,84 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  test-and-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Configure getcov (HTML, Cobertura, LCOV, Badge)
+        run: |
+          cat > getcov.rb <<'RUBY'
+          Getcov.configure do |c|
+            c.output_dir = 'coverage'
+            c.enable_html!
+            c.enable_cobertura!
+            c.enable_lcov!
+            c.enable_badge!
+          end
+          RUBY
+
+      - name: Run tests with coverage
+        env:
+          RUBYOPT: -rgetcov/auto
+        run: bundle exec rake test
+
+      - name: Archive coverage artifacts
+        run: |
+          mkdir -p pkg
+          (cd coverage && zip -r ../pkg/coverage.zip .) || true
+
+      - name: Build gem
+        run: |
+          gem build getcov.gemspec
+          mkdir -p pkg
+          mv getcov-*.gem pkg/
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-artifacts
+          path: |
+            pkg/*.gem
+            pkg/coverage.zip
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: test-and-build
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: build-artifacts
+          path: pkg
+
+      - name: Publish to RubyGems
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+        run: |
+          ls -l pkg
+          gem push pkg/getcov-*.gem
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            pkg/getcov-*.gem
+            pkg/coverage.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby CI
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ '3.1', '3.2', '3.3' ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'minitest'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mridul
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,158 @@
+# Getcov
+
+Getcov is a tiny, dependency‑free Ruby code‑coverage tool inspired by SimpleCov.
+It uses Ruby’s built‑in `Coverage` module to measure which lines are executed during
+your test run and prints concise reports (console + HTML), with exporters and CI helpers.
+
+## Features
+
+- CLI wrapper: `getcov <command>` auto-starts coverage
+- Auto loader: `-r getcov/auto`
+- Filters & only/ignore globs
+- Groups + per-group minimum thresholds
+- Track files not loaded (so 0% appears)
+- Minimum coverage gate (exit code 2)
+- Console summary
+- HTML report (index + per-file with **per-line highlighting**), repo links
+- Cobertura XML (`coverage/coverage.xml`) and LCOV (`coverage/lcov.info`)
+- SVG coverage badge (`coverage/coverage.svg`)
+- Branch coverage summary (if Ruby supports branches)
+- Parallel test merging helpers
+- GitHub Actions CI (Ruby 3.1/3.2/3.3 matrix)
+
+## Quick start
+
+```bash
+gem build getcov.gemspec
+gem install getcov-0.2.0.gem
+
+# recommended: wrap your test command
+getcov bundle exec rspec
+# or
+getcov bundle exec rake test
+
+# alternative: just require auto starter
+ruby -r getcov/auto -S rspec
+```
+
+## Configuration
+
+Create `getcov.rb` in your project root, or call `Getcov.configure` programmatically.
+
+```ruby
+Getcov.configure do |c|
+  c.output_dir = 'coverage'
+  c.minimum_coverage = 90.0
+
+  # Groups + thresholds
+  c.add_group 'Models', %r{^app/models/}
+  c.add_group 'Controllers', %r{^app/controllers/}
+  c.add_group_minimum 'Models', 95
+  c.add_group_minimum 'Controllers', 90
+
+  # Selection helpers
+  c.only_files 'app/**/*.rb'
+  c.ignore_files 'app/admin/**/*', 'vendor/**/*'
+  c.add_filter %r{(^|/)spec/}
+
+  # Track files even if not loaded
+  c.track_files 'app/**/*.rb'
+
+  # Repo links in HTML
+  c.repo_url = 'https://github.com/your/repo'
+  c.repo_branch = 'main'
+
+  # Formatters
+  c.enable_html!
+  c.enable_cobertura!
+  c.enable_lcov!
+  c.enable_badge!
+
+  # Parallel merge directory (see below)
+  # c.parallel_merge_dir = 'tmp/getcov'
+end
+```
+
+## Parallel runs (simple workflow)
+
+Workers:
+```bash
+export GETCOV_ROLE=worker
+# run tests with -r getcov/auto; finalize writes partial JSONs to c.parallel_merge_dir
+```
+
+Master (after all workers finish):
+```bash
+export GETCOV_ROLE=master
+# run a no-op to trigger finalize which merges partials + writes reports
+ruby -r getcov/auto -e ""
+```
+
+Alternatively, call `Getcov.merge_raw_results([...])` to combine raw result hashes yourself,
+then build a `Getcov::Result` and run formatters.
+
+## Badges
+
+After a run, publish `coverage/coverage.svg` wherever you like (README image, docs, etc).
+
+## CI
+
+GitHub Actions workflow is included in `.github/workflows/ruby.yml` (Ruby 3.1/3.2/3.3).
+
+## License
+
+MIT © 2025 Mridul Shukla
+
+
+## Extras
+
+### Per-file thresholds
+```ruby
+Getcov.configure do |c|
+  c.per_file_minimum = 85.0
+end
+```
+
+### PR comment / CI summary
+Enable the PR comment formatter to generate `coverage/pr_comment.md` and also write to
+`$GITHUB_STEP_SUMMARY` when running in GitHub Actions:
+
+```ruby
+require 'getcov/formatter/pr_comment'
+Getcov.configure { |c| c.add_formatter(Getcov::Formatter::PRComment) }
+```
+
+### JSON summary
+```ruby
+require 'getcov/formatter/summary_json'
+Getcov.configure { |c| c.add_formatter(Getcov::Formatter::SummaryJSON) }
+# => writes coverage/summary.json
+```
+
+
+## Release (RubyGems + GitHub)
+- Set repo secret `RUBYGEMS_API_KEY` (from rubygems.org → API Keys).
+- Bump version in `lib/getcov/version.rb`, commit, then:
+  ```bash
+  git tag vX.Y.Z
+  git push origin vX.Y.Z
+  ```
+- CI will test, generate coverage, publish the gem, and create a Release with artifacts.
+See `RELEASE.md` for details.
+
+
+## PR coverage diffs
+A workflow `.github/workflows/pr_coverage.yml` runs tests on both **HEAD** and **BASE**, then
+generates a Markdown diff (`coverage_diff.md`) and appends it to the GitHub Actions step summary.
+It fails the PR if total coverage drops by ≥ `FAIL_DROP` (default **1.0%**).
+
+To tweak the threshold, set an env var on the `Coverage diff` step:
+```yaml
+env:
+  FAIL_DROP: "0.5"
+```
+
+## GitHub Pages docs
+Workflow `.github/workflows/pages.yml` runs HTML coverage on pushes to default branch and publishes
+the `coverage/` folder to GitHub Pages.
+Enable Pages in repo settings to serve `index.html`.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task default: :test

data/exe/getcov

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+if ARGV.empty?
+  warn 'Usage: getcov <command> [args...]'
+  exit 1
+end
+
+ENV['RUBYOPT'] = [ENV['RUBYOPT'], '-rgetcov/auto'].compact.join(' ')
+exec(*ARGV)

data/lib/getcov/auto.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'getcov'
+
+config_file = File.expand_path('getcov.rb', Dir.pwd)
+if File.exist?(config_file)
+  require config_file
+end
+
+Getcov.start

data/lib/getcov/configuration.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+module Getcov
+  class Configuration
+    attr_accessor :root, :minimum_coverage, :per_file_minimum, :output_dir,
+                  :repo_url, :repo_branch, :parallel_merge_dir
+    attr_reader :filters, :groups, :tracked_globs, :formatters,
+                :group_minimums, :ignore_globs, :only_globs
+
+    def initialize
+      @root = Dir.pwd
+      @filters = []
+      @groups = {}
+      @tracked_globs = []
+      @formatters = []
+      @minimum_coverage = nil
+      @per_file_minimum = nil
+      @group_minimums = {}
+      @output_dir = File.expand_path('coverage', @root)
+      @repo_url = nil
+      @repo_branch = 'main'
+      @ignore_globs = []
+      @only_globs = []
+      @parallel_merge_dir = nil
+    end
+
+    # Selection & filtering
+    def add_filter(callable_or_pattern = nil, &block)
+      predicate =
+        if callable_or_pattern.respond_to?(:call)
+          callable_or_pattern
+        elsif callable_or_pattern
+          pattern = callable_or_pattern
+          ->(path) { path.match?(pattern) }
+        elsif block
+          block
+        else
+          raise ArgumentError, 'add_filter requires a callable, pattern, or block'
+        end
+      @filters << predicate
+    end
+
+    def ignore_files(*globs)  # convenience
+      @ignore_globs.concat(globs.flatten)
+    end
+    alias add_ignore_glob ignore_files
+
+    def only_files(*globs)    # convenience
+      @only_globs.concat(globs.flatten)
+    end
+
+    def filtered?(path)
+      unless @only_globs.empty?
+        return true unless @only_globs.any? { |g| File.fnmatch?(g, path, File::FNM_PATHNAME | File::FNM_EXTGLOB) }
+      end
+      if @ignore_globs.any? { |g| File.fnmatch?(g, path, File::FNM_PATHNAME | File::FNM_EXTGLOB) }
+        return true
+      end
+      @filters.any? { |f| f.call(path) }
+    end
+
+    def add_group(name, *patterns)
+      @groups[name] ||= []
+      @groups[name].concat(patterns.flatten)
+    end
+
+    def track_files(*globs)
+      @tracked_globs.concat(globs.flatten)
+    end
+
+    def add_formatter(formatter)
+      @formatters << formatter
+    end
+    def enable_html!;      require 'getcov/formatter/html';      add_formatter(Getcov::Formatter::HTML);      end
+    def enable_cobertura!; require 'getcov/formatter/cobertura'; add_formatter(Getcov::Formatter::Cobertura); end
+    def enable_lcov!;      require 'getcov/formatter/lcov';      add_formatter(Getcov::Formatter::LCOV);      end
+    def enable_badge!;     require 'getcov/formatter/badge';     add_formatter(Getcov::Formatter::Badge);     end
+
+    def add_group_minimum(name, percent)
+      @group_minimums[name] = percent.to_f
+    end
+
+    def group_minimum(name)
+      @group_minimums[name]
+    end
+
+    def group_for(path)
+      @groups.each do |name, patterns|
+        return name if patterns.any? { |p| path.match?(p.is_a?(String) ? Regexp.new(Regexp.escape(p)) : p) }
+      end
+      nil
+    end
+
+    def tracked_paths
+      return [] if @tracked_globs.empty?
+      @tracked_globs.flat_map { |g| Dir.glob(File.join(@root, g)) }.uniq
+    end
+  end
+end

data/lib/getcov/formatter/badge.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'fileutils'
+
+module Getcov
+  module Formatter
+    class Badge
+      def initialize(config) @config = config end
+
+      def write(result)
+        pct = result.total_coverage.round(0)
+        color = case pct
+                when 90..100 then '#4c1'
+                when 75..89  then '#97CA00'
+                when 60..74  then '#dfb317'
+                else '#e05d44'
+                end
+        svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" width="110" height="20" role="img" aria-label="coverage: #{pct}%">
+          <linearGradient id="s" x2="0" y2="100%">
+            <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+            <stop offset="1" stop-opacity=".1"/>
+          </linearGradient>
+          <rect rx="3" width="110" height="20" fill="#555"/>
+          <rect rx="3" x="60" width="50" height="20" fill="#{color}"/>
+          <path fill="#{color}" d="M60 0h4v20h-4z"/>
+          <rect rx="3" width="110" height="20" fill="url(#s)"/>
+          <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
+            <text x="30" y="14">coverage</text>
+            <text x="85" y="14">#{pct}%</text>
+          </g>
+        </svg>
+        SVG
+        FileUtils.mkdir_p(@config.output_dir)
+        File.write(File.join(@config.output_dir, 'coverage.svg'), svg)
+      end
+    end
+  end
+end

data/lib/getcov/formatter/cobertura.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+require 'fileutils'
+require 'time'
+
+module Getcov
+  module Formatter
+    class Cobertura
+      def initialize(config) @config = config end
+
+      def write(result)
+        out_dir = @config.output_dir
+        FileUtils.mkdir_p(out_dir)
+        File.write(File.join(out_dir, 'coverage.xml'), render(result))
+      end
+
+      def render(result)
+        timestamp = (Time.now.to_f * 1000).to_i
+        <<~XML
+        <?xml version="1.0"?>
+        <coverage lines-valid="#{result.files.sum(&:relevant)}" lines-covered="#{result.files.sum(&:covered)}" line-rate="#{(result.total_coverage/100.0).round(4)}" timestamp="#{timestamp}" version="getcov">
+          <packages>
+        #{packages_xml(result)}  </packages>
+        </coverage>
+        XML
+      end
+
+      private
+
+      def packages_xml(result)
+        groups = result.files.group_by { |fr| fr.group || 'Ungrouped' }
+        groups.map do |gname, files|
+          <<~PKG
+          <package name="#{xml_escape(gname)}">
+            <classes>
+          #{files.map { |fr| class_xml(fr) }.join}
+            </classes>
+          </package>
+          PKG
+        end.join
+      end
+
+      def class_xml(fr)
+        rate = fr.relevant.zero? ? 1.0 : (fr.covered.to_f / fr.relevant)
+        <<~CLS
+        <class name="#{xml_escape(fr.path)}" filename="#{xml_escape(fr.path)}" line-rate="#{rate.round(4)}">
+          <lines>
+        #{lines_xml(fr)}          </lines>
+        </class>
+        CLS
+      end
+
+      def lines_xml(fr)
+        return "" unless fr.hits
+        out = String.new
+        fr.hits.each_with_index do |hit, idx|
+          next if hit.nil?
+          ln = idx + 1
+          out << %Q{            <line number="#{ln}" hits="#{hit.to_i}"/>
+}
+        end
+        out
+      end
+
+      def xml_escape(s)
+        s.to_s.gsub('&','&amp;').gsub('<','&lt;').gsub('>','&gt;').gsub('"','&quot;').gsub("'", '&apos;')
+      end
+    end
+  end
+end