testprune 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5df7245c9484fac5c375f5bc3275e2af2ffb4a48e1090a15cfff56188a24047f
-  data.tar.gz: 23edfd9d58322bdc03dacc04d5986772dfe57690ad5a6481da6bcf21dc604715
+  metadata.gz: fdc667523d09a211fe97edcc2175b58b341ab9cfcadaa0aed693d139d95f8319
+  data.tar.gz: cc7047cf657da982ed4ba936c1b3cb4cba06ea11e6183b6619e61d08073cdb45
 SHA512:
-  metadata.gz: cab54aebaf7b972b7efa70c617bc769109ce74d3aee567717ddd33339d164410a78c4cb6e98ac6277f28828e26179fff8b4cf267d511a1fdbe22ea6b0e5781ca
-  data.tar.gz: 5a9ef2a87d2ce1ddd88ace0cc19dc6ba3259ba7a500db3abc9f88cb95805ef5a42736c29d7489eb4cdf992d7fec2361bf7b584fbd7532ca88044e8b6add3dde9
+  metadata.gz: 7d7cfef25ef87d93ea0e928409a9dd8aa778fac90ad56e501a2a29de1322b02656608a6b8761902b2e801773b8c900126f65695995d464fda44d84a71cdef5e2
+  data.tar.gz: 9ae8e0da87b1f18a54fb2b4d4a3f43875380af913694eaabd5aac78fbe2ca3d927709edb557ba9b6b9221e6f556ce37b9570d91f8359e41cfa0d99c1a880aacc

data/README.md

@@ -122,30 +122,46 @@ testprune report --json       # machine-readable (for CI dashboards)
 testprune report -s app -s lib
 ```
 
-**Example output** (against the bundled calculator fixture):
+**Example output** (against the bundled calculator fixture). In an interactive terminal the report is colorized and boxed via lipgloss:
+
+![testprune report — styled terminal output](assets/report-example.svg)
+
+<details>
+<summary>Plain-text (<code>NO_COLOR</code>) version</summary>
 
 ```
-testprune — test coverage redundancy report
-Suite: 4 test(s), framework=minitest
+  testprune — coverage redundancy report
+  4 tests · minitest
+────────────────────────────────────────────────────────────────
+
+  ● HIGH confidence — safe to remove  (1)
+  ──────────────────────────────────────────────────────────────
 
-HIGH confidence — safe to remove: 1
-  [identical] CalculatorTest#test_add_again
-      at: test/calculator_test.rb:16
-      reason: identical coverage to CalculatorTest#test_add
-      kept by: CalculatorTest#test_add
-      covers: Calculator#add (lib/calculator.rb:4)
-      ✓ safe — every covered unit remains covered by a retained test
+    [identical]  CalculatorTest#test_add_again
+    at: test/calculator_test.rb:16
+    reason: identical coverage to CalculatorTest#test_add
+    kept by: CalculatorTest#test_add
+    both cover: Calculator#add (lib/calculator.rb:4)
+    ✓ safe — every covered unit is retained by another test
 
-MEDIUM confidence — review (structural duplicates): 1
-  [structural] CalculatorTest#test_positive
-      at: test/calculator_test.rb:20
-      reason: test body structurally identical to CalculatorTest#test_nonpositive
-      · review-only — not auto-applied
+  ● MEDIUM confidence — review  (1)
+  ──────────────────────────────────────────────────────────────
 
-Estimated CI savings:
-  1 test(s), 0.0132s (~85.7% of 0.0154s test time)
+    [structural]  CalculatorTest#test_positive
+    at: test/calculator_test.rb:20
+    reason: test body structurally identical to CalculatorTest#test_nonpositive
+    covers: Calculator#sign (lib/calculator.rb:8)
+    · review-only — not auto-applied
+
+  Estimated CI savings
+  1 test(s)  ·  0.0132s saved  ·  ~85.7% of suite
+  Note: wall-clock savings lower on parallel CI runners
+
+  Run testprune apply to review and emit a removal patch.
 ```
 
+</details>
+
 ### Step 3 — Apply
 
 ```sh

data/assets/report-example.svg

