bashcov 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f9c5cde335ec3f77c2e8671870587c91c0b7921
-  data.tar.gz: 3aa49b58a3030285aa9dbdbd6852d1090f9770b0
+  metadata.gz: 663e369ac45484a1d8df36ec47520edc2a5bd5b5
+  data.tar.gz: 3016f906c0b63a1c8d9125c32c197cb1a44bf7f1
 SHA512:
-  metadata.gz: fe850cf7e3ff9c56889b853bbb128aeaf4cf4da97702308b2df1ba67f24ec4161c1d96f9dd0ca14d308dc0b8ae374850bd295891e55c94cf25bd7ff8e01bb87f
-  data.tar.gz: ccf1e25f9be556328f8f6abf311ff95a2161af389f387aa1a2c611fa3f8b8683d954fcd4b710ad337bb5ba6e85d84206cf1dbf2d09ef6c5c2345cdbf215429ab
+  metadata.gz: f977398907a51277dbca731ce8351c366324d13b4df904ffbf369bd49ec2f1d08c2417a3d9c5f7667822a7e0bc2ab2cba60c3eb708dddeb291d0144e6a231819
+  data.tar.gz: 9e122bfd8679f6422b2c974d4afb990a567662c8279f3d6d4ec709521ffbb61530890ea8ccc9a65da72b9e2758b742172e126d22ca903117f461311aa8515a8c

data/CHANGELOG.md

@@ -1,7 +1,15 @@
-## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v1.7.0...master))
+## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v1.8.0...master))
 
   * TBD
 
