rspec-covers 0.1.0

data/lib/rspec/covers.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+require "set"
+
+require_relative "covers/version"
+
+module RSpec
+  module Covers
+    class Error < StandardError; end
+
+    class << self
+      attr_writer :configuration, :reporter
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure(rspec_config = nil)
+        yield configuration if block_given?
+
+        Integration.install!(rspec_config) if rspec_config
+        configuration
+      end
+
+      def install!(rspec_config)
+        Integration.install!(rspec_config)
+      end
+
+      def installed?
+        @installed == true
+      end
+
+      def mark_installed!
+        @installed = true
+      end
+
+      def reporter
+        @reporter ||= Reporter.new
+      end
+
+      def coverage_probe
+        @coverage_probe ||= Probe::CoverageProbe.new(configuration)
+      end
+
+      def call_log_probe
+        @call_log_probe ||= Probe::CallLogProbe.new(configuration)
+      end
+
+      def dynamic_corpus
+        @dynamic_corpus ||= Tracer::DynamicCorpus.new
+      end
+
+      def run_example(example)
+        Thread.current[:rspec_covers_expectation_object_ids] = []
+        before_snapshot = coverage_probe.snapshot
+        call_log_probe.start_example if call_log_enabled?
+
+        example.run
+      ensure
+        call_log = call_log_enabled? ? call_log_probe.stop_example : Probe::CallLog.new(calls: [], returns_by_object_id: {})
+        executed = coverage_probe.difference(before_snapshot || {}, coverage_probe.snapshot)
+        process_example(example, executed, call_log) if example
+        Thread.current[:rspec_covers_expectation_object_ids] = nil
+      end
+
+      def record_expectation_actual(actual)
+        ids = Thread.current[:rspec_covers_expectation_object_ids]
+        ids << actual.__id__ if ids
+        call_log_probe.record_expectation(actual) if call_log_enabled?
+      end
+
+      def process_example(example, executed_locations, call_log)
+        declaration = Declaration.from_example(example, configuration)
+        dynamic_corpus.record(example.id, call_log.labels) if configuration.suggest || configuration.validate_declarations
+        measured_locations = measured_locations(executed_locations, declaration, call_log)
+        verdict = StrictVerdict.call(
+          executed_locations: measured_locations,
+          declaration: declaration,
+          config: configuration
+        )
+        example.metadata[:rspec_covers_risky] = verdict.risky?
+        suggestions = suggestions_for(example, declaration, call_log, executed_locations)
+        validation = validation_for(example, declaration, call_log, executed_locations)
+        unchecked_locations = unchecked_locations_for(executed_locations, measured_locations)
+
+        reporter.record(
+          ExampleResult.new(
+            id: example.id,
+            file: example.metadata[:file_path],
+            line: example.metadata[:line_number],
+            description: example.full_description,
+            verdict: verdict,
+            suggestions: suggestions,
+            declaration_validation: validation,
+            declaration: declaration,
+            example: example,
+            call_log: call_log,
+            executed_locations: executed_locations,
+            measured_locations: measured_locations,
+            unchecked_locations: unchecked_locations
+          )
+        )
+
+        emit_warning(example, verdict, suggestions, validation)
+        raise StrictCoverageError, verdict if fail_risky?(verdict, example)
+      end
+
+      def reset!
+        @configuration = Configuration.new
+        @reporter = Reporter.new
+        @coverage_probe = nil
+        @call_log_probe = nil
+        @dynamic_corpus = nil
+        @installed = false
+      end
+
+      private
+
+      def call_log_enabled?
+        configuration.suggest || configuration.mode == :checked || configuration.validate_declarations
+      end
+
+      def measured_locations(executed_locations, declaration, call_log)
+        return executed_locations unless configuration.mode == :checked
+
+        CheckedCoverage.new(configuration).filter(
+          executed_locations: executed_locations,
+          call_log: call_log,
+          expectation_object_ids: Thread.current[:rspec_covers_expectation_object_ids] || []
+        )
+      end
+
+      def suggestions_for(example, declaration, call_log, executed_locations)
+        return [] unless configuration.suggest
+        return [] if declaration.declared?
+
+        Tracer::Composite.new(configuration).suggest(
+          example: example,
+          call_log: call_log,
+          executed_locations: executed_locations,
+          corpus: dynamic_corpus
+        )
+      end
+
+      def validation_for(example, declaration, call_log, executed_locations)
+        return unless configuration.validate_declarations
+        return unless declaration.declared?
+
+        suggestions = Tracer::Composite.new(configuration).suggest(
+          example: example,
+          call_log: call_log,
+          executed_locations: executed_locations,
+          corpus: dynamic_corpus,
+          limit: nil
+        )
+
+        DeclarationValidator.new(configuration).call(
+          declaration: declaration,
+          suggestions: suggestions
+        )
+      end
+
+      def unchecked_locations_for(executed_locations, measured_locations)
+        return [] unless configuration.mode == :checked
+
+        Set.new(executed_locations).subtract(measured_locations).to_a
+      end
+
+      def fail_risky?(verdict, example)
+        verdict.risky? && configuration.risky == :fail && example.exception.nil?
+      end
+
+      def emit_warning(example, verdict, suggestions, validation)
+        messages = []
+        messages << verdict.message if verdict.reason == :undeclared_example && configuration.undeclared == :warn
+
+        suggestions.each do |suggestion|
+          messages << "#{example.metadata[:file_path]}:#{example.metadata[:line_number]} " \
+                      "suggestion: covers: #{suggestion.label.inspect} " \
+                      "(score #{suggestion.score.round(2)}: #{suggestion.reasons.join(" + ")})"
+        end
+
+        if validation && !validation.valid?
+          messages << "#{example.metadata[:file_path]}:#{example.metadata[:line_number]} " \
+                      "covers declaration has weak traceability evidence: " \
+                      "#{validation.unsupported_labels.join(", ")}"
+        end
+
+        messages.each { |message| rspec_message(message) }
+      end
+
+      def rspec_message(message)
+        if defined?(::RSpec) && ::RSpec.respond_to?(:configuration)
+          ::RSpec.configuration.reporter.message(message)
+        else
+          warn message
+        end
+      end
+    end
+  end
+end
+
+require_relative "covers/configuration"
+require_relative "covers/code_location"
+require_relative "covers/method_label"
+require_relative "covers/source_range"
+require_relative "covers/metadata_reader"
+require_relative "covers/declaration"
+require_relative "covers/declaration_validation"
+require_relative "covers/method_entry"
+require_relative "covers/probe/coverage_probe"
+require_relative "covers/probe/call_log_probe"
+require_relative "covers/strict_verdict"
+require_relative "covers/checked_coverage"
+require_relative "covers/static_method_scanner"
+require_relative "covers/production_inventory"
+require_relative "covers/tracer/composite"
+require_relative "covers/reporter"
+require_relative "covers/integration"
+require_relative "covers/formatter"
+require_relative "covers/evaluation"
+
+module Rspec
+  Covers = ::RSpec::Covers unless const_defined?(:Covers, false)
+end

