bashcov 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69ae560709ca922d5768a2755b4c9f9fa0de60d9
-  data.tar.gz: c0ccca240348b0736dca3357af5412c98159466a
+  metadata.gz: 4f9c5cde335ec3f77c2e8671870587c91c0b7921
+  data.tar.gz: 3aa49b58a3030285aa9dbdbd6852d1090f9770b0
 SHA512:
-  metadata.gz: 7032cb66094fa7f79ae7916eb93dc58e814d5e46cac8fce6a0006ec8370c9f18a8aba2de2a9f642e5c984e3a992e28e98cd59664a8d5828afa45bf33c5f6f5bf
-  data.tar.gz: 2ed6423accb917c077797224efe9644668349be5adb05ccd32b37413b8904bc1a560b566c871cde50331017bcd557ffdb6e75309822bd0cd58481ae0a6666f91
+  metadata.gz: fe850cf7e3ff9c56889b853bbb128aeaf4cf4da97702308b2df1ba67f24ec4161c1d96f9dd0ca14d308dc0b8ae374850bd295891e55c94cf25bd7ff8e01bb87f
+  data.tar.gz: ccf1e25f9be556328f8f6abf311ff95a2161af389f387aa1a2c611fa3f8b8683d954fcd4b710ad337bb5ba6e85d84206cf1dbf2d09ef6c5c2345cdbf215429ab

data/CHANGELOG.md

@@ -1,7 +1,15 @@
-## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v1.6.0...master))
+## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v1.7.0...master))
 
   * TBD
 
