coverband 4.1.0 → 4.2.0

data/lib/coverband/collectors/coverage.rb

@@ -1,48 +1,60 @@
 # frozen_string_literal: true
+require 'singleton'
+require_relative 'delta'
 
 module Coverband
   module Collectors
     ###
-    # TODO: look at alternatives to semaphore
-    # StandardError seems line be better option
+    # StandardError seems like be better option
     # coverband previously had RuntimeError here
     # but runtime error can let a large number of error crash this method
     # and this method is currently in a ensure block in middleware and threads
     ###
     class Coverage
-      def self.instance
-        Thread.current[:coverband_instance] ||= Coverband::Collectors::Coverage.new
-      end
+      include Singleton
 
       def reset_instance
         @project_directory = File.expand_path(Coverband.configuration.root)
-        @file_line_usage = {}
         @ignore_patterns = Coverband.configuration.ignore + ['internal:prelude', 'schema.rb']
         @reporting_frequency = Coverband.configuration.reporting_frequency
         @store = Coverband.configuration.store
         @verbose  = Coverband.configuration.verbose
         @logger   = Coverband.configuration.logger
-        @current_thread = Thread.current
         @test_env = Coverband.configuration.test_env
         @track_gems = Coverband.configuration.track_gems
-        @@previous_results = nil
-        Thread.current[:coverband_instance] = nil
+        Delta.reset
         self
       end
 
+      def runtime!
+        @store.type = nil
+      end
+
+      def eager_loading!
+        @store.type = Coverband::EAGER_TYPE
+      end
+
       def report_coverage(force_report = false)
         return if !ready_to_report? && !force_report
         raise 'no Coverband store set' unless @store
 
-        new_results = get_new_coverage_results
-        add_filtered_files(new_results)
-        @store.save_report(files_with_line_usage)
-        @file_line_usage.clear
+        original_previous_set = Delta.previous_results
+        files_with_line_usage = filtered_files(Delta.results)
+
+        ###
+        # Hack to prevent processes and threads from reporting first Coverage hit
+        # when we are in runtime collection mode, which do not have a cache of previous
+        # coverage to remove the initial stdlib Coverage loading data
+        ###
+        if ((original_previous_set.nil? && @store.type == Coverband::EAGER_TYPE) ||
+           (original_previous_set && @store.type != Coverband::EAGER_TYPE))
+          @store.save_report(files_with_line_usage)
+        end
       rescue StandardError => err
         if @verbose
-          @logger.error 'coverage failed to store'
-          @logger.error "error: #{err.inspect} #{err.message}"
-          @logger.error err.backtrace
+          @logger&.error 'coverage failed to store'
+          @logger&.error "error: #{err.inspect} #{err.message}"
+          @logger&.error err.backtrace
         end
         raise err if @test_env
       end
@@ -59,75 +71,27 @@ module Coverband
         @ignore_patterns.none? do |pattern|
           file.include?(pattern)
         end && (file.start_with?(@project_directory) ||
-         (@track_gems &&
-          Coverband.configuration.gem_paths.any? { |path| file.start_with?(path) }))
+                (@track_gems &&
+                 Coverband.configuration.gem_paths.any? { |path| file.start_with?(path) }))
       end
 
       private
 
-      def add_filtered_files(new_results)
-        new_results.each_pair do |file, line_counts|
-          next unless track_file?(file)
-          add_file(file, line_counts)
-        end
+      def filtered_files(new_results)
+        new_results.each_with_object({}) do |(file, line_counts), file_line_usage|
+          file_line_usage[file] = line_counts if track_file?(file)
+        end.select { |_file_name, coverage| coverage.any? { |value| value&.nonzero? } }
       end
 
       def ready_to_report?
         (rand * 100.0) >= (100.0 - @reporting_frequency)
       end
 