data/sig/minitest/covers.rbs

@@ -0,0 +1,6 @@
+module Minitest
+  module Covers
+    def self.configure: () { (::RSpec::Covers::Configuration) -> void } -> ::RSpec::Covers::Configuration
+    def self.install!: () -> void
+  end
+end

data/sig/rspec/covers.rbs

@@ -0,0 +1,27 @@
+module RSpec
+  module Covers
+    VERSION: String
+
+    def self.configure: (?untyped rspec_config) { (Configuration) -> void } -> Configuration
+    def self.install!: (untyped rspec_config) -> void
+
+    class Configuration
+      attr_accessor strict: bool
+      attr_accessor risky: Symbol
+      attr_accessor mode: Symbol
+      attr_accessor undeclared: Symbol
+      attr_accessor allowlist: Array[String]
+      attr_accessor suggest: bool
+      attr_accessor validate_declarations: bool
+      attr_accessor validation_threshold: Float
+      attr_accessor json_events: bool
+      attr_accessor root: String
+      attr_accessor production_paths: Array[String]
+      attr_accessor report_path: String?
+    end
+  end
+end
+
+module Rspec
+  Covers: singleton(::RSpec::Covers)
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: rspec-covers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yudai Takada
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Adds covers/uses metadata, per-example strict coverage checks, and traceability
+  suggestions for RSpec.
+email:
+- t.yudai92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- data/evaluation/ground_truth.example.json
+- lib/minitest/covers.rb
+- lib/rspec/covers.rb
+- lib/rspec/covers/checked_coverage.rb
+- lib/rspec/covers/code_location.rb
+- lib/rspec/covers/configuration.rb
+- lib/rspec/covers/declaration.rb
+- lib/rspec/covers/declaration_validation.rb
+- lib/rspec/covers/evaluation.rb
+- lib/rspec/covers/formatter.rb
+- lib/rspec/covers/integration.rb
+- lib/rspec/covers/metadata_reader.rb
+- lib/rspec/covers/method_entry.rb
+- lib/rspec/covers/method_label.rb
+- lib/rspec/covers/probe/call_log_probe.rb
+- lib/rspec/covers/probe/coverage_probe.rb
+- lib/rspec/covers/production_inventory.rb
+- lib/rspec/covers/rake_task.rb
+- lib/rspec/covers/reporter.rb
+- lib/rspec/covers/source_range.rb
+- lib/rspec/covers/static_method_scanner.rb
+- lib/rspec/covers/strict_verdict.rb
+- lib/rspec/covers/tracer/composite.rb
+- lib/rspec/covers/tracer/dynamic.rb
+- lib/rspec/covers/tracer/dynamic_corpus.rb
+- lib/rspec/covers/tracer/lcba.rb
+- lib/rspec/covers/tracer/nc.rb
+- lib/rspec/covers/tracer/ncc.rb
+- lib/rspec/covers/tracer/suggestion.rb
+- lib/rspec/covers/tracer/tokenizer.rb
+- lib/rspec/covers/version.rb
+- sig/minitest/covers.rbs
+- sig/rspec/covers.rbs
+homepage: https://github.com/ydah/rspec-covers
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ydah/rspec-covers
+  source_code_uri: https://github.com/ydah/rspec-covers
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: RSpec coverage intent metadata and strict coverage checks.
+test_files: []