branchproof 0.9.0 → 0.11.0

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/rails_support.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/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/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/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 |
 
 Keep source-boundary and parameter-binding rules together for auditing.
 rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity,
@@ -18,9 +18,11 @@ Not documented.
 - [Branchproof/CLI.md](doc/Branchproof/CLI.md)
 - [Branchproof/Comparison.md](doc/Branchproof/Comparison.md)
 - [Branchproof/ComparisonReport.md](doc/Branchproof/ComparisonReport.md)
+- [Branchproof/Configuration.md](doc/Branchproof/Configuration.md)
 - [Branchproof/Constraints/Solver.md](doc/Branchproof/Constraints/Solver.md)
 - [Branchproof/Constraints.md](doc/Branchproof/Constraints.md)
 - [Branchproof/CoverageIndex.md](doc/Branchproof/CoverageIndex.md)
+- [Branchproof/CoveragePolicy.md](doc/Branchproof/CoveragePolicy.md)
 - [Branchproof/DecisionSyntax.md](doc/Branchproof/DecisionSyntax.md)
 - [Branchproof/DecisionTable.md](doc/Branchproof/DecisionTable.md)
 - [Branchproof/DefaultInstrumentation.md](doc/Branchproof/DefaultInstrumentation.md)
@@ -43,10 +45,18 @@ Not documented.
 - [Branchproof/Minimizer.md](doc/Branchproof/Minimizer.md)
 - [Branchproof/MinitestAdapter.md](doc/Branchproof/MinitestAdapter.md)
 - [Branchproof/Project.md](doc/Branchproof/Project.md)
+- [Branchproof/RSpecAdapter/ClassRunnerGuard.md](doc/Branchproof/RSpecAdapter/ClassRunnerGuard.md)
+- [Branchproof/RSpecAdapter/ContextLifecycle.md](doc/Branchproof/RSpecAdapter/ContextLifecycle.md)
+- [Branchproof/RSpecAdapter/DefaultDiscovery.md](doc/Branchproof/RSpecAdapter/DefaultDiscovery.md)
+- [Branchproof/RSpecAdapter/ExampleLifecycle.md](doc/Branchproof/RSpecAdapter/ExampleLifecycle.md)
+- [Branchproof/RSpecAdapter/RunnerGuard.md](doc/Branchproof/RSpecAdapter/RunnerGuard.md)
+- [Branchproof/RSpecAdapter/UnsupportedRunner.md](doc/Branchproof/RSpecAdapter/UnsupportedRunner.md)
+- [Branchproof/RSpecAdapter.md](doc/Branchproof/RSpecAdapter.md)
 - [Branchproof/RailsSupport/Error.md](doc/Branchproof/RailsSupport/Error.md)
 - [Branchproof/RailsSupport.md](doc/Branchproof/RailsSupport.md)
 - [Branchproof/Records.md](doc/Branchproof/Records.md)
 - [Branchproof/Report.md](doc/Branchproof/Report.md)
+- [Branchproof/ReportSelection.md](doc/Branchproof/ReportSelection.md)
 - [Branchproof/Runtime.md](doc/Branchproof/Runtime.md)
 - [Branchproof/RuntimeFlow.md](doc/Branchproof/RuntimeFlow.md)
 - [Branchproof/SavedReport.md](doc/Branchproof/SavedReport.md)

data/sig/branchproof.rbs

@@ -34,13 +34,24 @@ module Branchproof
 
   class Project
     MODES: Array[String]
+    FRAMEWORKS: Array[String]
     RAILS_ENVIRONMENT: record
-    def initialize: (root: String, ?mode: String) -> void
+    def initialize: (root: String, ?mode: String, ?framework: String) -> void
     def to_h: () -> record
   end
 
+  class Configuration
+    SCHEMA_VERSION: Integer
+    PROJECTS: Array[String]
+    FRAMEWORKS: Array[String]
+    MINIMUM_CRITERIA: Array[String]
+    FIELDS: Array[String]
+    def self.load: (path: String, root: String, ?explicit: bool, ?disabled: bool) -> record?
+  end
+
   module RailsSupport
     def self.boot: (project: record) -> record
+    def self.validate_rspec!: (project: record) -> record?
   end
 
   class Instrumenter