-      def get_new_coverage_results
-        @semaphore.synchronize { new_coverage(::Coverage.peek_result.dup) }
-      end
-
-      def files_with_line_usage
-        @file_line_usage.select do |_file_name, coverage|
-          coverage.any? { |value| value&.nonzero? }
-        end
-      end
-
-      def array_diff(latest, original)
-        latest.map.with_index { |v, i| (v && original[i]) ? v - original[i] : nil }
-      end
-
-      def previous_results
-        @@previous_results
-      end
-
-      def add_previous_results(val)
-        @@previous_results = val
-      end
-
-      def new_coverage(current_coverage)
-        if previous_results
-          new_results = {}
-          current_coverage.each_pair do |file, line_counts|
-            if previous_results[file]
-              new_results[file] = array_diff(line_counts, previous_results[file])
-            else
-              new_results[file] = line_counts
-            end
-          end
-        else
-          new_results = current_coverage
-        end
-
-        add_previous_results(current_coverage)
-        new_results.dup
-      end
-
-      def add_file(file, line_counts)
-        @file_line_usage[file] = line_counts
-      end
-
       def initialize
         if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3.0')
           raise NotImplementedError, 'not supported until Ruby 2.3.0 and later'
         end
-        unless defined?(::Coverage)
-          # puts 'loading coverage'
-          require 'coverage'
-        end
+        require 'coverage'
         if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
           ::Coverage.start unless ::Coverage.running?
         else
@@ -138,8 +102,6 @@ module Coverband
             load safe_file
           end
         end
-        @semaphore = Mutex.new
-        @@previous_results = nil
         reset_instance
       end
     end

data/lib/coverband/collectors/delta.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+module Coverband
+  module Collectors
+    class Delta
+      @semaphore = Mutex.new
+      @@previous_coverage = nil
+      attr_reader :current_coverage
+
+      def initialize(current_coverage)
+        @current_coverage = current_coverage
+      end
+
+      class RubyCoverage
+        def self.results
+          ::Coverage.peek_result.dup
+        end
+      end
+
+      def self.results(process_coverage = RubyCoverage)
+        @semaphore.synchronize do
+          set_default_results
+          new(process_coverage.results).results
+        end
+      end
+
+      def self.previous_results
+        @@previous_coverage
+      end
+
+      def self.set_default_results
+        @@previous_coverage ||= {}
+      end
+
+      def results
+        new_results = generate
+        @@previous_coverage = current_coverage
+        new_results
+      end
+
+      def self.reset
+        @@previous_coverage = nil
+      end
+
+      private
+
+      def generate
+        current_coverage.each_with_object({}) do |(file, line_counts), new_results|
+          if @@previous_coverage[file]
+            new_results[file] = array_diff(line_counts, @@previous_coverage[file])
+          else
+            new_results[file] = line_counts
+          end
+        end
+      end
+
+      def array_diff(latest, original)
+        latest.map.with_index do |v, i|
+          if (v && original[i])
+            [0, v - original[i]].max
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coverband/integrations/background.rb

@@ -3,6 +3,7 @@
 module Coverband
   class Background
     @semaphore = Mutex.new
+    @thread = nil
 
     def self.stop
       return unless @thread
@@ -15,15 +16,15 @@ module Coverband
     end
 
     def self.running?
-      !!@thread
+      @thread && @thread.alive?
     end
 
     def self.start
-      return if @thread
+      return if running?
 
       logger = Coverband.configuration.logger
       @semaphore.synchronize do
-        return if @thread
+        return if running?
         logger&.debug('Coverband: Starting background reporting')
         sleep_seconds = Coverband.configuration.background_reporting_sleep_seconds
         @thread = Thread.new do

data/lib/coverband/integrations/rack_server_check.rb

@@ -20,7 +20,10 @@ module Coverband
 
     def rails_server?
       @stack.any? do |location|
