coverband 4.2.7 → 5.0.0.rc.3

data/lib/coverband/configuration.rb

@@ -3,16 +3,16 @@
 module Coverband
   class Configuration
     attr_accessor :root_paths, :root,
-                  :additional_files, :verbose,
-                  :reporter, :redis_namespace, :redis_ttl,
-                  :background_reporting_enabled,
-                  :background_reporting_sleep_seconds, :test_env,
-                  :web_enable_clear, :gem_details, :web_debug, :report_on_exit,
-                  :simulate_oneshot_lines_coverage, :track_views, :view_tracker,
-                  :reporting_wiggle
+      :additional_files, :verbose,
+      :reporter, :redis_namespace, :redis_ttl,
+      :background_reporting_enabled,
+      :background_reporting_sleep_seconds, :test_env,
+      :web_enable_clear, :gem_details, :web_debug, :report_on_exit,
+      :simulate_oneshot_lines_coverage, :track_views, :view_tracker,
+      :reporting_wiggle
 
     attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id,
-                :s3_secret_access_key, :password
+      :s3_secret_access_key, :password
     attr_reader :track_gems, :ignore, :use_oneshot_lines_coverage
 
     #####
@@ -22,20 +22,20 @@ module Coverband
     # * should we skip /bin/rails webpacker:compile ?
     # * Perhaps detect heroku deployment ENV var opposed to tasks?
     #####
-    IGNORE_TASKS = ['coverband:clear',
-                    'coverband:coverage',
-                    'coverband:coverage_server',
-                    'coverband:migrate',
-                    'assets:precompile',
-                    'db:version',
-                    'db:create',
-                    'db:drop',
-                    'db:seed',
-                    'db:setup',
-                    'db:test:prepare',
-                    'db:structure:dump',
-                    'db:structure:load',
-                    'db:version']
+    IGNORE_TASKS = ["coverband:clear",
+                    "coverband:coverage",
+                    "coverband:coverage_server",
+                    "coverband:migrate",
+                    "assets:precompile",
+                    "db:version",
+                    "db:create",
+                    "db:drop",
+                    "db:seed",
+                    "db:setup",
+                    "db:test:prepare",
+                    "db:structure:dump",
+                    "db:structure:load",
+                    "db:version"]
 
     # Heroku when building assets runs code from a dynamic directory
     # /tmp was added to avoid coverage from /tmp/build directories during
@@ -57,7 +57,7 @@ module Coverband
       @search_paths = TRACKED_DEFAULT_PATHS.dup
       @additional_files = []
       @verbose = false
-      @reporter = 'scov'
+      @reporter = "scov"
       @logger = nil
       @store = nil
       @background_reporting_enabled = true
@@ -67,21 +67,21 @@ module Coverband
       @track_gems = false
       @gem_details = false
       @track_views = false
-      @groups = {}
       @web_debug = false
       @report_on_exit = true
-      @use_oneshot_lines_coverage = ENV['ONESHOT'] || false
-      @simulate_oneshot_lines_coverage = ENV['SIMULATE_ONESHOT'] || false
+      @use_oneshot_lines_coverage = ENV["ONESHOT"] || false
+      @simulate_oneshot_lines_coverage = ENV["SIMULATE_ONESHOT"] || false
       @current_root = nil
       @all_root_paths = nil
       @all_root_patterns = nil
       @password = nil
 
-      # TODO: should we push these to adapter configs
+      # TODO: these are deprecated
       @s3_region = nil
       @s3_bucket = nil
       @s3_access_key_id = nil
       @s3_secret_access_key = nil
+
       @redis_namespace = nil
       @redis_ttl = 2_592_000 # in seconds. Default is 30 days.
       @reporting_wiggle = nil
@@ -89,30 +89,30 @@ module Coverband
 
     def logger
       @logger ||= if defined?(Rails.logger) && Rails.logger
-                    Rails.logger
-                  else
-                    Logger.new(STDOUT)
-                  end
+        Rails.logger
+      else
+        Logger.new(STDOUT)
+      end
     end
 
     def password
