coverband 4.2.0 → 4.2.1.rc1

data/lib/coverband/utils/results.rb

@@ -20,6 +20,41 @@ module Coverband
         get_results(results_type).source_files.find { |file| file.filename == source_file.filename }
       end
 
+      def runtime_relevant_coverage(source_file)
+        return unless eager_loading_coverage && runtime_coverage
+
+        eager_file = get_eager_file(source_file)
+        runtime_file = get_runtime_file(source_file)
+
+        return 0.0 unless runtime_file
+
+        return runtime_file.formatted_covered_percent unless eager_file
+
+        runtime_relavant_lines = eager_file.relevant_lines - eager_file.covered_lines_count
+        runtime_file.runtime_relavant_calculations(runtime_relavant_lines) { |file| file.formatted_covered_percent }
+      end
+
+      def runtime_relavent_lines(source_file)
+        return 0 unless runtime_coverage
+
+        eager_file = get_eager_file(source_file)
+        runtime_file = get_runtime_file(source_file)
+
+        return runtime_file.covered_lines_count unless eager_file
+
+        eager_file.relevant_lines - eager_file.covered_lines_count
+      end
+
+      ###
+      # TODO: Groups still have some issues, this should be generic for groups, but right now gem_name
+      # is specifically called out, need to revisit all gorups code.
+      ###
+      def group_file_list_with_type(group, file_list, results_type)
+        return unless get_results(results_type)
+
+        get_results(results_type).groups[group].find { |gem_files| gem_files.first.gem_name == file_list.first.gem_name }
+      end
+
       def file_from_path_with_type(full_path, results_type = :merged)
         return unless get_results(results_type)
 
@@ -44,6 +79,22 @@ module Coverband
 
       private
 
+      def get_eager_file(source_file)
+        eager_loading_coverage.source_files.find { |file| file.filename == source_file.filename }
+      end
+
+      def get_runtime_file(source_file)
+        runtime_coverage.source_files.find { |file| file.filename == source_file.filename }
+      end
+
+      def eager_loading_coverage
+        get_results(Coverband::EAGER_TYPE)
+      end
+
+      def runtime_coverage
+        get_results(Coverband::RUNTIME_TYPE)
+      end
+
       ###
       # This is a first version of lazy loading the results
       # for the full advantage we need to push lazy loading to the file level

data/lib/coverband/utils/source_file.rb

@@ -11,6 +11,8 @@ 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 +37,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 +51,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 +67,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 +93,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}/, '')
@@ -151,6 +163,10 @@ module Coverband
         Float(covered_lines.size * 100.0 / relevant_lines.to_f)
       end
 
+      def formatted_covered_percent
+        covered_percent&.round(2)
+      end
+
       def covered_strength
         return 0.0 if relevant_lines.zero?
 
@@ -166,7 +182,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 +190,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,7 +240,7 @@ 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
 
@@ -229,7 +253,7 @@ module Coverband
       end
 
       def gem_name
-        gem? ? short_name.split('/').first : nil
+        gem? ? short_name.split('/').first.gsub(/^\./, '') : nil
       end
 
       private

data/lib/coverband/utils/tasks.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 namespace :coverband do
-  Coverband.configure
+  # handles configuring in require => false and COVERBAND_DISABLE_AUTO_START cases
+  Coverband.configure unless Coverband.configured?
 
   def environment
+    Coverband.configuration.report_on_exit = false
+    Coverband.configuration.background_reporting_enabled = false
     Rake.application['environment'].invoke if Rake::Task.task_defined?('environment')
   end
 
@@ -11,12 +14,18 @@ namespace :coverband do
   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
+    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
   ###

data/lib/coverband/version.rb

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

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,

data/test/benchmarks/benchmark.rake

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 namespace :benchmarks do
   # https://github.com/evanphx/benchmark-ips
   # Enable and start GC before each job run. Disable GC afterwards.