-        location.path.include?('rails/commands/commands_tasks.rb') && location.label == 'server'
+        (
+          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
   end

data/lib/coverband/integrations/resque.rb

@@ -2,9 +2,13 @@
 
 Resque.after_fork do |job|
   Coverband.start
+  Coverband.runtime_coverage!
+  # no reason to miss coverage on a first resque job
+  Coverband::Collectors::Delta.set_default_results
 end
 
 Resque.before_first_fork do
+  Coverband.eager_loading_coverage!
   Coverband.configuration.background_reporting_enabled = false
   Coverband::Background.stop
   Coverband::Collectors::Coverage.instance.report_coverage(true)
@@ -21,4 +25,3 @@ module Coverband
 end
 
 Resque::Job.prepend(Coverband::ResqueWorker)
-

data/lib/coverband/reporters/base.rb

@@ -15,7 +15,7 @@ module Coverband
 
           if Coverband.configuration.verbose
             msg = "report:\n #{scov_style_report.inspect}"
-            Coverband.configuration.logger.debug msg
+            # Coverband.configuration.logger.debug msg
           end
           scov_style_report
         end
@@ -28,15 +28,18 @@ module Coverband
           end
 
           # normalize names across servers
-          report_hash.each_with_object({}) do |(key, vals), fixed_report|
-            filename = relative_path_to_full(key, roots)
-            fixed_report[filename] = if fixed_report.key?(filename) && fixed_report[filename]['data'] && vals['data']
-                                       merged_data = merge_arrays(fixed_report[filename]['data'], vals['data'])
-                                       vals['data'] = merged_data
-                                       vals
-                                     else
-                                       vals
-                                     end
+          report_hash.each_with_object({}) do |(name, report), fixed_report|
+            fixed_report[name] = {}
+            report.each_pair do |key, vals|
+              filename = relative_path_to_full(key, roots)
+              fixed_report[name][filename] = if fixed_report[name].key?(filename) && fixed_report[name][filename]['data'] && vals['data']
+                                         merged_data = merge_arrays(fixed_report[name][filename]['data'], vals['data'])
+                                         vals['data'] = merged_data
+                                         vals
+                                       else
+                                         vals
+                                       end
+            end
           end
         end
 
@@ -64,10 +67,14 @@ module Coverband
         ###
         def get_current_scov_data_imp(store, roots)
           scov_style_report = {}
-          store.coverage.each_pair do |key, line_data|
-            next if Coverband.configuration.ignore.any? { |i| key.match(i) }
-            next unless line_data
-            scov_style_report[key] = line_data
+          store.get_coverage_report.each_pair do |name, data|
+            data.each_pair do |key, line_data|
+              next if Coverband.configuration.ignore.any? { |i| key.match(i) }
+              next unless line_data
+
+              scov_style_report[name] = {} unless scov_style_report.key?(name)
+              scov_style_report[name][key] = line_data
+            end
           end
 
           scov_style_report = fix_file_names(scov_style_report, roots)

data/lib/coverband/reporters/html_report.rb

@@ -3,23 +3,28 @@
 module Coverband
   module Reporters
     class HTMLReport < Base
-      def self.report(store, options = {})
-        scov_style_report = super(store, options)
-        open_report = options.fetch(:open_report) { true }
-        html = options.fetch(:html) { false }
-        notice = options.fetch(:notice) { nil }
-        base_path = options.fetch(:base_path) { nil }
+      attr_accessor :filtered_report_files, :open_report, :html, :notice,
+                    :base_path, :filename
 
-        # list all files, even if not tracked by Coverband (0% coverage)
-        tracked_glob = "#{Coverband.configuration.current_root}/{app,lib,config}/**/*.{rb}"
-        report_files = Coverband::Utils::Result.add_not_loaded_files(scov_style_report, tracked_glob)
-        # apply coverband filters
-        filtered_report_files = {}
-        report_files.each_pair do |file, data|
-          next if Coverband.configuration.ignore.any? { |i| file.match(i) }
-          filtered_report_files[file] = data
-        end
+      def initialize(store, options = {})
+        coverband_reports = Coverband::Reporters::Base.report(store, options)
+        self.open_report = options.fetch(:open_report) { true }
+        self.html = options.fetch(:html) { false }
+        # 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.filename = options.fetch(:filename) { nil }
+
+        self.filtered_report_files = self.class.fix_reports(coverband_reports)
+      end
+
+      def file_details
+        Coverband::Utils::HTMLFormatter.new(filtered_report_files,
+                                            base_path: base_path,
+                                            notice: notice).format_source_file!(filename)
+      end
 
+      def report
         if html
           Coverband::Utils::HTMLFormatter.new(filtered_report_files,
                                               base_path: base_path,
@@ -35,6 +40,26 @@ module Coverband
           Coverband::Utils::S3Report.instance.persist! if Coverband.configuration.s3_bucket
         end
       end
+
+      private
+
+      def self.fix_reports(reports)
+        # list all files, even if not tracked by Coverband (0% coverage)
+        tracked_glob = "#{Coverband.configuration.current_root}/{app,lib,config}/**/*.{rb}"
+        filtered_report_files = {}
+
+        reports.each_pair do |report_name, report_data|
+          filtered_report_files[report_name] = {}
+          report_files = Coverband::Utils::Result.add_not_loaded_files(report_data, tracked_glob)
+
+          # apply coverband filters
+          report_files.each_pair do |file, data|
+            next if Coverband.configuration.ignore.any? { |i| file.match(i) }
+
+            filtered_report_files[report_name][file] = data
+          end
+        end
+      end
     end
   end
 end

data/lib/coverband/reporters/web.rb

@@ -22,6 +22,8 @@ module Coverband
 
         if request.post?
           case request.path_info
+          when %r{\/clear_file}
+            clear_file
           when %r{\/clear}
             clear
           when %r{\/collect_coverage}
@@ -39,6 +41,8 @@ module Coverband
             [200, { 'Content-Type' => 'text/html' }, [settings]]
           when %r{\/debug_data}
             [200, { 'Content-Type' => 'text/json' }, [debug_data]]
+          when %r{\/load_file_details}
+            [200, { 'Content-Type' => 'text/json' }, [load_file_details]]
           when %r{\/$}
             [200, { 'Content-Type' => 'text/html' }, [index]]
           else
@@ -50,11 +54,11 @@ module Coverband
       def index
         notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params['notice'])}<br/>"
         notice = request.params['notice'] ? notice : ''
