bashcov 1.8.2 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36bdcb7d7aa907185855227615d085b989fdc7754f4bd5ebdb7d65736db3ff7
-  data.tar.gz: 2bf28ebe2354264a91c926516584c091f008e5e11404d4b774c97dc01b3f8993
+  metadata.gz: dc1ae5949f8031caba0793e0529cc4c4b4f6234061283d9094255857a63fc8d1
+  data.tar.gz: d4423c15129a25abf041b2c4534f08b0073a7eb146eb1ccfb0e13af3c08bd0dd
 SHA512:
-  metadata.gz: fe32c995469459ad86f25991772b081613bb645a323fb279a5f2be9ffeb4ec6ced9601c07552654f28bfbd456473a23d04fc46741d7d0623dacde516956b05c7
-  data.tar.gz: 4aca021b938322c850bfa17e63b542ff3acc0e8a22194d77b0cc527d26901d99b318a440a43041c6e47a4977eaf551be8b2d146f0b9a4a4f79781171140a94d2
+  metadata.gz: a032b39c42880b459b7311c103ba0f53e2074e94602f58e4363545c3f7d7700aeb7df9edaf34431ff03f4e881ffdf8d49b5a471103745e158d00d8207d4acdb2
+  data.tar.gz: 57c5ce619ecdefb2bf0e4b64f04746f2f98cdd54e3778df837afebf8466447a05b127e116ac31f885df8ff912c78ad9ef18c704fa9120711d860f62e7dfd7a0d

data/.build.yml

@@ -0,0 +1,11 @@
+image: archlinux
+packages:
+  - ruby-bundler
+  - bash
+sources:
+  - https://git.sr.ht/~infertux/bashcov
+tasks:
+  - rake: |
+      cd bashcov
+      bundle install
+      bundle exec rake

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format d
+--order random
+--profile

data/.rubocop.yml

@@ -0,0 +1,55 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Metrics:
+  Enabled: false
+
+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
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.simplecov

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+SimpleCov.start do
+  minimum_coverage 95
+  add_filter "/features/"
+  add_filter "/spec/"
+  add_filter "/tmp/"
+  add_filter "/.git/"
+end

data/CHANGELOG.md

@@ -1,7 +1,29 @@
-## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v1.8.2...master))
+## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v3.0.1...master))
 
   * TBD
 
