simplecov-rspec 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cd20182766238dffc8bc1cbce5e10e8535c4f7b161061613b6b6a74e03d18ce
-  data.tar.gz: 2451f8c6723de90f596a0d475562245acb1aad4b143bdd22669d31c107eda8ff
+  metadata.gz: 357d45f1e4b96c53d5522233609b282d46fddc7433f656649f0c5739e6a6cd4f
+  data.tar.gz: 39cfacd21df933b7f17b6eaa547bfd7caaf78e05cdede1a4e71eb2d5ecabcbf8
 SHA512:
-  metadata.gz: fd4d19e6e3376ad8b391d5e59cf80c6e135e726b861d6063e3e3ee3920efddc08133f6549d79d0391d745cea73405ebe12faac31136a50b053569b59e2c58288
-  data.tar.gz: 1063210e9667c592a51e2e48d86c7df0e6233bda9e5e38016d987c6c61f261e297d814ae9ca6f6f1529056474883b5221f14a6e6ed66cf0b17779f2c0160694e
+  metadata.gz: 2fd6556e1261bdd178cf03afe828aadaf4ab9deb228dae5aaf51440e52b481808f53382d7c0e75073caf25d408802b94b91036ebae9a1ad791d5d5378a9b443a
+  data.tar.gz: d4129677343eb1099fff8e72286f023f09124551e8d73770c9aa2fecdb4624d09c4cdc4f3331ab5d2f21a2ffcdd5fa4294430457ff93aa3de7e2738d7eac4000

data/.markdownlint.yml

@@ -0,0 +1,25 @@
+default: true
+
+# Unordered list indentation
+MD007: { indent: 2 }
+
+# Line length
+MD013: { line_length: 90, tables: false, code_blocks: false }
+
+# Heading duplication is allowed for non-sibling headings
+MD024: { siblings_only: true }
+
+# Do not allow the specified trailing punctuation in a header
+MD026: { punctuation: '.,;:' }
+
+# Order list items must have a prefix that increases in numerical order
+MD029: { style: 'ordered' }
+
+# Lists do not need to be surrounded by blank lines
+MD032: false
+
+# Allow raw HTML in Markdown
+MD033: false
+
+# Allow emphasis to be used instead of a heading
+MD036: false

data/.rubocop.yml

@@ -10,7 +10,7 @@ AllCops:
 
   # RuboCop enforces rules depending on the oldest version of Ruby which
   # your project supports:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1
 
 Gemspec/DevelopmentDependencies:
   Enabled: false

data/.yardopts

@@ -0,0 +1,8 @@
+--no-private
+--hide-void-return
+--markup-provider=redcarpet
+--markup markdown
+- CHANGELOG.md
+- CONTRIBUTING.md
+- RELEASING.md
+- LICENSE.txt

data/CHANGELOG.md

@@ -4,6 +4,38 @@ Changes for each release are listed in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/) for its releases.
 
