Tweaks comments to match formatting convention

Author: infertux

lib/bashcov.rb

@@ -69,19 +69,19 @@ def command_name
     end
 
     def bash_path
-      # First attempt to use the value from `options`, but ignore all exceptions.
-      # This is used early for the `BASH_VERSION` definition, so first use will likely error.
+      # first attempt to use the value from `options`, but ignore all exceptions
+      # this is used early for the `BASH_VERSION` definition, so first use will likely error
       begin
         return @options.bash_path if @options.bash_path
       rescue NoMethodError; end # rubocop:disable Lint/SuppressedException
 
-      # Support the same `BASHCOV_BASH_PATH` environment variable used in the spec tests.
+      # support the same `BASHCOV_BASH_PATH` environment variable used in the spec tests
       return ENV.fetch("BASHCOV_BASH_PATH", nil) unless ENV.fetch("BASHCOV_BASH_PATH", "").empty?
 
-      # Fall back to standard Bash location, if available.
+      # fall back to standard Bash location, if available
       return "/bin/bash" if File.executable?("/bin/bash")
 
-      # Otherwise, try to execute a Bash from `PATH`.
+      # otherwise, try to execute a Bash from `PATH`
       "bash"
     end
 
@@ -112,7 +112,7 @@ def set_default_options!
   private
 
     def help
-      <<-HELP.gsub(/^ +/, "").gsub("\t", " " * 4)
+      <<~HELP.gsub("\t", " " * 4)
         Usage: #{program_name} [options] [--] <command> [options]
         Examples:
         \t#{program_name} ./script.sh
@@ -141,8 +141,9 @@ def option_parser
 
           options.bash_path = p
 
-          # Redefine `BASH_VERSION` constant with upated `bash_path`.
-          # This is hacky, but a lot of code references that constant and this should only have to be done once.
+          # redefine `BASH_VERSION` constant with updated `bash_path`, this is
+          # hacky, but a lot of code references that constant and this should
+          # only have to be done once
           send(:remove_const, "BASH_VERSION")
           const_set("BASH_VERSION", bash_version.freeze)
         end

lib/bashcov/detective.rb

@@ -43,7 +43,7 @@ def shellscript?(filename)
     #   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
+      # handle empty files that cause an immediate EOFError
       begin
         shebang = File.open(filename) { |f| f.readline.chomp }
       rescue EOFError
@@ -67,8 +67,8 @@ def shellscript_shebang_line?(shebang)
 
         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).
+        # handle "invalid byte sequence in UTF-8" from `StringScanner`, this can
+        # happen when trying to read binary data (e.g. .png)
         return false
       end
 

lib/bashcov/field_stream.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Bashcov
-  # Classes for streaming token-delimited fields
+  # Class for streaming token-delimited fields
   class FieldStream
     attr_accessor :read
 
@@ -43,7 +43,7 @@ def each(delimiter, field_count, start_match, &block)
         (field_count - chunk.size).times { yield "" }
       end
 
-      # Skip junk that might appear before the first start-of-fields match
+      # skip junk that might appear before the first start-of-fields match
       begin
         n, chunk = chunked.next
         yield_fields.call([n, chunk]) unless n.zero?

lib/bashcov/lexer.rb

@@ -99,17 +99,15 @@ def relevant?(line)
       line.sub!(/\s#.*\Z/, "") # remove comments
       line.strip!
 
-      relevant = true
+      return false if line.empty? ||
+                      IGNORE_IS.include?(line) ||
+                      line.start_with?(*IGNORE_START_WITH) ||
+                      line.end_with?(*IGNORE_END_WITH)
 
-      relevant &= false if line.empty? ||
-                           IGNORE_IS.include?(line) ||
-                           line.start_with?(*IGNORE_START_WITH) ||
-                           line.end_with?(*IGNORE_END_WITH)
+      return false if line =~ /\A[a-zA-Z_][a-zA-Z0-9_\-:]*\(\)/ # function declared without the `function` keyword
+      return false if line =~ /\A[^)]+\)\Z/ # case statement selector, e.g. `--help)`
 
