rspec-circleci-coverage 0.1.93

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d7701549e8db64ecb9f5c7542516bdaff16181b3d7ff439bce08f6d13d5953c4
+  data.tar.gz: 289634d878db811312ee09d44a823aea205c420ca5a881454c431407ba28782b
+SHA512:
+  metadata.gz: 071a80eaa21b9b8e683a7a2f7e15dc61e1588536d39a9fef90a3ca170fef0536458a0df935cdccacae07bec63f1186e71f9e973ce7c7882b3f766ac83f8d9940
+  data.tar.gz: a3b25e6f583bd085cb3508e6c6d8b4440648cd0db7b716aabc61d6d12077716859db719a29d3bb5136eac5b0d90274be47db62555cb6666455a22c70968ae365

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Circle Internet Services, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# RSpec CircleCI Coverage
+
+A RSpec plugin that generates coverage data for
+CircleCI's [Smarter Testing](https://circleci.com/docs/guides/test/smarter-testing/).
+
+## Usage
+
+Install the plugin:
+
+```bash
+gem install rspec-circleci-coverage
+```
+
+Add the plugin to your `spec_helper.rb`
+
+```ruby
+require "rspec-circleci-coverage"
+```
+
+To generate coverage, set the `CIRCLECI_COVERAGE` environment variable:
+
+```bash
+CIRCLECI_COVERAGE=coverage.json bundle exec rspec
+```
+
+## Development
+
+Run the integration tests:
+
+```bash
+bundle install
+bundle exec rspec
+```
+
+Generate the testsuite integration test:
+
+```shell
+circleci run testsuite 'integration test' --local --test-analysis=all && cat coverage.json | jq --sort-keys > coveragetmp.json && mv coveragetmp.json coverage.json
+```

data/lib/rspec/circleci/coverage.rb

@@ -0,0 +1,151 @@
+require 'coverage'
+require 'json'
+require 'pathname'
+
+module RSpec
+  module CircleCI
+    class Coverage
+      class << self
+        attr_accessor :instance
+      end
+
+      def self.install
+        # Only install if CIRCLECI_COVERAGE environment variable is set
+        return unless ENV['CIRCLECI_COVERAGE']
+
+        self.instance ||= new
+        instance.install
+      end
+
+      def initialize
+        @coverage_data = Hash.new { |h, k| h[k] = {} }
+        @before_coverage = {}
+        @installed = false
+      end
+
+      def install
+        return if @installed
+        @installed = true
+
+        # Start coverage tracking if not already running
+        unless ::Coverage.running?
+          ::Coverage.start(lines: true, eval: true)
+        end
+
+        coverage_instance = self
+
+        # Hook into RSpec lifecycle
+        RSpec.configure do |config|
+          config.before(:suite) do
+            $stdout.write("rspec-circleci-coverage: generating CircleCI coverage JSON...\n")
+          end
+
+          config.before(:each) do |_|
+            # Take a snapshot before each test
+            coverage_instance.capture_coverage
+          end
+
+          config.after(:each) do |example|
+            # Take a snapshot after each test and record coverage
+            coverage_instance.record_test_coverage(example)
+          end
+
+          config.after(:suite) do
+            # Write coverage data to file
+            coverage_instance.write_coverage_data
+          end
+        end
+      end
+
+      def capture_coverage
+        @before_coverage = ::Coverage.peek_result.dup
+      end
+
+      def record_test_coverage(example)
+        # Take a snapshot after each test
+        after_coverage = ::Coverage.peek_result
+
+        # Calculate which lines were executed during this test
+        test_key = format_test_key(example)
+
+        after_coverage.each do |file, coverage|
+          # Skip files outside project scope, spec files, and rspec gem internals
+          next unless in_project_scope?(file)
+          next if file.end_with?('_spec.rb')
+
+          lines = extract_lines(coverage)
+          next if lines.nil?
+
+          before_lines = extract_lines(@before_coverage[file])
+
+          # Find lines that were executed during this test
+          executed_lines = []
+          lines.each_with_index do |count, index|
+            next if count.nil?
+            # Treat a missing before-count as 0 so the first render of an
+            # eval'd file (e.g. a compiled template) is attributed to this test.
+            before_count = before_lines ? (before_lines[index] || 0) : 0
+
+            # Line was executed if count increased
+            if count > before_count
+              executed_lines << (index + 1) # Line numbers are 1-indexed
+            end
+          end
+
+          # Only add if lines were executed
+          if executed_lines.any?
+            relative_file = relative_path(file)
+            @coverage_data[relative_file][test_key] = executed_lines
+          end
+        end
+      end
+
+      def write_coverage_data
+        if @coverage_data.empty?
+          $stdout.write("rspec-circleci-coverage: warning: no coverage data collected\n")
+        end
+
+        File.write(coverage_file, JSON.pretty_generate(@coverage_data))
+        $stdout.write("rspec-circleci-coverage: wrote #{coverage_file}\n")
+      end
+
+      def coverage_file
+        ENV['CIRCLECI_COVERAGE']
+      end
+
+      def format_test_key(example)
+        file_path = example.metadata[:file_path]
+        # Clean path to remove ./ and other redundant components
+        file_path = Pathname.new(file_path).cleanpath.to_s if file_path
+        description = example.full_description
+        "#{file_path}!!#{description}|run"
+      end
+
+      def relative_path(file)
+        # Convert absolute path to relative path from current directory
+        pathname = Pathname.new(file)
+        pathname.absolute? ? pathname.relative_path_from(Dir.pwd).to_s : file
+      end
+
+      def in_project_scope?(file)
+        # Check if file is within the project directory
+        # Files outside the project (system files, gems, etc.) should be filtered out
+        return false unless file.start_with?(Dir.pwd)
+
+        # Exclude gem files (even if they're in .bundle or vendor directories)
+        return false if file.include?('/gems/')
+        return false if file.include?('/.bundle/')
+        return false if file.include?('/vendor/')
+        true
+      end
+
+      def extract_lines(coverage_value)
+        case coverage_value
+        when Array then coverage_value
+        when Hash then coverage_value[:lines]
+        else nil
+        end
+      end
+    end
+  end
+end

data/lib/rspec-circleci-coverage.rb

@@ -0,0 +1,4 @@
+require_relative 'rspec/circleci/coverage'
+
+# Auto-install when required
+RSpec::CircleCI::Coverage.install

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: rspec-circleci-coverage
+version: !ruby/object:Gem::Version
+  version: 0.1.93
+platform: ruby
+authors:
+- CircleCI
+bindir: bin
+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.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rspec-circleci-coverage.rb
+- lib/rspec/circleci/coverage.rb
+homepage: https://github.com/CircleCI-Public/smarter-testing-plugins
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/CircleCI-Public/smarter-testing-plugins
+  allowed_push_host: https://rubygems.org
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: An RSpec plugin that generates coverage data for CircleCI's Smarter Testing
+test_files: []