-      @password || ENV['COVERBAND_PASSWORD']
+      @password || ENV["COVERBAND_PASSWORD"]
     end
 
     def s3_bucket
-      @s3_bucket || ENV['AWS_BUCKET']
+      puts "deprecated, s3 is no longer support"
     end
 
     def s3_region
-      @s3_region || ENV['AWS_REGION']
+      puts "deprecated, s3 is no longer support"
     end
 
     def s3_access_key_id
-      @s3_access_key_id || ENV['AWS_ACCESS_KEY_ID']
+      puts "deprecated, s3 is no longer support"
     end
 
     def s3_secret_access_key
-      @s3_secret_access_key || ENV['AWS_SECRET_ACCESS_KEY']
+      puts "deprecated, s3 is no longer support"
     end
 
     def store
@@ -120,7 +120,7 @@ module Coverband
     end
 
     def store=(store)
-      raise 'Pass in an instance of Coverband::Adapters' unless store.is_a?(Coverband::Adapters::Base)
+      raise "Pass in an instance of Coverband::Adapters" unless store.is_a?(Coverband::Adapters::Base)
 
       # Default to 5 minutes if using the hash redis store
       # This is a safer default for the high server volumes that need the hash store
@@ -134,7 +134,7 @@ module Coverband
     # Search Paths
     ###
     def tracked_search_paths
-      "#{Coverband.configuration.current_root}/{#{@search_paths.join(',')}}/**/*.{rb}"
+      "#{Coverband.configuration.current_root}/{#{@search_paths.join(",")}}/**/*.{rb}"
     end
 
     ###
@@ -151,43 +151,8 @@ module Coverband
       @ignore = (@ignore + ignored_array).uniq
     end
 
-    def track_gems=(value)
-      @track_gems = value
-      return unless @track_gems
-
-      # by default we ignore vendor where many deployments put gems
-      # we will remove this default if track_gems is set
-      @ignore.delete('vendor/')
-      # while we want to allow vendored gems we don't want to track vendored ruby STDLIB
-      @ignore << 'vendor/ruby-*' unless @ignore.include?('vendor/ruby-*')
-      add_group('App', root)
-      # TODO: rework support for multiple gem paths
-      # this works but seems hacky and error prone
-      # basically since it is converted to a regex we join all the paths
-      # with a regex 'OR' using '|'
-      add_group('Gems', gem_paths.join('|'))
-    end
-
-    #
-    # Returns the configured groups. Add groups using SimpleCov.add_group
-    #
-    def groups
-      @groups ||= {}
-    end
-
-    #
-    # Define a group for files. Works similar to add_filter, only that the first
-    # argument is the desired group name and files PASSING the filter end up in the group
-    # (while filters exclude when the filter is applicable).
-    #
-    def add_group(group_name, filter_argument = nil)
-      groups[group_name] = filter_argument
-    end
-
-    def gem_paths
-      # notes ignore any paths that aren't on this system, resolves
-      # bug related to multiple ruby version managers / bad dot files
-      Gem::PathSupport.new(ENV).path.select { |path| File.exist?(path) }
+    def track_gems=(_value)
+      puts "gem tracking is deprecated, setting this will be ignored"
     end
 
     def current_root
@@ -198,7 +163,6 @@ module Coverband
       return @all_root_paths if @all_root_paths
 
       @all_root_paths = Coverband.configuration.root_paths.dup
-      @all_root_paths += Coverband.configuration.gem_paths.dup if Coverband.configuration.track_gems
       @all_root_paths << "#{Coverband.configuration.current_root}/"
       @all_root_paths
     end
@@ -210,30 +174,30 @@ module Coverband
     SKIPPED_SETTINGS = %w[@s3_secret_access_key @store]
     def to_h
       instance_variables
