branchproof 0.11.1 → 0.12.0

data/lib/branchproof/summary_report.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/ClassLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+require_relative "summary_ranking"
+
+module Branchproof
+  # Terminal view that lists the largest coverage gaps first.
+  class SummaryReport
+    RULE_LABELS = { "true" => "T", "false" => "F", "dont_care" => "-" }.freeze
+    ORDER_NOTE = "Order: unexecuted decisions first, then most missing obligations " \
+                 "(decision-table rules, unproven MC/DC conditions, missing alternatives); " \
+                 "a count, not a risk estimate."
+    SHOWN_TESTS = 3
+    EXPRESSION_WIDTH = 100
+
+    class << self
+      # Shared wording for terminal rows and GitHub output.
+      def gap_summary(decision)
+        parts = []
+        parts << "unexecuted" if decision.unexecuted
+        if decision.table_calculated
+          parts << "DT #{decision.missing_rules.length}/#{decision.required_rules} rules missing"
+        end
+        unless decision.conditions.empty?
+          parts << "MC/DC #{decision.unproven_conditions.length}/#{decision.conditions.length} conditions unproven"
+        end
+        unless decision.alternatives.empty?
+          parts << "#{decision.missing_alternatives.length}/#{decision.alternatives.length} alternatives missing"
+        end
+        parts.join("; ")
+      end
+
+      # One line per missing case: decision-table rules when some are missing,
+      # otherwise unproven conditions; then missing alternatives.
+      def case_lines(decision, coordinator)
+        lines = []
+        if decision.rule_cases?
+          expressions = decision.conditions.sort_by { |row| row[:index].to_i }.map { |row| row[:expression] }
+          heading = coordinator.decision_table_expected_heading({ context: decision.context })
+          decision.missing_rules.each do |rule|
+            lines << "#{rule_text(rule, expressions, coordinator)}; " \
+                     "#{heading.downcase.delete_suffix(":")} #{rule[:outcome] ? "true" : "false"}"
+          end
+        else
+          decision.unproven_conditions.each do |row|
+            explanation = coordinator.condition_explanation(decision_id: decision.id, condition_id: row[:id])
+            lines << "Condition #{row[:index]}: #{row[:expression]} NOT_PROVEN#{explanation}"
+          end
+        end
+        if decision.rule_cases? && decision.unproven_conditions.any?
+          row = decision.unproven_conditions.first
+          explanation = coordinator.condition_explanation(decision_id: decision.id, condition_id: row[:id])
+          lines << "MC/DC evidence: Condition #{row[:index]}: #{row[:expression]} NOT_PROVEN#{explanation}"
+          remaining = decision.unproven_conditions.length - 1
+          lines << "Additional unproven conditions: #{remaining}" if remaining.positive?
+        end
+        decision.missing_alternatives.each { |row| lines << "Need selection of: #{row[:expression]}" }
+        lines
+      end
+
+      def one_line(text, width = EXPRESSION_WIDTH)
+        text = text.to_s.gsub(/\s+/, " ").strip
+        text.length > width ? "#{text[0, width - 3]}..." : text
+      end
+
+      def rule_text(rule, expressions, coordinator)
+        signature = Array(rule[:conditions]).map { |item| RULE_LABELS.fetch(item.to_s, item.to_s) }.join
+        requirements = Array(rule[:conditions]).each_with_index.filter_map do |item, index|
+          requirement = coordinator.decision_table_requirement(item)
+          "#{expressions[index] || "condition #{index}"} #{requirement}" if requirement
+        end
+        "#{rule[:label]} [#{signature}]: #{requirements.join(", ")}"
+      end
+    end
+
+    def initialize(document:, level:, coordinator:, missing_only: false, selection: ReportSelection.new)
+      @document = document || {}
+      @level = level.to_i
+      @coordinator = coordinator
+      @missing_only = missing_only ? true : false
+      @selection = selection
+      @ranking = SummaryRanking.new(document: @document, selection: selection)
+      @tests = @ranking.index.tests.to_h { |test| [test[:id].to_s, test] }
+    end
+
+    def render
+      baseline = fetch(@document, :baseline) || {}
+      completeness = fetch(@document, :completeness) || {}
+      lines = ["Branchproof summary view", "Tests: #{fetch(baseline, :status) || "INCOMPLETE"}"]
+      if completeness.values.include?(false) || fetch(baseline, :status).to_s != "PASSED"
+        lines << "Warning: failed or incomplete run; counts are lower bounds."
+      end
+      lines << ""
+      render_focus_notice(lines)
+      lines << "Whole-run coverage and policy:" if @selection.decision_ids
+      lines.concat(@coordinator.coverage_ladder_lines)
+      lines.concat(@coordinator.coverage_policy_lines)
+      lines.concat(@coordinator.changed_scope_lines) if @selection.decision_ids
+      lines.concat(@coordinator.collation_lines)
+      if @ranking.available?
+        render_ranking(lines)
+      else
+        lines << "Ranking unavailable: the report has no analysis."
+      end
+      unsupported = @ranking.unsupported_count
+      if unsupported.positive?
+        lines << "Unsupported decisions: #{unsupported} (not ranked; MC/DC unavailable) (run-wide)"
+      end
+      Array(fetch(@document, :diagnostics)).each do |diagnostic|
+        prefix = @selection.decision_ids ? "Run-wide diagnostic" : "Diagnostic"
+        lines << "#{prefix}: #{@coordinator.diagnostic_message(diagnostic)}"
+      end
+      lines.join("\n") << "\n"
+    end
+
+    private
+
+    def render_ranking(lines)
+      lines << ORDER_NOTE
+      lines << ""
+      files = @ranking.files
+      files = files.select { |file| file.gaps.positive? } if @missing_only
+      files, hidden_files = @selection.limit(files)
+      gaps, hidden_gaps = @selection.limit(@ranking.gaps)
+      if @selection.top
+        lines << "Display limit: top #{@selection.top} per list; " \
+                 "hidden #{hidden_files} #{hidden_files == 1 ? "file" : "files"}, " \
+                 "#{hidden_gaps} #{hidden_gaps == 1 ? "decision" : "decisions"}"
+        lines << ""
+      end
+      render_files(lines, files)
+      render_gaps(lines, gaps)
+    end
+
+    def render_files(lines, files)
+      lines << "Files:"
+      lines << "  none" if files.empty?
+      files.each_with_index do |file, position|
+        parts = ["#{file.gaps}/#{file.decisions.length} decisions with gaps"]
+        parts << "#{file.unexecuted} unexecuted" if file.unexecuted.positive?
+        parts << "DT #{file.missing_rules}/#{file.required_rules} rules missing" if file.required_rules.positive?
+        parts << "MC/DC #{file.unproven_conditions}/#{file.conditions} conditions unproven" if file.conditions.positive?
+        parts << "#{file.missing_alternatives}/#{file.alternatives} alternatives missing" if file.alternatives.positive?
+        path = if file.relative_path
+                 @selection.decision_ids ? @coordinator.display_scope_path(file.relative_path) : file.relative_path
+               else
+                 "location unavailable"
+               end
+        lines << "  #{position + 1}. #{path}: #{parts.join("; ")}"
+      end
+      lines << ""
+    end
+
+    def render_gaps(lines, gaps)
+      lines << "Where to start:"
+      if gaps.empty?
+        if @selection.decision_ids
+          message = if !focus_match? || empty_changed_scope? || !@coordinator.changed_coverage_available?
+                      "No changed-scope gaps can be reported from the available evidence"
+                    else
+                      "No changed-scope gaps found"
+                    end
+          lines << "  #{message}"
+        else
+          lines << (focus_match? ? "  No missing coverage" : "  none")
+        end
+        lines << ""
+        return
+      end
+      gaps.each_with_index do |decision, position|
+        lines << "  #{position + 1}. #{location(decision)}  #{self.class.one_line(decision.expression)}"
+        lines << "     #{self.class.gap_summary(decision)}"
+        if @level >= 2
+          lines << "     Cases to test: #{decision.cases_to_test}"
+          self.class.case_lines(decision, @coordinator).each { |line| lines << "     #{line}" }
+        end
+        render_reaching_tests(lines, decision) if @level >= 3
+        lines << ""
+      end
+    end
+
+    def render_reaching_tests(lines, decision)
+      ids = decision.test_ids
+      if ids.empty?
+        lines << "     Tests reaching this decision: none recorded"
+        return
+      end
+      lines << "     Tests reaching this decision:"
+      ids.map { |id| test_label(id) }.sort.first(SHOWN_TESTS).each { |label| lines << "       #{label}" }
+      lines << "       #{ids.length - SHOWN_TESTS} more" if ids.length > SHOWN_TESTS
+    end
+
+    def render_focus_notice(lines)
+      return unless @selection.focus_active?
+
+      label = @selection.focus_label
+      no_match = @selection.decision_ids ? "no matching changed decisions" : "no matching decisions"
+      label = @coordinator.display_scope_path(label) if @selection.decision_ids
+      lines << (focus_match? ? "Focus: #{label}" : "Focus: #{no_match} for #{label}")
+    end
+
+    def focus_match?
+      return true unless @selection.focus_active?
+
+      ids = if @selection.decision_ids
+              @selection.selected_decision_ids(@document)
+            else
+              @selection.matching_decision_ids(@document)
+            end
+      !ids.empty?
+    end
+
+    def empty_changed_scope?
+      @selection.decision_ids&.empty?
+    end
+
+    def location(decision)
+      path = @selection.decision_ids ? @coordinator.display_scope_path(decision.relative_path) : decision.relative_path
+      return "location unavailable" if decision.relative_path.nil?
+
+      decision.line ? "#{path}:#{decision.line}" : path
+    end
+
+    def test_label(id)
+      test = @tests[id.to_s]
+      return id.to_s unless test
+
+      label = test[:name].to_s
+      label += " (#{test[:relative_path]}:#{test[:line]})" if test[:relative_path] && test[:line]
+      command = @coordinator.rerun_command(id)
+      command ? "#{label} (rerun: #{command})" : label
+    end
+
+    def fetch(hash, key)
+      return nil unless hash.respond_to?(:key?)
+
+      hash.key?(key) ? hash[key] : hash[key.to_s]
+    end
+  end
+end
+# rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/ClassLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

