bashcov 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf955fd7135b192e4da886b5f8348f73422e06fd658bfdf11935533f3522f197
-  data.tar.gz: d63c79fce3a315693f96a32a6a4fe7a40c94ea32c3bfd7a0019c9a94cb67c145
+  metadata.gz: f0747d5303e019390aac25da832f145d0fe434ca0990ce68b11124423f6cf1f7
+  data.tar.gz: daed283089aa39da826552a98178c59916e215e30552113ebf094103388cae5b
 SHA512:
-  metadata.gz: b7e891c4b1b9d272c0c11f44bb008deda2aff88f33bf5d0c9068d5f4a396f7efaa1bd915610b498126d07bef2e9512b2a4efd88dd76cef19d58b9d89d796b51b
-  data.tar.gz: 7a26df75b930a634741ef9f9e6a1d23c80be4a05dd1164623c7f1b907f3ae76450ed3694fe2d64201e59171fdde8638af9db726853849fc644acf8309bc583e0
+  metadata.gz: 8e04f898757e9fd035eac7f5da81e5de7a93a2d492f3039a6c97c2b88610fcce1f86af7c3ddc734ae941f6cfcebe05361dfe442826f7dcf792d0d6cb9a88b542
+  data.tar.gz: 9446b060debec76ebb08765cb7c16b8c16bb1d17b50d85da3543631ab2c5c9c32671033bdfd9bd811cda0d735c454a2a2e803f30ad812aebb7ea253e7e8cc2d2

data/CHANGELOG.md

@@ -1,7 +1,19 @@
-## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v4.0.0...master))
+## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v4.0.1...master))
 
   * TBD
 
+## v4.0.1, 2026-10-26 ([changes](https://github.com/infertux/bashcov/compare/v4.0.0...v4.0.1))
+
+  * [BUGFIX]  Fix coverage of multiline strings on Bash < 5.3 (fixes #108)
+  * [BUGFIX]  Fix coverage of multiline strings opened after a line continuation
+  * [BUGFIX]  Handle escaped characters in multiline double-quoted strings
+  * [BUGFIX]  Stop heredoc matches at the first closing delimiter
+  * [BUGFIX]  Only allow tab-indented heredoc delimiters after `<<-`
+  * [BUGFIX]  Recognize heredoc delimiters quoted with double quotes or a backslash
+  * [MISC]    Speed up lexer on files with multiline constructs
+  * [MISC]    Make sure we use compatible cucumber and aruba releases
+  * [MISC]    Add link to Buy Me a Coffee
+
 ## v4.0.0, 2026-08-25 ([changes](https://github.com/infertux/bashcov/compare/v3.3.0...v4.0.0))
 
   * [BUGFIX]  Fix build for Nix

data/Gemfile.nix.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bashcov (4.0.0)
+    bashcov (4.0.1)
       simplecov (~> 1.1)
 
 GEM
@@ -17,7 +17,7 @@ GEM
     ast (2.4.3)
     base64 (0.3.0)
     benchmark (0.5.0)
-    bigdecimal (4.1.2)
+    bigdecimal (4.1.3)
     builder (3.3.0)
     bundler-audit (0.9.3)
       bundler (>= 1.2.0)
@@ -51,26 +51,26 @@ GEM
     diff-lcs (1.6.2)
     erb (6.0.7)
     ffi (1.16.3)
-    io-console (0.9.2)
+    io-console (0.9.4)
     irb (1.18.0)
       pp (>= 0.6.0)
       prism (>= 1.3.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.21.2)
+    json (3.1.0)
     language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
     logger (1.7.0)
     memoist3 (1.0.0)
     mini_mime (1.1.5)
     multi_test (1.1.0)
-    parallel (2.1.0)
+    parallel (2.3.0)
     parser (3.3.12.0)
       ast (~> 2.4.1)
       racc
     pp (0.6.4)
       prettyprint
-    prettyprint (0.2.0)
+    prettyprint (0.2.1)
     prism (1.9.0)
     racc (1.8.1)
     rainbow (3.1.1)
@@ -79,12 +79,12 @@ GEM
       logger
       prism (>= 1.6.0)
       tsort
-    rdoc (8.0.0)
+    rdoc (8.1.0)
       erb
       prism (>= 1.6.0)
       rbs (>= 4.0.0)
       tsort
-    regexp_parser (2.12.0)
+    regexp_parser (2.13.1)
     reline (0.7.0)
       io-console (~> 0.5)
     rspec (3.13.2)
@@ -100,14 +100,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.90.0)
+    rubocop (1.92.0)
       json (>= 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
       parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.9.3, < 3.0)
