coverband 4.2.0 → 4.2.2

data/lib/coverband/utils/source_file.rb

@@ -10,7 +10,7 @@
 module Coverband
   module Utils
     class SourceFile
-      include Coverband::Utils::FilePathHelper
+      # TODO: Refactor Line into its own file
       # 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
@@ -35,6 +35,7 @@ module Coverband
           raise ArgumentError, 'Only String accepted for source' unless src.is_a?(String)
           raise ArgumentError, 'Only Integer accepted for line_number' unless line_number.is_a?(Integer)
           raise ArgumentError, 'Only Integer and nil accepted for coverage' unless coverage.is_a?(Integer) || coverage.nil?
+
           @src         = src
           @line_number = line_number
           @coverage    = coverage
@@ -48,7 +49,7 @@ module Coverband
 
         # Returns true if this is a line that has been covered
         def covered?
-          !never? && !skipped? && coverage > 0
+          !never? && !skipped? && coverage.positive?
         end
 
         # Returns true if this line is not relevant for coverage
@@ -64,7 +65,7 @@ module Coverband
         # Returns true if this line was skipped, false otherwise. Lines are skipped if they are wrapped with
         # # :nocov: comment lines.
         def skipped?
-          !!skipped
+          skipped
         end
 
         # The status of this line - either covered, missed, skipped or never. Useful i.e. for direct use
@@ -90,18 +91,27 @@ module Coverband
 
       def initialize(filename, file_data)
         @filename = filename
+        @runtime_relavant_lines = nil
         if file_data.is_a?(Hash)
           @coverage = file_data['data']
           @first_updated_at = @last_updated_at = NOT_AVAILABLE
           @first_updated_at = Time.at(file_data['first_updated_at']) if file_data['first_updated_at']
           @last_updated_at =  Time.at(file_data['last_updated_at']) if file_data['last_updated_at']
         else
+          # TODO: Deprecate this code path this was backwards compatability from 3-4
           @coverage = file_data
           @first_updated_at = NOT_AVAILABLE
           @last_updated_at = NOT_AVAILABLE
         end
       end
 
