bashcov 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3681e4625478878ae7c5a9438d92c4e4a7997d4f
-  data.tar.gz: 0e3658daf9c4a2826da7df042565f38d56e22327
+  metadata.gz: a38548d5c6225411e74a70bc3de2982531e83d15
+  data.tar.gz: b8df3975562e21dbbd9acde6fa4413d79d0197ab
 SHA512:
-  metadata.gz: 2221d53847bfcfae69bb7594075e864dba7942aa83171ac9a75bd54ae4ded53b5904138a5856fd9e5bb2090910e306a533222bc87867d41fe51ddd4e48dfe2de
-  data.tar.gz: 9110bebfcdce140144574f9d64702720a09f727db0562e73202df1ebb71482e57fedfd6d0c1921453da2e16b79bf21eaa294e3a9525d6d751f8170f9d8eafc49
+  metadata.gz: 0aac1da4bfb28a0edab21b6bf1c02bd2215a8d301176d005436b92da6f1c5b7a03c19aa60b3ad5ff88fa9e72e3029a4f5734b39ce41e6dc70ae6f66de8495163
+  data.tar.gz: 46decd7f48918f1e57af03033aecaaac8f3d761e8904458ce3c3acb95b1ad91d171853d2d57f5213419ea514722a946dc29d8ed98fd2a0dd79a824a48cac84e0

data/CHANGELOG.md

@@ -1,7 +1,15 @@
-## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v1.3.1...master))
+## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v1.4.0...master))
 
   * TBD
 