+## v1.8.0, 2018-01-13 ([changes](https://github.com/infertux/bashcov/compare/v1.7.0...v1.8.0))
+
+  * [FEATURE] Merge coverage results from multiple runs when
+              `SimpleCov.use_merging` is set to `true`. Auto-generate
+              likely-unique values for `SimpleCov.command_name`, providing the
+              `--command-name` option and `BASHCOV_COMMAND_NAME` environment
+              variable for users to set a command name explicitly (#34)
+
 ## 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

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2017 Cédric Félizard
+Copyright (c) 2012-2018 Cédric Félizard
 
 MIT License
 

data/README.md

@@ -60,6 +60,35 @@ your project's root (like [this](https://github.com/infertux/bashcov/blob/master
 See [SimpleCov README](https://github.com/colszowka/simplecov#readme) for more
 information.
 
+#### Controlling the command name
+
+Bashcov respects all of your `.simplecov` settings save one --
+[`SimpleCov.command_name`](http://www.rubydoc.info/gems/simplecov/SimpleCov/Configuration#command_name-instance_method),
+which is the tag that SimpleCov attaches to coverage results from a particular
+test suite. You can set the value of `SimpleCov.command_name` by using
+Bashcov's `--command-name` option, or by assigning a value to the environment
+variable `BASHCOV_COMMAND_NAME`. Otherwise, Bashcov will generate a command
+name for you based on the name of the currently-executing Bash script and any
+arguments passed to it. For example, assuming your Bash lives at `/bin/bash`
+and you run the command
+
+```
+$ bashcov -- ./test_suite.sh --and some --flags
+```
+
+Bashcov will set `SimpleCov.command_name` to `"/bin/bash ./test_suite.sh --and
+some --flags"`. Basing `SimpleCov.command_name` on the executing command helps
+to ensure that multiple coverage runs don't [overwrite each other's
+results](https://github.com/colszowka/simplecov#test-suite-names) due to
+SimpleCov identifying multiple runs by the same tag. The `--command-name` and
+`BASHCOV_COMMAND_NAME` knobs are there for you to twiddle in case your test
+suite runs the exact same `bashcov` command more than once, in which case the
+generated command name will not distinguish each invocation from the others.
+
+For more info on `SimpleCov.command_name` and its relation to SimpleCov's
+result-merging behavior, see the [SimpleCov
+README](https://github.com/colszowka/simplecov#merging-results).
+
 ### Some gory details
 
 Figuring out where an executing Bash script lives in the file system can be

data/Rakefile

@@ -2,6 +2,9 @@
 
 require "bundler/gem_tasks"
 
+require "cucumber/rake/task"
+Cucumber::Rake::Task.new
+
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.ruby_opts = "-w"
@@ -10,4 +13,4 @@ end
 require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
-task default: %i[rubocop spec]
+task default: %i[rubocop spec cucumber]

data/bashcov.gemspec

@@ -25,7 +25,9 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "simplecov", "~> 0.15"
 
+  gem.add_development_dependency "aruba", "~> 0.14.3"
   gem.add_development_dependency "coveralls"
+  gem.add_development_dependency "cucumber"
   gem.add_development_dependency "mutant-rspec"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"

data/bin/bashcov

@@ -14,8 +14,20 @@ coverage = runner.result
 
 require "simplecov"
 
-SimpleCov.command_name Bashcov.fullname
+SimpleCov.start
+
+SimpleCov.command_name Bashcov.command_name
 SimpleCov.root Bashcov.root_directory
-SimpleCov.at_exit { SimpleCov::Result.new(coverage).format! }
+
+result = SimpleCov::Result.new(coverage)
+if SimpleCov.use_merging
+  SimpleCov::ResultMerger.store_result(result)
+  result = SimpleCov::ResultMerger.merged_result
+end
+
+SimpleCov.at_exit do
+  puts "Run completed using #{Bashcov.fullname}"
+  result.format!
+end
 
 exit status.exitstatus

data/lib/bashcov.rb

@@ -14,19 +14,10 @@ module Bashcov
 
   # A +Struct+ to store Bashcov configuration
   Options = Struct.new(
-    *%i[skip_uncovered mute bash_path root_directory command]
+    *%i[skip_uncovered mute bash_path root_directory command command_name]
   )
 
   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)
@@ -62,12 +53,22 @@ module Bashcov
       [
         program_name,
         VERSION,
-        "(with Bash #{BASH_VERSION},",
+        "with Bash #{BASH_VERSION},",
         "Ruby #{RUBY_VERSION},",
-        "and SimpleCov #{SimpleCov::VERSION})",
+        "and SimpleCov #{SimpleCov::VERSION}.",
       ].join(" ")
     end
 
+    # @return [String] The value to use as +SimpleCov.command_name+. Uses the
+    #   value of +--command-name+, if this flag was provided, or
+    #   +BASHCOV_COMMAND_NAME, if set, defaulting to a stringified
+    #   representation of {Bashcov#command}.
+    def command_name
+      return @options.command_name if @options.command_name
+      return ENV["BASHCOV_COMMAND_NAME"] unless ENV.fetch("BASHCOV_COMMAND_NAME", "").empty?
+      command.compact.join(" ")
+    end
+
     # Wipe the current options and reset default values
     def set_default_options!
       @options = Options.new
@@ -78,6 +79,17 @@ module Bashcov
       @options.root_directory   = Dir.getwd
     end
 
+    # Define option accessors
+    Options.new.members.each do |option|
+      [option, "#{option}="].each do |method|
+        next if instance_methods(false).include?(method)
+
+        define_method method do |*args|
+          options.public_send(*[method, *args])
+        end
+      end
+    end
+
   private
 
     def help
@@ -113,6 +125,9 @@ module Bashcov
           raise Errno::ENOENT, d unless File.directory? d
           options.root_directory = d
         end
+        opts.on("--command-name NAME", "Value to use as SimpleCov.command_name") do |c|
+          options.command_name = c
+        end
 
         opts.separator "\nCommon options:"
 

data/lib/bashcov/field_stream.rb

@@ -36,9 +36,6 @@ module Bashcov
     def each(delimiter, field_count, start_match)
       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
-
       # The number of fields processed since passing the last start-of-fields
       # match
       seen_fields = 0
@@ -58,7 +55,6 @@ module Bashcov
           # Fill out any remaining (unparseable) fields with empty strings
           yield_remaining.call
 
-          matched_start = nil
           seen_fields = 0
         elsif seen_fields < field_count
           yield field

data/lib/bashcov/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Cédric Félizard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-28 00:00:00.000000000 Z
+date: 2018-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.3
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mutant-rspec
   requirement: !ruby/object:Gem::Requirement