@@ -13,11 +14,9 @@ namespace :benchmarks do
       run_gc
     end
 
-    def warmup_stats(*)
-    end
+    def warmup_stats(*); end
 
-    def add_report(*)
-    end
+    def add_report(*); end
 
     private
 
@@ -33,11 +32,7 @@ namespace :benchmarks do
   end
 
   def clone_classifier
-    # rubocop:disable Style/IfUnlessModifier
-    unless Dir.exist? classifier_dir
-      system "git clone https://github.com/jekyll/classifier-reborn.git #{classifier_dir}"
-    end
-    # rubocop:enable Style/IfUnlessModifier
+    system "git clone https://github.com/jekyll/classifier-reborn.git #{classifier_dir}" unless Dir.exist? classifier_dir
   end
 
   # desc 'setup standard benchmark'
@@ -79,7 +74,6 @@ namespace :benchmarks do
   task :setup_redis do
     Coverband.configure do |config|
       config.root                = Dir.pwd
-      config.reporting_frequency = 100.0
       config.logger              = $stdout
       config.store               = benchmark_redis_store
     end
@@ -89,7 +83,6 @@ namespace :benchmarks do
   task :setup_file do
     Coverband.configure do |config|
       config.root                = Dir.pwd
-      config.reporting_frequency = 100.0
       config.logger              = $stdout
       file_path                  = '/tmp/benchmark_store.json'
       config.store               = Coverband::Adapters::FileStore.new(file_path)
@@ -134,7 +127,7 @@ namespace :benchmarks do
       x.config(time: 12, warmup: 5, suite: suite)
       x.report 'coverband' do
         work
-        Coverband.report_coverage(true)
+        Coverband.report_coverage
       end
       x.report 'no coverband' do
         work
@@ -160,6 +153,7 @@ namespace :benchmarks do
   def adjust_report(report)
     report.keys.each do |file|
       next unless rand < 0.15
+
       report[file] = fake_line_numbers
     end
     report
@@ -170,11 +164,7 @@ namespace :benchmarks do
     # this is a hack because in the benchmark we don't have real files
     ###
     def store.file_hash(file)
-      if @file_hash_cache[file]
-        @file_hash_cache[file]
-      else
-        @file_hash_cache[file] = Digest::MD5.file(__FILE__).hexdigest
-      end
+      @file_hash_cache[file] || @file_hash_cache[file] = Digest::MD5.file(__FILE__).hexdigest
     end
 
     def store.full_path_to_relative(file)
@@ -232,7 +222,7 @@ namespace :benchmarks do
       10.times do
         Coverband.configure do |config|
           redis_url = ENV['CACHE_REDIS_URL'] || ENV['REDIS_URL']
-          config.store = Coverband::Adapters::RedisStore.new(Redis.new(url: redis_url), redis_namespace: 'coverband_data')
+          config.store = Coverband::Adapters::RedisStore.new(Redis.new(url: redis_url), redis_namespace: 'coverband_bench_data')
         end
       end
     end.pretty_print
@@ -269,13 +259,13 @@ namespace :benchmarks do
   end
 
   # desc 'runs benchmarks on default redis setup'
-  task run_redis: [:setup, :setup_redis] do
+  task run_redis: %i[setup setup_redis] do
     puts 'Coverband configured with default Redis store'
     run_work(true)
   end
 
   # desc 'runs benchmarks file store'
-  task run_file: [:setup, :setup_file] do
+  task run_file: %i[setup setup_file] do
     puts 'Coverband configured with file store'
     run_work(true)
   end

data/test/coverband/adapters/file_store_test.rb

@@ -10,13 +10,13 @@ class AdaptersFileStoreTest < Minitest::Test
     @store = Coverband::Adapters::FileStore.new(@test_file_path)
   end
 