@@ -0,0 +1,30 @@
+<svg viewBox="0 0 661 668" xmlns="http://www.w3.org/2000/svg" role="img" aria-label="testprune report — styled terminal output">
+  <rect width="661" height="668" fill="#0d1117" rx="14"/>
+  <g font-family="ui-monospace,'SF Mono',Menlo,Consolas,monospace" font-size="13" xml:space="preserve">
+    <text x="22" y="34"><tspan fill="#7D56F4">╭──────────────────────────────────────────╮</tspan></text>
+    <text x="22" y="54"><tspan fill="#7D56F4">│ </tspan><tspan fill="#E2E8F0">  testprune — coverage redundancy report</tspan><tspan fill="#E2E8F0"> </tspan><tspan fill="#7D56F4">│</tspan></text>
+    <text x="22" y="74"><tspan fill="#7D56F4">│ </tspan><tspan fill="#E2E8F0">  4 tests · minitest</tspan><tspan fill="#E2E8F0">                     </tspan><tspan fill="#7D56F4">│</tspan></text>
+    <text x="22" y="94"><tspan fill="#7D56F4">╰──────────────────────────────────────────╯</tspan></text>
+    <text x="22" y="134"><tspan fill="#22C55E" font-weight="700">  ● HIGH confidence — safe to remove</tspan><tspan fill="#9CA3AF">  (1)</tspan></text>
+    <text x="22" y="154"><tspan fill="#3D3D5C">  ──────────────────────────────────────────────────────────────</tspan></text>
+    <text x="22" y="194"><tspan fill="#7D56F4">    [identical]</tspan><tspan fill="#E2E8F0">  CalculatorTest#test_add_again</tspan></text>
+    <text x="22" y="214"><tspan fill="#3D3D5C">    at: </tspan><tspan fill="#9CA3AF">test/calculator_test.rb:16</tspan></text>
+    <text x="22" y="234"><tspan fill="#3D3D5C">    reason: </tspan><tspan fill="#9CA3AF">identical coverage to CalculatorTest#test_add</tspan></text>
+    <text x="22" y="254"><tspan fill="#3D3D5C">    kept by: CalculatorTest#test_add</tspan></text>
+    <text x="22" y="274"><tspan fill="#3D3D5C">    both cover: Calculator#add (lib/calculator.rb:4)</tspan></text>
+    <text x="22" y="294"><tspan fill="#22C55E">    ✓ safe — every covered unit is retained by another test</tspan></text>
+    <text x="22" y="334"><tspan fill="#F59E0B" font-weight="700">  ● MEDIUM confidence — review</tspan><tspan fill="#9CA3AF">  (1)</tspan></text>
+    <text x="22" y="354"><tspan fill="#3D3D5C">  ──────────────────────────────────────────────────────────────</tspan></text>
+    <text x="22" y="394"><tspan fill="#7D56F4">    [structural]</tspan><tspan fill="#E2E8F0">  CalculatorTest#test_positive</tspan></text>
+    <text x="22" y="414"><tspan fill="#3D3D5C">    at: </tspan><tspan fill="#9CA3AF">test/calculator_test.rb:20</tspan></text>
+    <text x="22" y="434"><tspan fill="#3D3D5C">    reason: </tspan><tspan fill="#9CA3AF">test body structurally identical to CalculatorTest#test_nonpositive</tspan></text>
+    <text x="22" y="454"><tspan fill="#3D3D5C">    covers: Calculator#sign (lib/calculator.rb:8)</tspan></text>
+    <text x="22" y="474"><tspan fill="#3D3D5C">    · review-only — not auto-applied</tspan></text>
+    <text x="22" y="514"><tspan fill="#7D56F4">╭─────────────────────────────────────────────────────────╮</tspan></text>
+    <text x="22" y="534"><tspan fill="#7D56F4">│ </tspan><tspan fill="#E2E8F0">  Estimated CI savings</tspan><tspan fill="#E2E8F0">                                  </tspan><tspan fill="#7D56F4">│</tspan></text>
+    <text x="22" y="554"><tspan fill="#7D56F4">│ </tspan><tspan fill="#22C55E">  1 test(s)</tspan><tspan fill="#9CA3AF">  ·  </tspan><tspan fill="#22C55E">0.0132s saved</tspan><tspan fill="#9CA3AF">  ·  </tspan><tspan fill="#22C55E">~85.7% of suite</tspan><tspan fill="#E2E8F0">       </tspan><tspan fill="#7D56F4">│</tspan></text>
+    <text x="22" y="574"><tspan fill="#7D56F4">│ </tspan><tspan fill="#9CA3AF">  Note: wall-clock savings lower on parallel CI runners</tspan><tspan fill="#E2E8F0"> </tspan><tspan fill="#7D56F4">│</tspan></text>
+    <text x="22" y="594"><tspan fill="#7D56F4">╰─────────────────────────────────────────────────────────╯</tspan></text>
+    <text x="22" y="634"><tspan fill="#9CA3AF">  Run </tspan><tspan fill="#7D56F4">testprune apply</tspan><tspan fill="#9CA3AF"> to review and emit a removal patch.</tspan></text>
+  </g>
+</svg>