+      def runtime_relavant_calculations(runtime_relavant_lines)
+        @runtime_relavant_lines = runtime_relavant_lines
+        yield self
+      ensure
+        @runtime_relavant_lines = nil
+      end
+
       # The path to this source file relative to the projects directory
       def project_filename
         @filename.sub(/^#{Coverband.configuration.root}/, '')
@@ -148,7 +158,12 @@ module Coverband
 
         return 0.0 if relevant_lines.zero?
 
-        Float(covered_lines.size * 100.0 / relevant_lines.to_f)
+        # handle edge case where runtime in dev can go over 100%
+        [Float(covered_lines.size * 100.0 / relevant_lines.to_f), 100.0].min
+      end
+
+      def formatted_covered_percent
+        covered_percent&.round(2)
       end
 
       def covered_strength
@@ -166,7 +181,7 @@ module Coverband
       end
 
       def relevant_lines
-        lines.size - never_lines.size - skipped_lines.size
+        @runtime_relavant_lines || (lines.size - never_lines.size - skipped_lines.size)
       end
 
       # Returns all covered lines as SimpleCov::SourceFile::Line
@@ -174,6 +189,14 @@ module Coverband
         @covered_lines ||= lines.select(&:covered?)
       end
 
+      def covered_lines_count
+        covered_lines&.count
+      end
+
+      def line_coverage(index)
+        lines[index]&.coverage
+      end
+
       # Returns all lines that should have been, but were not covered
       # as instances of SimpleCov::SourceFile::Line
       def missed_lines
@@ -216,12 +239,12 @@ module Coverband
       # I had previously patched this in my local Rails app
       def short_name
         filename.sub(/^#{Coverband.configuration.root}/, '.')
-                .sub(%r{^.*\/gems}, '.')
+                .sub(%r{^.*\/gems\/}, '.')
                 .gsub(%r{^\.\/}, '')
       end
 
       def relative_path
-        full_path_to_relative(filename)
+        RelativeFileConverter.convert(filename)
       end
 
       def gem?
@@ -229,7 +252,7 @@ module Coverband
       end
 
       def gem_name
-        gem? ? short_name.split('/').first : nil
+        gem? ? short_name.split('/').first.gsub(%r{^\.}, '') : nil
       end
 
       private

data/lib/coverband/utils/tasks.rb

@@ -1,37 +1,37 @@
 # frozen_string_literal: true
 
 namespace :coverband do
-  Coverband.configure
-
-  def environment
-    Rake.application['environment'].invoke if Rake::Task.task_defined?('environment')
-  end
+  # handles configuring in require => false and COVERBAND_DISABLE_AUTO_START cases
+  Coverband.configure unless Coverband.configured?
 
   desc 'report runtime Coverband code coverage'
   task :coverage do
-    environment
     if Coverband.configuration.reporter == 'scov'
-      Coverband::Reporters::HTMLReport.report(Coverband.configuration.store)
+      Coverband::Reporters::HTMLReport.new(Coverband.configuration.store).report
     else
       Coverband::Reporters::ConsoleReport.report(Coverband.configuration.store)
     end
   end
 
+  desc 'report runtime Coverband code coverage'
+  task :coverage_server do
+    Rake.application['environment'].invoke if Rake::Task.task_defined?('environment')
+    Rack::Server.start app: Coverband::Reporters::Web.new, Port: ENV.fetch('COVERBAND_COVERAGE_PORT', 1022).to_i
+  end
+
   ###
   # clear data helpful for development or after configuration issues
   ###
   desc 'reset Coverband coverage data, helpful for development, debugging, etc'
   task :clear do
-    environment
     Coverband.configuration.store.clear!
   end
 
   ###
-  # clear data helpful for development or after configuration issues
+  # Updates the data in the coverband store from one format to another
   ###
   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,9 @@
 # frozen_string_literal: true
 
+###
+# ensure we properly do release candidate versioning; https://github.com/danmayer/coverband/issues/288
+# use format '4.2.1.rc.1' ~> 4.2.1.rc to prerelease versions like v4.2.1.rc.2 and v4.2.1.rc.3
+###
 module Coverband
-  VERSION = '4.2.0'
+  VERSION = '4.2.2'
 end

data/lib/coverband.rb

@@ -6,10 +6,13 @@ require 'redis'
 require 'coverband/version'
 require 'coverband/at_exit'
 require 'coverband/configuration'
-require 'coverband/utils/file_path_helper'
+require 'coverband/utils/relative_file_converter'
+require 'coverband/utils/absolute_file_converter'
 require 'coverband/adapters/base'
 require 'coverband/adapters/redis_store'
+require 'coverband/adapters/hash_redis_store'
 require 'coverband/adapters/file_store'
+require 'coverband/utils/file_hasher'
 require 'coverband/utils/s3_report'
 require 'coverband/utils/html_formatter'
 require 'coverband/utils/result'
@@ -20,27 +23,26 @@ require 'coverband/utils/file_groups'
 require 'coverband/utils/lines_classifier'
 require 'coverband/utils/results'
 require 'coverband/collectors/coverage'
+require 'coverband/collectors/view_tracker'
 require 'coverband/reporters/base'
 require 'coverband/reporters/html_report'
 require 'coverband/reporters/console_report'
-require 'coverband/integrations/background'
-require 'coverband/integrations/rack_server_check'
 require 'coverband/reporters/web'
-require 'coverband/integrations/middleware'
 require 'coverband/integrations/background'
+require 'coverband/integrations/background_middleware'
+require 'coverband/integrations/rack_server_check'
+
+Coverband::Adapters::RedisStore = Coverband::Adapters::HashRedisStore if ENV['COVERBAND_HASH_REDIS_STORE']
 
 module Coverband
+  @@configured = false
   CONFIG_FILE = './config/coverband.rb'
-  RUNTIME_TYPE = nil
+  RUNTIME_TYPE = :runtime
   EAGER_TYPE = :eager_loading
   MERGED_TYPE = :merged
   TYPES = [RUNTIME_TYPE, EAGER_TYPE]
   ALL_TYPES = TYPES + [:merged]
 
-  class << self
-    attr_accessor :configuration_data
-  end
-
   def self.configure(file = nil)
     configuration_file = file || ENV.fetch('COVERBAND_CONFIG', CONFIG_FILE)
     configuration
@@ -49,45 +51,60 @@ module Coverband
     elsif File.exist?(configuration_file)
       load configuration_file
     else
-      configuration.logger&.debug('using default configuration')
+      configuration.logger.debug('using default configuration')
     end
-    coverage.reset_instance
+    @@configured = true
+    coverage_instance.reset_instance
   end
 
-  def self.report_coverage(force_report = false)
-    Coverband::Collectors::Coverage.instance.report_coverage(force_report)
+  def self.configured?
+    @@configured
+  end
+
+  def self.report_coverage
+    coverage_instance.report_coverage
   end
 
   def self.configuration
-    self.configuration_data ||= Configuration.new
+    @configuration ||= Configuration.new
   end
 
   def self.start
     Coverband::Collectors::Coverage.instance
-    # TODO Railtie sets up at_exit after forks, via middleware, perhaps this hsould be
+    # TODO: Railtie sets up at_exit after forks, via middleware, perhaps this should be
     # added if not rails or if rails but not rackserverrunning
-    AtExit.register
-    Background.start if configuration.background_reporting_enabled && !RackServerCheck.running?
+    AtExit.register unless tasks_to_ignore?
+    Background.start if configuration.background_reporting_enabled && !RackServerCheck.running? && !tasks_to_ignore?
+  end
+
+  def self.tasks_to_ignore?
+    (defined?(Rake) &&
+    Rake.respond_to?(:application) &&
+    (Rake&.application&.top_level_tasks || []).any? { |task| Coverband::Configuration::IGNORE_TASKS.include?(task) })
   end
 
   def self.eager_loading_coverage!
-    coverage.eager_loading!
+    coverage_instance.eager_loading!
+  end
+
+  def self.eager_loading_coverage(&block)
+    coverage_instance.eager_loading(&block)
   end
 
   def self.runtime_coverage!
-    coverage.runtime!
+    coverage_instance.runtime!
   end
 
-  def self.coverage
+  private_class_method def self.coverage_instance
     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
+    require 'coverband/integrations/resque' if defined? ::Resque
+    require 'coverband/integrations/bundler' if defined? ::Bundler
   end
 end

data/public/application.css

@@ -634,15 +634,15 @@ abbr.timeago {
   float: right;
   color: #dddddd; }
 
-.group_tabs {
+.group_tabs, .extra_tabs {
   list-style: none;
   float: left;
   margin: 0;
   padding: 0; }
-  .group_tabs li {
+  .group_tabs li, .extra_tabs li {
     display: inline;
     float: left; }
-    .group_tabs li a {
+    .group_tabs li a, .extra_tabs li a {
       font-family: Helvetica, Arial, sans-serif;
       display: block;
       float: left;
@@ -664,15 +664,15 @@ abbr.timeago {
       -moz-border-radius-topright: 2px;
       border-top-left-radius: 2px;
       border-top-right-radius: 2px; }
-      .group_tabs li a:hover {
+      .group_tabs li a:hover, .extra_tabs li a:hover {
         background-color: #cccccc;
         background: -webkit-gradient(linear, 0 0, 0 bottom, from(#eeeeee), to(#aaaaaa));
         background: -moz-linear-gradient(#eeeeee, #aaaaaa);
         background: linear-gradient(#eeeeee, #aaaaaa); }
-      .group_tabs li a:active {
+      .group_tabs li a:active, .extra_tabs li a:active {
         padding-top: 5px;
         padding-bottom: 3px; }
-    .group_tabs li.active a {
+    .group_tabs li.active a, .extra_tabs li.active a {
       color: black;
       text-shadow: white 1px 1px 0px;
       background-color: #dddddd;

data/public/application.js

@@ -1,4 +1,14 @@
 $(document).ready(function() {
+  // remove the url params like notice=message so they don't stick around
+  window.history.replaceState(
+    "object or string",
+    "Coverband",
+    window.location.href.replace(/notice=.*/, "")
+  );
+  $(".notice")
+    .delay(3000)
+    .fadeOut("slow");
+
   $(".del").click(function() {
     if (!confirm("Do you want to delete")) {
       return false;
@@ -13,8 +23,25 @@ $(document).ready(function() {
     aoColumns: [
       null,
       { sType: "percent" },
+      { sType: "percent" },
+      null,
+      null,
+      null,
       null,
       null,
+      null
+    ]
+  });
+
+  // Configuration for fancy sortable tables for source file groups
+  $(".gem_list").dataTable({
+    aaSorting: [[1, "asc"]],
+    bPaginate: false,
+    bJQueryUI: true,
+    aoColumns: [
+      null,
+      { sType: "percent" },
+      { sType: "percent" },
       null,
       null,
       null,