bashcov 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8231d6219cf75be371db48df2d4d14f9db58401bc2636432a4b7352163bde782
-  data.tar.gz: 63f184fb4d8c15008d74d0b5c466cabfc3c0bde5b6f5527a1a92727b4f373f39
+  metadata.gz: a6b65a0c0d70e2ae93acb297d3d89fe9de010f4dbc63b92a025504c50bb1100b
+  data.tar.gz: 1cf1037ed383e6f4f0764f6991c0371326dcde1ebe340e5264aae855d5281174
 SHA512:
-  metadata.gz: 6217f58d4ad6eac425ba4dee9ae3144b4fdbd46d3f95bb5e63a02f67dd7d78f9442cae52879c0d73ad9b067fa873de5f3b0e6b331ab4a3edacbcd05f02de08c0
-  data.tar.gz: 621c56636e5b2594c36a6bdcc71d5445b520bd17b23c12a69352a21fb7cebbc7cf2fff4901927a6f58142235db69978fb47fa0583b381b0826d28c642a0ee391
+  metadata.gz: 596e7890b99b1fa1c23ecc42a64d092aeaaa9f03f5fb7181261df5d695405e33b1557de8c4218b591ded6aab4d0ecbaaae0929b4bc69bb83d43cc36d45df60d0
+  data.tar.gz: f442d9628a530ffad4058727c93eb25c30241f9a2c74199ab26ace4e704431e44e94f586df5a4fb1e7316f9c5800ab436014c16b203571e8f4625ffe17b42dbd

data/CHANGELOG.md

@@ -1,7 +1,20 @@
-## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v3.0.2...master))
+## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v3.1.0...master))
 
   * TBD
 
+## v3.1.0, 2023-09-28 ([changes](https://github.com/infertux/bashcov/compare/v3.0.3...v3.1.0))
+
+  * [FEATURE] Better diagnostics for runner result specs
+  * [BUGFIX]  Use `/usr/bin/env bash`
+  * [FEATURE] Initialize GitHub Actions workflow
+  * [MISC]    Make `Detective#shellscript_syntax?` private
+  * [BUGFIX]  Handle binary data
+  * [BUGFIX]  Fix Rubocop violations
+
+## v3.0.3, 2023-07-14 ([changes](https://github.com/infertux/bashcov/compare/v3.0.2...v3.0.3))
+
+  * [BUGFIX]  Improve shebang detection (#74)
+
 ## v3.0.2, 2023-04-18 ([changes](https://github.com/infertux/bashcov/compare/v3.0.1...v3.0.2))
 
   * [BUGFIX]  Match function names containing digits and colons

data/README.md

@@ -1,7 +1,6 @@
 # Bashcov
 
 [![Funding](https://img.shields.io/liberapay/patrons/infertux.svg?logo=liberapay)](https://liberapay.com/infertux/donate)
-[![Sponsors](https://img.shields.io/liberapay/patrons/infertux)](https://liberapay.com/infertux)
 [![Gem Version](https://img.shields.io/gem/v/bashcov.svg)](https://rubygems.org/gems/bashcov)
 [![Build Status](https://gitlab.com/infertux/bashcov/badges/master/pipeline.svg)](https://gitlab.com/infertux/bashcov/-/pipelines)
 [![Maintainability](https://api.codeclimate.com/v1/badges/083fdbba795049cd5f06/maintainability)](https://codeclimate.com/github/infertux/bashcov/maintainability)

data/lib/bashcov/detective.rb

@@ -38,8 +38,6 @@ module Bashcov
         (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
@@ -52,13 +50,33 @@ module Bashcov
         return false
       end
 
-      return false unless shebang[0..1] == "#!"
+      shellscript_shebang_line?(shebang)
+    end
+
+    # @param [String] shebang a line to test for shell shebang-itude
+    # @return [Boolean] whether the line is a valid shell shebang
+    def shellscript_shebang_line?(shebang)
+      scanner = StringScanner.new(shebang)
+
+      begin
+        return false if scanner.scan(/#!\s*/).nil?
+
+        shell = scanner.scan(/\S+/)
+
+        return false if shell.nil?
+
+        args = scanner.skip(/\s+/).nil? ? [] : scanner.rest.split(/\s+/)
+      rescue ArgumentError
+        # Handle "invalid byte sequence in UTF-8" from `StringScanner`.  Can
+        # happen when trying to read binary data (e.g. .pngs).
+        return false
+      end
 
-      shell, arg = shebang[2..].split(/\s+/, 2)
       shell_basename = File.basename(shell)
 
       SHELL_BASENAMES.include?(shell_basename) ||
-        (OTHER_BASENAMES.include?(shell_basename) && SHELL_BASENAMES.include?(arg))
+        (OTHER_BASENAMES.include?(shell_basename) &&
+          args.any? { |arg| SHELL_BASENAMES.include?(File.basename(arg)) })
     end
 
     # @param [String,Pathname] filename the name of the file to be checked
@@ -68,6 +86,8 @@ module Bashcov
       SHELLSCRIPT_EXTENSIONS.include? File.extname(filename)
     end
 
+  private
+
     # @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

data/lib/bashcov/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Cédric Félizard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2023-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -205,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Code coverage tool for Bash