-        .each_with_object('gem_paths': gem_paths) do |var, hash|
-          hash[var.to_s.delete('@')] = instance_variable_get(var) unless SKIPPED_SETTINGS.include?(var.to_s)
+        .each_with_object({}) do |var, hash|
+          hash[var.to_s.delete("@")] = instance_variable_get(var) unless SKIPPED_SETTINGS.include?(var.to_s)
         end
     end
 
     def use_oneshot_lines_coverage=(value)
-      raise(Exception, 'One shot line coverage is only available in ruby >= 2.6') unless one_shot_coverage_implemented_in_ruby_version? || !value
+      raise(StandardError, "One shot line coverage is only available in ruby >= 2.6") unless one_shot_coverage_implemented_in_ruby_version? || !value
 
       @use_oneshot_lines_coverage = value
     end
 
     def one_shot_coverage_implemented_in_ruby_version?
-      Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6.0')
+      Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
     end
 
     private
 
     def redis_url
-      ENV['COVERBAND_REDIS_URL'] || ENV['REDIS_URL']
+      ENV["COVERBAND_REDIS_URL"] || ENV["REDIS_URL"]
     end
 
     def redis_store_options
-      { ttl: Coverband.configuration.redis_ttl,
-        redis_namespace: Coverband.configuration.redis_namespace }
+      {ttl: Coverband.configuration.redis_ttl,
+       redis_namespace: Coverband.configuration.redis_namespace}
     end
   end
 end

data/lib/coverband/integrations/background.rb

@@ -27,9 +27,9 @@ module Coverband
       @semaphore.synchronize do
         return if running?
 
-        logger.debug('Coverband: Starting background reporting') if Coverband.configuration.verbose
+        logger.debug("Coverband: Starting background reporting") if Coverband.configuration.verbose
         sleep_seconds = Coverband.configuration.background_reporting_sleep_seconds
-        @thread = Thread.new do
+        @thread = Thread.new {
           loop do
             Coverband.report_coverage
             Coverband.configuration.view_tracker&.report_views_tracked
@@ -41,7 +41,7 @@ module Coverband
             end
             sleep(sleep_seconds)
           end
-        end
+        }
       end
     end
   end

data/lib/coverband/integrations/rack_server_check.rb

@@ -15,14 +15,14 @@ module Coverband
     end
 
     def rack_server?
-      @stack.any? { |line| line.path.include?('lib/rack/') }
+      @stack.any? { |line| line.path.include?("lib/rack/") }
     end
 
     def rails_server?
       @stack.any? do |location|
         (
-          location.path.include?('rails/commands/commands_tasks.rb') && location.label == 'server' ||
-          location.path.include?('rails/commands/server/server_command.rb') && location.label == 'perform'
+          location.path.include?("rails/commands/commands_tasks.rb") && location.label == "server" ||
+          location.path.include?("rails/commands/server/server_command.rb") && location.label == "perform"
         )
       end
     end

data/lib/coverband/reporters/base.rb

@@ -8,7 +8,7 @@ module Coverband
     ###
     class Base
       class << self
-        DATA_KEY = 'data'
+        DATA_KEY = "data"
 
         def report(store, _options = {})
           all_roots = Coverband.configuration.all_root_paths
@@ -49,7 +49,7 @@ module Coverband
         protected
 
         def fix_file_names(report_hash, roots)
-          Coverband.configuration.logger.debug "fixing root: #{roots.join(', ')}" if Coverband.configuration.verbose
+          Coverband.configuration.logger.debug "fixing root: #{roots.join(", ")}" if Coverband.configuration.verbose
 
           # normalize names across servers
           report_hash.each_with_object({}) do |(name, report), fixed_report|
@@ -57,12 +57,12 @@ module Coverband
             report.each_pair do |key, vals|
               filename = Coverband::Utils::AbsoluteFileConverter.convert(key)
               fixed_report[name][filename] = if fixed_report[name].key?(filename) && fixed_report[name][filename][DATA_KEY] && vals[DATA_KEY]
-                                               merged_data = merge_arrays(fixed_report[name][filename][DATA_KEY], vals[DATA_KEY])
-                                               vals[DATA_KEY] = merged_data
-                                               vals
-                                             else
-                                               vals
-                                             end
+                merged_data = merge_arrays(fixed_report[name][filename][DATA_KEY], vals[DATA_KEY])
+                vals[DATA_KEY] = merged_data
+                vals
+              else
+                vals
+              end
             end
           end
         end