data/lib/testprune/report.rb

@@ -46,13 +46,37 @@ module Testprune
       out << "      at: #{fp.file}:#{fp.line}" if fp.file
       out << "      reason: #{candidate.reason}"
       out << "      kept by: #{candidate.kept_by.join(', ')}" unless candidate.kept_by.empty?
-      out << "      covers: #{covered_labels(fp)}"
+      out.concat(coverage_text_lines(candidate, fp))
       out << "      #{safety_line(candidate)}"
       out
     end
 
-    def covered_labels(footprint)
-      labels = footprint.units.map { |id| @result.label_for(id) }.sort
+    def coverage_text_lines(candidate, fp)
+      case candidate.group
+      when :identical
+        ["      both cover: #{covered_labels(fp.units)}"]
+      when :subset
+        keeper = find_keeper(candidate)
+        lines = ["      candidate covers: #{covered_labels(fp.units)}"]
+        if keeper
+          extra = keeper.units - fp.units
+          lines << "      keeper adds: #{covered_labels(extra)}" unless extra.empty?
+        end
+        lines
+      else
+        ["      covers: #{covered_labels(fp.units)}"]
+      end
+    end
+
+    def find_keeper(candidate)
+      return nil if candidate.kept_by.empty?
+      return nil unless @result.respond_to?(:detector_result)
+
+      @result.detector_result.footprints.find { |f| f.id == candidate.kept_by.first }
+    end
+
+    def covered_labels(units)
+      labels = units.map { |id| @result.label_for(id) }.sort
       labels.size <= 4 ? labels.join('; ') : "#{labels.first(4).join('; ')} (+#{labels.size - 4} more)"
     end
 

data/lib/testprune/ui/report_renderer.rb

@@ -101,9 +101,7 @@ module Testprune
           lines << "    #{styled('kept by: ', Styles::DIM_TEXT)}#{styled(candidate.kept_by.join(', '), Styles::DIM_TEXT)}"
         end
 
-        covers = fp.units.map { |id| @result.label_for(id) }.sort
-        covers_text = covers.size <= 4 ? covers.join(' · ') : "#{covers.first(4).join(' · ')} (+#{covers.size - 4} more)"
-        lines << "    #{styled('covers: ', Styles::DIM_TEXT)}#{styled(covers_text, Styles::DIM_TEXT)}"
+        lines.concat(coverage_detail_lines(candidate, fp))
 
         safety = case candidate.safe
                  when true  then styled('    ✓ safe — every covered unit is retained by another test', Styles::SAFE_LINE)
@@ -138,6 +136,39 @@ module Testprune
         tty? ? Styles::SUCCESS_BOX.render(msg) : msg
       end
 
+      def coverage_detail_lines(candidate, fp)
+        case candidate.group
+        when :identical
+          [coverage_line('both cover', fp.units)]
+        when :subset
+          keeper = keeper_footprint(candidate)
+          lines = [coverage_line('candidate covers', fp.units)]
+          if keeper
+            extra = keeper.units - fp.units
+            lines << coverage_line('keeper adds', extra) unless extra.empty?
+          end
+          lines
+        else
+          [coverage_line('covers', fp.units)]
+        end
+      end
+
+      def coverage_line(label, units)
+        "    #{styled("#{label}: ", Styles::DIM_TEXT)}#{styled(format_units(units), Styles::DIM_TEXT)}"
+      end
+
+      def keeper_footprint(candidate)
+        return nil if candidate.kept_by.empty?
+        return nil unless @result.respond_to?(:detector_result)
+
+        @result.detector_result.footprints.find { |f| f.id == candidate.kept_by.first }
+      end
+
+      def format_units(units)
+        labels = units.map { |id| @result.label_for(id) }.sort
+        labels.size <= 4 ? labels.join(' · ') : "#{labels.first(4).join(' · ')} (+#{labels.size - 4} more)"
+      end
+
       def cta_line
         "  #{styled('Run ', Styles::META_TEXT)}" \
         "#{styled('testprune apply', Styles::PURPLE_TEXT)}" \

data/lib/testprune/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Testprune
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testprune
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Seth MacPherson
@@ -57,6 +57,7 @@ files:
 - LICENSE
 - README.md
 - assets/quickstart.svg
+- assets/report-example.svg
 - exe/testprune
 - lib/testprune.rb
 - lib/testprune/adapters/minitest.rb