bashcov 3.1.3 → 3.3.0

data/lib/bashcov/lexer.rb

@@ -13,7 +13,7 @@ module Bashcov
     IGNORE_END_WITH = %w[(].freeze
 
     # Lines containing only one of these keywords are irrelevant for coverage
-    IGNORE_IS = %w[esac if then else elif fi while do done { } ;;].freeze
+    IGNORE_IS = %w[esac if then else elif fi while do done { } ;; ( )].freeze
 
     # @param [String] filename File to analyze
     # @param [Hash] coverage Coverage with executed lines marked
@@ -41,7 +41,7 @@ module Bashcov
         # heredoc
         mark_multiline(
           lines, lineno,
-          /\A[^\n]+<<-?'?(\w+)'?.*$.*\1/m
+          /\A[^\n]+<<-?\s*'?(\w+)'?.*$.*\1/m
         )
 
         # multiline string concatenated with backslashes
@@ -99,17 +99,15 @@ module Bashcov
       line.sub!(/\s#.*\Z/, "") # remove comments
       line.strip!
 
-      relevant = true
+      return false if line.empty? ||
+                      IGNORE_IS.include?(line) ||
+                      line.start_with?(*IGNORE_START_WITH) ||
+                      line.end_with?(*IGNORE_END_WITH)
 
-      relevant &= false if line.empty? ||
-                           IGNORE_IS.include?(line) ||
-                           line.start_with?(*IGNORE_START_WITH) ||
-                           line.end_with?(*IGNORE_END_WITH)
+      return false if line =~ /\A[a-zA-Z_@][a-zA-Z0-9_@\-:.]*\(\)/ # function declared without the `function` keyword
+      return false if line =~ /\A[^)]+\)\Z/ # case statement selector, e.g. `--help)`
 
-      relevant &= false if line =~ /\A[a-zA-Z_][a-zA-Z0-9_:]*\(\)/ # function declared without the `function` keyword
-      relevant &= false if line =~ /\A[^)]+\)\Z/ # case statement selector, e.g. `--help)`
-
-      relevant
+      true
     end
   end
 end

data/lib/bashcov/line.rb

@@ -4,11 +4,11 @@ module Bashcov
   # {Line} represents a line of code.
   module Line
     # Uncovered line
-    # @see http://ruby-doc.org/stdlib-2.3.0/libdoc/coverage/rdoc/Coverage.html
+    # @see http://ruby-doc.org/stdlib-3.0.0/libdoc/coverage/rdoc/Coverage.html
     UNCOVERED = 0
 
     # Ignored line
-    # @see http://ruby-doc.org/stdlib-2.3.0/libdoc/coverage/rdoc/Coverage.html
+    # @see http://ruby-doc.org/stdlib-3.0.0/libdoc/coverage/rdoc/Coverage.html
     IGNORED = nil
   end
 end

data/lib/bashcov/runner.rb

@@ -23,8 +23,7 @@ module Bashcov
     # @note Binds Bashcov +stdin+ to the program being executed.
     # @return [Process::Status] Status of the executed command
     def run
-      # Clear out previous run
-      @result = nil
+      @result = nil # clear out previous run
 
       field_stream = FieldStream.new
       @xtrace = Xtrace.new(field_stream)
@@ -34,8 +33,8 @@ module Bashcov
       options[fd] = fd # bind FDs to the child process
 
       if Bashcov.options.mute
-        options[:out] = "/dev/null"
-        options[:err] = "/dev/null"
+        options[:out] = File::NULL
+        options[:err] = File::NULL
       end
 
       env =

data/lib/bashcov/version.rb

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

data/lib/bashcov/xtrace.rb

@@ -114,9 +114,9 @@ module Bashcov
     # @raise [XtraceError] when +lineno+ is not composed solely of digits,
     #   indicating that something has gone wrong with parsing the +PS4+ fields
     def parse_hit!(lineno, *paths)
-      # 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+ isn't a series of digits, add +@files+ to the exception in
+      # order to propagate the existing coverage data back to the
+      # {Bashcov::Runner} instance
       if /\A\d+\z/.match?(lineno)
         lineno = lineno.to_i
       elsif lineno == "${LINENO-}"
@@ -128,15 +128,14 @@ module Bashcov
         )
       end
 