@@ -75,8 +75,8 @@ module Coverband
 
           longest.each_with_index do |_line, index|
             merged[index] = if first[index] || second[index]
-                              (first[index].to_i + second[index].to_i)
-                            end
+              (first[index].to_i + second[index].to_i)
+            end
           end
 
           merged

data/lib/coverband/reporters/console_report.rb

@@ -12,7 +12,7 @@ module Coverband
         scov_style_report.each_pair do |file, usage|
           # TODO: In Coverband 5 deprecate none hash format
           if usage.is_a?(Hash)
-            Coverband.configuration.logger.info "#{file}: #{usage['data']}"
+            Coverband.configuration.logger.info "#{file}: #{usage["data"]}"
           else
             Coverband.configuration.logger.info "#{file}: #{usage}"
           end

data/lib/coverband/reporters/html_report.rb

@@ -3,16 +3,15 @@
 module Coverband
   module Reporters
     class HTMLReport < Base
-      attr_accessor :filtered_report_files, :open_report, :static, :notice,
-                    :base_path, :filename
+      attr_accessor :filtered_report_files, :open_report, :notice,
+        :base_path, :filename
 
       def initialize(store, options = {})
         coverband_reports = Coverband::Reporters::Base.report(store, options)
         self.open_report = options.fetch(:open_report) { true }
-        self.static = options.fetch(:static) { true }
         # TODO: refactor notice out to top level of web only
         self.notice = options.fetch(:notice) { nil }
-        self.base_path = options.fetch(:base_path) { nil }
+        self.base_path = options.fetch(:base_path) { "./" }
         self.filename = options.fetch(:filename) { nil }
 
         self.filtered_report_files = self.class.fix_reports(coverband_reports)
@@ -20,16 +19,12 @@ module Coverband
 
       def file_details
         Coverband::Utils::HTMLFormatter.new(filtered_report_files,
-                                            base_path: base_path,
-                                            notice: notice).format_source_file!(filename)
+          base_path: base_path,
+          notice: notice).format_source_file!(filename)
       end
 
       def report
-        if static?
-          report_static_site
-        else
-          report_dynamic_html
-        end
+        report_dynamic_html
       end
 
       def report_data
@@ -38,31 +33,16 @@ module Coverband
 
       private
 
-      def static?
-        static
-      end
-
-      def report_static_site
-        Coverband::Utils::HTMLFormatter.new(filtered_report_files).format_static_html!
-        if open_report
-          `open #{Coverband.configuration.root}/coverage/index.html`
-        else
-          Coverband.configuration.logger.info 'report is ready and viewable: open coverage/index.html'
-        end
-
-        Coverband::Utils::S3Report.instance.persist! if Coverband.configuration.s3_bucket
-      end
-
       def report_dynamic_html
         Coverband::Utils::HTMLFormatter.new(filtered_report_files,
-                                            base_path: base_path,
-                                            notice: notice).format_dynamic_html!
+          base_path: base_path,
+          notice: notice).format_dynamic_html!
       end
 
       def report_dynamic_data
         Coverband::Utils::HTMLFormatter.new(filtered_report_files,
-                                            base_path: base_path,
-                                            notice: notice).format_dynamic_data!
+          base_path: base_path,
+          notice: notice).format_dynamic_data!
       end
     end
   end

data/lib/coverband/reporters/web.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 begin
-  require 'rack'
+  require "rack"
 rescue LoadError
-  puts 'error loading Coverband web reporter as Rack is not available'
+  puts "error loading Coverband web reporter as Rack is not available"
 end
 
 module Coverband
@@ -12,27 +12,31 @@ module Coverband
       attr_reader :request
 
       def initialize
