simplecov-rspec 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f72895c7f0c30898b8b0359e0b4f6f8cafa838b7f9deb59fb220cef5e8a92c4
-  data.tar.gz: a383b340c09720a2a9440d714a5d289271c1174577f6cd9a8afecb645f7ba78e
+  metadata.gz: 5f85ad1153e6f9763be15065fb878d655e678c2b25822fc0cfd0c34702d8555f
+  data.tar.gz: efb0fcb94e7391d3d2179fa77d31a1964bcdce7de6f84c503e9deb082c9d1b12
 SHA512:
-  metadata.gz: 58626ae17aff8c6645255092e1ec565d8b85f26824915b532471367ede6f900732c168fffbd659c946604ffc7e7b8ea53aa931aadffeede2a96b3350d820d0fe
-  data.tar.gz: c5dfe1463c2edd3bd72ad4cc215ad2371d53d51254e4ebd4fa33ee25aeacb6f6ee9b3ff880214ae42ff12482330c934676aa487e937c09d7ec85e577866db64a
+  metadata.gz: 0507b2f6bcc191dcde75aa43c5a78b808fbb0437b1894751028e44f31c96b5f07499a837aa768e681d8b0ba149363ddb3c410e2a677c053383de24dfb32efd39
+  data.tar.gz: 65a297b875d450c10533d0186ccc5612ab9687a9b8fc2074528713d377ff3d37f3713128a0f8ba08976674c3566c1bf5b91bd4316687f8f9c7de79eafee9c5c7

data/.rubocop.yml

@@ -35,3 +35,6 @@ Style/AsciiComments:
 
 Style/StderrPuts:
   Enabled: false
+
+Naming/FileName:
+  Exclude: ['lib/simplecov-rspec.rb', 'spec/simplecov-rspec_spec.rb']

data/CHANGELOG.md

@@ -4,6 +4,16 @@ Changes for each release are listed in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/) for its releases.
 