-      relevant &= false if line =~ /\A[a-zA-Z_][a-zA-Z0-9_\-:]*\(\)/ # function declared without the `function` keyword
-      relevant &= false if line =~ /\A[^)]+\)\Z/ # case statement selector, e.g. `--help)`
-
-      relevant
+      true
     end
   end
 end

lib/bashcov/line.rb

@@ -4,11 +4,11 @@ module Bashcov
   # {Line} represents a line of code.
   module Line
     # Uncovered line
-    # @see http://ruby-doc.org/stdlib-2.3.0/libdoc/coverage/rdoc/Coverage.html
+    # @see http://ruby-doc.org/stdlib-3.0.0/libdoc/coverage/rdoc/Coverage.html
     UNCOVERED = 0
 
     # Ignored line
-    # @see http://ruby-doc.org/stdlib-2.3.0/libdoc/coverage/rdoc/Coverage.html
+    # @see http://ruby-doc.org/stdlib-3.0.0/libdoc/coverage/rdoc/Coverage.html
     IGNORED = nil
   end
 end

lib/bashcov/runner.rb

@@ -23,8 +23,7 @@ def initialize(command)
     # @note Binds Bashcov +stdin+ to the program being executed.
     # @return [Process::Status] Status of the executed command
     def run
-      # Clear out previous run
-      @result = nil
+      @result = nil # clear out previous run
 
       field_stream = FieldStream.new
       @xtrace = Xtrace.new(field_stream)

lib/bashcov/xtrace.rb

@@ -114,9 +114,9 @@ def read
     # @raise [XtraceError] when +lineno+ is not composed solely of digits,
     #   indicating that something has gone wrong with parsing the +PS4+ fields
     def parse_hit!(lineno, *paths)
-      # 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.
+      # if +LINENO+ isn't a series of digits, add +@files+ to the exception in
+      # order to propagate the existing coverage data back to the
+      # {Bashcov::Runner} instance
       if /\A\d+\z/.match?(lineno)
         lineno = lineno.to_i
       elsif lineno == "${LINENO-}"
@@ -128,15 +128,14 @@ def parse_hit!(lineno, *paths)
         )
       end
 
-      # The next three fields will be $BASH_SOURCE, $PWD, $OLDPWD, and $LINENO
       bash_source, pwd, oldpwd = paths.map { |p| Pathname.new(p) }
 
       update_wd_stacks!(pwd, oldpwd)
 
       script = find_script(bash_source)
 
-      # For one-liners, +LINENO+ == 0. Do this to avoid an +IndexError+;
-      # one-liners will be culled from the coverage results later on.
+      # for one-liners, +LINENO+ == 0, do this to avoid an +IndexError+
+      # one-liners will be culled from the coverage results later on
       index = (lineno > 1 ? lineno - 1 : 0)
 
       @files[script] ||= []
@@ -172,16 +171,16 @@ def update_wd_stacks!(pwd, oldpwd)
       @pwd_stack[0] ||= pwd
       @oldpwd_stack[0] ||= oldpwd unless oldpwd.to_s.empty?
 
-      # We haven't changed working directories; short-circuit.
+      # return if we haven't changed working directories
       return if pwd == @pwd_stack[-1]
 
-      # If the current +pwd+ is identical to the top of the +@oldpwd_stack+ and
+      # if the current +pwd+ is identical to the top of the +@oldpwd_stack+ and
       # the current +oldpwd+ is identical to the second-to-top entry, then a
-      # previous cd/pushd has been undone.
+      # previous cd/pushd has been undone
       if pwd == @oldpwd_stack[-1] && oldpwd == @oldpwd_stack[-2]
         @pwd_stack.pop
         @oldpwd_stack.pop
-      else # New cd/pushd
+      else # new cd/pushd
         @pwd_stack << pwd
         @oldpwd_stack << oldpwd
       end