-        full_path = Gem::Specification.find_by_name('coverband').full_gem_path
+        init_web
+      end
+
+      def init_web
+        full_path = Gem::Specification.find_by_name("coverband").full_gem_path
         @static = Rack::Static.new(self,
-                                   root: File.expand_path('public', full_path),
-                                   urls: [/.*\.css/, /.*\.js/, /.*\.gif/, /.*\.png/])
+          root: File.expand_path("public", full_path),
+          urls: [/.*\.css/, /.*\.js/, /.*\.gif/, /.*\.png/])
       end
 
       def check_auth
         return true unless Coverband.configuration.password
 
-        auth_header = request.get_header('HTTP_AUTHORIZATION')
+        auth_header = request.get_header("HTTP_AUTHORIZATION")
         return unless auth_header
 
-        Coverband.configuration.password == Base64.decode64(auth_header.split[1]).split(':')[1]
+        Coverband.configuration.password == Base64.decode64(auth_header.split[1]).split(":")[1]
       end
 
       def call(env)
         @request = Rack::Request.new(env)
 
-        return [401, { 'www-authenticate' => 'Basic realm=""' }, ['']] unless check_auth
+        return [401, {"www-authenticate" => 'Basic realm=""'}, [""]] unless check_auth
 
-        request_path_info = (request.path_info == '') ? '/' : request.path_info
+        request_path_info = request.path_info == "" ? "/" : request.path_info
         if request.post?
           case request_path_info
           when %r{\/clear_view_tracking_file}
@@ -44,40 +48,40 @@ module Coverband
           when %r{\/clear}
             clear
           else
-            [404, { 'Content-Type' => 'text/html' }, ['404 error!']]
+            [404, {"Content-Type" => "text/html"}, ["404 error!"]]
           end
         else
           case request_path_info
           when /.*\.(css|js|gif|png)/
             @static.call(env)
           when %r{\/settings}
-            [200, { 'Content-Type' => 'text/html' }, [settings]]
+            [200, {"Content-Type" => "text/html"}, [settings]]
           when %r{\/view_tracker_data}
-            [200, { 'Content-Type' => 'text/json' }, [view_tracker_data]]
+            [200, {"Content-Type" => "text/json"}, [view_tracker_data]]
           when %r{\/view_tracker}
-            [200, { 'Content-Type' => 'text/html' }, [view_tracker]]
+            [200, {"Content-Type" => "text/html"}, [view_tracker]]
           when %r{\/enriched_debug_data}
-            [200, { 'Content-Type' => 'text/json' }, [enriched_debug_data]]
+            [200, {"Content-Type" => "text/json"}, [enriched_debug_data]]
           when %r{\/debug_data}
-            [200, { 'Content-Type' => 'text/json' }, [debug_data]]
+            [200, {"Content-Type" => "text/json"}, [debug_data]]
           when %r{\/load_file_details}
-            [200, { 'Content-Type' => 'text/json' }, [load_file_details]]
+            [200, {"Content-Type" => "text/json"}, [load_file_details]]
           when %r{\/$}
-            [200, { 'Content-Type' => 'text/html' }, [index]]
+            [200, {"Content-Type" => "text/html"}, [index]]
           else
-            [404, { 'Content-Type' => 'text/html' }, ['404 error!']]
+            [404, {"Content-Type" => "text/html"}, ["404 error!"]]
           end
         end
       end
 
       def index
-        notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params['notice'])}<br/>"
-        notice = request.params['notice'] ? notice : ''
+        notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params["notice"])}<br/>"
+        notice = request.params["notice"] ? notice : ""
         Coverband::Reporters::HTMLReport.new(Coverband.configuration.store,
-                                             static: false,
-                                             base_path: base_path,
-                                             notice: notice,
-                                             open_report: false).report
+          static: false,
+          base_path: base_path,
+          notice: notice,
+          open_report: false).report
       end
 
       def settings
@@ -85,11 +89,11 @@ module Coverband
       end
 
       def view_tracker