+## v1.4.0, 2016-10-08 ([changes](https://github.com/infertux/bashcov/compare/v1.3.1...v1.4.0))
+
+  * [BUGFIX]  Fix incorrect coverage for case statements (#21)
+  * [BUGFIX]  Fix rare race condition leading to a crash when a file is deleted at the wrong moment
+  * [FEATURE] Add support for heredoc and multiline strings in general (#2)
+  * [MISC]    Set up Travis CI to test Bashcov with Bash 4.0 through 4.4
+  * [MISC]    Drop support for old Ruby versions (2.0 and 2.1)
+
 ## v1.3.1, 2016-02-19 ([changes](https://github.com/infertux/bashcov/compare/v1.3.0...v1.3.1))
 
   * [FEATURE] Add support back for Ruby 2.0.0 until it's officially EOL

data/bashcov.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{\Abin/}).map { |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = ">= 2.0.0"
+  gem.required_ruby_version = ">= 2.2.5"
 
   gem.add_dependency "simplecov", "~> 0.11"
 

data/lib/bashcov/bash_info.rb

@@ -6,15 +6,9 @@ module Bashcov
   #   runtime
   # @note receiver is expected to implement +bash_path+
   module BashInfo
-    # @return [Array<String>] An array representing the components of
-    #   +BASH_VERSINFO+
-    def bash_versinfo
-      `#{bash_path} -c 'echo "${BASH_VERSINFO[@]}"'`.chomp.split
-    end
-
     # @return [Boolean] Whether Bash supports +BASH_XTRACEFD+
     def bash_xtracefd?
-      bash_versinfo[0..1].join.to_i >= 41
+      BASH_VERSION >= "4.1"
     end
 
     # @param [Integer] length the number of bytes to test; default 128

data/lib/bashcov/field_stream.rb

@@ -63,8 +63,8 @@ module Bashcov
           matched_start = nil
           seen_fields = 0
         elsif seen_fields < field_count
-            yield field
-            seen_fields += 1
+          yield field
+          seen_fields += 1
         end
       end
 

data/lib/bashcov/lexer.rb

@@ -22,34 +22,58 @@ module Bashcov
       @filename = filename
       @coverage = coverage
 
-      unless File.file?(@filename)
+      unless File.file?(@filename) # rubocop:disable Style/GuardClause
         raise ArgumentError, "#{@filename} is not a file"
       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!
 
-      !line.empty? and
-        !IGNORE_IS.include? line and
-        !line.start_with?(*IGNORE_START_WITH) and
-        !line.end_with?(*IGNORE_END_WITH) and
-        line !~ /\A\w+\(\)/ # function declared without the 'function' keyword
+      relevant = true
+
+      relevant &= false if line.empty? ||
+                           IGNORE_IS.include?(line) ||
+                           line.start_with?(*IGNORE_START_WITH) ||
+                           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
     end
   end
 end

data/lib/bashcov/runner.rb

@@ -99,7 +99,7 @@ module Bashcov
         end
       end
 
-      inject_xtrace_flag! do
+      with_xtrace_flag do
         yield
       end
     end
@@ -108,7 +108,7 @@ module Bashcov
     # @yield [void] adds "xtrace" to +SHELLOPTS+ and then runs the provided
     #   block
     # @return [Object, ...] the value returned by the calling block
-    def inject_xtrace_flag!
+    def with_xtrace_flag
       existing_flags_s = ENV["SHELLOPTS"]
       existing_flags = (existing_flags_s || "").split(":")
       ENV["SHELLOPTS"] = (existing_flags | ["xtrace"]).join(":")
@@ -146,9 +146,7 @@ module Bashcov
     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
 

data/lib/bashcov/version.rb

@@ -3,5 +3,5 @@
 # :nodoc:
 module Bashcov
   # Current Bashcov version
-  VERSION = "1.3.1"
+  VERSION = "1.4.0".freeze
 end

data/lib/bashcov/xtrace.rb

@@ -12,10 +12,10 @@ module Bashcov
   class Xtrace
     # [String] Character that will be used to indicate the nesting level of
     #   +xtrace+d instructions
-    DEPTH_CHAR = "+"
+    DEPTH_CHAR = "+".freeze
 
     # [String] Prefix used in +PS4+ to identify relevant output
-    PREFIX = "BASHCOV>"
+    PREFIX = "BASHCOV>".freeze
 
     # [Array<String>] A collection of Bash internal variables to expand in the
     #   {PS4}
@@ -115,11 +115,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.
-      unless lineno =~ /\A\d+\z/
-        lineno_err = lineno.empty? ? nil : lineno
-
+      if lineno =~ /\A\d+\z/
+        lineno = lineno.to_i
+      else
         raise XtraceError.new(
-          "expected integer for LINENO, got `#{lineno_err.inspect}'", @files
+          "expected integer for LINENO, got #{lineno.inspect}", @files
         )
       end
 
@@ -132,7 +132,7 @@ module Bashcov
 
       # For one-liners, +LINENO+ == 0. Do this to avoid an +IndexError+;
       # one-liners will be culled from the coverage results later on.
-      index = (lineno_i = lineno.to_i) > 1 ? lineno_i - 1 : 0
+      index = (lineno > 1 ? lineno - 1 : 0)
 
       @files[script] ||= []
       @files[script][index] ||= 0
@@ -148,7 +148,14 @@ module Bashcov
     #   otherwise, +bash_source+ cleaned of redundant slashes and dots
     def find_script(bash_source)
       script = @pwd_stack.reverse.map { |wd| wd + bash_source }.find(&:file?)
-      script.nil? ? bash_source.cleanpath : script.realpath
+
+      return bash_source.cleanpath if script.nil?
+
+      begin
+        script.realpath
+      rescue Errno::ENOENT # catch race condition if the file has been deleted
+        bash_source.cleanpath
+      end
     end
 
     # Updates the stacks that track the history of values for +PWD+ and

data/lib/bashcov.rb

@@ -18,6 +18,15 @@ module Bashcov
   )
 
   class << self
+    # Define option accessors
+    Options.new.members.each do |option|
+      [option, "#{option}="].each do |method|
+        define_method method do |*args|
+          options.public_send(*[method, *args])
+        end
+      end
+    end
+
     # @return [Struct] The +Struct+ object representing Bashcov configuration
     def options
       set_default_options! unless defined?(@options)
@@ -50,7 +59,7 @@ module Bashcov
     # @return [String] Program name including version for easy consistent output
     # @note +fullname+ instead of name to avoid clashing with +Module.name+
     def fullname
-      "#{program_name} v#{VERSION}"
+      "#{program_name} #{VERSION} (bash #{BASH_VERSION})"
     end
 
     # Wipe the current options and reset default values
@@ -65,16 +74,6 @@ module Bashcov
 
   private
 
-    # Passes off +respond_to?+ to {options} for missing methods
-    def respond_to_missing?(*args)
-      options.respond_to?(*args)
-    end
-
-    # Dispatches missing methods to {options}
-    def method_missing(method_name, *args, &block)
-      options.public_send(method_name, *args, &block)
-    end
-
     def help
       <<-HELP.gsub(/^ +/, "").gsub("\t", " " * 4)
         Usage: #{program_name} [options] [--] <command> [options]
@@ -121,4 +120,7 @@ module Bashcov
       end
     end
   end
+
+  # Current Bash version (e.g. 4.2)
+  BASH_VERSION = `#{bash_path} -c 'echo -n ${BASH_VERSINFO[0]}.${BASH_VERSINFO[1]}'`.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Cédric Félizard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-19 00:00:00.000000000 Z
+date: 2016-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -174,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -187,4 +187,3 @@ signing_key:
 specification_version: 4
 summary: Code coverage tool for Bash
 test_files: []
-has_rdoc: