Modernize Gem for Ruby 3 and fix the test suite

[References #63]

[Fixes #31]
[Fixes #43]
[Fixes #56]

Author: infertux

.gitlab-ci.yml

@@ -0,0 +1,43 @@
+# Official language image. Look for the different tagged releases at:
+# https://hub.docker.com/r/library/ruby/tags/
+image: ruby:latest
+
+before_script:
+  - ruby -v
+  - bundle install -j $(nproc)
+  - ./spec/install_bash.sh
+  - bash --version
+  - id
+  - env
+
+# Bash versions can be found at https://git.savannah.gnu.org/cgit/bash.git
+rspec-bash-5.2:
+  variables:
+    INSTALL_BASH_VERSION: "5.2"
+  script: rspec
+
+rspec-bash-5.1:
+  variables:
+    INSTALL_BASH_VERSION: "5.1"
+  script: rspec
+
+rspec-bash-5.0:
+  variables:
+    INSTALL_BASH_VERSION: "5.0"
+  script: rspec
+
+rspec-bash-4.4:
+  variables:
+    INSTALL_BASH_VERSION: "4.4"
+  script: rspec
+
+rspec-bash-4.3:
+  variables:
+    INSTALL_BASH_VERSION: "4.3"
+  script: rspec
+
+rubocop:
+  script: rubocop
+
+yard:
+  script: yard stats --list-undoc

.rubocop.yml

@@ -1,28 +1,44 @@
-AllCops:
-  TargetRubyVersion: 2.5
-
-Metrics/AbcSize:
-  Max: 30
-
-Metrics/BlockLength:
-  Exclude: ["spec/**/*.rb"]
+require:
+  - rubocop-rake
+  - rubocop-rspec
 
-Metrics/ClassLength:
-  Max: 150
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
 
-Metrics/LineLength:
-  Max: 100
-  Exclude: ["spec/**/*.rb"]
+Metrics:
+  Enabled: false
 
-Metrics/MethodLength:
-  Max: 20
+Gemspec/DevelopmentDependencies:
+  Enabled: false
 
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
+Layout/LineLength:
+  Enabled: 100
+
 Lint/RedundantSplatExpansion:
   Enabled: false
 
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
 Style/ParallelAssignment:
   Enabled: false
 

.travis.yml

@@ -1,18 +1,24 @@
-## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v2.0.0...master))
+## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v3.0.0...master))
 
   * TBD
 
-## v2.0.0, 2020-07-?? ([changes](https://github.com/infertux/bashcov/compare/v1.8.2...v2.0.0))
+## v3.0.0, 2023-04-10 ([changes](https://github.com/infertux/bashcov/compare/v1.8.2...v3.0.0))
 
+  * [MISC]    New minimum Bash version supported is 4.3
+  * [MISC]    New minimum Ruby version supported is 3.0
+  * [BUGFIX]  Running Bashcov as root is now working (especially useful with Docker) although it is not recommended (#31, #43 and #56)
+  * [BUGFIX]  Fix comments preceded by tabs not filtered out (#68)
+  * [BUGFIX]  Fix two-line multilines not being treated as related (#67)
+  * [BUGFIX]  Redefine `BASH_VERSION` when `bash_path` is read from command options (#57)
+  * [BUGFIX]  Mute output from Bashcov and SimpleCov when requested (#54)
+  * [BUGFIX]  Correctly handle empty scripts by short-circuiting
+              `FieldStream#each` if the reader stream is at end-of-file before
+              the start-of-fields pattern is encountered (#41)
   * [FEATURE] Bashcov omits from the coverage results any files that match one
               or more of the filters in `SimpleCov.filters` (#38)
   * [FEATURE] Ensure that files matching the `SimpleCov.tracked_files` glob
               pattern are included in the coverage results, regardless of
               whether `Bashcov.skip_uncovered` is enabled (#38)
-  * [MISC]    Add support for Ruby 2.6 and drop 2.3
-  * [BUGFIX]  Correctly handle empty scripts by short-circuiting
-              `FieldStream#each` if the reader stream is at end-of-file before
-              the start-of-fields pattern is encountered (#41)
 
 ## v1.8.2, 2018-03-27 ([changes](https://github.com/infertux/bashcov/compare/v1.8.1...v1.8.2))
 

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Bashcov
 
 [![Gem Version](https://img.shields.io/gem/v/bashcov.svg)](https://rubygems.org/gems/bashcov)
-[![Build Status](https://api.travis-ci.org/infertux/bashcov.svg?branch=master)](https://travis-ci.org/infertux/bashcov)
+[![Build Status](https://gitlab.com/infertux/bashcov/badges/master/pipeline.svg)](https://gitlab.com/infertux/bashcov/-/pipelines)
 [![Coverage Status](https://coveralls.io/repos/infertux/bashcov/badge.svg?branch=master)](https://coveralls.io/r/infertux/bashcov)
 [![Maintainability](https://api.codeclimate.com/v1/badges/083fdbba795049cd5f06/maintainability)](https://codeclimate.com/github/infertux/bashcov/maintainability)
 [![Inline docs](http://inch-ci.org/github/infertux/bashcov.svg)](http://inch-ci.org/github/infertux/bashcov)
@@ -22,8 +22,8 @@ It uses the [SimpleCov](https://github.com/colszowka/simplecov) coverage library
 SimpleCov gets installed automatically when you install Bashcov.
 
 Here are example coverages generated by Bashcov:
-[test app demo](https://infertux.github.com/bashcov/test_app/ "Coverage for the bundled test application") &
-[RVM demo](https://infertux.github.com/bashcov/rvm/ "Coverage for RVM").
+[test app demo](https://infertux.github.io/bashcov/test_app/ "Coverage for the bundled test application") &
+[RVM demo](https://infertux.github.io/bashcov/rvm/ "Coverage for RVM").
 
 ## Installation
 

README.md

@@ -0,0 +1,3 @@
+`./test.sh` will run all [GitLab CI pipelines](https://gitlab.com/infertux/bashcov/-/pipelines) locally.
+
+You'll need [Docker](https://www.docker.com/) and [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner) installed on your machine.

TESTING.md

@@ -64,11 +64,3 @@ it may yield a path that doesn't refer to the currently-running script.
 However, it performs well under the various working directory changes performed
 in the [test app demo] and avoids the spurious extra hits caused by using
 subshells in the `PS4`.
-
-One final note on innards: Bash 4.3 fixed a bug in which `PS4` expansion is
-truncated to a maximum of 128 characters. On platforms whose Bash version
-suffers from this bug, Bashcov uses the ASCII record separator character to
-delimit the `PS4` fields, whereas it uses a long random string on Bash 4.3 and
-above. When the field delimiter appears in the path of a script under test or
-in a command the script executes, Bashcov won't correctly parse the `PS4` and
-will abort early with incomplete coverage results.

USAGE.md

@@ -1,37 +1,43 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "bashcov/version"
+require_relative "lib/bashcov/version"
 
-Gem::Specification.new do |gem|
-  gem.name          = "bashcov"
-  gem.version       = Bashcov::VERSION
-  gem.authors       = ["Cédric Félizard"]
-  gem.email         = ["[email protected]"]
-  gem.description   = "Code coverage tool for Bash"
-  gem.summary       = gem.description
-  gem.homepage      = "https://github.com/infertux/bashcov"
-  gem.license       = "MIT"
+Gem::Specification.new do |spec|
+  spec.name          = "bashcov"
+  spec.version       = Bashcov::VERSION
+  spec.authors       = ["Cédric Félizard"]
+  spec.email         = ["[email protected]"]
 
-  gem.files         = `git ls-files -z`.split("\x0").reject do |file|
-    file.start_with?(".") || file.match(%r{\A(test|spec|features)/})
-  end
+  spec.summary       = spec.description
+  spec.description   = "Code coverage tool for Bash"
+  spec.homepage      = "https://github.com/infertux/bashcov"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
 
-  gem.executables   = gem.files.grep(%r{\Abin/}).map { |f| File.basename(f) }
-  gem.require_paths = ["lib"]
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/infertux/bashcov"
+  spec.metadata["changelog_uri"] = "https://github.com/infertux/bashcov/blob/master/CHANGELOG.md"
 
-  gem.required_ruby_version = ">= 2.5.8"
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  gem.add_dependency "simplecov", "~> 0.18.5"
+  spec.add_dependency "simplecov", "~> 0.21.2"
 
-  gem.add_development_dependency "aruba"
-  gem.add_development_dependency "bundler-audit"
-  gem.add_development_dependency "coveralls"
-  gem.add_development_dependency "cucumber"
-  gem.add_development_dependency "mutant-rspec"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "rubocop"
-  gem.add_development_dependency "yard"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "bundler-audit"
+  # spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rake"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "yard"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

bashcov.gemspec

@@ -17,7 +17,7 @@ def aruba_working_directory_expanded
   end
 
   def simplecov_results_json
-    run_command_and_stop(<<-'COMMAND')
+    run_command_and_stop(<<-COMMAND)
       ruby -rjson -rsimplecov -e '
         SimpleCov.at_exit { } # noop to prevent output other than the desired JSON
         print SimpleCov::ResultMerger.results.map(&:to_hash).to_json

features/step_definitions/bashcov_steps.rb

@@ -3,15 +3,12 @@
 require "optparse"
 require "pathname"
 
-require "bashcov/bash_info"
 require "bashcov/runner"
 require "bashcov/version"
 
 # Bashcov default module
 # @note Keep it short!
 module Bashcov
-  extend Bashcov::BashInfo
-
   # A +Struct+ to store Bashcov configuration
   Options = Struct.new(
     *%i[skip_uncovered mute bash_path root_directory command command_name]
@@ -55,8 +52,9 @@ def fullname
         VERSION,
         "with Bash #{BASH_VERSION},",
         "Ruby #{RUBY_VERSION},",
-        "and SimpleCov #{SimpleCov::VERSION}.",
-      ].join(" ")
+        "and SimpleCov #{SimpleCov::VERSION}",
+        (Process.uid.zero? ? " as root user (NOT recommended)" : nil),
+      ].compact.join(" ")
     end
 
     # @return [String] The value to use as +SimpleCov.command_name+. Uses the
@@ -65,7 +63,7 @@ def fullname
     #   representation of {Bashcov#command}.
     def command_name
       return @options.command_name if @options.command_name
-      return ENV["BASHCOV_COMMAND_NAME"] unless ENV.fetch("BASHCOV_COMMAND_NAME", "").empty?
+      return ENV.fetch("BASHCOV_COMMAND_NAME", nil) unless ENV.fetch("BASHCOV_COMMAND_NAME", "").empty?
 
       command.compact.join(" ")
     end
@@ -78,7 +76,7 @@ def bash_path
       rescue NoMethodError; end # rubocop:disable Lint/SuppressedException
 
       # Support the same `BASHCOV_BASH_PATH` environment variable used in the spec tests.
-      return ENV["BASHCOV_BASH_PATH"] unless ENV.fetch("BASHCOV_BASH_PATH", "").empty?
+      return ENV.fetch("BASHCOV_BASH_PATH", nil) unless ENV.fetch("BASHCOV_BASH_PATH", "").empty?
 
       # Fall back to standard Bash location.
       "/bin/bash"
@@ -121,8 +119,8 @@ def help
       HELP
     end
 
-    def option_parser # rubocop:disable Metrics/MethodLength
-      OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
+    def option_parser
+      OptionParser.new do |opts|
         opts.program_name = program_name
         opts.version = Bashcov::VERSION
         opts.banner = help