data/lib/branchproof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Branchproof
-  VERSION = "0.11.1"
+  VERSION = "0.12.0"
 end

data/lib/branchproof/worker.rb

@@ -65,7 +65,10 @@ module Branchproof
              else
                "worker"
              end
-      write_failure(payload || {}, code, { message: e.message }) if payload
+      if payload
+        evidence_snapshot = runtime&.snapshot if %w[minitest_missing minitest_unsupported_version].include?(code)
+        write_failure(payload, code, { message: e.message }, evidence: evidence_snapshot)
+      end
       2
     end
 
@@ -83,9 +86,8 @@ module Branchproof
         require_relative "rspec_adapter"
         Branchproof::RSpecAdapter.new(runtime: runtime)
       else
-        require "minitest"
-        require "minitest/test"
         require_relative "minitest_adapter"
+        Branchproof::MinitestAdapter.load_framework!
         Branchproof::MinitestAdapter.new(runtime: runtime)
       end
     end
@@ -131,8 +133,8 @@ module Branchproof
       framework = project[:framework].to_s.empty? ? "minitest" : project[:framework].to_s
       version = if framework == "rspec" && defined?(RSpec::Core::Version::STRING)
                   RSpec::Core::Version::STRING
-                elsif framework == "minitest" && defined?(Minitest::VERSION)
-                  Minitest::VERSION
+                elsif framework == "minitest"
+                  Gem.loaded_specs["minitest"]&.version&.to_s || (Minitest::VERSION if defined?(Minitest::VERSION))
                 end
       metadata = { kind: project[:kind].to_s, root: project[:root].to_s,
                    framework: framework, framework_version: version,
@@ -169,12 +171,15 @@ module Branchproof
       nil
     end
 
-    def write_failure(payload, code, details)
+    def write_failure(payload, code, details, evidence: nil)
       return unless payload["result_path"]
 
-      write_completion(payload, { status: "ERROR", executed_tests: 0, failed_tests: 0, skipped_tests: 0,
-                                  finalized: false, exit_status: 2, project: project_metadata_for(payload),
-                                  diagnostics: [{ code: code, severity: "error", message: details.to_s }] })
+      diagnostic = { code: code, severity: "error", message: details.to_s }
+      result = { status: "ERROR", executed_tests: 0, failed_tests: 0, skipped_tests: 0,
+                 finalized: false, exit_status: 2, project: project_metadata_for(payload),
+                 diagnostics: [diagnostic] }
+      result[:evidence] = incomplete_evidence(evidence, [diagnostic]) if evidence
+      write_completion(payload, result)
     end
 
     def project_metadata_for(payload)

data/lib/branchproof.rb

@@ -11,8 +11,10 @@ module Branchproof
   class Error < StandardError; end
   autoload :Configuration, "branchproof/configuration"
   autoload :CoveragePolicy, "branchproof/coverage_policy"
+  autoload :CoverageSummary, "branchproof/coverage_summary"
   autoload :ReportSelection, "branchproof/report_selection"
   autoload :CLI, "branchproof/cli"
+  autoload :Doctor, "branchproof/doctor"
   autoload :Instrumenter, "branchproof/instrumenter"
   autoload :Loader, "branchproof/loader"
   autoload :Runtime, "branchproof/runtime"
@@ -26,9 +28,19 @@ module Branchproof
   autoload :Report, "branchproof/report"
   autoload :CoverageIndex, "branchproof/coverage_index"
   autoload :FocusedReport, "branchproof/focused_report"
+  autoload :SummaryRanking, "branchproof/summary_ranking"
+  autoload :SummaryReport, "branchproof/summary_report"
+  autoload :HtmlReport, "branchproof/html_report"
+  autoload :GithubReport, "branchproof/github_report"
   autoload :SavedReport, "branchproof/saved_report"
   autoload :Comparison, "branchproof/comparison"
+  autoload :Collation, "branchproof/collation"
+  autoload :CollationManifest, "branchproof/collation_manifest"
   autoload :ComparisonReport, "branchproof/comparison_report"
+  autoload :ChangedScope, "branchproof/changed_scope"
+  autoload :GitChanges, "branchproof/git_changes"
+  autoload :ChangedDecisionMap, "branchproof/changed_decision_map"
+  autoload :ChangedCoverage, "branchproof/changed_coverage"
   autoload :Worker, "branchproof/worker"
 end
 

data/llms.txt

@@ -2,7 +2,7 @@
 
 |  |  |
 | --- | --- |
-| **Defined in** | lib/branchproof.rb, lib/branchproof/cli.rb, lib/branchproof/limits.rb, lib/branchproof/loader.rb, lib/branchproof/report.rb, lib/branchproof/source.rb, lib/branchproof/worker.rb, lib/branchproof/project.rb, lib/branchproof/records.rb, lib/branchproof/runtime.rb, lib/branchproof/version.rb, lib/branchproof/analyzer.rb, lib/branchproof/evidence.rb, lib/branchproof/minimizer.rb, lib/branchproof/comparison.rb, lib/branchproof/constraints.rb, lib/branchproof/instrumenter.rb, lib/branchproof/runtime_flow.rb, lib/branchproof/saved_report.rb, lib/branchproof/value_syntax.rb, lib/branchproof/configuration.rb, lib/branchproof/rails_support.rb, lib/branchproof/rspec_adapter.rb, lib/branchproof/value_runtime.rb, lib/branchproof/coverage_index.rb, lib/branchproof/decision_table.rb, lib/branchproof/default_syntax.rb, lib/branchproof/focused_report.rb, lib/branchproof/coverage_policy.rb, lib/branchproof/decision_syntax.rb, lib/branchproof/default_runtime.rb, lib/branchproof/exception_syntax.rb, lib/branchproof/iteration_syntax.rb, lib/branchproof/minitest_adapter.rb, lib/branchproof/report_selection.rb, lib/branchproof/comparison_report.rb, lib/branchproof/exception_runtime.rb, lib/branchproof/iteration_runtime.rb, lib/branchproof/flow_instrumentation.rb, lib/branchproof/value_instrumentation.rb, lib/branchproof/default_instrumentation.rb, lib/branchproof/exception_instrumentation.rb, lib/branchproof/iteration_instrumentation.rb, lib/branchproof/extended_alternative_runtime.rb |
+| **Defined in** | lib/branchproof.rb, lib/branchproof/cli.rb, lib/branchproof/doctor.rb, lib/branchproof/limits.rb, lib/branchproof/loader.rb, lib/branchproof/report.rb, lib/branchproof/source.rb, lib/branchproof/worker.rb, lib/branchproof/project.rb, lib/branchproof/records.rb, lib/branchproof/runtime.rb, lib/branchproof/version.rb, lib/branchproof/analyzer.rb, lib/branchproof/evidence.rb, lib/branchproof/collation.rb, lib/branchproof/minimizer.rb, lib/branchproof/rake_task.rb, lib/branchproof/comparison.rb, lib/branchproof/constraints.rb, lib/branchproof/git_changes.rb, lib/branchproof/html_report.rb, lib/branchproof/instrumenter.rb, lib/branchproof/runtime_flow.rb, lib/branchproof/saved_report.rb, lib/branchproof/value_syntax.rb, lib/branchproof/changed_scope.rb, lib/branchproof/configuration.rb, lib/branchproof/github_report.rb, lib/branchproof/rails_support.rb, lib/branchproof/rspec_adapter.rb, lib/branchproof/value_runtime.rb, lib/branchproof/coverage_index.rb, lib/branchproof/decision_table.rb, lib/branchproof/default_syntax.rb, lib/branchproof/focused_report.rb, lib/branchproof/summary_report.rb, lib/branchproof/coverage_policy.rb, lib/branchproof/decision_syntax.rb, lib/branchproof/default_runtime.rb, lib/branchproof/fallback_syntax.rb, lib/branchproof/summary_ranking.rb, lib/branchproof/changed_coverage.rb, lib/branchproof/coverage_summary.rb, lib/branchproof/exception_syntax.rb, lib/branchproof/fallback_runtime.rb, lib/branchproof/iteration_syntax.rb, lib/branchproof/minitest_adapter.rb, lib/branchproof/report_selection.rb, lib/branchproof/comparison_report.rb, lib/branchproof/exception_runtime.rb, lib/branchproof/iteration_runtime.rb, lib/branchproof/collation_manifest.rb, lib/branchproof/changed_decision_map.rb, lib/branchproof/flow_instrumentation.rb, lib/branchproof/value_instrumentation.rb, lib/branchproof/default_instrumentation.rb, lib/branchproof/fallback_instrumentation.rb, lib/branchproof/exception_instrumentation.rb, lib/branchproof/iteration_instrumentation.rb, lib/branchproof/extended_alternative_runtime.rb |
 
 Keep source-boundary and parameter-binding rules together for auditing.
 rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity,
@@ -16,6 +16,12 @@ Not documented.
 
 - [Branchproof/Analyzer.md](doc/Branchproof/Analyzer.md)
 - [Branchproof/CLI.md](doc/Branchproof/CLI.md)
+- [Branchproof/ChangedCoverage.md](doc/Branchproof/ChangedCoverage.md)
+- [Branchproof/ChangedCoveragePolicy.md](doc/Branchproof/ChangedCoveragePolicy.md)
+- [Branchproof/ChangedDecisionMap.md](doc/Branchproof/ChangedDecisionMap.md)
+- [Branchproof/ChangedScope.md](doc/Branchproof/ChangedScope.md)
+- [Branchproof/Collation.md](doc/Branchproof/Collation.md)
+- [Branchproof/CollationManifest.md](doc/Branchproof/CollationManifest.md)
 - [Branchproof/Comparison.md](doc/Branchproof/Comparison.md)
 - [Branchproof/ComparisonReport.md](doc/Branchproof/ComparisonReport.md)
 - [Branchproof/Configuration.md](doc/Branchproof/Configuration.md)
@@ -23,19 +29,28 @@ Not documented.
 - [Branchproof/Constraints.md](doc/Branchproof/Constraints.md)
 - [Branchproof/CoverageIndex.md](doc/Branchproof/CoverageIndex.md)
 - [Branchproof/CoveragePolicy.md](doc/Branchproof/CoveragePolicy.md)
+- [Branchproof/CoverageSummary.md](doc/Branchproof/CoverageSummary.md)
 - [Branchproof/DecisionSyntax.md](doc/Branchproof/DecisionSyntax.md)
 - [Branchproof/DecisionTable.md](doc/Branchproof/DecisionTable.md)
 - [Branchproof/DefaultInstrumentation.md](doc/Branchproof/DefaultInstrumentation.md)
 - [Branchproof/DefaultRuntime.md](doc/Branchproof/DefaultRuntime.md)
 - [Branchproof/DefaultSyntax.md](doc/Branchproof/DefaultSyntax.md)
+- [Branchproof/Doctor/TerminalRenderer.md](doc/Branchproof/Doctor/TerminalRenderer.md)
+- [Branchproof/Doctor.md](doc/Branchproof/Doctor.md)
 - [Branchproof/Error.md](doc/Branchproof/Error.md)
 - [Branchproof/Evidence.md](doc/Branchproof/Evidence.md)
 - [Branchproof/ExceptionInstrumentation.md](doc/Branchproof/ExceptionInstrumentation.md)
 - [Branchproof/ExceptionRuntime.md](doc/Branchproof/ExceptionRuntime.md)
 - [Branchproof/ExceptionSyntax.md](doc/Branchproof/ExceptionSyntax.md)
 - [Branchproof/ExtendedAlternativeRuntime.md](doc/Branchproof/ExtendedAlternativeRuntime.md)
+- [Branchproof/FallbackInstrumentation.md](doc/Branchproof/FallbackInstrumentation.md)
+- [Branchproof/FallbackRuntime.md](doc/Branchproof/FallbackRuntime.md)
+- [Branchproof/FallbackSyntax.md](doc/Branchproof/FallbackSyntax.md)
 - [Branchproof/FlowInstrumentation.md](doc/Branchproof/FlowInstrumentation.md)
 - [Branchproof/FocusedReport.md](doc/Branchproof/FocusedReport.md)
+- [Branchproof/GitChanges.md](doc/Branchproof/GitChanges.md)
+- [Branchproof/GithubReport.md](doc/Branchproof/GithubReport.md)
+- [Branchproof/HtmlReport.md](doc/Branchproof/HtmlReport.md)
 - [Branchproof/Instrumenter.md](doc/Branchproof/Instrumenter.md)
 - [Branchproof/IterationInstrumentation.md](doc/Branchproof/IterationInstrumentation.md)
 - [Branchproof/IterationRuntime.md](doc/Branchproof/IterationRuntime.md)
@@ -54,6 +69,7 @@ Not documented.
 - [Branchproof/RSpecAdapter.md](doc/Branchproof/RSpecAdapter.md)
 - [Branchproof/RailsSupport/Error.md](doc/Branchproof/RailsSupport/Error.md)
 - [Branchproof/RailsSupport.md](doc/Branchproof/RailsSupport.md)
+- [Branchproof/RakeTask.md](doc/Branchproof/RakeTask.md)
 - [Branchproof/Records.md](doc/Branchproof/Records.md)
 - [Branchproof/Report.md](doc/Branchproof/Report.md)
 - [Branchproof/ReportSelection.md](doc/Branchproof/ReportSelection.md)
@@ -61,6 +77,10 @@ Not documented.
 - [Branchproof/RuntimeFlow.md](doc/Branchproof/RuntimeFlow.md)
 - [Branchproof/SavedReport.md](doc/Branchproof/SavedReport.md)
 - [Branchproof/Source.md](doc/Branchproof/Source.md)
+- [Branchproof/SummaryRanking/Decision.md](doc/Branchproof/SummaryRanking/Decision.md)
+- [Branchproof/SummaryRanking/SourceFile.md](doc/Branchproof/SummaryRanking/SourceFile.md)
+- [Branchproof/SummaryRanking.md](doc/Branchproof/SummaryRanking.md)
+- [Branchproof/SummaryReport.md](doc/Branchproof/SummaryReport.md)
 - [Branchproof/ValueInstrumentation.md](doc/Branchproof/ValueInstrumentation.md)
 - [Branchproof/ValueRuntime.md](doc/Branchproof/ValueRuntime.md)
 - [Branchproof/ValueSyntax.md](doc/Branchproof/ValueSyntax.md)