@@ -57,6 +68,8 @@ module Branchproof
   end
 
   module Runtime
+    def self.register_test: (test: record) -> record?
+    def self.test_phase_counts: () -> Hash[String, Hash[String, Integer]]
     def self.boot: (evidence: Evidence) -> nil
     def self.enter: (String decision_id) -> nil
     def self.condition: (String decision_id, Integer index, untyped value) -> untyped
@@ -100,6 +113,7 @@ module Branchproof
     def register_test: (test: record) -> record
     def record: (execution: record) -> record
     def diagnose: (diagnostic: record) -> nil
+    def test_phase_counts: () -> Hash[String, Hash[String, Integer]]
     def snapshot: () -> record
     def merge: (snapshot: record) -> record
   end
@@ -112,6 +126,14 @@ module Branchproof
     def missing: (decision_id: String, condition_index: Integer) -> record?
   end
 
+  class CoveragePolicy
+    CRITERIA: Hash[String, Hash[Symbol, String]]
+    COMPLETENESS_FIELDS: Array[String]
+    def self.normalize: (Hash[String | Symbol, untyped] minimum) -> Hash[String, Integer | Float]
+    def initialize: (minimum: Hash[String | Symbol, untyped]) -> void
+    def call: (document: document?) -> record
+  end
+
   module Constraints
     VERSION: Integer
     NUMERIC_OPERATORS: Array[String]
@@ -164,17 +186,41 @@ module Branchproof
     def run: (test_files: Array[String], runner_args: Array[String], on_complete: ^(record) -> untyped, ?before_load: ^() -> untyped?) -> nil
   end
 
+  class RSpecAdapter
+    class UnsupportedRunner < ArgumentError
+      def diagnostic_code: () -> String
+    end
+
+    FORBIDDEN_OPTIONS: Hash[Symbol, String]
+    attr_reader tests: Hash[String, record]
+    def self.active_adapter: () -> RSpecAdapter?
+    def self.active_adapter=: (RSpecAdapter?) -> RSpecAdapter?
+    def self.runner_adapter: () -> RSpecAdapter?
+    def self.runner_adapter=: (RSpecAdapter?) -> RSpecAdapter?
+    attr_reader late_execution_error: ArgumentError?
+    def initialize: (runtime: untyped) -> void
+    def reject_execution!: (String message) -> bot
+    def enter_runner!: (untyped runner) -> bool
+    def example_started: (untyped notification) -> untyped
+    def example_finished: (untyped notification) -> untyped
+    def run: (test_files: Array[String], runner_args: Array[String], on_complete: ^(record) -> untyped, ?before_load: ^() -> untyped?, ?after_load: ^() -> untyped?, ?test_selection_explicit: bool) -> untyped
+    def validate_runner!: () -> nil
+  end
+
   class Report
     SCHEMA_VERSION: String
     CRITERION_VERSION: String
     VIEWS: Array[Symbol]
-    def initialize: (inventory: document, evidence: document, analysis: document?, minima: Array[document], baseline: document, diagnostics: Array[document], ?level: Integer, ?missing_only: bool, ?view: Symbol, ?run_metadata: document, ?saved_document: document?) -> void
-    def self.from_document: (document: document, ?level: Integer?, ?view: Symbol, ?missing_only: bool) -> Report
+    def initialize: (inventory: document, evidence: document, analysis: document?, minima: Array[document], baseline: document, diagnostics: Array[document], ?level: Integer, ?missing_only: bool, ?view: Symbol, ?run_metadata: document, ?saved_document: document?, ?focus: String?, ?top: (Integer | String)?, ?minimum: document?) -> void
+    def self.from_document: (document: document, ?level: Integer?, ?view: Symbol, ?missing_only: bool, ?focus: String?, ?top: (Integer | String)?, ?minimum: document?) -> Report
     def diagnostic_message: (Hash[Symbol | String, untyped] diagnostic) -> String
     def condition_explanation: (decision_id: String, condition_id: String) -> String
     def decision_table_requirement: (untyped value) -> String?
     def decision_table_reachability: (document rule) -> String
     def decision_table_expected_heading: (document decision) -> String
