coverband 4.0.1 → 4.2.0

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
@@ -133,7 +134,7 @@ module Coverband
 
       # Warning to identify condition from Issue #56
       def coverage_exceeding_source_warn
-        warn "Warning: coverage data provided by Coverage [#{coverage.size}] exceeds number of lines in #{filename} [#{src.size}]"
+        warn "Warning: coverage data from Coverage [#{coverage.size}] exceeds line count in #{filename} [#{src.size}]"
       end
 
       # Access SimpleCov::SourceFile::Line source lines by line number
@@ -210,6 +211,27 @@ module Coverband
         end
       end
 
+      # a bug that existed in simplecov was not checking that root
+      # was at the start of the file name
+      # I had previously patched this in my local Rails app
+      def short_name
+        filename.sub(/^#{Coverband.configuration.root}/, '.')
+                .sub(%r{^.*\/gems}, '.')
+                .gsub(%r{^\.\/}, '')
+      end
+
+      def relative_path
+        full_path_to_relative(filename)
+      end
+
+      def gem?
+        filename =~ %r{^.*\/gems\/}
+      end
+
+      def gem_name
+        gem? ? short_name.split('/').first : nil
+      end
+
       private
 
       # ruby 1.9 could use Float#round(places) instead

data/lib/coverband/utils/tasks.rb

@@ -3,27 +3,17 @@
 namespace :coverband do
   Coverband.configure
 
-  ###
-  # NOTE: If your project has set many simplecov filters.
-  # You might want to override them and clear the filters.
-  # Or run the task `coverage_no_filters` below.
-  ###
-  desc 'report runtime Coverband code coverage'
-  task coverage: :environment do
-    if Coverband.configuration.reporter == 'scov'
-      Coverband::Reporters::HTMLReport.report(Coverband.configuration.store)
-    else
-      Coverband::Reporters::ConsoleReport.report(Coverband.configuration.store)
-    end
+  def environment
+    Rake.application['environment'].invoke if Rake::Task.task_defined?('environment')
   end
 
-  desc 'report runtime coverband code coverage after disabling simplecov filters'
-  task coverage_no_filters: :environment do
+  desc 'report runtime Coverband code coverage'
+  task :coverage do
+    environment
     if Coverband.configuration.reporter == 'scov'
-      clear_simplecov_filters
       Coverband::Reporters::HTMLReport.report(Coverband.configuration.store)
     else
-      puts 'coverage without filters only makes sense for SimpleCov reports'
+      Coverband::Reporters::ConsoleReport.report(Coverband.configuration.store)
     end
   end
 
@@ -31,7 +21,17 @@ namespace :coverband do
   # clear data helpful for development or after configuration issues
   ###
   desc 'reset Coverband coverage data, helpful for development, debugging, etc'
-  task clear: :environment do
+  task :clear do
+    environment
     Coverband.configuration.store.clear!
   end
+
+  ###
+  # clear data helpful for development or after configuration issues
+  ###
+  desc 'upgrade previous Coverband datastore to latest format'
+  task :migrate do
+    environment
+    Coverband.configuration.store.migrate!
+  end
 end

data/lib/coverband/version.rb

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

data/lib/coverband.rb

@@ -3,9 +3,10 @@
 require 'logger'
 require 'json'
 require 'redis'
-
 require 'coverband/version'
+require 'coverband/at_exit'
 require 'coverband/configuration'
+require 'coverband/utils/file_path_helper'
 require 'coverband/adapters/base'
 require 'coverband/adapters/redis_store'
 require 'coverband/adapters/file_store'
@@ -13,9 +14,11 @@ require 'coverband/utils/s3_report'
 require 'coverband/utils/html_formatter'
 require 'coverband/utils/result'
 require 'coverband/utils/file_list'
+require 'coverband/utils/gem_list'
 require 'coverband/utils/source_file'
+require 'coverband/utils/file_groups'
 require 'coverband/utils/lines_classifier'
-require 'coverband/utils/railtie' if defined? ::Rails::Railtie
+require 'coverband/utils/results'
 require 'coverband/collectors/coverage'
 require 'coverband/reporters/base'
 require 'coverband/reporters/html_report'
@@ -28,6 +31,11 @@ require 'coverband/integrations/background'
 
 module Coverband
   CONFIG_FILE = './config/coverband.rb'
+  RUNTIME_TYPE = nil
+  EAGER_TYPE = :eager_loading
+  MERGED_TYPE = :merged
+  TYPES = [RUNTIME_TYPE, EAGER_TYPE]
+  ALL_TYPES = TYPES + [:merged]
 
   class << self
     attr_accessor :configuration_data
@@ -43,6 +51,11 @@ module Coverband
     else
       configuration.logger&.debug('using default configuration')
     end
+    coverage.reset_instance
+  end
+
+  def self.report_coverage(force_report = false)
+    Coverband::Collectors::Coverage.instance.report_coverage(force_report)
   end
 
   def self.configuration
@@ -51,13 +64,30 @@ module Coverband
 
   def self.start
     Coverband::Collectors::Coverage.instance
+    # TODO Railtie sets up at_exit after forks, via middleware, perhaps this hsould be
+    # added if not rails or if rails but not rackserverrunning
+    AtExit.register
     Background.start if configuration.background_reporting_enabled && !RackServerCheck.running?
   end
 
+  def self.eager_loading_coverage!
+    coverage.eager_loading!
+  end
+
+  def self.runtime_coverage!
+    coverage.runtime!
+  end
+
+  def self.coverage
+    Coverband::Collectors::Coverage.instance
+  end
+
   unless ENV['COVERBAND_DISABLE_AUTO_START']
     # Coverband should be setup as early as possible
     # to capture usage of things loaded by initializers or other Rails engines
     configure
     start
+    require 'coverband/utils/railtie' if defined? ::Rails::Railtie
+    require 'coverband/integrations/resque' if defined? Resque
   end
 end

data/public/application.css

@@ -748,6 +748,11 @@ td {
     text-align: center;
     border-radius: 6px; }
 
+  .loader {
+    text-align: center;
+  }
+
+
 #header {
   color: #FFF;
   font-size: 12px;