kettle-soup-cover 1.0.5 → 1.0.7

data/SECURITY.md

@@ -6,8 +6,16 @@
 |-----------|-----------|
 | 1.latest  | ✅         |
 
-## Reporting a Vulnerability
+## Security contact information
 
-Peter Boling is the primary maintainer of this gem. Please find a way
-to [contact him directly](https://railsbling.com/contact) to report the issue. Include as much relevant information as
-possible.
+To report a security vulnerability, please use the
+[Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
+
+## Additional Support
+
+If you are interested in support for versions older than the latest release,
+please consider sponsoring the project / maintainer @ https://liberapay.com/pboling/donate,
+or find other sponsorship links in the [README].
+
+[README]: README.md

data/lib/kettle/change.rb

@@ -0,0 +1,39 @@
+module Kettle
+  class Change < Module
+    def initialize(constants: nil, path: nil)
+      super()
+      @constants = Array(constants) if constants
+      @path = path if path
+    end
+
+    def included(base)
+      constant_changer = ConstantChange.to_mod(constants: @constants, path: @path)
+      base.send(:extend, constant_changer)
+    end
+
+    module ConstantChange
+      class << self
+        def to_mod(constants: nil, path: nil)
+          Module.new do
+            if constants && path
+              define_method(:reset_const) do |*_args, &block|
+                delete_const do
+                  block&.call
+                  load(path)
+                end
+              end
+
+              define_method(:delete_const) do |*_args, &block|
+                constants.each do |var|
+                  remove_const(var) if defined?(var)
+                end
+                block&.call
+                nil
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kettle/soup/cover/config.rb

@@ -15,38 +15,38 @@
 SimpleCov.configure do
   track_files("lib/**/*.rb")
 
-  command_name Kettle::Soup::Cover::COMMAND_NAME
+  command_name Kettle::Soup::Cover::Constants::COMMAND_NAME
 
   enable_coverage :branch
   primary_coverage :branch
 
   # Filters (skip these paths for coverage tracking)
-  add_filter Kettle::Soup::Cover::FILTER_DIRS
+  add_filter Kettle::Soup::Cover::Constants::FILTER_DIRS
 
   # Setup Coverage Dir
-  coverage_dir(Kettle::Soup::Cover::COVERAGE_DIR)
+  coverage_dir(Kettle::Soup::Cover::Constants::COVERAGE_DIR)
 
   # Formatters
-  if Kettle::Soup::Cover::MULTI_FORMATTERS
-    Kettle::Soup::Cover.load_formatters
+  if Kettle::Soup::Cover::Constants::MULTI_FORMATTERS
+    Kettle::Soup::Cover::Loaders.load_formatters
   else
     require "simplecov-html"
     formatter SimpleCov::Formatter::HTMLFormatter
   end
 
   # Use Merging (merges RSpec + Cucumber Test Results)
-  use_merging(Kettle::Soup::Cover::USE_MERGING) unless Kettle::Soup::Cover::USE_MERGING.nil?
-  merge_timeout(Kettle::Soup::Cover::MERGE_TIMEOUT) if Kettle::Soup::Cover::MERGE_TIMEOUT
+  use_merging(Kettle::Soup::Cover::Constants::USE_MERGING) unless Kettle::Soup::Cover::Constants::USE_MERGING.nil?
+  merge_timeout(Kettle::Soup::Cover::Constants::MERGE_TIMEOUT) if Kettle::Soup::Cover::Constants::MERGE_TIMEOUT
 
   # Fail build when missed coverage targets
   # NOTE: Checking SpecTracker.instance.full_suite? here would be awesome, but won't work
   #       SpecTracker must wait for instantiation until it has
   #       RSpec's config.world.all_examples,
   #       and that doesn't happen until the before(:suite) hook
-  if Kettle::Soup::Cover::IS_CI || Kettle::Soup::Cover::MIN_COVERAGE_HARD
+  if Kettle::Soup::Cover::Constants::IS_CI || Kettle::Soup::Cover::Constants::MIN_COVERAGE_HARD
     minimum_coverage(
-      branch: Kettle::Soup::Cover::MIN_COVERAGE_BRANCH,
-      line: Kettle::Soup::Cover::MIN_COVERAGE_LINE,
+      branch: Kettle::Soup::Cover::Constants::MIN_COVERAGE_BRANCH,
+      line: Kettle::Soup::Cover::Constants::MIN_COVERAGE_LINE,
     )
   end
 end

data/lib/kettle/soup/cover/constants.rb

@@ -0,0 +1,113 @@
+module Kettle
+  module Soup
+    module Cover
+      module Constants
+        FALSE = "false"
+        TRUE = "true"
+        PREFIX = ENV.fetch("K_SOUP_COV_PREFIX", "K_SOUP_COV_")
+        ENV_GET = ->(suffix, default) { ENV.fetch("#{PREFIX}#{suffix}", default) }
+        FORMATTER_PLUGINS = {
+          # HTML for Humans
+          html: {
+            type: :html,
+            klass: "HTMLFormatter",
+            lib: "simplecov-html",
+          },
+          # XML for Jenkins
+          xml: {
+            type: :xml,
+            klass: "CoberturaFormatter",
+            lib: "simplecov-cobertura",
+          },
+          # RCOV for Hudson
+          rcov: {
+            type: :rcov,
+            klass: "RcovFormatter",
+            lib: "simplecov-rcov",
+          },
+          # LCOV for GCOV
+          lcov: {
+            type: :lcov,
+            klass: "LcovFormatter",
+            lib: "simplecov-lcov",
+          },
+          # JSON for CodeClimate
+          json: {
+            type: :json,
+            klass: "JSONFormatter",
+            lib: "simplecov_json_formatter",
+          },
+          # TTY / Console output
+          tty: {
+            type: :tty,
+            klass: "Console",
+            lib: "simplecov-console",
+          },
+        }
+
+        CI = ENV.fetch("CI", FALSE)
+        IS_CI = CI.casecmp?(TRUE)
+        COMMAND_NAME = ENV_GET.call("COMMAND_NAME", "RSpec (COVERAGE)")
+        COVERAGE_DIR = ENV_GET.call("DIR", "coverage")
+        DEBUG = ENV_GET.call("DEBUG", FALSE).casecmp?(TRUE)
+        DO_COV = ENV_GET.call("DO", CI).casecmp?(TRUE)
+        FILTER_DIRS = ENV_GET.call(
+          "FILTER_DIRS",
+          "bin,certs,checksums,config,coverage,docs,features,gemfiles,pkg,results,sig,spec,src,test,test-results,vendor",
+        )
+          .split(",")
+          .map { |dir_name| %r{^/#{Regexp.escape(dir_name)}/} }
+        FORMATTERS = ENV_GET.call(
+          "FORMATTERS",
+          IS_CI ? "html,xml,rcov,lcov,json,tty" : "html,tty",
+        )
+          .split(",")
+          .map { |fmt_name| FORMATTER_PLUGINS[fmt_name.strip.to_sym] }
+        MIN_COVERAGE_HARD = ENV_GET.call("MIN_HARD", CI).casecmp?(TRUE)
+        MIN_COVERAGE_BRANCH = ENV_GET.call("MIN_BRANCH", "80").to_i
+        MIN_COVERAGE_LINE = ENV_GET.call("MIN_LINE", "80").to_i
+        MULTI_FORMATTERS_DEFAULT = if IS_CI
+          TRUE
+        else
+          FORMATTERS.any? ? TRUE : FALSE
+        end
+        MULTI_FORMATTERS = ENV_GET.call("MULTI_FORMATTERS", MULTI_FORMATTERS_DEFAULT).casecmp?(TRUE)
+        # A wild approximation, but will suffice for nearly all users
+        is_mac = RbConfig::CONFIG["host_os"].include?("darwin")
+        # Set to "" to prevent opening a browser with the coverage rake task
+        OPEN_BIN = ENV_GET.call("OPEN_BIN", is_mac ? "open" : "xdg-open")
+        USE_MERGING = ENV_GET.call("USE_MERGING", nil)&.casecmp?(TRUE)
+        MERGE_TIMEOUT = ENV_GET.call("MERGE_TIMEOUT", nil)&.to_i
+        VERBOSE = ENV_GET.call("VERBOSE", FALSE).casecmp?(TRUE)
+
+        include Kettle::Change.new(
+          constants: %w[
+            CI
+            COMMAND_NAME
+            COVERAGE_DIR
+            DEBUG
+            DO_COV
+            ENV_GET
+            FALSE
+            FILTER_DIRS
+            FORMATTER_PLUGINS
+            FORMATTERS
+            IS_CI
+            MERGE_TIMEOUT
+            MIN_COVERAGE_BRANCH
+            MIN_COVERAGE_LINE
+            MIN_COVERAGE_HARD
+            MULTI_FORMATTERS_DEFAULT
+            MULTI_FORMATTERS
+            OPEN_BIN
+            PREFIX
+            TRUE
+            USE_MERGING
+            VERBOSE
+          ],
+          path: "kettle/soup/cover/constants.rb",
+        )
+      end
+    end
+  end
+end

data/lib/kettle/soup/cover/loaders.rb

@@ -0,0 +1,36 @@
+module Kettle
+  module Soup
+    module Cover
+      module Loaders
+        extend self
+
+        def load_formatters
+          SimpleCov.formatters = Kettle::Soup::Cover::Constants::FORMATTERS
+            .each_with_object([]) do |fmt_data, formatters|
+            require fmt_data[:lib].to_s
+
+            klass = SimpleCov::Formatter.const_get(fmt_data[:klass])
+
+            if fmt_data[:type] == :lcov
+              klass.config do |c|
+                c.report_with_single_file = true
+                c.single_report_path = "#{Kettle::Soup::Cover::Constants::COVERAGE_DIR}/lcov.info"
+              end
+            end
+
+            formatters << klass
+          end
+        end
+
+        def load_filters
+          require "kettle/soup/cover/filters/gt_line_filter"
+          require "kettle/soup/cover/filters/lt_line_filter"
+        end
+
+        def install_tasks
+          load("kettle/soup/cover/tasks.rb")
+        end
+      end
+    end
+  end
+end

data/lib/kettle/soup/cover/rakelib/coverage.rake

@@ -5,9 +5,27 @@ task :coverage do
     ENV["K_SOUP_COV_PREFIX"] = "K_SOUP_COV_"
     ENV["K_SOUP_COV_DO"] = "true"
     ENV["K_SOUP_COV_MULTI_FORMATTERS"] = "true"
-    ENV["K_SOUP_COV_FORMATTERS"] = "html"
+    ENV["K_SOUP_COV_FORMATTERS"] ||= "html"
     ENV["K_SOUP_COV_DIR"] ||= "coverage"
   end
   Rake::Task["test"].invoke
-  %x(open #{Kettle::Soup::Cover::COVERAGE_DIR}/index.html)
+  html_report = "#{Kettle::Soup::Cover::COVERAGE_DIR}/index.html"
+  if Kettle::Soup::Cover::OPEN_BIN.empty?
+    puts "Kettle::Soup::Cover::OPEN_BIN not configured. Coverage report is at #{html_report}"
+  else
+    begin
+      %x(#{Kettle::Soup::Cover::OPEN_BIN} #{html_report})
+    rescue Errno::ENOENT => error
+      message = error.message || ""
+      # `open` command is macOS only.  xdg-open is a decent alternative on many Linux systems.
+      if message.include?("No such file or directory - #{Kettle::Soup::Cover::OPEN_BIN}")
+        puts "Configured Kettle::Soup::Cover::OPEN_BIN (#{Kettle::Soup::Cover::OPEN_BIN}) not available. Coverage report is at #{html_report}"
+      elsif message.include?("No such file or directory")
+        puts "No coverage report found at #{html_report}"
+        puts message
+      else
+        raise error
+      end
+    end
+  end
 end

data/lib/kettle/soup/cover/version.rb

@@ -4,7 +4,7 @@ module Kettle
   module Soup
     module Cover
       module Version
-        VERSION = "1.0.5"
+        VERSION = "1.0.7"
       end
     end
   end

data/lib/kettle/soup/cover.rb

@@ -14,156 +14,40 @@
 #   SimpleCov.start
 #
 
+# Standard Lib
+require "rbconfig"
+
+# External gems
+require "version_gem"
+
+# This gem
+require_relative "../change"
+require_relative "cover/version"
+require_relative "cover/constants"
+require_relative "cover/loaders"
+
 module Kettle
   module Soup
     module Cover
       class Error < StandardError; end
 
-      CONSTANTS = %w[
-        CI
-        COMMAND_NAME
-        COVERAGE_DIR
-        DEBUG
-        DO_COV
-        ENV_GET
-        FALSE
-        FILTER_DIRS
-        FORMATTER_PLUGINS
-        FORMATTERS
-        IS_CI
-        MERGE_TIMEOUT
-        MIN_COVERAGE_BRANCH
-        MIN_COVERAGE_LINE
-        MIN_COVERAGE_HARD
-        MULTI_FORMATTERS_DEFAULT
-        MULTI_FORMATTERS
-        PREFIX
-        TRUE
-        USE_MERGING
-        VERBOSE
-      ]
-      FALSE = "false"
-      TRUE = "true"
-      PREFIX = ENV.fetch("K_SOUP_COV_PREFIX", "K_SOUP_COV_")
-      ENV_GET = ->(suffix, default) { ENV.fetch("#{PREFIX}#{suffix}", default) }
-      FORMATTER_PLUGINS = {
-        # HTML for Humans
-        html: {
-          type: :html,
-          klass: "HTMLFormatter",
-          lib: "simplecov-html",
-        },
-        # XML for Jenkins
-        xml: {
-          type: :xml,
-          klass: "CoberturaFormatter",
-          lib: "simplecov-cobertura",
-        },
-        # RCOV for Hudson
-        rcov: {
-          type: :rcov,
-          klass: "RcovFormatter",
-          lib: "simplecov-rcov",
-        },
-        # LCOV for GCOV
-        lcov: {
-          type: :lcov,
-          klass: "LcovFormatter",
-          lib: "simplecov-lcov",
-        },
-        # JSON for CodeClimate
-        json: {
-          type: :json,
-          klass: "JSONFormatter",
-          lib: "simplecov_json_formatter",
-        },
-        # TTY / Console output
-        tty: {
-          type: :tty,
-          klass: "Console",
-          lib: "simplecov-console",
-        },
-      }
-
-      CI = ENV.fetch("CI", FALSE)
-      IS_CI = CI.casecmp?(TRUE)
-      COMMAND_NAME = ENV_GET.call("COMMAND_NAME", "RSpec (COVERAGE)")
-      COVERAGE_DIR = ENV_GET.call("DIR", "coverage")
-      DEBUG = ENV_GET.call("DEBUG", FALSE).casecmp?(TRUE)
-      DO_COV = ENV_GET.call("DO", CI).casecmp?(TRUE)
-      FILTER_DIRS = ENV_GET.call(
-        "FILTER_DIRS",
-        "bin,certs,checksums,config,coverage,docs,features,gemfiles,pkg,results,sig,spec,src,test,test-results,vendor",
-      )
-        .split(",")
-        .map { |dir_name| %r{^/#{Regexp.escape(dir_name)}/} }
-      FORMATTERS = ENV_GET.call(
-        "FORMATTERS",
-        IS_CI ? "html,xml,rcov,lcov,json,tty" : "html,tty",
-      )
-        .split(",")
-        .map { |fmt_name| FORMATTER_PLUGINS[fmt_name.strip.to_sym] }
-      MIN_COVERAGE_HARD = ENV_GET.call("MIN_HARD", CI).casecmp?(TRUE)
-      MIN_COVERAGE_BRANCH = ENV_GET.call("MIN_BRANCH", "80").to_i
-      MIN_COVERAGE_LINE = ENV_GET.call("MIN_LINE", "80").to_i
-      MULTI_FORMATTERS_DEFAULT = if IS_CI
-        CI
-      else
-        FORMATTERS.any? ? TRUE : FALSE
-      end
-      MULTI_FORMATTERS = ENV_GET.call("MULTI_FORMATTERS", MULTI_FORMATTERS_DEFAULT).casecmp?(TRUE)
-      USE_MERGING = ENV_GET.call("USE_MERGING", nil)&.casecmp?(TRUE)
-      MERGE_TIMEOUT = ENV_GET.call("MERGE_TIMEOUT", nil)&.to_i
-      VERBOSE = ENV_GET.call("VERBOSE", FALSE).casecmp?(TRUE)
+      # Provide a public API for constants that is a bit less namespaced
+      include Constants
+      extend Loaders
 
       module_function
 
-      def load_formatters
-        SimpleCov.formatters = FORMATTERS
-          .each_with_object([]) do |fmt_data, formatters|
-          require fmt_data[:lib].to_s
-
-          klass = SimpleCov::Formatter.const_get(fmt_data[:klass])
-
-          if fmt_data[:type] == :lcov
-            klass.config do |c|
-              c.report_with_single_file = true
-              c.single_report_path = "#{Kettle::Soup::Cover::COVERAGE_DIR}/lcov.info"
-            end
-          end
-
-          formatters << klass
-        end
+      def reset_const(&block)
+        Constants.reset_const(&block)
       end
 
-      def load_filters
-        require "kettle/soup/cover/filters/gt_line_filter"
-        require "kettle/soup/cover/filters/lt_line_filter"
-      end
-
-      def install_tasks
-        load("kettle/soup/cover/tasks.rb")
-      end
-
-      # Const manipulation is to help with testing this gem
-      def reset_const(&_)
-        delete_const do
-          yield if block_given?
-          # Loading myself... Woah.
-          load("kettle/soup/cover.rb")
-        end
-      end
-
-      # Const manipulation is to help with testing this gem
-      def delete_const(&_)
-        CONSTANTS.each do |var|
-          remove_const(var)
-        end
-        remove_const(:CONSTANTS)
-        yield if block_given?
-
-        nil
+      def delete_const(&block)
+        Constants.delete_const(&block)
       end
     end
   end
 end
+
+Kettle::Soup::Cover::Version.class_eval do
+  extend VersionGem::Basic
+end

data/lib/kettle-soup-cover.rb

@@ -1,4 +1,4 @@
-# USAGE:
+# rubocop:disable Naming/FileName# USAGE:
 # In your `spec/spec_helper.rb`,
 # just prior to loading the library under test:
 #
@@ -10,13 +10,8 @@
 #   SimpleCov.start
 #
 
-# External gems
-require "version_gem"
-
-require_relative "kettle/soup/cover/version"
-
+# For technical reasons, if we move to Zeitwerk, this cannot be require_relative.
+#   See: https://github.com/fxn/zeitwerk#for_gem_extension
+# Hook for other libraries to load this library (e.g. via bundler)
 require "kettle/soup/cover"
-
-Kettle::Soup::Cover::Version.class_eval do
-  extend VersionGem::Basic
-end
+# rubocop:enable Naming/FileName

data/sig/kettle/soup/cover.rbs

@@ -4,7 +4,6 @@ module Kettle
     module Cover
       CI: String
       COMMAND_NAME: String
-      CONSTANTS: Array[String]
       COVERAGE_DIR: String
       DEBUG: bool
       DO_COV: bool
@@ -22,6 +21,7 @@ module Kettle
       MULTI_FORMATTERS_DEFAULT: String
       PREFIX: String
       TRUE: String
+      OPEN_BIN: String
       USE_MERGING: bool?
       VERBOSE: bool
       VERSION: String