-        Coverband::Reporters::HTMLReport.report(Coverband.configuration.store,
-                                                html: true,
-                                                base_path: base_path,
-                                                notice: notice,
-                                                open_report: false)
+        Coverband::Reporters::HTMLReport.new(Coverband.configuration.store,
+                                             html: true,
+                                             base_path: base_path,
+                                             notice: notice,
+                                             open_report: false).report
       end
 
       def settings
@@ -62,7 +66,15 @@ module Coverband
       end
 
       def debug_data
-        Coverband.configuration.store.coverage.to_json
+        Coverband.configuration.store.get_coverage_report.to_json
+      end
+
+      def load_file_details
+        filename = request.params['filename']
+        Coverband::Reporters::HTMLReport.new(Coverband.configuration.store,
+                                             filename: filename,
+                                             base_path: base_path,
+                                             open_report: false).file_details
       end
 
       def collect_coverage
@@ -81,6 +93,17 @@ module Coverband
         [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
       end
 
+      def clear_file
+        if Coverband.configuration.web_enable_clear
+          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'
+        end
+        [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
+      end
+
       def reload_files
         Coverband.configuration&.safe_reload_files&.each do |safe_file|
           load safe_file

data/lib/coverband/utils/html_formatter.rb

@@ -18,7 +18,7 @@ module Coverband
       def initialize(report, options = {})
         @notice = options.fetch(:notice) { nil }
         @base_path = options.fetch(:base_path) { nil }
-        @coverage_result = Coverband::Utils::Result.new(report) if report
+        @coverage_result = Coverband::Utils::Results.new(report) if report
       end
 
       def format!
@@ -33,6 +33,12 @@ module Coverband
         format_settings
       end
 
+      def format_source_file!(filename)
+        source_file = @coverage_result.file_from_path_with_type(filename)
+  
+        formatted_source_file(@coverage_result, source_file)
+      end
+
       private
 
       def format_settings
@@ -86,20 +92,28 @@ module Coverband
       end
 
       # Returns the html for the given source_file
-      def formatted_source_file(source_file)
+      def formatted_source_file(result, source_file)
         template('source_file').result(binding)
       rescue Encoding::CompatibilityError => e
         puts "Encoding error file:#{source_file.filename} Coverband/ERB error #{e.message}."
       end
 
+      # Returns the html to ajax load a given source_file
+      def formatted_source_file_loader(result, source_file)
+        template('source_file_loader').result(binding)
+      rescue Encoding::CompatibilityError => e
+        puts "Encoding error file:#{source_file.filename} Coverband/ERB error #{e.message}."
+      end
+
       # Returns a table containing the given source files
-      def formatted_file_list(title, source_files, options = {})
+      def formatted_file_list(title, result, source_files, options = {})
         title_id = title.gsub(/^[^a-zA-Z]+/, '').gsub(/[^a-zA-Z0-9\-\_]/, '')
         # Silence a warning by using the following variable to assign to itself:
         # "warning: possibly useless use of a variable in void context"
         # The variable is used by ERB via binding.
         title_id = title_id
         options = options
+
         if title == 'Gems'
           template('gem_list').result(binding)
         else
@@ -116,7 +130,9 @@ module Coverband
       end
 
       def coverage_css_class(covered_percent)
-        if covered_percent > 90
+        if covered_percent.nil?
+          ''
+        elsif covered_percent > 90
           'green'
         elsif covered_percent > 80
           'yellow'

data/lib/coverband/utils/railtie.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+Coverband.eager_loading_coverage!
 module Coverband
   class Railtie < Rails::Railtie
     initializer 'coverband.configure' do |app|
@@ -8,6 +9,13 @@ module Coverband
 
     config.after_initialize do
       Coverband.report_coverage(true)
+      Coverband.configuration.logger&.debug('Coverband: reported after_initialize')
+      Coverband.runtime_coverage!
+    end
+
+    config.before_initialize do
+      Coverband.configuration.logger&.debug('Coverband: set to eager_loading')
+      Coverband.eager_loading_coverage!
     end
 
     rake_tasks do

data/lib/coverband/utils/result.rb

@@ -32,8 +32,9 @@ module Coverband
       # Initialize a new Coverband::Result from given Coverage.result (a Hash of filenames each containing an array of
       # coverage data)
       def initialize(original_result)
-        @original_result = original_result.freeze
-        @files = Coverband::Utils::FileList.new(original_result.map do |filename, coverage|
+        @original_result = (original_result || {}).freeze
+
+        @files = Coverband::Utils::FileList.new(@original_result.map do |filename, coverage|
           Coverband::Utils::SourceFile.new(filename, coverage) if File.file?(filename)
         end.compact.sort_by(&:short_name))
         filter!

data/lib/coverband/utils/results.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+####
+# A way to access the various coverage data breakdowns
+####
+module Coverband
+  module Utils
+    class Results
+      attr_accessor :type, :report
+
+      def initialize(report)
+        self.report = report
+        self.type = Coverband::MERGED_TYPE
+        @results = {}
+      end
+
+      def file_with_type(source_file, results_type)
+        return unless get_results(results_type)
+
+        get_results(results_type).source_files.find { |file| file.filename == source_file.filename }
+      end
+
+      def file_from_path_with_type(full_path, results_type = :merged)
+        return unless get_results(results_type)
+
+        get_results(results_type).source_files.find { |file| file.filename == full_path }
+      end
+
+      def method_missing(method, *args)
+        if get_results(type).respond_to?(method)
+          get_results(type).send(method, *args)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method)
+        if get_results(type).respond_to?(method)
+          true
+        else
+          false
+        end
+      end
+
+      private
+
+      ###
+      # This is a first version of lazy loading the results
+      # for the full advantage we need to push lazy loading to the file level
+      # inside Coverband::Utils::Result
+      ###
+      def get_results(type)
+        return nil unless Coverband::ALL_TYPES.include?(type)
+
+        if @results.key?(type)
+          @results[type]
+        else
+          @results[type] = Coverband::Utils::Result.new(report[type])
+        end
+      end
+    end
+  end
+end

data/lib/coverband/utils/source_file.rb

@@ -10,6 +10,7 @@
 module Coverband
   module Utils
     class SourceFile
+      include Coverband::Utils::FilePathHelper
       # Representation of a single line in a source file including
       # this specific line's source code, line_number and code coverage,
       # with the coverage being either nil (coverage not applicable, e.g. comment
@@ -219,6 +220,10 @@ module Coverband
                 .gsub(%r{^\.\/}, '')
       end
 
+      def relative_path
+        full_path_to_relative(filename)
+      end
+
       def gem?
         filename =~ %r{^.*\/gems\/}
       end

data/lib/coverband/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coverband
-  VERSION = '4.1.0'
+  VERSION = '4.2.0'
 end