couve 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91781d6bb92f7f023f6ab39ea4d0f7f707318bef6d09ef8cced4a9c2810e78c2
-  data.tar.gz: ff8ad3ff9c1a7c7c2318ab23d53db3a45f629d9b6c2f44104bf7c5d89beccb3b
+  metadata.gz: 6733bb77b61c6eeb3d8154eb7dc8e04afdae265464983866b237c7474198612a
+  data.tar.gz: 2418be05c9acbf968ac32019ef0d86918b117b68a9f77719d4295e88c074188c
 SHA512:
-  metadata.gz: b921af295d7211b7db8d8fd3e3bea3628f64529ccc031a46a02fc88f42fada6b76acc21f4309f80d2faaea2783fa02783519c3503f67a2d44cfe3054b7c5831b
-  data.tar.gz: fb3836c3e78b7c686f84b559e7344398bc1bed5e6ffca394c6025a4a3389a0b01914f7ab945fbd3a65f697a57b3598da7b8772c919c5b5c20499691c620111f5
+  metadata.gz: 819b2d0c9f768011eb37641ac59a7ac94077222071e867a4a1a50cc51a6ece7bf4028bac072463551e266940e0d12d6b0ce72b15e76070f651a05bef5f4e0257
+  data.tar.gz: 9f4cb0dc81003cacd9df9a4702e4d4bc4b4950747d84a1c28ca7c7783241cd3b823e1589a873da0b792123527bf2b8a90c0f08dec66019f6821a6256c8585d42

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.8.0] - 2026-06-05
+
+- Add `--fail-on-low-coverage` flag to exit with a non-zero status when any reported file is below 100% coverage.
+
+## [0.7.0] - 2026-06-05
+
+- Add `--changed-files` to report the coverage status of a given list of files (e.g. a branch's changed files), including fully covered ones, instead of the project-wide below-100% view.
+- Rename the report heading from "Coverage problems" to "Coverage report".
+
 ## [0.6.0] - 2026-06-04
 
 - Add Markdown output format, selected from the output file extension (`.md`). HTML remains the default.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    couve (0.6.0)
+    couve (0.8.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -65,6 +65,43 @@ couve coverage.json coverage.md     # post to the PR
 gh pr comment "$PR_NUMBER" --body-file coverage.md
 ```
 
+### Reporting only the files you changed
+
+By default the report lists every file in the coverage data that is below 100%. With `--changed-files` you flip that around: instead of a project-wide view, you get the coverage status of exactly the files you touched on a branch — including the ones that are fully covered.
+
+Pass a file with one repo-relative path per line, or `-` to read the list from standard input:
+
+```sh
+git diff --name-only origin/main...HEAD > changed.txt
+couve coverage.json report.md --changed-files changed.txt
+
+# or pipe the list straight in:
+git diff --name-only origin/main...HEAD | couve coverage.json report.md --changed-files -
+```
+
+Only files that appear both in the list and in the coverage data are shown; the rest of the project is left out. Coverage is still reported per file (the whole file's percentage and missed lines), not just the lines in your diff.
+
+### Failing the build on low coverage
+
+By default couve always exits `0` — it only generates the report. Pass `--fail-on-low-coverage` to make couve exit `1` when any **reported** file is below the green threshold, i.e. rated 🔴 or 🟡 (`< 66.66%`):
+
+```sh
+couve coverage.json report.md --fail-on-low-coverage
+```
+
+The report is written **before** couve exits, so the offending files stay visible in the report (and in any PR comment built from it). The offending files are also printed to standard error:
+
+```
+couve: coverage below 66.66% in app/models/foo.rb, app/services/bar.rb
+```
+
+The threshold is the same fixed band used for the rating indicators; there is nothing to configure. The flag respects `--changed-files` scope: when you only report the files you changed, only those files are evaluated, so a green (or empty) changed-file set passes the build even if untouched files elsewhere are poorly covered.
+
+```sh
+# Post the report to the PR, then redden the build if a changed file is under-covered:
+git diff --name-only origin/main...HEAD | couve coverage.json report.md --changed-files - --fail-on-low-coverage
+```
+
 ## Development
 
 To contribute to Couve's development, follow these steps:

data/lib/couve/parser.rb

@@ -3,10 +3,19 @@
 require "json"
 
 module Couve
-  class Parser
-    def initialize(coverage)
+  class Parser # rubocop:disable Metrics/ClassLength
+    RED_THRESHOLD = 33.33
+    GREEN_THRESHOLD = 66.66
+
+    def initialize(coverage, changed_files: nil)
       @coverage = JSON.parse(coverage, symbolize_names: true)
-      @coverage[:source_files].reject! { |file| file[:covered_percent] == 100 }
+
+      if changed_files
+        @coverage[:source_files].select! { |file| changed_files.include?(file[:name]) }
+      else
+        @coverage[:source_files].reject! { |file| file[:covered_percent] == 100 }
+      end
+
       @coverage[:source_files].sort_by! { |file| file[:covered_percent] }
     end
 
@@ -16,7 +25,7 @@ module Couve
           <body>
             <div class="container mt-5">
               <h1 class="display-5">
-                Coverage problems
+                Coverage report
               </h1>
 
               <table class="table table-hover mt-5">
@@ -47,7 +56,7 @@ module Couve
       end
 
       <<~MARKDOWN
-        ## Coverage problems
+        ## Coverage report
 
         | Rating | Coverage | File | Not covered lines |
         | :---: | ---: | :--- | :--- |
@@ -55,6 +64,16 @@ module Couve
       MARKDOWN
     end
 
+    def low_coverage_files
+      @coverage[:source_files]
+        .select { |source_file| source_file[:covered_percent].round(2) < GREEN_THRESHOLD }
+        .map { |source_file| source_file[:name] }
+    end
+
+    def low_coverage?
+      low_coverage_files.any?
+    end
+
     private
 
     # rubocop:disable Metrics/MethodLength
@@ -92,9 +111,9 @@ module Couve
     # rubocop:enable Metrics/MethodLength
 
     def percentage_bar_color(percentage)
-      if percentage < 33.33
+      if percentage < RED_THRESHOLD
         "bg-danger"
-      elsif percentage < 66.66
+      elsif percentage < GREEN_THRESHOLD
         "bg-warning"
       else
         "bg-success"
@@ -102,9 +121,9 @@ module Couve
     end
 
     def percentage_indicator(percentage)
-      if percentage < 33.33
+      if percentage < RED_THRESHOLD
         "🔴"
-      elsif percentage < 66.66
+      elsif percentage < GREEN_THRESHOLD
         "🟡"
       else
         "🟢"

data/lib/couve/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Couve
-  VERSION = "0.6.0"
+  VERSION = "0.8.0"
 end

data/lib/couve.rb

@@ -1,20 +1,51 @@
 # frozen_string_literal: true
 
+require "optparse"
+
 require_relative "couve/version"
 require_relative "couve/parser"
 
 module Couve
-  def self.start
-    coverage_file = ARGV[0]
-    output_file = ARGV[1]
+  def self.start(argv = ARGV)
+    coverage_file, output_file, changed_files_source, fail_on_low_coverage = parse_arguments(argv)
 
     coverage = File.read(coverage_file)
-    parser = Couve::Parser.new(coverage)
+    parser = Couve::Parser.new(coverage, changed_files: changed_files(changed_files_source))
 
     report = output_file.end_with?(".md") ? parser.to_markdown : parser.to_html
 
-    File.open(output_file, "w") do |f|
-      f.puts report
-    end
+    File.open(output_file, "w") { |f| f.puts report }
+
+    return unless fail_on_low_coverage && parser.low_coverage?
+
+    warn "couve: coverage below #{Couve::Parser::GREEN_THRESHOLD}% in #{parser.low_coverage_files.join(", ")}"
+    exit 1
+  end
+
+  def self.parse_arguments(argv) # rubocop:disable Metrics/MethodLength
+    argv = argv.dup
+    changed_files_source = nil
+    fail_on_low_coverage = false
+
+    OptionParser.new do |opts|
+      opts.on("--changed-files PATH", "Only report the files listed in PATH (use - for stdin)") do |path|
+        changed_files_source = path
+      end
+
+      opts.on("--fail-on-low-coverage",
+              "Exit 1 if any reported file is below #{Couve::Parser::GREEN_THRESHOLD}% coverage") do
+        fail_on_low_coverage = true
+      end
+    end.parse!(argv)
+
+    [argv[0], argv[1], changed_files_source, fail_on_low_coverage]
+  end
+
+  def self.changed_files(source)
+    return nil unless source
+
+    contents = source == "-" ? $stdin.read : File.read(source)
+
+    contents.lines.map { |line| line.strip.delete_prefix("./") }.reject(&:empty?)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couve
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Cezinha
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-06-04 00:00:00.000000000 Z
+date: 2026-06-05 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -32,7 +32,6 @@ files:
 - bin/guard
 - bin/rubocop
 - bin/setup
-- couve.gemspec
 - exe/couve
 - lib/couve.rb
 - lib/couve/parser.rb

data/couve.gemspec

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/couve/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "couve"
-  spec.version = Couve::VERSION
-  spec.authors = ["Cezinha"]
-  spec.email = ["cesar@asseinfo.com.br"]
-  spec.metadata = { "rubygems_mfa_required" => "true" }
-
-  spec.summary = "Generate a human readable report for CodeClimate test-reporter gem."
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib", "lib/couve"]
-  spec.required_ruby_version = ">= 3"
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end