+## v0.2.0 (2024-09-08)
+
+[Full Changelog](https://github.com/main-branch/simplecov-rspec/compare/v0.1.0..v0.2.0)
+
+Changes since v0.1.0:
+
+* 2b544ee Allow the CI build to be manually triggered
+* 50e1b4a Rename lib/simplecov/rspec to lib/simplecov-rspec (and related files)
+* 0884d23 Move CI build using Ruby head to an different workflow
+
 ## v0.1.0 (2024-09-07)
 
 [Full Changelog](https://github.com/main-branch/simplecov-rspec/compare/9fe828c..v0.1.0)

data/README.md

@@ -56,7 +56,7 @@ gem install simplecov-rspec
 
 To use `simplecov-rspec`, follow these steps:
 
-1. Add `require 'simplecov/rspec'` to your `spec_helper.rb`.
+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.
 
@@ -64,7 +64,7 @@ Here is an example `spec_helper.rb`. Your spec helper may include
 other code in addition to these:
 
 ```ruby
-require 'simplecov/rspec'
+require 'simplecov-rspec'
 
 SimpleCov::RSpec.start
 
@@ -80,7 +80,7 @@ That is it!
 To initialize simplecov-rspec with defaults, add the following to your `spec_helper.rb`:
 
 ```ruby
-require 'simplecov/rspec'
+require 'simplecov-rspec'
 
 SimpleCov::RSpec.start
 ```

data/Rakefile

@@ -60,7 +60,8 @@ unless RUBY_PLATFORM == 'java'
 
   YARD::Rake::YardocTask.new('yard:build') do |t|
     t.files = %w[lib/**/*.rb examples/**/*]
-    t.stats_options = ['--list-undoc']
+    t.options = %w[--no-private]
+    t.stats_options = %w[--list-undoc]
   end
 
   CLEAN << '.yardoc'

data/lib/simplecov-rspec/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Simplecov
+  class Rspec
+    # This gem's version
+    VERSION = '0.2.0'
+  end
+end

data/lib/{simplecov/rspec.rb → simplecov-rspec.rb}

@@ -32,16 +32,19 @@ module SimpleCov
   #   Command line environment variables (default: ENV)
   #   @return [Hash]
   #   @api private
+  #   @private
   #
   # @!attribute [r] simplecov_module
   #   The SimpleCov module (default: ::SimpleCov)
   #   @return [Module]
   #   @api private
+  #   @private
   #
   # @!attribute [r] start_config_block
   #   A configuration block to pass to `SimpleCov.start`
   #   @return [Proc]
   #   @api private
+  #   @private
   #
   # @api public
   #
@@ -132,21 +135,33 @@ module SimpleCov
     # rubocop:enable Layout/LineLength
 
     # Environment variable to override coverage_threshold
+    # @api private
+    # @private
     COVERAGE_THRESHOLD = 'COVERAGE_THRESHOLD'
 
     # Environment variable to override fail_on_low_coverage
+    # @api private
+    # @private
     FAIL_ON_LOW_COVERAGE = 'FAIL_ON_LOW_COVERAGE'
 
     # Environment variable to override list_uncovered_lines
+    # @api private
+    # @private
     LIST_UNCOVERED_LINES = 'LIST_UNCOVERED_LINES'
 
     # Default value for coverage_threshold
+    # @api private
+    # @private
     DEFAULT_TEST_COVERAGE_THRESHOLD = 100
 
     # Default value for fail_on_low_coverage
+    # @api private
+    # @private
     DEFAULT_FAIL_ON_LOW_COVERAGEERAGE = true
 
     # Default value for list_uncovered_lines
+    # @api private
+    # @private
     DEFAULT_LIST_UNCOVERED_LINES = false
 
     attr_reader :env, :simplecov_module, :start_config_block
@@ -159,6 +174,7 @@ module SimpleCov
     # @return [Integer]
     #
     # @api private
+    # @private
     #
     def coverage_threshold
       return env.fetch(COVERAGE_THRESHOLD).to_i if env.key?(COVERAGE_THRESHOLD)
@@ -176,6 +192,7 @@ module SimpleCov
     # @return [Boolean]
     #
     # @api private
+    # @private
     #
     def fail_on_low_coverage?
       return false if rspec_dry_run?
@@ -195,6 +212,7 @@ module SimpleCov
     # @return [Boolean]
     #
     # @api private
+    # @private
     #
     def list_uncovered_lines?
       return env_true?(LIST_UNCOVERED_LINES) if env.key?(LIST_UNCOVERED_LINES)
@@ -209,6 +227,7 @@ module SimpleCov
     # @return [Boolean]
     #
     # @api private
+    # @private
     #
     def rspec_dry_run? = @rspec_dry_run
 
@@ -219,6 +238,7 @@ module SimpleCov
     # Create a new SimpleCov::RSpec instance
     # @see SimpleCov::RSpec.start
     # @api private
+    # @private
     def initialize(
       coverage_threshold: nil,
       fail_on_low_coverage: nil,
@@ -242,6 +262,7 @@ module SimpleCov
     # Set the at_exit hook and then configure and start SimpleCov
     # @return [Void]
     # @api private
+    # @private
     def start
       simplecov_module.at_exit(&at_exit_hook)
       simplecov_module.start(&start_config_block)
@@ -250,6 +271,7 @@ module SimpleCov
     # Called by SimpleCov.at_exit
     # @return [Proc]
     # @api private
+    # @private
     def at_exit_hook
       lambda do
         simplecov_module.result.format!
@@ -261,6 +283,7 @@ module SimpleCov
     # Output the at_exit report
     # @return [Void]
     # @api private
+    # @private
     def output_at_exit_report
       low_coverage_report if show_low_coverage_report?
       lines_not_covered_report if show_lines_not_covered_report?
@@ -270,16 +293,19 @@ module SimpleCov
     # Whether to show the low coverage report
     # @return [Boolean]
     # @api private
+    # @private
     def show_low_coverage_report? = coverage_below_threshold?
 
     # Whether the test coverage is below the threshold
     # @return [Boolean]
     # @api private
+    # @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
+    # @private
     def low_coverage_report
       $stderr.puts
       $stderr.print 'FAIL: ' if fail_on_low_coverage?
@@ -294,11 +320,13 @@ module SimpleCov
     # Whether to show lines not covered report
     # @return [Boolean]
     # @api private
+    # @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
+    # @private
     def lines_not_covered_report
       $stderr.puts
       $stderr.puts "The following lines were not covered by tests:\n"
@@ -317,6 +345,7 @@ module SimpleCov
     # @param name [String] the name of the environment variable
     # @return [Boolean]
     # @api private
+    # @private
     #
     def env_true?(name)
       value = env.fetch(name, '').downcase
@@ -324,5 +353,3 @@ module SimpleCov
     end
   end
 end
-
-require_relative 'rspec/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Couball
@@ -201,16 +201,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/simplecov/rspec.rb
-- lib/simplecov/rspec/version.rb
+- 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
+  changelog_uri: https://rubydoc.info/gems/simplecov-rspec/0.2.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/simplecov-rspec/0.2.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []

data/lib/simplecov/rspec/version.rb

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