-      # The next three fields will be $BASH_SOURCE, $PWD, $OLDPWD, and $LINENO
       bash_source, pwd, oldpwd = paths.map { |p| Pathname.new(p) }
 
       update_wd_stacks!(pwd, oldpwd)
 
       script = find_script(bash_source)
 
-      # For one-liners, +LINENO+ == 0. Do this to avoid an +IndexError+;
-      # one-liners will be culled from the coverage results later on.
+      # for one-liners, +LINENO+ == 0, do this to avoid an +IndexError+
+      # one-liners will be culled from the coverage results later on
       index = (lineno > 1 ? lineno - 1 : 0)
 
       @files[script] ||= []
@@ -172,16 +171,16 @@ module Bashcov
       @pwd_stack[0] ||= pwd
       @oldpwd_stack[0] ||= oldpwd unless oldpwd.to_s.empty?
 
-      # We haven't changed working directories; short-circuit.
+      # return if we haven't changed working directories
       return if pwd == @pwd_stack[-1]
 
-      # If the current +pwd+ is identical to the top of the +@oldpwd_stack+ and
+      # if the current +pwd+ is identical to the top of the +@oldpwd_stack+ and
       # the current +oldpwd+ is identical to the second-to-top entry, then a
-      # previous cd/pushd has been undone.
+      # previous cd/pushd has been undone
       if pwd == @oldpwd_stack[-1] && oldpwd == @oldpwd_stack[-2]
         @pwd_stack.pop
         @oldpwd_stack.pop
-      else # New cd/pushd
+      else # new cd/pushd
         @pwd_stack << pwd
         @oldpwd_stack << oldpwd
       end

data/lib/bashcov.rb

@@ -3,7 +3,6 @@
 require "optparse"
 require "pathname"
 
-require "bashcov/runner"
 require "bashcov/version"
 
 # Bashcov default module
@@ -69,17 +68,22 @@ module Bashcov
     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.
+      # 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
+      rescue NoMethodError
+        nil
+      end
 
-      # Support the same `BASHCOV_BASH_PATH` environment variable used in the spec tests.
+      # 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"
+      # fall back to standard Bash location, if available
+      return "/bin/bash" if File.executable?("/bin/bash")
+
+      # otherwise, try to execute a Bash from `PATH`
+      "bash"
     end
 
     def bash_version
@@ -98,7 +102,7 @@ module Bashcov
     # Define option accessors
     Options.new.members.each do |option|
       [option, "#{option}="].each do |method|
-        next if instance_methods(false).include?(method)
+        next if method_defined?(method, false)
 
         define_method method do |*args|
           options.public_send(*[method, *args])
@@ -109,7 +113,7 @@ module Bashcov
   private
 
     def help
-      <<-HELP.gsub(/^ +/, "").gsub("\t", " " * 4)
+      <<~HELP.gsub("\t", " " * 4)
         Usage: #{program_name} [options] [--] <command> [options]
         Examples:
         \t#{program_name} ./script.sh
@@ -138,8 +142,9 @@ module Bashcov
 
           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.
+          # redefine `BASH_VERSION` constant with updated `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

data/shell.nix

@@ -0,0 +1 @@
+(import ./compat.nix).shellNix

data/test.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 set -euo pipefail
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.3.0
 platform: ruby
 authors:
 - Cédric Félizard
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -38,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  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: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +79,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+- !ruby/object:Gem::Dependency
+  name: irb
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +121,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -165,13 +220,21 @@ files:
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
+- Gemfile.nix.lock
 - Guardfile
+- HACKING.md
+- INSTALL.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - TESTING.md
 - USAGE.md
 - bin/bashcov
+- compat.nix
+- default.nix
+- flake.lock
+- flake.nix
+- gemset.nix
 - lib/bashcov.rb
 - lib/bashcov/detective.rb
 - lib/bashcov/errors.rb
@@ -181,6 +244,7 @@ files:
 - lib/bashcov/runner.rb
 - lib/bashcov/version.rb
 - lib/bashcov/xtrace.rb
+- shell.nix
 - test.sh
 homepage: https://github.com/infertux/bashcov
 licenses:
@@ -190,7 +254,6 @@ metadata:
   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
@@ -198,15 +261,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Code coverage tool for Bash
 test_files: []