+## v0.3.1 (2024-09-16)
+
+[Full Changelog](https://github.com/main-branch/simplecov-rspec/compare/v0.3.0..v0.3.1)
+
+Changes since v0.3.0:
+
+* 1fca720 Remove unneeded --exclude options in .yardopts
+* e60794d Update yardopts with new standard options
+* 31537ec Fix the YARD doc generation to use the correct license file name
+* aebb048 Standardize YARD and Markdown Lint configurations
+* 474adfb Update CODEOWNERS file
+* ca1aca3 Document why the JRuby --debug flag is being set
+* 8e0ad31 Set JRuby —debug option when running tests in GitHub Actions workflows
+* fa10ba3 Fix example of uncovered lines listing in README
+
+## v0.3.0 (2024-09-14)
+
+[Full Changelog](https://github.com/main-branch/simplecov-rspec/compare/v0.2.1..v0.3.0)
+
+Changes since v0.2.1:
+
+* 55c3812 Output the number of lines missing coverage
+* 9356f64 Rename variables from "lines_not_covered" to "uncovered_lines" to be consistent
+* ec637c0 Fix error in README
+* 9d9cb0c Rearrange workflow definitions to have the name first
+* ac8efae Update continuous integration and experimental ruby builds
+* ac1da92 Use v1 tag for the semver_pr_label_check workflow
+* d701393 Auto-correct new Rubocop offenses
+* 0319f68 Update minimal Ruby version to 3.1
+* d6b57d1 Update code climate test coverage reporter version to v9
+* 02553a1 Change simplecov from a development dependency to a runtime dependency
+
 ## v0.2.1 (2024-09-10)
 
 [Full Changelog](https://github.com/main-branch/simplecov-rspec/compare/v0.2.0..v0.2.1)

data/README.md

@@ -24,7 +24,7 @@ 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:
+2 lines are not covered by tests:
   ./lib/example_project.rb:74
   ./lib/example_project.rb:75
 ```
@@ -91,7 +91,7 @@ This is equivalent to starting with the following options:
 SimpleCov::RSpec.start(
     coverage_threshold: 100,
     fail_on_low_coverage: true,
-    list_lines_not_covered: false
+    list_uncovered_lines: false
 )
 ```
 

data/lib/simplecov-rspec/version.rb

@@ -3,6 +3,6 @@
 module Simplecov
   class Rspec
     # This gem's version
-    VERSION = '0.2.1'
+    VERSION = '0.3.1'
   end
 end

data/lib/simplecov-rspec.rb

@@ -286,11 +286,11 @@ module SimpleCov
     # @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?
+      uncovered_lines_report if show_uncovered_lines_report?
+      $stderr.puts if show_low_coverage_report? || show_uncovered_lines_report?
     end
 
-    # Whether to show the low coverage report
+    # Whether to show the low coverage
     # @return [Boolean]
     # @api private
     # @private
@@ -302,7 +302,7 @@ module SimpleCov
     # @private
     def coverage_below_threshold? = simplecov_module.result.covered_percent < coverage_threshold
 
-    # Output the low coverage part of the at_exit report
+    # Output the low coverage report
     # @return [Void]
     # @api private
     # @private
@@ -317,23 +317,59 @@ module SimpleCov
     # @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
+    # Whether to show the uncovered lines
     # @return [Boolean]
     # @api private
     # @private
-    def show_lines_not_covered_report? = list_uncovered_lines? && uncovered_lines_found?
+    def show_uncovered_lines_report? = list_uncovered_lines? && uncovered_lines_found?
 
-    # Output the lines not covered part of the at_exit report
+    # An uncovered line
+    #
+    # @!attribute project_filename [rw]
+    #   The path to the file with uncovered lines relative to the project root
+    #   @return [String]
+    #   @api private
+    #
+    # @!attribute line_number [rw]
+    #   The line number of the uncovered line
+    #   @return [Integer]
+    #   @api private
+    #
+    # @api private
+    UncoveredLine = Struct.new(:project_filename, :line_number)
+
+    # Return the uncovered lines from the SimpleCov result
+    # @return [Array<UncoveredLine>]
+    # @api private
+    def uncovered_lines
+      @uncovered_lines ||=
+        simplecov_module.result.files.flat_map do |source_file|
+          source_file.missed_lines.map do |line|
+            project_filename = File.join('.', source_file.project_filename)
+            UncoveredLine.new(project_filename, line.number)
+          end
+        end
+    end
+
+    # Return the singular or plural form of a word based on the count
+    # @param count [Integer] the count
+    # @param singular [String] the singular form of the phrase
+    # @param plural [String] the plural form of the phrase
+    # @return [String]
+    # @api private
+    def pluralize(count, singular, plural) = count == 1 ? singular : plural
+
+    # Output the uncovered lines
     # @return [Void]
     # @api private
     # @private
-    def lines_not_covered_report
+    def uncovered_lines_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
+      count = uncovered_lines.count
+      things = pluralize(uncovered_lines.count, 'line is', 'lines are')
+      $stderr.puts "#{count} #{things} not covered by tests:\n"
+      uncovered_lines.each do |uncovered_line|
+        $stderr.puts "  #{uncovered_line.project_filename}:#{uncovered_line.line_number}"
       end
     end
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -30,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.64'
+        version: '1.66'
   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'
+        version: '1.66'
 - !ruby/object:Gem::Dependency
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
@@ -194,8 +194,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".markdownlint.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
@@ -209,8 +211,8 @@ licenses:
 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.2.1/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/simplecov-rspec/0.2.1
+  changelog_uri: https://rubydoc.info/gems/simplecov-rspec/0.3.1/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/simplecov-rspec/0.3.1
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -220,13 +222,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- 'Platform: Mac, Linux, or Windows'
+- 'Ruby: MRI 3.1 or later, TruffleRuby 24 or later, or JRuby 9.4 or later'
 rubygems_version: 3.5.16
 signing_key:
 specification_version: 4