-  def test_covered_lines_for_file
-    assert_equal @store.covered_lines_for_file('dog.rb')[0],  1
-    assert_equal @store.covered_lines_for_file('dog.rb')[1],  2
+  def test_coverage
+    assert_equal @store.coverage['dog.rb']['data'][0],  1
+    assert_equal @store.coverage['dog.rb']['data'][1],  2
   end
 
   def test_covered_lines_when_null
-    assert_equal @store.covered_lines_for_file('none.rb'), []
+    assert_nil @store.coverage['none.rb']
   end
 
   def test_covered_files
@@ -31,7 +31,7 @@ class AdaptersFileStoreTest < Minitest::Test
   def test_save_report
     mock_file_hash
     @store.send(:save_report, 'cat.rb' => [0, 1])
-    assert_equal @store.covered_lines_for_file('cat.rb')[1], 1
+    assert_equal @store.coverage['cat.rb']['data'][1], 1
   end
 
   private

data/test/coverband/adapters/redis_store_test.rb

@@ -7,8 +7,11 @@ class RedisTest < Minitest::Test
 
   def setup
     super
+    Coverband.configuration.redis_namespace = 'coverband_test'
     @redis = Redis.new
-    @store = Coverband::Adapters::RedisStore.new(@redis)
+    @store = Coverband::Adapters::RedisStore.new(@redis, redis_namespace: 'coverband_test')
+    Coverband.configuration.store = @store
+    @store.clear!
   end
 
   def test_coverage
@@ -58,21 +61,19 @@ class RedisTest < Minitest::Test
     assert_nil @store.type
   end
 
-  def test_covered_lines_for_file
+  def test_coverage_for_file
     mock_file_hash
     expected = basic_coverage
     @store.save_report(expected)
-    assert_equal example_line, @store.covered_lines_for_file('app_path/dog.rb')
+    assert_equal example_line, @store.coverage['app_path/dog.rb']['data']
   end
 
-  def test_covered_lines_when_null
-    assert_equal [], @store.covered_lines_for_file('app_path/dog.rb')
+  def test_coverage_when_null
+    assert_nil @store.coverage['app_path/dog.rb']
   end
 
   def test_clear
     @redis.expects(:del).twice
     @store.clear!
   end
-
-
 end

data/test/coverband/at_exit_test.rb

@@ -9,5 +9,3 @@ class AtExitTest < Minitest::Test
     2.times { Coverband::AtExit.register }
   end
 end
-
-

data/test/coverband/collectors/coverage_test.rb

@@ -8,11 +8,11 @@ class CollectorsCoverageTest < Minitest::Test
   def setup
     super
     Coverband.configure do |config|
-      config.store = Coverband::Adapters::RedisStore.new(Redis.new)
+      config.store = Coverband::Adapters::RedisStore.new(Redis.new, redis_namespace: 'coverband_test')
     end
     @coverband = Coverband::Collectors::Coverage.instance.reset_instance
     # preload first coverage hit
-    @coverband.report_coverage(true)
+    @coverband.report_coverage
   end
 
   def teardown
@@ -24,17 +24,31 @@ class CollectorsCoverageTest < Minitest::Test
 
   test 'Dog class coverage' do
     file = require_unique_file
-    coverband.report_coverage(true)
+    coverband.report_coverage
     coverage = Coverband.configuration.store.coverage
-    assert_equal(coverage[file]["data"], [nil, nil, 1, 1, 0, nil, nil])
+    assert_equal(coverage[file]['data'], [nil, nil, 1, 1, 0, nil, nil])
   end
 
   test 'Dog method and class coverage' do
     load File.expand_path('../../dog.rb', File.dirname(__FILE__))
     Dog.new.bark
-    coverband.report_coverage(true)
+    coverband.report_coverage
     coverage = Coverband.configuration.store.coverage