+      regexp_parser (>= 2.11.3, < 3.0)
       rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
@@ -122,15 +122,15 @@ GEM
       regexp_parser (>= 2.0)
       rubocop (~> 1.86, >= 1.86.2)
     ruby-progressbar (1.13.0)
-    simplecov (1.1.1)
+    simplecov (1.3.2)
     sys-uname (1.5.1)
       ffi (~> 1.1)
       memoist3 (~> 1.0.0)
     thor (1.5.0)
     tsort (0.2.0)
-    unicode-display_width (3.2.0)
-      unicode-emoji (~> 4.1)
-    unicode-emoji (4.2.0)
+    unicode-display_width (3.3.0)
+      unicode-emoji (~> 4.3)
+    unicode-emoji (4.3.0)
     yard (0.9.45)
 
 PLATFORMS
@@ -147,11 +147,11 @@ PLATFORMS
   x86_64-linux-musl
 
 DEPENDENCIES
-  aruba
+  aruba (~> 2.4.1)
   bashcov!
   benchmark
   bundler-audit
-  cucumber
+  cucumber (~> 11.1.1)
   ffi (~> 1.16.0)
   irb
   rake

data/README.md

@@ -1,5 +1,6 @@
 # Bashcov
 
+[![Buy Me a Coffee](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg)](https://buymeacoffee.com/infertux)
 [![Funding](https://img.shields.io/liberapay/patrons/infertux.svg?logo=liberapay)](https://liberapay.com/infertux/donate)
 [![Gem Version](https://img.shields.io/gem/v/bashcov.svg)](https://rubygems.org/gems/bashcov)
 [![Build Status](https://github.com/infertux/bashcov/actions/workflows/ci.yml/badge.svg)](https://github.com/infertux/bashcov/actions/workflows/ci.yml)
@@ -59,7 +60,7 @@ For development tips, see [the hacking guide](./HACKING.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 consider supporting it on [Liberapay](https://liberapay.com/infertux) through your employer or directly. Thank you for supporting *Free and Open-Source Software*.
+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 consider supporting it on [Buy Me a Coffee](https://buymeacoffee.com/infertux) or [Liberapay](https://liberapay.com/infertux) through your employer or directly. Thank you for supporting *Free and Open-Source Software*.
 
 ## License
 

data/flake.nix

@@ -206,7 +206,7 @@
               pname = "bashcov";
               gemdir = self;
               lockfile = ./Gemfile.nix.lock;
-              version = "4.0.0";
+              version = "4.0.1";
               postBuild = ''
                 for gem in $out/${ruby.gemPath}/bundler/gems/*; do
                   ln -sfrT "$gem" $out/${ruby.gemPath}/gems/"''${gem##*/}"

data/gemset.nix

@@ -38,7 +38,7 @@
       path = ./.;
       type = "path";
     };
-    version = "4.0.0";
+    version = "4.0.1";
   };
   benchmark = {
     groups = ["development"];
@@ -55,10 +55,10 @@
     platforms = [];
     source = {
       remotes = ["https://rubygems.org"];
-      sha256 = "1g9zi8c4i7g8zz0c3hxrw6mblrjvgn7akys60clb9si7c1k1gljk";
+      sha256 = "0rng45p4vc3f6nac44cnylwch7rj4zsff3icdz6c7garwpjy3sv1";
       type = "gem";
     };
-    version = "4.1.2";
+    version = "4.1.3";
   };
   builder = {
     groups = ["default" "development"];
@@ -211,10 +211,10 @@
     platforms = [];
     source = {
       remotes = ["https://rubygems.org"];
-      sha256 = "026v93kja19bfslnwi9xfq2dj4r89kkwdprim4whjg6h3n4lz9zg";
+      sha256 = "1cgvhm0d4awr8j42b8v1nl1jfgx45ihv8mylargfi3lj697k00x4";
       type = "gem";
     };
-    version = "0.9.2";
+    version = "0.9.4";
   };
   irb = {
     dependencies = ["pp" "prism" "rdoc" "reline"];
@@ -232,10 +232,10 @@
     platforms = [];
     source = {
       remotes = ["https://rubygems.org"];
-      sha256 = "0shwgjqbj856mb6m9kgkpy08nhym2gdvc2yaprlimfmky9y3n78z";
+      sha256 = "1n1v9rhb19cnf1a89s6yvvhw394jy8qnqx9sg8bn12g5zpwcrrrw";
       type = "gem";
     };
-    version = "2.21.2";
+    version = "3.1.0";
   };
   language_server-protocol = {
     groups = ["default" "development"];
@@ -302,10 +302,10 @@
     platforms = [];
     source = {
       remotes = ["https://rubygems.org"];
-      sha256 = "0mlkn1vhh9lr7vljibpgspwsswk7mzm8nw6bbr616c9fbj35hlmk";
+      sha256 = "0vvs2sar7wnw70j1jc1kv1k23m5grc0ci3bbrcf6mkh18683wnpp";
       type = "gem";
     };
-    version = "2.1.0";
+    version = "2.3.0";
   };
   parser = {
     dependencies = ["ast" "racc"];
@@ -334,10 +334,10 @@
     platforms = [];
     source = {
       remotes = ["https://rubygems.org"];
-      sha256 = "14zicq3plqi217w6xahv7b8f7aj5kpxv1j1w98344ix9h5ay3j9b";
+      sha256 = "1m5pqkp8rdk0bkxxz3bp3vn8pn3bd9a97dkl8wfh1kyplrzdamfm";
       type = "gem";
     };
-    version = "0.2.0";
+    version = "0.2.1";
   };
   prism = {
     groups = ["default" "development"];
@@ -396,20 +396,20 @@
     platforms = [];
     source = {
       remotes = ["https://rubygems.org"];
-      sha256 = "0sf4909q2mr9z0rpygv94z12b0yamg07gz8cba2mi5k3m448rgq3";
+      sha256 = "02pn63i2r5z44hcfhxbaag9rvqsyznsliivnn7f3dzaw1a43gz5y";
       type = "gem";
     };
-    version = "8.0.0";
+    version = "8.1.0";
   };
   regexp_parser = {
     groups = ["default" "development"];
     platforms = [];
     source = {
       remotes = ["https://rubygems.org"];
-      sha256 = "1fwfw26a32rps78920nn29shqg2zmqv72i89j1fap41isshida9m";
+      sha256 = "0jxl6c5cagjz5i5n9jplhdy2izad6wapmwgfhqggb22nqfvvdvas";
       type = "gem";
     };
-    version = "2.12.0";
+    version = "2.13.1";
   };
   reline = {
     dependencies = ["io-console"];
@@ -482,10 +482,10 @@
     platforms = [];
     source = {
       remotes = ["https://rubygems.org"];
-      sha256 = "0hl2pxa6nydnh3jmgrjkdgmsj19r5yblgialym74w5f5nmjw1d4y";
+      sha256 = "1q2nih91fjbv6j1qqxfhlc480zyhz94rniyh469vsw1fzd0q1xia";
       type = "gem";
     };
-    version = "1.90.0";
+    version = "1.92.0";
   };
   rubocop-ast = {
     dependencies = ["parser" "prism"];
@@ -535,10 +535,10 @@
     platforms = [];
     source = {
       remotes = ["https://rubygems.org"];
-      sha256 = "0y0ya82s3zi2wmkadnmb3l9r13mbsvd1g63n9mlp8bhb7zqmx0i5";
+      sha256 = "118fdpg7h1ny1fz6kmiyz6gccvwmb23h6bhsi1hdpf7ib4byq8ia";
       type = "gem";
     };
-    version = "1.1.1";
+    version = "1.3.2";
   };
   sys-uname = {
     dependencies = ["ffi" "memoist3"];
@@ -577,20 +577,20 @@
     platforms = [];
     source = {
       remotes = ["https://rubygems.org"];
-      sha256 = "0hiwhnqpq271xqari6mg996fgjps42sffm9cpk6ljn8sd2srdp8c";
+      sha256 = "04xnl0zwpjjvxipd6rdnxkm11pfhbhhi3179yzv51nqi9dmacyjb";
       type = "gem";
     };
-    version = "3.2.0";
+    version = "3.3.0";
   };
   unicode-emoji = {
     groups = ["default" "development"];
     platforms = [];
     source = {
       remotes = ["https://rubygems.org"];
-      sha256 = "03zqn207zypycbz5m9mn7ym763wgpk7hcqbkpx02wrbm1wank7ji";
+      sha256 = "1kp89lja8ii7l6f0bq5vdxq1p3kxr3a2qmmhdc38qdwh6akjzh0i";
       type = "gem";
     };
-    version = "4.2.0";
+    version = "4.3.0";
   };
   yard = {
     groups = ["development"];

data/lib/bashcov/lexer.rb

@@ -15,6 +15,34 @@ module Bashcov
     # Lines containing only one of these keywords are irrelevant for coverage
     IGNORE_IS = %w[esac if then else elif fi while do done { } ;; ( )].freeze
 
+    # Constructs spanning multiple lines, as +[regexp, forward]+ pairs tried in
+    # order. Regexps are anchored with +\G+ to match from a given line offset.
+    MULTILINE_PATTERNS = [
+      # multi-line arrays
+      [/\G[^\n]*\b=\([^()]*\)/, false],
+
+      # heredoc, possibly with a quoted delimiter (e.g. 'EOF', "EOF" or \EOF) -
+      # ends at the first line holding only the delimiter, which `<<-` also
+      # allows to be indented with tabs
+      [/\G[^\n]+<<[ \t]*\\?['"]?(\w+)['"]?[^\n]*\n(?:[^\n]*\n)*?\1$/, true],
+      [/\G[^\n]+<<-[ \t]*\\?['"]?(\w+)['"]?[^\n]*\n(?:[^\n]*\n)*?\t*\1$/, true],
+
+      # multiline string concatenated with backslashes
+      [/\G[^\n]+\\$(\s*['"][^'"]*['"]\s*\\$){1,}\s*['"][^'"]*['"]\s*$/, true],
+
+      # multiline string concatenated with newlines, possibly opened after a
+      # line continuation (but never after an unescaped newline) - this must
+      # come before simple line continuations which would claim the opening
+      # line otherwise - unlike single quotes, double quotes may contain escaped
+      # characters such as \"
+      *[false, true].product([["'", /[^']*/], ['"', /(?:[^"\\]|\\.)*/m]]).map do |forward, (char, body)|
+        [/\G[^\n]+(?:[ \t=]|\\\n[ \t]*)+#{char}#{body}#{char}/m, forward]
+      end,
+
+      # simple line continuations with backslashes
+      [/\G([^\n&|;]*[^\\&|;](\\\\)*\\\n)+[^\n&|;]*[^\n\\&|;](\\\\)*$/, true],
+    ].freeze
+
     # @param [String] filename File to analyze
     # @param [Hash] coverage Coverage with executed lines marked
     # @raise [ArgumentError] if the given +filename+ is invalid.
@@ -28,60 +56,46 @@ module Bashcov
     # Process and complete initial coverage.
     # @return [void]
     def complete_coverage
-      lines = File.read(@filename).encode("utf-8", invalid: :replace).lines
-
-      lines.each_with_index do |line, lineno|
-        # multi-line arrays
-        mark_multiline(
-          lines, lineno,
-          /\A[^\n]*\b=\([^()]*\)/,
-          forward: false,
-        )
-
-        # heredoc
-        mark_multiline(
-          lines, lineno,
-          /\A[^\n]+<<-?\s*'?(\w+)'?.*$.*\1/m,
-        )
-
-        # multiline string concatenated with backslashes
-        mark_multiline(
-          lines, lineno,
-          /\A[^\n]+\\$(\s*['"][^'"]*['"]\s*\\$){1,}\s*['"][^'"]*['"]\s*$/,
-        )
-
-        # simple line continuations with backslashes
-        mark_multiline(
-          lines, lineno,
-          /\A([^\n&|;]*[^\\&|;](\\\\)*\\\n)+[^\n&|;]*[^\n\\&|;](\\\\)*$/,
-        )
-
-        # multiline string concatenated with newlines
-        [false, true].each do |direction|
-          %w[' "].each do |char|
-            mark_multiline(
-              lines, lineno,
-              /\A[^\n]+[\s=]+#{char}[^#{char}]*#{char}/m,
-              forward: direction,
-            )
-          end
-        end
-
-        mark_line(line, lineno)
+      content = File.read(@filename).encode("utf-8", invalid: :replace)
+      lines = content.lines
+      offsets = lines.each_with_object([0]) { |line, memo| memo << (memo.last + line.size) }
+
+      lineno = 0
+      while lineno < lines.size
+        # skip ahead past a multiline construct once its lines are marked, but
+        # recheck its last line as it may open another one, e.g. `a'; b='`
+        last = mark_multilines(content, offsets[lineno], lineno) || lineno
+        lineno.upto(last) { |sub_lineno| mark_line(lines[sub_lineno], sub_lineno) }
+        lineno = (last > lineno ? last : last + 1)
       end
     end
 
   private
 
-    def mark_multiline(lines, lineno, regexp, forward: true)
-      # skip if we are already inside marked multiline string
-      return unless @coverage[lineno + 1].nil?
+    # @return [Integer, nil] last line of the multiline construct starting at
+    #   +lineno+, if any
+    def mark_multilines(content, offset, lineno)
+      MULTILINE_PATTERNS.each do |regexp, forward|
+        last = mark_multiline(content, offset, lineno, regexp, forward: forward)
+        return last if last
+      end
+
+      nil
+    end
 
-      seek_forward = lines[lineno..].join
-      return unless (multiline_match = seek_forward.match(regexp))
+    def mark_multiline(content, offset, lineno, regexp, forward: true)
+      # +regexp+ is anchored with \G so it only matches from +offset+
+      return unless (multiline_match = content.match(regexp, offset))
 
       length = multiline_match.to_s.count($/)
       first, last = lineno + 1, lineno + length
+
+      # skip if we are already inside marked multiline string - only inner
+      # lines are checked since Bash may report the hit on the last line
+      # (e.g. `readonly` before Bash 5.3), which is also the next line when
+      # the string spans only two lines
+      return unless first.upto(last - 1).all? { |i| @coverage[i].nil? }
+
       range = (forward ? first.upto(last) : (last - 1).downto(first - 1))
       reference_lineno = (forward ? first - 1 : last)
 
@@ -92,6 +106,8 @@ module Bashcov
         # mark related lines with the same coverage as the reference line
         @coverage[sub_lineno] ||= @coverage[reference_lineno]
       end
+
+      last if length.positive?
     end
 
     def mark_line(line, lineno)

data/lib/bashcov/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Cédric Félizard
@@ -27,16 +27,16 @@ dependencies:
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: benchmark
   requirement: !ruby/object:Gem::Requirement
@@ -69,16 +69,16 @@ dependencies:
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 11.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 11.1.1
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
@@ -268,7 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.22
 specification_version: 4
 summary: Code coverage tool for Bash
 test_files: []