simplecov-rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f72895c7f0c30898b8b0359e0b4f6f8cafa838b7f9deb59fb220cef5e8a92c4
+  data.tar.gz: a383b340c09720a2a9440d714a5d289271c1174577f6cd9a8afecb645f7ba78e
+SHA512:
+  metadata.gz: 58626ae17aff8c6645255092e1ec565d8b85f26824915b532471367ede6f900732c168fffbd659c946604ffc7e7b8ea53aa931aadffeede2a96b3350d820d0fe
+  data.tar.gz: c5dfe1463c2edd3bd72ad4cc215ad2371d53d51254e4ebd4fa33ee25aeacb6f6ee9b3ff880214ae42ff12482330c934676aa487e937c09d7ec85e577866db64a

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format Fuubar

data/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  DefaultFormatter: fuubar
+
+  # Output extra information for each offense to make it easier to diagnose:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+
+  # RuboCop enforces rules depending on the oldest version of Ruby which
+  # your project supports:
+  TargetRubyVersion: 3.0
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+# The DSL for RSpec and the gemspec file make it very hard to limit block length
+Metrics/BlockLength:
+  Exclude:
+    - '**/*_spec.rb'
+    - '*.gemspec'
+
+Metrics/ModuleLength:
+  CountAsOne: ['hash']
+
+Metrics/ClassLength:
+  CountAsOne: ['hash']
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/StderrPuts:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+Changes for each release are listed in this file.
+
+This project adheres to [Semantic Versioning](https://semver.org/) for its releases.
+
+## v0.1.0 (2024-09-07)
+
+[Full Changelog](https://github.com/main-branch/simplecov-rspec/compare/9fe828c..v0.1.0)
+
+Changes:
+
+* 93d7004 Add RSpec HTML formatter for CI build
+* 94f5a80 Configure RSpec to run turnip tests when run from rake
+* b3bf845 Use SimpleCov LCov formatter in the CI build
+* 9fe828c Initial revision

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 James Couball
+
+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,174 @@
+# The `simplecov-rspec` Gem
+
+[![Gem Version](https://badge.fury.io/rb/simplecov-rspec.svg)](https://badge.fury.io/rb/simplecov-rspec)
+[![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/simplecov-rspec/)
+[![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/simplecov-rspec/file/CHANGELOG.md)
+[![Build Status](https://github.com/main-branch/simplecov-rspec/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/main-branch/simplecov-rspec/actions/workflows/continuous_integration.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9a58b51d18910db724c7/maintainability)](https://codeclimate.com/github/main-branch/simplecov-rspec/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/9a58b51d18910db724c7/test_coverage)](https://codeclimate.com/github/main-branch/simplecov-rspec/test_coverage)
+
+`simplecov-rspec` is a Ruby gem that integrates SimpleCov with RSpec to ensure your
+tests meet a minimum coverage threshold. It enhances your test suite by automatically
+failing tests when coverage falls below a specified threshold and, optionally,
+listing uncovered lines to help you improve coverage.
+
+When `simplecov-rspec` is used, RSpec will report an error if the percent of test
+coverage falls below a defined threshold:
+
+```text
+Coverage report generated for RSpec to /Projects/example_project/coverage. 284 / 286 LOC (99.3%) covered.
+
+FAIL: RSpec Test coverage fell below 100%
+```
+
+If configured to list the lines that were not covered by tests, RSpec will additionally output:
+
+```text
+The following lines were not covered by tests:
+  ./lib/example_project.rb:74
+  ./lib/example_project.rb:75
+```
+
+* [Installation](#installation)
+* [Getting Started](#getting-started)
+  * [Basic Setup](#basic-setup)
+  * [Configuration from Environment Variables](#configuration-from-environment-variables)
+* [Development](#development)
+* [Contributing](#contributing)
+* [License](#license)
+* [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add simplecov-rspec
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install simplecov-rspec
+```
+
+## Getting Started
+
+To use `simplecov-rspec`, follow these steps:
+
+1. Add `require 'simplecov/rspec'` to your `spec_helper.rb`.
+2. Replace `SimpleCov.start` with `SimpleCov::RSpec.start` in your `spec_helper.rb`,
+   ensuring this line appears before requiring your project files.
+
+Here is an example `spec_helper.rb`. Your spec helper may include
+other code in addition to these:
+
+```ruby
+require 'simplecov/rspec'
+
+SimpleCov::RSpec.start
+
+require 'my_project'
+```
+
+This will configure RSpec to fail when test coverage falls below 100%.
+
+That is it!
+
+### Basic Setup
+
+To initialize simplecov-rspec with defaults, add the following to your `spec_helper.rb`:
+
+```ruby
+require 'simplecov/rspec'
+
+SimpleCov::RSpec.start
+```
+
+This is equivalent to starting with the following options:
+
+```ruby
+SimpleCov::RSpec.start(
+    coverage_threshold: 100,
+    fail_on_low_coverage: true,
+    list_lines_not_covered: false
+)
+```
+
+The test coverage threshold is the minimum percent of lines covered by tests as
+tracked by SimpleCov.
+
+To initialize SimpleCov with a test coverage threshold less than 100%:
+
+```ruby
+SimpleCov::RSpec.start(coverage_threshold: 90)
+```
+
+A configuration block can be given to the `start` method to further configure
+SimpleCov:
+
+```ruby
+# Initialize SimpleCov with a specific formatter
+SimpleCov::RSpec.start { formatter = SimpleCov::Formatter::LcovFormatter }
+```
+
+This block is passed on to `SimpleCov::RSpec.start`. See [Configuring
+SimpleCov](https://github.com/simplecov-ruby/simplecov?tab=readme-ov-file#configuring-simplecov)
+for details.
+
+### Configuration from Environment Variables
+
+Environment variables can be used to set these options as follows:
+
+You can configure `simplecov-rspec` using the following environment variables:
+
+* **`COVERAGE_THRESHOLD`**: Sets the minimum coverage threshold (0-100). Overrides
+  `coverage_threshold`.
+* **`FAIL_ON_LOW_COVERAGE`**: Controls whether tests fail if coverage is below the threshold.
+  Set to 'true', 'yes', 'on', or '1' (case insensitive) to enable.
+* **`LIST_UNCOVERED_LINES`**: Determines if uncovered lines are listed. Set to 'true',
+  'yes', 'on', or '1' (case insensitive) to enable.
+
+For example, here is a bash script to run tests in an infinite loop while writing
+test output to `fail.txt`:
+
+```bash
+while true; do COV_NO_FAIL=TRUE rspec >> fail.txt; done
+```
+
+In a CI system, you might want to set `LIST_UNCOVERED_LINES=yes` in order to list
+uncovered lines on different platforms than the one you run for local development.
+
+## Development
+
+If you want to contribute or experiment with the gem, follow these steps to set up
+your development environment:
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake
+spec` to run the tests. You can also run `bin/console` for an interactive prompt that
+will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push git
+commits and the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/main-branch/simplecov-rspec. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to the
+[code of
+conduct](https://github.com/main-branch/simplecov-rspec/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Simplecov::Rspec project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/main-branch/simplecov-rspec/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+desc 'Run the same tasks that the CI build will run'
+if RUBY_PLATFORM == 'java'
+  task default: %w[spec rubocop bundle:audit build]
+else
+  task default: %w[spec rubocop yard bundle:audit build]
+end
+
+# Bundler Audit
+
+require 'bundler/audit/task'
+Bundler::Audit::Task.new
+
+# Bundler Gem Build
+
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+CLEAN << 'pkg'
+CLOBBER << 'Gemfile.lock'
+
+# RSpec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*{_spec.rb,.feature}'
+end
+
+CLEAN << 'coverage'
+CLEAN << '.rspec_status'
+CLEAN << 'rspec-report.xml'
+
+# Rubocop
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |t|
+  t.options = %w[
+    --format progress
+    --format json --out rubocop-report.json
+  ]
+end
+
+CLEAN << 'rubocop-report.json'
+
+unless RUBY_PLATFORM == 'java'
+  # yard:build
+
+  require 'yard'
+
+  YARD::Rake::YardocTask.new('yard:build') do |t|
+    t.files = %w[lib/**/*.rb examples/**/*]
+    t.stats_options = ['--list-undoc']
+  end
+
+  CLEAN << '.yardoc'
+  CLEAN << 'doc'
+
+  # yard:audit
+
+  desc 'Run yardstick to show missing YARD doc elements'
+  task :'yard:audit' do
+    sh "yardstick 'lib/**/*.rb'"
+  end
+
+  # yard:coverage
+
+  require 'yardstick/rake/verify'
+
+  Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
+    verify.threshold = 100
+  end
+
+  # yard
+
+  desc 'Run all YARD tasks'
+  task yard: %i[yard:build yard:audit yard:coverage]
+end

data/lib/simplecov/rspec/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# SimpleCov module
+module Simplecov
+  # SimpleCov::RSpec module
+  module Rspec
+    # This gem's version
+    VERSION = '0.1.0'
+  end
+end

data/lib/simplecov/rspec.rb

@@ -0,0 +1,328 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+# SimpleCov namespace
+module SimpleCov
+  # Configure SimpleCov to fail RSpec if the test coverage falls below a given threshold
+  #
+  # Configures RSpec to:
+  #
+  # 1. Fail (and exit with with a non-zero exitcode) if the test
+  #    coverage is below the configured threshold and
+  # 2. (optionally) list the lines of code not covered by tests.
+  #
+  # Simply add the line `SimpleCov::RSpec.start` in place of `SimpleCov::Start` in
+  # the project's `spec_helper.rb`. This line must appear before the project is
+  # required.
+  #
+  # @example Initialize SimpleCov with defaults
+  #   SimpleCov::RSpec.start
+  #
+  # @example Initialize SimpleCov with a test coverage threshold other than 100%
+  #   SimpleCov::RSpec.start(coverage_threshold: 90, fail_on_low_coverage: true, list_uncovered_lines: false)
+  #
+  # @example Pass a configuration block to SimpleCov::RSpec.start
+  #   SimpleCov::RSpec.start { formatter = SimpleCov::Formatter::LcovFormatter }
+  #
+  # @example Bash script to run tests in an infinite loop writing failures to `fail.txt`:
+  #   while true; do FAIL_ON_LOW_COVERAGE=TRUE rspec >> fail.txt; done
+  #
+  # @!attribute [r] env
+  #   Command line environment variables (default: ENV)
+  #   @return [Hash]
+  #   @api private
+  #
+  # @!attribute [r] simplecov_module
+  #   The SimpleCov module (default: ::SimpleCov)
+  #   @return [Module]
+  #   @api private
+  #
+  # @!attribute [r] start_config_block
+  #   A configuration block to pass to `SimpleCov.start`
+  #   @return [Proc]
+  #   @api private
+  #
+  # @api public
+  #
+  class RSpec
+    # rubocop:disable Layout/LineLength
+
+    # Configure and start SimpleCov for RSpec
+    #
+    # @example Initialize SimpleCov with defaults
+    #   SimpleCov::RSpec.start
+    #
+    # @return [Void]
+    #
+    # @api public
+    #
+    # @overload start(coverage_threshold: 100, fail_on_low_coverage: true, list_uncovered_lines: false, rspec_dry_run: ::RSpec.configuration.dry_run?, env: ENV, &start_config_block)
+    #
+    #   @param coverage_threshold [Integer] the test coverage threshold (default: 100)
+    #
+    #     Coverage below this threshold will cause the rspec to fail if
+    #     fail_on_low_coverage is true.
+    #
+    #   @param fail_on_low_coverage [Boolean] whether to fail if the coverage is below the threshold (default: true)
+    #
+    #     This setting will be read from the environment variable FAIL_ON_LOW_COVERAGE if
+    #     it is NOT given in the `.start` method. Setting that environment variable
+    #     to 'true', 'yes', 'on', or '1' will cause this setting to be `false`
+    #     (the logic is inverted). Any other value will cause this seetting to
+    #     be `true`.
+    #
+    #   @param list_uncovered_lines [Boolean] whether to list the lines not covered by tests (default: false)
+    #
+    #     All lines not covered by tests will be listed if the coverage is below the threshold.
+    #     Probably only makes sense to use if the threshold is 100%.
+    #
+    #     This setting will be read from the environment variable LIST_UNCOVERED_LINES
+    #     if it is NOT given in the `.start` method. Setting that environment variable
+    #     to 'true', 'yes', 'on', or '1' will cause this setting to be `true`. Any
+    #     other value will cause this setting to be `false`.
+    #
+    #   @param start_config_block [Proc] a configuration block to pass to `SimpleCov.start` (default: nil)
+    #
+    #   @param rspec_dry_run [Boolean] whether the rspec run is a dry run
+    #
+    #     Typically not set by the user. Used for this gem's unit testing.
+    #
+    #     If RSpec is being run in dry run mode, test coverage under the threshold will not fail the build.
+    #
+    #     The purpose of this is to allow the test coverage to be run in a dry run by an IDE
+    #     so it can report failed tests and coverage without reporting that the entire RSpec
+    #     run has failed.
+    #
+    #   @param simplecov_module [Module] the SimpleCov module (default: ::SimpleCov)
+    #
+    #     Typically not set by the user. Used for this gem's unit testing.
+    #
+    #     Allows the SimpleCov module to be mocked.
+    #
+    #   @param env [Hash] the environment variables (default: ENV)
+    #
+    #     Typically not set by the user. Used for this gem's unit testing.
+    #
+    #   @example Initialize SimpleCov with a test coverage threshold other than 100%
+    #     SimpleCov::RSpec.start(coverage_threshold: 90)
+    #
+    #   @example Initialize SimpleCov to not fail the test run if the coverage is below the threshold
+    #     SimpleCov::RSpec.start(fail_on_low_coverage: false)
+    #
+    #     # OR use an environment variable to override the default
+    #     ENV['FAIL_ON_LOW_COVERAGE'] = 'true'
+    #     SimpleCov::RSpec.start
+    #
+    #     # OR use an environment variable to override the default from the rspec command line
+    #     FAIL_ON_LOW_COVERAGE=TRUE rspec
+    #
+    #   @example Initialize SimpleCov to list the lines not covered by tests
+    #     SimpleCov::RSpec.start(list_uncovered_lines: true)
+    #
+    #     # OR use an environment variable to override the default
+    #     ENV['LIST_UNCOVERED_LINES'] = 'true'
+    #     SimpleCov::RSpec.start
+    #
+    #     # OR use an environment variable to override the default from the rspec command line
+    #     LIST_UNCOVERED_LINES=TRUE rspec
+    #
+    def self.start(...) = new(...).send(:start)
+
+    # rubocop:enable Layout/LineLength
+
+    # Environment variable to override coverage_threshold
+    COVERAGE_THRESHOLD = 'COVERAGE_THRESHOLD'
+
+    # Environment variable to override fail_on_low_coverage
+    FAIL_ON_LOW_COVERAGE = 'FAIL_ON_LOW_COVERAGE'
+
+    # Environment variable to override list_uncovered_lines
+    LIST_UNCOVERED_LINES = 'LIST_UNCOVERED_LINES'
+
+    # Default value for coverage_threshold
+    DEFAULT_TEST_COVERAGE_THRESHOLD = 100
+
+    # Default value for fail_on_low_coverage
+    DEFAULT_FAIL_ON_LOW_COVERAGEERAGE = true
+
+    # Default value for list_uncovered_lines
+    DEFAULT_LIST_UNCOVERED_LINES = false
+
+    attr_reader :env, :simplecov_module, :start_config_block
+
+    # The coverage threshold
+    #
+    # Searches the ENV, the value given in the `.start` method, and the default value
+    # and returns the first value found.
+    #
+    # @return [Integer]
+    #
+    # @api private
+    #
+    def coverage_threshold
+      return env.fetch(COVERAGE_THRESHOLD).to_i if env.key?(COVERAGE_THRESHOLD)
+
+      return @coverage_threshold.to_i unless @coverage_threshold.nil?
+
+      DEFAULT_TEST_COVERAGE_THRESHOLD
+    end
+
+    # Whether to fail if the coverage is below the threshold
+    #
+    # Searches the ENV, the value given in the `.start` method, and the default value
+    # and returns the first value found.
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    #
+    def fail_on_low_coverage?
+      return false if rspec_dry_run?
+
+      return env_true?(FAIL_ON_LOW_COVERAGE) if env.key?(FAIL_ON_LOW_COVERAGE)
+
+      return @fail_on_low_coverage unless @fail_on_low_coverage.nil?
+
+      DEFAULT_FAIL_ON_LOW_COVERAGEERAGE
+    end
+
+    # Whether to list the lines not covered by tests
+    #
+    # Searches the ENV, the value given in the `.start` method, and the default value
+    # and returns the first value found.
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    #
+    def list_uncovered_lines?
+      return env_true?(LIST_UNCOVERED_LINES) if env.key?(LIST_UNCOVERED_LINES)
+
+      return @list_uncovered_lines unless @list_uncovered_lines.nil?
+
+      DEFAULT_LIST_UNCOVERED_LINES
+    end
+
+    # Whether the rspec run is a dry run
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    #
+    def rspec_dry_run? = @rspec_dry_run
+
+    private
+
+    # rubocop:disable Metrics/ParameterLists
+
+    # Create a new SimpleCov::RSpec instance
+    # @see SimpleCov::RSpec.start
+    # @api private
+    def initialize(
+      coverage_threshold: nil,
+      fail_on_low_coverage: nil,
+      list_uncovered_lines: nil,
+      rspec_dry_run: ::RSpec.configuration.dry_run?,
+      env: ENV,
+      simplecov_module: ::SimpleCov,
+      &start_config_block
+    )
+      @coverage_threshold = coverage_threshold
+      @fail_on_low_coverage = fail_on_low_coverage
+      @list_uncovered_lines = list_uncovered_lines
+      @start_config_block = start_config_block
+      @rspec_dry_run = rspec_dry_run
+      @env = env
+      @simplecov_module = simplecov_module
+    end
+
+    # rubocop:enable Metrics/ParameterLists
+
+    # Set the at_exit hook and then configure and start SimpleCov
+    # @return [Void]
+    # @api private
+    def start
+      simplecov_module.at_exit(&at_exit_hook)
+      simplecov_module.start(&start_config_block)
+    end
+
+    # Called by SimpleCov.at_exit
+    # @return [Proc]
+    # @api private
+    def at_exit_hook
+      lambda do
+        simplecov_module.result.format!
+        output_at_exit_report
+        exit 1 if coverage_below_threshold? && fail_on_low_coverage?
+      end
+    end
+
+    # Output the at_exit report
+    # @return [Void]
+    # @api private
+    def output_at_exit_report
+      low_coverage_report if show_low_coverage_report?
+      lines_not_covered_report if show_lines_not_covered_report?
+      $stderr.puts if show_low_coverage_report? || show_lines_not_covered_report?
+    end
+
+    # Whether to show the low coverage report
+    # @return [Boolean]
+    # @api private
+    def show_low_coverage_report? = coverage_below_threshold?
+
+    # Whether the test coverage is below the threshold
+    # @return [Boolean]
+    # @api private
+    def coverage_below_threshold? = simplecov_module.result.covered_percent < coverage_threshold
+
+    # Output the low coverage part of the at_exit report
+    # @return [Void]
+    # @api private
+    def low_coverage_report
+      $stderr.puts
+      $stderr.print 'FAIL: ' if fail_on_low_coverage?
+      $stderr.puts "Test coverage is below the low coverage threshold of #{coverage_threshold}%"
+    end
+
+    # Whether there are uncovered lines
+    # @return [Boolean]
+    # @api private
+    def uncovered_lines_found? = simplecov_module.result.files.any? { |source_file| source_file.missed_lines.any? }
+
+    # Whether to show lines not covered report
+    # @return [Boolean]
+    # @api private
+    def show_lines_not_covered_report? = list_uncovered_lines? && uncovered_lines_found?
+
+    # Output the lines not covered part of the at_exit report
+    # @return [Void]
+    # @api private
+    def lines_not_covered_report
+      $stderr.puts
+      $stderr.puts "The following lines were not covered by tests:\n"
+      simplecov_module.result.files.each do |source_file| # SimpleCov::SourceFile
+        source_file.missed_lines.each do |line| # SimpleCov::SourceFile::Line
+          $stderr.puts "  ./#{source_file.project_filename}:#{line.number}"
+        end
+      end
+    end
+
+    # Return `true` if the environment variable is set to a truthy value
+    #
+    # @example
+    #   env_true?('LIST_UNCOVERED_LINES')
+    #
+    # @param name [String] the name of the environment variable
+    # @return [Boolean]
+    # @api private
+    #
+    def env_true?(name)
+      value = env.fetch(name, '').downcase
+      %w[yes on true 1].include?(value)
+    end
+  end
+end
+
+require_relative 'rspec/version'

metadata

@@ -0,0 +1,235 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Couball
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: create_github_release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.64'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.64'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: turnip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+- !ruby/object:Gem::Dependency
+  name: yardstick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: |
+  Configures RSpec to fail (and exit with with a non-zero exitcode) if the
+  test coverage is below the configured threshold and (optionally) list the
+  lines of code not covered by tests.
+email:
+- jcouball@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simplecov/rspec.rb
+- lib/simplecov/rspec/version.rb
+homepage: https://github.com/main-branch/simplecov-rspec
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/main-branch/simplecov-rspec
+  changelog_uri: https://rubydoc.info/gems/simplecov-rspec/0.1.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/simplecov-rspec/0.1.0
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Configure SimpleCov to fail RSpec if the test coverage falls below a given
+  threshold
+test_files: []