coverband 4.2.5.rc.2 → 5.0.0.rc.3

data/lib/coverband/collectors/delta.rb

@@ -39,23 +39,33 @@ module Coverband
 
       def self.reset
         @@previous_coverage = {}
+        @@project_directory = File.expand_path(Coverband.configuration.root)
+        @@ignore_patterns = Coverband.configuration.ignore
       end
 
       private
 
       def generate
-        # TODO: if we filtered before doing this we would avoid calculating the line diff on a ton of files
-        # This would be a fairly noticeable perf win
         current_coverage.each_with_object({}) do |(file, line_counts), new_results|
+          ###
+          # Eager filter:
+          # Normally I would break this out into additional methods
+          # and improve the readability but this is in a tight loop
+          # on the critical performance path, and any refactoring I come up with
+          # would slow down the performance.
+          ###
+          next unless @@ignore_patterns.none? { |pattern| file.match(pattern) } &&
+            file.start_with?(@@project_directory)
+
           # This handles Coverage branch support, setup by default in
           # simplecov 0.18.x
           arr_line_counts = line_counts.is_a?(Hash) ? line_counts[:lines] : line_counts
           new_results[file] = if @@previous_coverage && @@previous_coverage[file]
-                                prev_line_counts = @@previous_coverage[file].is_a?(Hash) ? @@previous_coverage[file][:lines] : @@previous_coverage[file]
-                                array_diff(arr_line_counts, prev_line_counts)
-                              else
-                                arr_line_counts
-                              end
+            prev_line_counts = @@previous_coverage[file].is_a?(Hash) ? @@previous_coverage[file][:lines] : @@previous_coverage[file]
+            array_diff(arr_line_counts, prev_line_counts)
+          else
+            arr_line_counts
+          end
         end
       end
 
@@ -68,9 +78,9 @@ module Coverband
       def transform_oneshot_lines_results(results)
         results.each_with_object({}) do |(file, coverage), new_results|
           @@stubs[file] ||= ::Coverage.line_stub(file)
-          transformed_line_counts = coverage[:oneshot_lines].each_with_object(@@stubs[file].dup) do |line_number, line_counts|
+          transformed_line_counts = coverage[:oneshot_lines].each_with_object(@@stubs[file].dup) { |line_number, line_counts|
             line_counts[line_number - 1] = 1
-          end
+          }
           new_results[file] = transformed_line_counts
         end
       end

data/lib/coverband/collectors/view_tracker.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'singleton'
+require "singleton"
 
 module Coverband
   module Collectors
@@ -14,12 +14,12 @@ module Coverband
     # TODO: test and ensure slim, haml, and other support
     ###
     class ViewTracker
-      DEFAULT_TARGET = Dir.glob('app/views/**/*.html.erb').reject { |file| file.match(/(_mailer)/) }
+      DEFAULT_TARGET = Dir.glob("app/views/**/*.html.erb").reject { |file| file.match(/(_mailer)/) }
       attr_accessor :target, :logged_views, :views_to_record
       attr_reader :logger, :roots, :store, :ignore_patterns
 
       def initialize(options = {})
-        raise NotImplementedError, 'View Tracker requires Rails 4 or greater' unless self.class.supported_version?
+        raise NotImplementedError, "View Tracker requires Rails 4 or greater" unless self.class.supported_version?
 
         @project_directory = File.expand_path(Coverband.configuration.root)
         @ignore_patterns = Coverband.configuration.ignore
@@ -28,7 +28,7 @@ module Coverband
         @target = options.fetch(:target) { DEFAULT_TARGET }
 
         @roots = options.fetch(:roots) { Coverband.configuration.all_root_patterns }
-        @roots = @roots.split(',') if @roots.is_a?(String)
+        @roots = @roots.split(",") if @roots.is_a?(String)
         @one_time_timestamp = false
 
         @logged_views = []
@@ -65,7 +65,7 @@ module Coverband
         normalized_views = {}
         views.each_pair do |view, time|
           roots.each do |root|
-            view = view.gsub(/#{root}/, '')
+            view = view.gsub(/#{root}/, "")
           end
           normalized_views[view] = time
         end
@@ -90,7 +90,7 @@ module Coverband
         if (tracking_time = redis_store.get(tracker_time_key))
           Time.at(tracking_time.to_i).iso8601
         else
-          'N/A'
+          "N/A"
         end
       end
 
@@ -108,21 +108,21 @@ module Coverband
       end
 
       def report_views_tracked
-        redis_store.set(tracker_time_key, Time.now.to_i) unless @one_time_timestamp || redis_store.exists(tracker_time_key)
+        redis_store.set(tracker_time_key, Time.now.to_i) unless @one_time_timestamp || tracker_time_key_exists?
         @one_time_timestamp = true
         reported_time = Time.now.to_i
         views_to_record.each do |file|
           redis_store.hset(tracker_key, file, reported_time)
         end
         self.views_to_record = []
-      rescue StandardError => e
+      rescue => e
         # we don't want to raise errors if Coverband can't reach redis.
         # This is a nice to have not a bring the system down
         logger&.error "Coverband: view_tracker failed to store, error #{e.class.name}"
       end
 
       def self.supported_version?
-        defined?(Rails) && defined?(Rails::VERSION) && Rails::VERSION::STRING.split('.').first.to_i >= 4
+        defined?(Rails) && defined?(Rails::VERSION) && Rails::VERSION::STRING.split(".").first.to_i >= 4
       end
 
       protected
@@ -145,12 +145,20 @@ module Coverband
         store.raw_store
       end
 
+      def tracker_time_key_exists?
+        if defined?(redis_store.exists?)
+          redis_store.exists?(tracker_time_key)
+        else
+          redis_store.exists(tracker_time_key)
+        end
+      end
+
       def tracker_key
-        'render_tracker_2'
+        "render_tracker_2"
       end
 
       def tracker_time_key
-        'render_tracker_time'
+        "render_tracker_time"
       end
     end
   end

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,25 +22,25 @@ 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
     # heroku asset compilation
-    IGNORE_DEFAULTS = %w[vendor/ .erb$ .slim$ /tmp internal:prelude schema.rb]
+    IGNORE_DEFAULTS = %w[vendor/ .erb$ .slim$ /tmp internal:prelude db/schema.rb]
 
     # Add in missing files which were never loaded
     # we need to know what all paths to check for unloaded files
@@ -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/integrations/resque.rb

@@ -22,4 +22,16 @@ module Coverband
   end
 end
 
-Resque::Job.prepend(Coverband::ResqueWorker)
+if defined?(Coverband::COVERBAND_ALTERNATE_PATCH)
+  Resque::Job.class_eval do
+    def perform_with_coverband
+      perform_without_coverband
+    ensure
+      Coverband.report_coverage
+    end
+    alias perform_without_coverband perform
+    alias perform perform_with_coverband
+  end
+else
+  Resque::Job.prepend(Coverband::ResqueWorker)
+end