-    assert_equal(coverage["./test/dog.rb"]["data"], [nil, nil, 1, 1, 1, nil, nil])
+    assert_equal(coverage['./test/dog.rb']['data'], [nil, nil, 1, 1, 1, nil, nil])
+  end
+
+  test 'Dog eager load coverage' do
+    store = Coverband.configuration.store
+    assert_nil store.type
+    file = coverband.eager_loading do
+      require_unique_file
+    end
+    coverage = Coverband.configuration.store.coverage[file]
+    assert_nil coverage, 'No runtime coverage'
+    coverband.eager_loading!
+    coverage = Coverband.configuration.store.coverage[file]
+    refute_nil coverage, 'Eager load coverage is present'
+    assert_equal(coverage['data'], [nil, nil, 1, 1, 0, nil, nil])
   end
 
   test 'gets coverage instance' do
@@ -46,8 +60,8 @@ class CollectorsCoverageTest < Minitest::Test
   end
 
   test 'report_coverage raises errors in tests' do
+    Coverband::Adapters::RedisStore.any_instance.stubs(:save_report).raises('Oh no')
     @coverband.reset_instance
-    @coverband.expects(:ready_to_report?).raises('Oh no')
     assert_raises RuntimeError do
       @coverband.report_coverage
     end
@@ -55,10 +69,10 @@ class CollectorsCoverageTest < Minitest::Test
 
   test 'report_coverage raises errors in tests with verbose enabled' do
     Coverband.configuration.verbose = true
-    logger = mock()
+    logger = mock
     Coverband.configuration.logger = logger
     @coverband.reset_instance
-    @coverband.expects(:ready_to_report?).raises('Oh no')
+    Coverband::Adapters::RedisStore.any_instance.stubs(:save_report).raises('Oh no')
     logger.expects(:error).times(3)
     error = assert_raises RuntimeError do
       @coverband.report_coverage
@@ -70,4 +84,38 @@ class CollectorsCoverageTest < Minitest::Test
     heroku_build_file = '/tmp/build_81feca8c72366e4edf020dc6f1937485/config/initializers/assets.rb'
     assert_equal false, @coverband.send(:track_file?, heroku_build_file)
   end
+
+  test 'one shot line coverage disabled for ruby >= 2.6' do
+    return unless Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
+    Coverband::Collectors::Coverage.expects(:ruby_version_greater_than_or_equal_to?).with('2.6.0').returns(true)
+    ::Coverage.expects(:running?).returns(false)
+    ::Coverage.expects(:start).with(oneshot_lines: false)
+    Coverband::Collectors::Coverage.send(:new)
+  end
+
+  test 'one shot line coverage enabled for ruby >= 2.6' do
+    return unless Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
+    Coverband.configuration.expects(:use_oneshot_lines_coverage).returns(true)
+    Coverband::Collectors::Coverage.expects(:ruby_version_greater_than_or_equal_to?).with('2.6.0').returns(true)
+    ::Coverage.expects(:running?).returns(false)
+    ::Coverage.expects(:start).with(oneshot_lines: true)
+    Coverband::Collectors::Coverage.send(:new)
+  end
+
+  test 'one shot line coverage for ruby >= 2.6 when already running' do
+    return unless Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
+    Coverband::Collectors::Coverage.expects(:ruby_version_greater_than_or_equal_to?).with('2.6.0').returns(true)
+    ::Coverage.expects(:running?).returns(true)
+    ::Coverage.expects(:start).never
+    Coverband::Collectors::Coverage.send(:new)
+  end
+
+  test 'no one shot line coverage for ruby < 2.6' do
+    return unless Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
+    Coverband::Collectors::Coverage.expects(:ruby_version_greater_than_or_equal_to?).with('2.6.0').returns(false)
+    Coverband::Collectors::Coverage.expects(:ruby_version_greater_than_or_equal_to?).with('2.5.0').returns(true)
+    ::Coverage.expects(:running?).returns(false)
+    ::Coverage.expects(:start).with()
+    Coverband::Collectors::Coverage.send(:new)
+  end
 end