+## v1.7.0, 2017-12-28 ([changes](https://github.com/infertux/bashcov/compare/v1.6.0...v1.7.0))
+
+  * [MISC]    Add support for Ruby 2.5 and drop 2.2
+  * [BUGFIX]  Fix issue where coverage would be run twice and overwritten (#33)
+  * [FEATURE] Enhance shell script detection by parsing shebangs, checking
+              filename extensions, and running syntax checks with `bash -n`
+              (classes `Detective` & `Runner`) (#30)
+
 ## v1.6.0, 2017-10-24 ([changes](https://github.com/infertux/bashcov/compare/v1.5.1...v1.6.0))
 
   * [BUGFIX]  Don't crash when files contain invalid UTF-8 characters (#27)

data/README.md

@@ -1,10 +1,10 @@
 # Bashcov
 
+[![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)
-[![Dependency Status](https://gemnasium.com/infertux/bashcov.png)](https://gemnasium.com/infertux/bashcov)
-[![Code Climate](https://codeclimate.com/github/infertux/bashcov.png)](https://codeclimate.com/github/infertux/bashcov)
 [![Coverage Status](https://coveralls.io/repos/infertux/bashcov/badge.png?branch=master)](https://coveralls.io/r/infertux/bashcov)
-[![Gem Version](https://img.shields.io/gem/v/bashcov.svg)](https://rubygems.org/gems/bashcov)
+[![Dependency Status](https://gemnasium.com/infertux/bashcov.png)](https://gemnasium.com/infertux/bashcov)
+[![Maintainability](https://api.codeclimate.com/v1/badges/083fdbba795049cd5f06/maintainability)](https://codeclimate.com/github/infertux/bashcov/maintainability)
 
 **Code coverage for Bash**
 

data/bashcov.gemspec

@@ -21,7 +21,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.2.7"
+  gem.required_ruby_version = ">= 2.3.0"
 
   gem.add_dependency "simplecov", "~> 0.15"
 

data/bin/bashcov

@@ -16,6 +16,6 @@ require "simplecov"
 
 SimpleCov.command_name Bashcov.fullname
 SimpleCov.root Bashcov.root_directory
-SimpleCov::Result.new(coverage).format!
+SimpleCov.at_exit { SimpleCov::Result.new(coverage).format! }
 
 exit status.exitstatus

data/lib/bashcov.rb

@@ -59,7 +59,13 @@ 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} #{VERSION} (bash #{BASH_VERSION})"
+      [
+        program_name,
+        VERSION,
+        "(with Bash #{BASH_VERSION},",
+        "Ruby #{RUBY_VERSION},",
+        "and SimpleCov #{SimpleCov::VERSION})",
+      ].join(" ")
     end
 
     # Wipe the current options and reset default values

data/lib/bashcov/detective.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "set"
+
+module Bashcov
+  # Detect shell scripts
+  class Detective
+    # [Set<String>] Basenames of shell executables
+    SHELL_BASENAMES = Set.new(%w[bash sh ash dash]).freeze
+
+    # [Set<String>] Basenames of executables commonly used to +exec+ other
+    #   processes, including shells
+    OTHER_BASENAMES = Set.new(%w[env]).freeze
+
+    # [Set<String>] Filename extensions commonly used for shell scripts
+    SHELLSCRIPT_EXTENSIONS = Set.new(%w[.bash .sh]).freeze
+
+    # Create an object that can be used for inferring whether a file is or is
+    # not a shell script.
+    # @param [String] bash_path path to a Bash interpreter
+    def initialize(bash_path)
+      @bash_path = bash_path
+    end
+
+    # Checks whether the provided file refers to a shell script by
+    # determining whether the first line is a shebang that refers to a shell
+    # executable, or whether the file has a shellscript extension and contains
+    # valid shell syntax.
+    # @param [String,Pathname] filename the name of the file to be checked
+    # @return [Boolean] whether +filename+ refers to a shell script
+    # @note returns +false+ when +filename+ is not readable, even if +filename+
+    #   indeed refers to a shell script.
+    def shellscript?(filename)
+      return false unless File.exist?(filename) && File.readable?(filename) \
+        && File.file?(File.realpath(filename))
+
+      shellscript_shebang?(filename) || \
+        (shellscript_extension?(filename) && shellscript_syntax?(filename))
+    end
+
+  private
+
+    # @param [String,Pathname] filename the name of the file to be checked
+    # @return [Boolean] whether +filename+'s first line is a valid shell
+    #   shebang
+    # @note assumes that +filename+ is readable and refers to a regular file
+    def shellscript_shebang?(filename)
+      # Handle empty files that cause an immediate EOFError
+      begin
+        shebang = File.open(filename) { |f| f.readline.chomp }
+      rescue EOFError
+        return false
+      end
+
+      return false unless shebang[0..1] == "#!"
+
+      shell, arg = shebang[2..-1].split(/\s+/, 2)
+      shell_basename = File.basename(shell)
+
+      SHELL_BASENAMES.include?(shell_basename) || \
+        (OTHER_BASENAMES.include?(shell_basename) && SHELL_BASENAMES.include?(arg))
+    end
+
+    # @param [String,Pathname] filename the name of the file to be checked
+    # @return [Boolean] whether +filename+'s extension is a valid shellscript
+    # extension
+    def shellscript_extension?(filename)
+      SHELLSCRIPT_EXTENSIONS.include? File.extname(filename)
+    end
+
+    # @param [String,Pathname] filename the name of the file to be checked
+    # @return [Boolean] whether +filename+'s text matches valid shell syntax
+    # @note assumes that +filename+ is readable and refers to a regular file
+    def shellscript_syntax?(filename)
+      system(@bash_path, "-n", filename.to_s, in: :close, out: :close, err: :close)
+      $?.success?
+    end
+  end
+end

data/lib/bashcov/field_stream.rb

@@ -34,9 +34,7 @@ module Bashcov
     #   since the last match, yields empty strings until +field_count+ is
     #   reached.
     def each(delimiter, field_count, start_match)
-      unless block_given?
-        return enum_for(__method__, delimiter, field_count, start_match)
-      end
+      return enum_for(__method__, delimiter, field_count, start_match) unless block_given?
 
       # Whether the current field is the start-of-fields match
       matched_start = nil

data/lib/bashcov/lexer.rb

@@ -22,9 +22,7 @@ module Bashcov
       @filename = filename
       @coverage = coverage
 
-      unless File.file?(@filename) # rubocop:disable Style/GuardClause
-        raise ArgumentError, "#{@filename} is not a file"
-      end
+      raise ArgumentError, "#{@filename} is not a file" unless File.file?(@filename)
     end
 
     # Process and complete initial coverage.

data/lib/bashcov/runner.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "bashcov/detective"
 require "bashcov/errors"
 require "bashcov/field_stream"
 require "bashcov/lexer"
@@ -11,6 +12,7 @@ module Bashcov
     # @param [String] command Command to run
     def initialize(command)
       @command = command
+      @detective = Detective.new(Bashcov.bash_path)
     end
 
     # Runs the command with appropriate xtrace settings.
@@ -74,8 +76,11 @@ module Bashcov
   private
 
     def write_warning(message)
-      warn format "%s: warning: %s", Bashcov.program_name,
-                  message.gsub(/^\s+/, "").lines.map(&:chomp).join(" ")
+      warn [
+        Bashcov.program_name,
+        ": warning: ",
+        message.gsub(/^\s+/, "").lines.map(&:chomp).join(" "),
+      ].join
     end
 
     def run_xtrace(fd, env, options)
@@ -123,8 +128,10 @@ module Bashcov
     def find_bash_files!
       return if Bashcov.skip_uncovered
 
-      Pathname.glob("#{Bashcov.root_directory}/**/*.sh").each do |filename|
-        @coverage[filename] = [] unless @coverage.include?(filename)
+      Pathname.new(Bashcov.root_directory).find do |filename|
+        if !@coverage.include?(filename) && @detective.shellscript?(filename)
+          @coverage[filename] = []
+        end
       end
     end
 

data/lib/bashcov/version.rb

@@ -3,5 +3,5 @@
 # :nodoc:
 module Bashcov
   # Current Bashcov version
-  VERSION = "1.6.0".freeze
+  VERSION = "1.7.0"
 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 = "+".freeze
+    DEPTH_CHAR = "+"
 
     # [String] Prefix used in +PS4+ to identify relevant output
-    PREFIX = "BASHCOV>".freeze
+    PREFIX = "BASHCOV>"
 
     # [Array<String>] A collection of Bash internal variables to expand in the
     #   {PS4}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Cédric Félizard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2017-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -127,6 +127,7 @@ files:
 - bin/bashcov
 - lib/bashcov.rb
 - lib/bashcov/bash_info.rb
+- lib/bashcov/detective.rb
 - lib/bashcov/errors.rb
 - lib/bashcov/field_stream.rb
 - lib/bashcov/lexer.rb
@@ -146,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.7
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -154,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Code coverage tool for Bash