+    def coverage_policy: () -> record
+    def coverage_policy_lines: () -> Array[String]
+    def rerun_command: (String test_id) -> String?
     def write: (io: _WriteIO, format: Symbol | String) -> nil
     def exit_code: () -> Integer
   end
@@ -188,10 +234,23 @@ module Branchproof
   end
 
   class FocusedReport
-    def initialize: (document: document, view: Symbol, level: Integer, ?missing_only: bool) -> void
+    def initialize: (document: document, view: Symbol, level: Integer, ?missing_only: bool, ?coordinator: Report?, ?focus: String?, ?top: (Integer | String)?, ?selection: ReportSelection?) -> void
     def render: () -> String
   end
 
+  class ReportSelection
+    attr_reader focus: record?
+    attr_reader top: Integer?
+    def initialize: (?focus: String?, ?top: (Integer | String)?) -> void
+    def active?: () -> bool
+    def focus_active?: () -> bool
+    def focus_label: () -> String?
+    def matching_decision_ids: (document: document) -> Array[String]
+    def filter_decisions: (Array[record] decisions, ?inventory: document) -> Array[record]
+    def limit: (Array[record] items) -> [Array[record], Integer]
+    def sort_key: (record decision, ?inventory: document) -> [String, Integer, Integer, String]
+  end
+
   class SavedReport
     def self.read: (String path) -> document
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branchproof
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Lucian Ghinda
@@ -50,7 +50,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 description: Inventory Ruby decisions and report masking MC/DC evidence from Minitest
-  runs.
+  or RSpec runs.
 email:
 - lucianghinda@users.noreply.github.com
 executables:
@@ -70,9 +70,11 @@ files:
 - doc/Branchproof/CLI.md
 - doc/Branchproof/Comparison.md
 - doc/Branchproof/ComparisonReport.md
+- doc/Branchproof/Configuration.md
 - doc/Branchproof/Constraints.md
 - doc/Branchproof/Constraints/Solver.md
 - doc/Branchproof/CoverageIndex.md
+- doc/Branchproof/CoveragePolicy.md
 - doc/Branchproof/DecisionSyntax.md
 - doc/Branchproof/DecisionTable.md
 - doc/Branchproof/DefaultInstrumentation.md
@@ -95,10 +97,18 @@ files:
 - doc/Branchproof/Minimizer.md
 - doc/Branchproof/MinitestAdapter.md
 - doc/Branchproof/Project.md
+- doc/Branchproof/RSpecAdapter.md
+- doc/Branchproof/RSpecAdapter/ClassRunnerGuard.md
+- doc/Branchproof/RSpecAdapter/ContextLifecycle.md
+- doc/Branchproof/RSpecAdapter/DefaultDiscovery.md
+- doc/Branchproof/RSpecAdapter/ExampleLifecycle.md
+- doc/Branchproof/RSpecAdapter/RunnerGuard.md
+- doc/Branchproof/RSpecAdapter/UnsupportedRunner.md
 - doc/Branchproof/RailsSupport.md
 - doc/Branchproof/RailsSupport/Error.md
 - doc/Branchproof/Records.md
 - doc/Branchproof/Report.md
+- doc/Branchproof/ReportSelection.md
 - doc/Branchproof/Runtime.md
 - doc/Branchproof/RuntimeFlow.md
 - doc/Branchproof/SavedReport.md
@@ -116,8 +126,10 @@ files:
 - lib/branchproof/cli.rb
 - lib/branchproof/comparison.rb
 - lib/branchproof/comparison_report.rb
+- lib/branchproof/configuration.rb
 - lib/branchproof/constraints.rb
 - lib/branchproof/coverage_index.rb
+- lib/branchproof/coverage_policy.rb
 - lib/branchproof/decision_syntax.rb
 - lib/branchproof/decision_table.rb
 - lib/branchproof/default_instrumentation.rb
@@ -142,6 +154,8 @@ files:
 - lib/branchproof/rails_support.rb
 - lib/branchproof/records.rb
 - lib/branchproof/report.rb
+- lib/branchproof/report_selection.rb
+- lib/branchproof/rspec_adapter.rb
 - lib/branchproof/runtime.rb
 - lib/branchproof/runtime_flow.rb
 - lib/branchproof/saved_report.rb