-        notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params['notice'])}<br/>"
-        notice = request.params['notice'] ? notice : ''
+        notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params["notice"])}<br/>"
+        notice = request.params["notice"] ? notice : ""
         Coverband::Utils::HTMLFormatter.new(nil,
-                                            notice: notice,
-                                            base_path: base_path).format_view_tracker!
+          notice: notice,
+          base_path: base_path).format_view_tracker!
       end
 
       def view_tracker_data
@@ -102,62 +106,62 @@ module Coverband
 
       def enriched_debug_data
         Coverband::Reporters::HTMLReport.new(Coverband.configuration.store,
-                                             static: false,
-                                             base_path: base_path,
-                                             notice: '',
-                                             open_report: false).report_data
+          static: false,
+          base_path: base_path,
+          notice: "",
+          open_report: false).report_data
       end
 
       def load_file_details
-        filename = request.params['filename']
+        filename = request.params["filename"]
         Coverband::Reporters::HTMLReport.new(Coverband.configuration.store,
-                                             filename: filename,
-                                             base_path: base_path,
-                                             open_report: false).file_details
+          filename: filename,
+          base_path: base_path,
+          open_report: false).file_details
       end
 
       def clear
         if Coverband.configuration.web_enable_clear
           Coverband.configuration.store.clear!
-          notice = 'coverband coverage cleared'
+          notice = "coverband coverage cleared"
         else
-          notice = 'web_enable_clear isnt enabled in your configuration'
+          notice = "web_enable_clear isnt enabled in your configuration"
         end
-        [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
+        [301, {"Location" => "#{base_path}?notice=#{notice}"}, []]
       end
 
       def clear_file
         if Coverband.configuration.web_enable_clear
-          filename = request.params['filename']
+          filename = request.params["filename"]
           Coverband.configuration.store.clear_file!(filename)
           notice = "coverage for file #{filename} cleared"
         else
-          notice = 'web_enable_clear isnt enabled in your configuration'
+          notice = "web_enable_clear isnt enabled in your configuration"
         end
-        [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
+        [301, {"Location" => "#{base_path}?notice=#{notice}"}, []]
       end
 
       def clear_view_tracking
         if Coverband.configuration.web_enable_clear
           tracker = Coverband::Collectors::ViewTracker.new(store: Coverband.configuration.store)
           tracker.reset_recordings
-          notice = 'view tracking reset'
+          notice = "view tracking reset"
         else
-          notice = 'web_enable_clear isnt enabled in your configuration'
+          notice = "web_enable_clear isnt enabled in your configuration"
         end
-        [301, { 'Location' => "#{base_path}/view_tracker?notice=#{notice}" }, []]
+        [301, {"Location" => "#{base_path}/view_tracker?notice=#{notice}"}, []]
       end
 
       def clear_view_tracking_file
         if Coverband.configuration.web_enable_clear
           tracker = Coverband::Collectors::ViewTracker.new(store: Coverband.configuration.store)
-          filename = request.params['filename']
+          filename = request.params["filename"]
           tracker.clear_file!(filename)
           notice = "coverage for file #{filename} cleared"
         else
-          notice = 'web_enable_clear isnt enabled in your configuration'
+          notice = "web_enable_clear isnt enabled in your configuration"
         end
-        [301, { 'Location' => "#{base_path}/view_tracker?notice=#{notice}" }, []]
+        [301, {"Location" => "#{base_path}/view_tracker?notice=#{notice}"}, []]
       end
 
       private
@@ -167,8 +171,11 @@ module Coverband
       # mount Coverband::Web, at: '/coverage'
       # "/coverage/collect_coverage?" become:
       # /coverage/
+      # NOTE: DO NOT let standardrb `autofix` this to regex match
+      # %r{\/.*\/}.match?(request.path) ? request.path.match("\/.*\/")[0] : "/"
+      # ^^ the above is NOT valid Ruby 2.3/2.4 even though rubocop / standard think it is
       def base_path
-        request.path =~ %r{\/.*\/} ? request.path.match("\/.*\/")[0] : '/'
+        request.path =~ %r{\/.*\/} ? request.path.match("\/.*\/")[0] : "/"
       end
     end
   end