+## v3.0.1, 2023-04-15 ([changes](https://github.com/infertux/bashcov/compare/v3.0.0...v3.0.1))
+
+  * [BUGFIX]  Fix incorrect executables path in gemspec
+
+## 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)
+
 ## v1.8.2, 2018-03-27 ([changes](https://github.com/infertux/bashcov/compare/v1.8.1...v1.8.2))
 
   * [BUGFIX]  Fix coverage for complex heredoc constructions (#32)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2018 Cédric Félizard
+Copyright (c) 2012-2023 Cédric Félizard
 
 MIT License
 

data/README.md

@@ -1,146 +1,65 @@
 # Bashcov
 
+[![Funding](https://img.shields.io/liberapay/patrons/infertux.svg?logo=liberapay)](https://liberapay.com/infertux/donate)
+[![Sponsors](https://img.shields.io/liberapay/patrons/infertux)](https://liberapay.com/infertux)
 [![Gem Version](https://img.shields.io/gem/v/bashcov.svg)](https://rubygems.org/gems/bashcov)
-[![Build Status](https://secure.travis-ci.org/infertux/bashcov.png?branch=master)](https://travis-ci.org/infertux/bashcov)
-[![Coverage Status](https://coveralls.io/repos/infertux/bashcov/badge.png?branch=master)](https://coveralls.io/r/infertux/bashcov)
-[![Dependency Status](https://gemnasium.com/infertux/bashcov.png)](https://gemnasium.com/infertux/bashcov)
+[![Build Status](https://gitlab.com/infertux/bashcov/badges/master/pipeline.svg)](https://gitlab.com/infertux/bashcov/-/pipelines)
 [![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)
 
-**Code coverage for Bash**
-
-  * [Source Code]
-  * [Bug Tracker]
-  * [API Documentation]
-  * [Changelog]
-  * [Rubygem]
-  * [Continuous Integration]
-  * [Dependencies]
-  * [SimpleCov]
-
-[Source Code]: https://github.com/infertux/bashcov "Source Code on Github"
-[Bug Tracker]: https://github.com/infertux/bashcov/issues "Bug Tracker on Github"
-[API documentation]: http://rubydoc.info/gems/bashcov/frames "API Documentation on Rubydoc"
-[Changelog]: https://github.com/infertux/bashcov/blob/master/CHANGELOG.md "Project Changelog"
-[Rubygem]: https://rubygems.org/gems/bashcov "Bashcov on Rubygems"
-[Continuous Integration]: https://travis-ci.org/infertux/bashcov "Bashcov on Travis-CI"
-[Dependencies]: https://gemnasium.com/infertux/bashcov "Bashcov dependencies on Gemnasium"
-[Bashcov]: https://github.com/infertux/bashcov
-[SimpleCov]: https://github.com/colszowka/simplecov "Bashcov is backed by SimpleCov to generate awesome coverage report"
-[Test app demo]: https://infertux.github.com/bashcov/test_app/ "Coverage for the bundled test application"
-
-You should check out these coverage examples - it's worth a thousand words:
-
-  - [Test app demo]
-  - [RVM demo](https://infertux.github.com/bashcov/rvm/ "Coverage for RVM")
+Bashcov is a **code coverage analysis tool for Bash**.
+
+In most cases, you'll want overall coverage results for your project from
+[shUnit2](https://github.com/kward/shunit2),
+[Bats](https://github.com/bats-core/bats-core),
+[bash_unit](https://github.com/pgrange/bash_unit),
+[assert.sh](https://github.com/lehmannro/assert.sh),
+[bashaspec](https://github.com/d10n/bashaspec),
+etc.
+Bashcov automatically takes care of this by caching and merging results when generating reports,
+so your report includes coverage across your test suites and thereby gives you a better picture of blank spots.
+
+It uses the [SimpleCov](https://github.com/colszowka/simplecov) coverage library to generate HTML reports.
+SimpleCov gets installed automatically when you install Bashcov.
+
+Here are example coverages generated by Bashcov:
+[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
 
-`$ gem install bashcov`
+`gem install bashcov`
+
+If the `gem` command is unavailable, you need to [install Ruby](https://www.ruby-lang.org/en/documentation/installation/) first.
 
 ## Usage
 
-`$ bashcov --help` prints all available options.
-Here are some examples:
+`bashcov --help` prints all available options. Here are some examples:
 
-    $ bashcov ./script.sh
-    $ bashcov --skip-uncovered ./script.sh
-    $ bashcov -- ./script.sh --some --flags
-    $ bashcov --skip-uncovered -- ./script.sh --some --flags
+    bashcov ./script.sh
+    bashcov --skip-uncovered ./script.sh
+    bashcov -- ./script.sh --some --flags
+    bashcov --skip-uncovered -- ./script.sh --some --flags
 
-`script.sh` can be a mere Bash script or typically your CI script.
-Bashcov will keep track of all executed scripts.
+`./script.sh` can be a mere Bash script or typically your CI script. Bashcov will keep track of all executed scripts.
 
-Then it will create a directory named `./coverage/` containing nice HTML files.
-Open `./coverage/index.html` to browse the coverage report.
+It will create a directory named `./coverage/`, you may open `./coverage/index.html` to browse the coverage report.
 
 ### SimpleCov integration
 
-You can take great advantage of [SimpleCov] by adding a `.simplecov` file in
-your project's root (like [this](https://github.com/infertux/bashcov/blob/master/spec/test_app/.simplecov)).
-See [SimpleCov README](https://github.com/colszowka/simplecov#readme) for more
-information.
-
-#### Controlling the command name
-
-Bashcov respects all of your `.simplecov` settings save one --
-[`SimpleCov.command_name`](http://www.rubydoc.info/gems/simplecov/SimpleCov/Configuration#command_name-instance_method),
-which is the tag that SimpleCov attaches to coverage results from a particular
-test suite. You can set the value of `SimpleCov.command_name` by using
-Bashcov's `--command-name` option, or by assigning a value to the environment
-variable `BASHCOV_COMMAND_NAME`. Otherwise, Bashcov will generate a command
-name for you based on the name of the currently-executing Bash script and any
-arguments passed to it. For example, assuming your Bash lives at `/bin/bash`
-and you run the command
-
-```
-$ bashcov -- ./test_suite.sh --and some --flags
-```
-
-Bashcov will set `SimpleCov.command_name` to `"/bin/bash ./test_suite.sh --and
-some --flags"`. Basing `SimpleCov.command_name` on the executing command helps
-to ensure that multiple coverage runs don't [overwrite each other's
-results](https://github.com/colszowka/simplecov#test-suite-names) due to
-SimpleCov identifying multiple runs by the same tag. The `--command-name` and
-`BASHCOV_COMMAND_NAME` knobs are there for you to twiddle in case your test
-suite runs the exact same `bashcov` command more than once, in which case the
-generated command name will not distinguish each invocation from the others.
-
-For more info on `SimpleCov.command_name` and its relation to SimpleCov's
-result-merging behavior, see the [SimpleCov
-README](https://github.com/colszowka/simplecov#merging-results).
-
-### Some gory details
-
-Figuring out where an executing Bash script lives in the file system can be
-surprisingly difficult. Bash offers a fair amount of [introspection into its
-internals](https://www.gnu.org/software/bash/manual/html_node/Bash-Variables.html),
-but the location of the current script has to be inferred from the limited
-information available through `BASH_SOURCE`, `PWD`, and `OLDPWD` (and
-potentially `DIRSTACK` if you are using `pushd`/`popd`). For this purpose,
-Bashcov puts Bash in debug mode and sets up a `PS4` that expands the values of
-these variables, reading them on each command that Bash executes. But, given
-that:
-
-  * `BASH_SOURCE` is only an absolute path if the script was invoked using an
-    absolute path,
-  * the builtins `cd`, `pushd`, and `popd` alter `PWD` and `OLDPWD`, and
-  * none of these variables are read-only and can therefore be `unset` or
-    otherwise altered,
-
-it can be easy to lose track of where we are.
-
-_"Wait a minute, what about `pwd`, `readlink`, and so on?"_ That would be great,
-except that subshells executed as part of expanding the `PS4` can cause Bash to
-report [extra executions](https://github.com/infertux/bashcov/commit/4130874e30a05b7ab6ea66fb96a19acaa973c178)
-for [certain lines](https://github.com/infertux/bashcov/pull/16). Also,
-subshells are slow as the `PS4` is expanded on each and every command when Bash
-is in debug mode.
-
-To deal with these limitations, Bashcov uses the expedient of maintaining two
-stacks that track changes to `PWD` and `OLDPWD`. To determine the full path to
-the executing script, Bashcov iterates in reverse over the `PWD` stack, testing
-for the first `$PWD/$BASH_SOURCE` combination that refers to an existing file.
-This heuristic is susceptible to false positives -- under certain combinations
-of directory structure, script invocation paths, and working directory changes,
-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.
+You can leverage the underlying library [SimpleCov](https://github.com/colszowka/simplecov)
+by adding a `.simplecov` file in your project's root, like [this](https://github.com/infertux/bashcov/blob/master/spec/test_app/.simplecov).
+See [advanced usage](./USAGE.md) for more information.
 
 ## Contributing
 
 Bug reports and patches are most welcome.
 See the [contribution guidelines](https://github.com/infertux/bashcov/blob/master/CONTRIBUTING.md).
 
+## Sponsorship
+
+Bashcov was [created in 2012](https://github.com/infertux/bashcov/commit/f65e65e5aa3377beb334beee9924136a34a913e8) and it needs your help. I have been maintaining the project for over a decade and keeping it working with new releases of Bash and Ruby takes time. If you use Bashcov professionally, please considerer supporting it on [Liberapay](https://liberapay.com/infertux) through your employer or directly. Thank you for supporting *Free and Open-Source Software*.
+
 ## License
 
 MIT
-

data/Rakefile

@@ -2,8 +2,13 @@
 
 require "bundler/gem_tasks"
 
+require "bundler/audit/task"
+Bundler::Audit::Task.new
+
 require "cucumber/rake/task"
-Cucumber::Rake::Task.new
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w[--publish-quiet]
+end
 
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec) do |t|
@@ -13,4 +18,4 @@ end
 require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
-task default: %i[rubocop spec cucumber]
+task default: %i[bundle:audit cucumber spec rubocop]

data/TESTING.md

@@ -0,0 +1,4 @@
+`bundle exec rake` will run a quick test suite with the current Bash and Ruby version.
+
+`./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.

data/USAGE.md

@@ -0,0 +1,66 @@
+### Controlling the command name
+
+Bashcov respects all of your `.simplecov` settings save one --
+[`SimpleCov.command_name`](http://www.rubydoc.info/gems/simplecov/SimpleCov/Configuration#command_name-instance_method),
+which is the tag that SimpleCov attaches to coverage results from a particular
+test suite. You can set the value of `SimpleCov.command_name` by using
+Bashcov's `--command-name` option, or by assigning a value to the environment
+variable `BASHCOV_COMMAND_NAME`. Otherwise, Bashcov will generate a command
+name for you based on the name of the currently-executing Bash script and any
+arguments passed to it. For example, assuming your Bash lives at `/bin/bash`
+and you run the command
+
+```
+bashcov -- ./test_suite.sh --and some --flags
+```
+
+Bashcov will set `SimpleCov.command_name` to `"/bin/bash ./test_suite.sh --and
+some --flags"`. Basing `SimpleCov.command_name` on the executing command helps
+to ensure that multiple coverage runs don't [overwrite each other's
+results](https://github.com/colszowka/simplecov#test-suite-names) due to
+SimpleCov identifying multiple runs by the same tag. The `--command-name` and
+`BASHCOV_COMMAND_NAME` knobs are there for you to twiddle in case your test
+suite runs the exact same `bashcov` command more than once, in which case the
+generated command name will not distinguish each invocation from the others.
+
+For more info on `SimpleCov.command_name` and its relation to SimpleCov's
+result-merging behavior, see the [SimpleCov
+README](https://github.com/colszowka/simplecov#merging-results).
+
+### Some gory details
+
+Figuring out where an executing Bash script lives in the file system can be
+surprisingly difficult. Bash offers a fair amount of [introspection into its
+internals](https://www.gnu.org/software/bash/manual/html_node/Bash-Variables.html),
+but the location of the current script has to be inferred from the limited
+information available through `BASH_SOURCE`, `PWD`, and `OLDPWD` (and
+potentially `DIRSTACK` if you are using `pushd`/`popd`). For this purpose,
+Bashcov puts Bash in debug mode and sets up a `PS4` that expands the values of
+these variables, reading them on each command that Bash executes. But, given
+that:
+
+  * `BASH_SOURCE` is only an absolute path if the script was invoked using an
+    absolute path,
+  * the builtins `cd`, `pushd`, and `popd` alter `PWD` and `OLDPWD`, and
+  * none of these variables are read-only and can therefore be `unset` or
+    otherwise altered,
+
+it can be easy to lose track of where we are.
+
+_"Wait a minute, what about `pwd`, `readlink`, and so on?"_ That would be great,
+except that subshells executed as part of expanding the `PS4` can cause Bash to
+report [extra executions](https://github.com/infertux/bashcov/commit/4130874e30a05b7ab6ea66fb96a19acaa973c178)
+for [certain lines](https://github.com/infertux/bashcov/pull/16). Also,
+subshells are slow as the `PS4` is expanded on each and every command when Bash
+is in debug mode.
+
+To deal with these limitations, Bashcov uses the expedient of maintaining two
+stacks that track changes to `PWD` and `OLDPWD`. To determine the full path to
+the executing script, Bashcov iterates in reverse over the `PWD` stack, testing
+for the first `$PWD/$BASH_SOURCE` combination that refers to an existing file.
+This heuristic is susceptible to false positives -- under certain combinations
+of directory structure, script invocation paths, and working directory changes,
+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`.

data/bin/bashcov

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-lib = File.expand_path("../../lib", __FILE__)
+lib = File.expand_path("../lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "bashcov"
@@ -26,8 +26,18 @@ if SimpleCov.use_merging
 end
 
 SimpleCov.at_exit do
-  puts "Run completed using #{Bashcov.fullname}"
-  result.format!
+  puts "Run completed using #{Bashcov.fullname}" unless Bashcov.mute
+
+  begin
+    # XXX: suppress output from https://github.com/colszowka/simplecov-html/blob/9ec41504ab139fabfaddfc786dfdab5d6aca0bab/lib/simplecov-html.rb#L25
+    # See https://github.com/infertux/bashcov/issues/53
+    original_stdout = $stdout
+    $stdout = StringIO.new if Bashcov.mute
+
+    result.format!
+  ensure
+    $stdout = original_stdout
+  end
 end
 
 exit status.exitstatus

data/lib/bashcov/detective.rb

@@ -34,7 +34,7 @@ module Bashcov
       return false unless File.exist?(filename) && File.readable?(filename) \
         && File.file?(File.realpath(filename))
 
-      shellscript_shebang?(filename) || \
+      shellscript_shebang?(filename) ||
         (shellscript_extension?(filename) && shellscript_syntax?(filename))
     end
 
@@ -54,10 +54,10 @@ module Bashcov
 
       return false unless shebang[0..1] == "#!"
 
-      shell, arg = shebang[2..-1].split(/\s+/, 2)
+      shell, arg = shebang[2..].split(/\s+/, 2)
       shell_basename = File.basename(shell)
 
-      SHELL_BASENAMES.include?(shell_basename) || \
+      SHELL_BASENAMES.include?(shell_basename) ||
         (OTHER_BASENAMES.include?(shell_basename) && SHELL_BASENAMES.include?(arg))
     end
 

data/lib/bashcov/field_stream.rb

@@ -23,7 +23,7 @@ module Bashcov
       end
     end
 
-    # Yields fields extracted from a input stream
+    # Yields fields extracted from an input stream
     # @param [String, nil] delimiter   the field separator
     # @param [Integer]     field_count the number of fields to extract
     # @param [Regexp]      start_match a +Regexp+ that, when matched against the
@@ -33,39 +33,51 @@ module Bashcov
     #   +start_match+ is matched with fewer than +field_count+ fields yielded
     #   since the last match, yields empty strings until +field_count+ is
     #   reached.
-    def each(delimiter, field_count, start_match)
+    def each(delimiter, field_count, start_match, &block)
       return enum_for(__method__, delimiter, field_count, start_match) unless block_given?
 
-      # The number of fields processed since passing the last start-of-fields
-      # match
-      seen_fields = 0
+      chunked = each_field(delimiter).chunk(&chunk_matches(start_match))
 
-      fields = each_field(delimiter)
+      yield_fields = lambda do |(_, chunk)|
+        chunk.each(&block)
+        (field_count - chunk.size).times { yield "" }
+      end
+
+      # Skip junk that might appear before the first start-of-fields match
+      begin
+        n, chunk = chunked.next
+        yield_fields.call([n, chunk]) unless n.zero?
+      rescue StopIteration
+        return
+      end
 
-      # Close over +field_count+ and +seen_fields+ to yield empty strings to
-      # the caller when we've already hit the next start-of-fields match
-      yield_remaining = -> { (field_count - seen_fields).times { yield "" } }
+      chunked.each(&yield_fields)
+    end
 
-      # Advance until the first start-of-fields match
-      loop { break if fields.next =~ start_match }
+  private
 
-      fields.each do |field|
-        # If the current field is the start-of-fields match...
-        if field =~ start_match
-          # Fill out any remaining (unparseable) fields with empty strings
-          yield_remaining.call
+    # @param [Regexp] start_match a +Regexp+ that, when matched against the
+    #   input stream, signifies the beginning of the next series of fields to
+    #   yield
+    # @return [Proc] a unary +Proc+ that returns +nil+ if the argument mathes
+    #   the +start_match+ +Regexp+, and otherwise returns the number of
+    #   start-of-fields signifiers so far encountered.
+    # @example
+    #   chunker = chunk_matches /<=>/
+    #   chunked = %w[foo fighters <=> bar none <=> baz luhrmann].chunk(&chunker)
+    #   chunked.to_a
+    #     #=> [[0, ["foo", "fighters"]], [1, ["bar", "none"]], [2, ["baz", "luhrmann"]]]
+    def chunk_matches(start_match)
+      i = 0
 
-          seen_fields = 0
-        elsif seen_fields < field_count
-          yield field
-          seen_fields += 1
+      lambda do |e|
+        if e.match?(start_match)
+          i += 1
+          nil
+        else
+          i
         end
       end
-
-      # One last filling-out of empty fields if we're at the end of the stream
-      yield_remaining.call
-
-      read.close unless read.closed?
     end
   end
 end

data/lib/bashcov/lexer.rb

@@ -27,8 +27,8 @@ module Bashcov
 
     # Process and complete initial coverage.
     # @return [void]
-    def complete_coverage # rubocop:disable Metrics/MethodLength
-      lines = IO.read(@filename).encode("utf-8", invalid: :replace).lines
+    def complete_coverage
+      lines = File.read(@filename).encode("utf-8", invalid: :replace).lines
 
       lines.each_with_index do |line, lineno|
         # multi-line arrays
@@ -72,7 +72,7 @@ module Bashcov
   private
 
     def mark_multiline(lines, lineno, regexp, forward: true)
-      seek_forward = lines[lineno..-1].join
+      seek_forward = lines[lineno..].join
       return unless (multiline_match = seek_forward.match(regexp))
 
       length = multiline_match.to_s.count($/)
@@ -81,7 +81,7 @@ module Bashcov
       reference_lineno = (forward ? first - 1 : last)
 
       # don't seek backward if first line is already covered
-      return if !forward && @coverage[first]
+      return if !forward && @coverage[first - 1]
 
       range.each do |sub_lineno|
         # mark related lines with the same coverage as the reference line
@@ -95,8 +95,8 @@ module Bashcov
       @coverage[lineno] = Bashcov::Line::UNCOVERED if relevant?(line)
     end
 
-    def relevant?(line) # rubocop:disable Metrics/CyclomaticComplexity
-      line.sub!(/ #.*\Z/, "") # remove comments
+    def relevant?(line)
+      line.sub!(/\s#.*\Z/, "") # remove comments
       line.strip!
 
       relevant = true
@@ -107,7 +107,7 @@ module Bashcov
                            line.end_with?(*IGNORE_END_WITH)
 
       relevant &= false if line =~ /\A\w+\(\)/ # function declared without the `function` keyword
-      relevant &= false if line =~ /\A[^\)]+\)\Z/ # case statement selector, e.g. `--help)`
+      relevant &= false if line =~ /\A[^)]+\)\Z/ # case statement selector, e.g. `--help)`
 
       relevant
     end

data/lib/bashcov/runner.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require "tempfile"
+
+require "simplecov"
+
 require "bashcov/detective"
 require "bashcov/errors"
 require "bashcov/field_stream"
@@ -18,23 +22,40 @@ module Bashcov
     # Runs the command with appropriate xtrace settings.
     # @note Binds Bashcov +stdin+ to the program being executed.
     # @return [Process::Status] Status of the executed command
-    def run # rubocop:disable Metrics/MethodLength
+    def run
       # Clear out previous run
       @result = nil
 
       field_stream = FieldStream.new
       @xtrace = Xtrace.new(field_stream)
-
       fd = @xtrace.file_descriptor
-      env = { "PS4" => Xtrace.ps4 }
+
       options = { in: :in }
+      options[fd] = fd # bind FDs to the child process
 
       if Bashcov.options.mute
         options[:out] = "/dev/null"
         options[:err] = "/dev/null"
       end
 
-      run_xtrace(fd, env, options) do
+      env =
+        if Process.uid.zero?
+          # if running as root, Bash 4.4+ does not inherit $PS4 from the environment
+          # https://github.com/infertux/bashcov/issues/43#issuecomment-450605839
+          write_warning "running as root is NOT recommended, Bashcov may not work properly."
+
+          temp_file = Tempfile.new("bashcov_bash_env")
+          temp_file.write("export PS4='#{Xtrace.ps4}'\n")
+          temp_file.close
+
+          { "BASH_ENV" => temp_file.path }
+        else
+          { "PS4" => Xtrace.ps4 }
+        end
+
+      env["BASH_XTRACEFD"] = fd.to_s
+
+      with_xtrace_flag do
         command_pid = Process.spawn env, *@command, options # spawn the command
 
         begin
@@ -58,6 +79,8 @@ module Bashcov
         end
       end
 
+      temp_file&.unlink
+
       $?
     end
 
@@ -83,39 +106,13 @@ module Bashcov
       ].join
     end
 
-    def run_xtrace(fd, env, options)
-      # Older versions of Bash (< 4.1) don't have the BASH_XTRACEFD variable
-      if Bashcov.bash_xtracefd?
-        options[fd] = fd # bind FDs to the child process
-
-        env["BASH_XTRACEFD"] = fd.to_s
-      else
-        # Send subprocess standard error to @xtrace.file_descriptor
-        options[:err] = fd
-
-        # Don't bother issuing warning if we're silencing output anyway
-        unless Bashcov.mute
-          write_warning <<-WARNING
-            you are using a version of Bash that does not support
-            BASH_XTRACEFD. All xtrace output will print to standard error, and
-            your script's output on standard error will not be printed to the
-            console.
-          WARNING
-        end
-      end
-
-      with_xtrace_flag do
-        yield
-      end
-    end
-
     # @note +SHELLOPTS+ must be exported so we use Ruby's {ENV} variable
     # @yield [void] adds "xtrace" to +SHELLOPTS+ and then runs the provided
     #   block
     # @return [Object, ...] the value returned by the calling block
     def with_xtrace_flag
-      existing_flags_s = ENV["SHELLOPTS"]
-      existing_flags = (existing_flags_s || "").split(":")
+      existing_flags_s = ENV.fetch("SHELLOPTS", "")
+      existing_flags = existing_flags_s.split(":")
       ENV["SHELLOPTS"] = (existing_flags | ["xtrace"]).join(":")
 
       yield
@@ -126,25 +123,49 @@ module Bashcov
     # Add files which have not been executed at all (i.e. with no coverage)
     # @return [void]
     def find_bash_files!
-      return if Bashcov.skip_uncovered
+      filtered_files.each do |filename|
+        @coverage[filename] = [] if !@coverage.include?(filename) && @detective.shellscript?(filename)
+      end
+    end
 
-      Pathname.new(Bashcov.root_directory).find do |filename|
-        if !@coverage.include?(filename) && @detective.shellscript?(filename)
-          @coverage[filename] = []
-        end
+    # @return [Array<Pathname>] the list of files that should be included in
+    #   coverage results, unless filtered by one or more SimpleCov filters
+    def tracked_files
+      return @tracked_files if defined? @tracked_files
+
+      mandatory = SimpleCov.tracked_files ? Pathname.glob(SimpleCov.tracked_files) : []
+      under_root = Bashcov.skip_uncovered ? [] : Pathname.new(Bashcov.root_directory).find.to_a
+
+      @tracked_files = (mandatory + under_root).uniq
+    end
+
+    # @return [Array<Pathname>] the list of files that should be included in
+    #   coverage results
+    def filtered_files
+      return @filtered_files if defined? @filtered_files
+
+      source_files = tracked_files.map do |file|
+        SimpleCov::SourceFile.new(file.to_s, @coverage.fetch(file, []))
+      end
+
+      source_file_to_tracked_file = source_files.zip(tracked_files).to_h
+
+      @filtered_files = SimpleCov.filtered(source_files).map do |source_file|
+        source_file_to_tracked_file[source_file]
       end
     end
 
     # @return [void]
     def expunge_invalid_files!
       @coverage.each_key do |filename|
-        next if filename.file?
+        if !filename.file?
+          @coverage.delete filename
+          write_warning "#{filename} was executed but has been deleted since then - it won't be reported in coverage."
 
-        @coverage.delete filename
-        write_warning <<-WARNING
-          #{filename} was executed but has been deleted since then - it won't
-          be reported in coverage.
-        WARNING
+        elsif !@detective.shellscript?(filename)
+          @coverage.delete filename
+          write_warning "#{filename} was partially executed but has invalid Bash syntax - it won't be reported in coverage."
+        end
       end
     end
 
@@ -158,7 +179,7 @@ module Bashcov
     end
 
     def convert_coverage
-      Hash[@coverage.map { |filename, coverage| [filename.to_s, coverage] }]
+      @coverage.transform_keys(&:to_s)
     end
   end
 end

data/lib/bashcov/version.rb

@@ -3,5 +3,5 @@
 # :nodoc:
 module Bashcov
   # Current Bashcov version
-  VERSION = "1.8.2"
+  VERSION = "3.0.1"
 end

data/lib/bashcov/xtrace.rb

@@ -24,11 +24,10 @@ module Bashcov
     class << self
       attr_writer :delimiter, :ps4
 
-      # [String] A randomly-generated UUID or the ASCII RS (record separator)
-      #   character, depending on whether the current Bash suffers from the
-      #   truncated +PS4+ bug. Used for delimiting the fields of the +PS4+.
+      # [String] A randomly-generated UUID used for delimiting the fields of
+      # the +PS4+.
       def delimiter
-        @delimiter ||= Bashcov.truncated_ps4? ? "\x1E" : SecureRandom.uuid
+        @delimiter ||= SecureRandom.uuid
       end
 
       # @return [String] +PS4+ variable used for xtrace output. Expands to
@@ -93,9 +92,12 @@ module Bashcov
       # play nicely with +Enumerator+s backed by +IO+ objects.
       loop do
         break if (hit = (1..field_count).map { fields.next }).empty?
+
         parse_hit!(*hit)
       end
 
+      @read.close unless @read.closed?
+
       @files
     end
 
@@ -115,8 +117,11 @@ module Bashcov
       # If +LINENO+ isn't a series of digits, something has gone wrong. Add
       # +@files+ to the exception in order to propagate the existing coverage
       # data back to the {Bashcov::Runner} instance.
-      if lineno =~ /\A\d+\z/
+      if /\A\d+\z/.match?(lineno)
         lineno = lineno.to_i
+      elsif lineno == "${LINENO-}"
+        # the variable doesn't expand on line misses so we can safely ignore it
+        return
       else
         raise XtraceError.new(
           "expected integer for LINENO, got #{lineno.inspect}", @files

data/lib/bashcov.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 @@ module Bashcov
         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,17 +63,35 @@ module Bashcov
     #   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
 
+    def bash_path
+      # First attempt to use the value from `options`, but ignore all exceptions.
+      # This is used early for the `BASH_VERSION` definition, so first use will likely error.
+      begin
+        return @options.bash_path if @options.bash_path
+      rescue NoMethodError; end # rubocop:disable Lint/SuppressedException
+
+      # Support the same `BASHCOV_BASH_PATH` environment variable used in the spec tests.
+      return ENV.fetch("BASHCOV_BASH_PATH", nil) unless ENV.fetch("BASHCOV_BASH_PATH", "").empty?
+
+      # Fall back to standard Bash location.
+      "/bin/bash"
+    end
+
+    def bash_version
+      `#{bash_path} -c 'echo -n ${BASH_VERSINFO[0]}.${BASH_VERSINFO[1]}'`
+    end
+
     # Wipe the current options and reset default values
     def set_default_options!
       @options = Options.new
 
       @options.skip_uncovered   = false
       @options.mute             = false
-      @options.bash_path        = "/bin/bash"
       @options.root_directory   = Dir.getwd
     end
 
@@ -103,8 +119,8 @@ module Bashcov
       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
@@ -119,10 +135,17 @@ module Bashcov
         end
         opts.on("--bash-path PATH", "Path to Bash executable") do |p|
           raise Errno::ENOENT, p unless File.file? p
+
           options.bash_path = p
+
+          # Redefine `BASH_VERSION` constant with upated `bash_path`.
+          # This is hacky, but a lot of code references that constant and this should only have to be done once.
+          send(:remove_const, "BASH_VERSION")
+          const_set("BASH_VERSION", bash_version.freeze)
         end
         opts.on("--root PATH", "Project root directory") do |d|
           raise Errno::ENOENT, d unless File.directory? d
+
           options.root_directory = d
         end
         opts.on("--command-name NAME", "Value to use as SimpleCov.command_name") do |c|
@@ -143,5 +166,5 @@ module Bashcov
   end
 
   # Current Bash version (e.g. 4.2)
-  BASH_VERSION = `#{bash_path} -c 'echo -n ${BASH_VERSINFO[0]}.${BASH_VERSINFO[1]}'`.freeze
+  BASH_VERSION = bash_version.freeze
 end

data/test.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -euo pipefail
+
+jobs=$(grep -o '^[a-z].*:$' .gitlab-ci.yml | tr -d ':' | grep -Ev '^(before_script)$')
+
+for job in $jobs; do
+    echo "Running ${job}..."
+    gitlab-runner exec docker "$job"
+done

metadata

@@ -1,45 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 3.0.1
 platform: ruby
 authors:
 - Cédric Félizard
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2023-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.21.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mutant-rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -144,6 +158,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".build.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -151,10 +169,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bashcov.gemspec
+- TESTING.md
+- USAGE.md
 - bin/bashcov
 - lib/bashcov.rb
-- lib/bashcov/bash_info.rb
 - lib/bashcov/detective.rb
 - lib/bashcov/errors.rb
 - lib/bashcov/field_stream.rb
@@ -163,11 +181,16 @@ files:
 - lib/bashcov/runner.rb
 - lib/bashcov/version.rb
 - lib/bashcov/xtrace.rb
+- test.sh
 homepage: https://github.com/infertux/bashcov
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/infertux/bashcov
+  source_code_uri: https://github.com/infertux/bashcov
+  changelog_uri: https://github.com/infertux/bashcov/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -175,16 +198,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Code coverage tool for Bash
 test_files: []

data/bashcov.gemspec

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "bashcov/version"
-
-Gem::Specification.new do |gem|
-  gem.name          = "bashcov"
-  gem.version       = Bashcov::VERSION
-  gem.authors       = ["Cédric Félizard"]
-  gem.email         = ["cedric@felizard.fr"]
-  gem.description   = "Code coverage tool for Bash"
-  gem.summary       = gem.description
-  gem.homepage      = "https://github.com/infertux/bashcov"
-  gem.license       = "MIT"
-
-  gem.files         = `git ls-files -z`.split("\x0").reject do |file|
-    file.start_with?(".") || file.match(%r{\A(test|spec|features)/})
-  end
-
-  gem.executables   = gem.files.grep(%r{\Abin/}).map { |f| File.basename(f) }
-  gem.require_paths = ["lib"]
-
-  gem.required_ruby_version = ">= 2.3.0"
-
-  gem.add_dependency "simplecov", "0.15.1"
-
-  gem.add_development_dependency "aruba", "~> 0.14.3"
-  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"
-end

data/lib/bashcov/bash_info.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Bashcov
-  # Module exposing information concerning the installed Bash version
-  # @note methods do not cache results because +bash_path+ can change at
-  #   runtime
-  # @note receiver is expected to implement +bash_path+
-  module BashInfo
-    # @return [Boolean] Whether Bash supports +BASH_XTRACEFD+
-    def bash_xtracefd?
-      BASH_VERSION >= "4.1"
-    end
-
-    # @param [Integer] length the number of bytes to test; default 128
-    # @return [Boolean] whether Bash supports a +PS4+ of at least a given
-    #   number of bytes
-    # @see https://tiswww.case.edu/php/chet/bash/CHANGES
-    # @note Item +i.+ under the +bash-4.2-release+ to +bash-4.3-alpha+ change
-    #   list notes that version 4.2 truncates +PS4+ if it is greater than 128
-    #   bytes.
-    def truncated_ps4?(length = 128)
-      ps4 = SecureRandom.base64(length)
-      !`PS4=#{ps4} #{bash_path} 2>&1 1>&- -xc 'echo hello'`.start_with?(ps4)
-    end
-  end
-end