Fix coverage for heredoc and multiline strings

Mark subsequent lines with the same coverage as the first line.

[Fixes #2]

Author: infertux

lib/bashcov/lexer.rb

@@ -27,21 +27,38 @@ def initialize(filename, coverage)
       end
     end
 
-    # Yields uncovered relevant lines.
-    # @note Uses +@coverage+ to avoid wasting time parsing executed lines.
+    # Process and complete initial coverage.
     # @return [void]
-    def uncovered_relevant_lines
-      lineno = 0
-      File.open(@filename, "rb").each_line do |line|
-        if @coverage[lineno] == Bashcov::Line::IGNORED && relevant?(line)
-          yield lineno
-        end
-        lineno += 1
+    def complete_coverage
+      lines = File.read(@filename).lines
+
+      lines.each_with_index do |line, lineno|
+        mark_multiline(lines, lineno, /\A[^\n]+<<-?'?(\w+)'?\s*$.*\1/m) # heredoc
+        mark_multiline(lines, lineno, /\A[^\n]+\\$(\s*['"][^'"]*['"]\s*\\$){1,}\s*['"][^'"]*['"]\s*$/) # multiline string
+
+        mark_line(line, lineno)
       end
     end
 
   private
 
+    def mark_multiline(lines, lineno, regexp)
+      seek_forward = lines[lineno..-1].join
+      return unless (multiline_match = seek_forward.match(regexp))
+
+      length = multiline_match.to_s.count($/)
+      (lineno + 1).upto(lineno + length).each do |sub_lineno|
+        # mark subsequent lines with the same coverage as the first line
+        @coverage[sub_lineno] = @coverage[lineno]
+      end
+    end
+
+    def mark_line(line, lineno)
+      return unless @coverage[lineno] == Bashcov::Line::IGNORED
+
+      @coverage[lineno] = Bashcov::Line::UNCOVERED if relevant?(line)
+    end
+
     def relevant?(line)
       line.sub!(/ #.*\Z/, "") # remove comments
       line.strip!

lib/bashcov/runner.rb

@@ -146,9 +146,7 @@ def expunge_invalid_files!
     def mark_relevant_lines!
       @coverage.each_pair do |filename, coverage|
         lexer = Lexer.new(filename, coverage)
-        lexer.uncovered_relevant_lines do |lineno|
-          @coverage[filename][lineno] = Bashcov::Line::UNCOVERED
-        end
+        lexer.complete_coverage
       end
     end
 

spec/bashcov/runner_spec.rb

@@ -171,7 +171,14 @@
   describe "#result" do
     it "returns the expected coverage hash" do
       runner.run
-      expect(runner.result).to eq expected_coverage
+      result = runner.result
+
+      expected_coverage.each do |file, expected_hits|
+        result[file].each_with_index do |actual_hit, lineno|
+          expected = expected_hits.fetch(lineno)
+          expect(actual_hit).to eq(expected), "#{file}:#{lineno.succ} expected #{expected.inspect}, got #{actual_hit.inspect}"
+        end
+      end
     end
 
     context "with skip_uncovered = true" do

spec/support/test_app.rb

@@ -17,7 +17,7 @@ def expected_coverage
     "#{test_app}/never_called.sh" => [nil, nil, 0],
     "#{test_app}/scripts/case.sh" => [nil, nil, nil, 2, nil, 1, nil, nil, 0, 1, nil, nil, nil, 1, 1],
     "#{test_app}/scripts/cd.sh" => [nil, nil, 1, 2, nil, 3, 1, 3, nil, 2, nil, nil, 1, nil, 3, nil, 6, nil, 1, nil, 1],
-    "#{test_app}/scripts/delete.sh" => [nil, nil, 1, nil, 0, 0, nil, 1, 1],
+    "#{test_app}/scripts/delete.sh" => [nil, nil, 1, 1, 1, 1, nil, 1, 1],
     "#{test_app}/scripts/function.sh" => [nil, nil, nil, 2, nil, nil, nil, 1, 1, nil, nil, nil, nil, 1, nil, nil, 1, 1, 1],
     "#{test_app}/scripts/long_line.sh" => [nil, nil, 1, 1, 1, 0],
     "#{test_app}/scripts/nested/simple.sh" => [nil, nil, nil, nil, 1, 1, nil, 0, nil, nil, 1],
@@ -29,7 +29,7 @@ def expected_coverage
     "#{test_app}/scripts/source.sh" => [nil, nil, 1, nil, 2],
     "#{test_app}/scripts/sourced.txt" => [nil, nil, 1],
     "#{test_app}/scripts/unicode.sh" => [nil, nil, nil, 1],
-    "#{test_app}/scripts/multiline.sh" => [nil, nil, nil, 1, nil, 0, nil, 1, nil, 1, nil, 0, nil, nil, 1, 2, 1, 1, 0, nil, nil, nil, nil, 2, nil, nil, nil, 1, 1],
+    "#{test_app}/scripts/multiline.sh" => [nil, nil, nil, 1, nil, 0, nil, 1, nil, 1, nil, 0, nil, nil, 1, 2, 1, 1, 0, nil, nil, 2, nil, nil, 1, 1, 1, 1, nil, 1, 1, 1, 1, 1, nil, 1],
     "#{test_app}/scripts/executable" => [nil, nil, 1],
     "#{test_app}/scripts/exit_non_zero.sh" => [nil, nil, 1],
     "#{test_app}/test_suite.sh" => [nil, nil, 2, nil, 1],

spec/test_app/scripts/multiline.sh

@@ -19,11 +19,18 @@ fi # nil
   echo 'no!'
 # nil
 # nil
-variable=($( # nil
-  echo hi
-)) # 2
+variable=($(echo hi)) # 2
 # nil
 # nil
+echo "after 1" \
+  "after 2" \
+  "after 3" \
+  "after 4"
 # nil
-echo after1 # 1
-echo after2 # 1
+cat <<EOF
+this is
+        a cat!
+  actually it's a $SHELL
+EOF
+# nil
+echo the end # 1