coverband 6.0.1 → 6.0.3.rc.1

data/public/dependencies.js

@@ -1147,7 +1147,7 @@ this._iRecordsTotal:this.aiDisplayMaster.length};this.fnRecordsDisplay=function(
 bSort:true,bInfo:true,bAutoWidth:true,bProcessing:false,bSortClasses:true,bStateSave:false,bServerSide:false};this.oScroll={sX:"",sXInner:"",sY:"",bCollapse:false,iBarWidth:0};this.aanFeatures=[];this.oLanguage={sProcessing:"Processing...",sLengthMenu:"Show _MENU_ entries",sZeroRecords:"No matching records found",sEmptyTable:"No data available in table",sInfo:"Showing _START_ to _END_ of _TOTAL_ entries",sInfoEmpty:"Showing 0 to 0 of 0 entries",sInfoFiltered:"(filtered from _MAX_ total entries)",
 sInfoPostFix:"",sSearch:"Search:",sUrl:"",oPaginate:{sFirst:"First",sPrevious:"Previous",sNext:"Next",sLast:"Last"}};this.aoData=[];this.aiDisplay=[];this.aiDisplayMaster=[];this.aoColumns=[];this.iNextId=0;this.asDataSearch=[];this.oPreviousSearch={sSearch:"",bRegex:false,bSmart:true};this.aoPreSearchCols=[];this.aaSorting=[[0,"asc",0]];this.aaSortingFixed=null;this.asStripClasses=[];this.asDestoryStrips=[];this.fnFooterCallback=this.fnHeaderCallback=this.fnRowCallback=null;this.aoDrawCallback=[];
 this.fnInitComplete=null;this.sTableId="";this.nTableWrapper=this.nTBody=this.nTFoot=this.nTHead=this.nTable=null;this.iDefaultSortIndex=0;this.bInitialised=false;this.aoOpenRows=[];this.sDom="lfrtip";this.sPaginationType="two_button";this.iCookieDuration=7200;this.sCookiePrefix="SpryMedia_DataTables_";this.sAjaxSource=null;this.bAjaxDataGet=true;this.fnServerData=function(a,b,c){j.ajax({url:a,data:b,success:c,dataType:"json",cache:false,error:function(){alert("DataTables warning: JSON data from server failed to load or be parsed. This is most likely to be caused by a JSON formatting error.")}})};
-this.fnFormatNumber=function(a){if(a<1E3)return a;else{var b=a+"";a=b.split("");var c="";b=b.length;for(var d=0;d<b;d++){if(d%3===0&&d!==0)c=","+c;c=a[b-d-1]+c}}return c};this.aLengthMenu=[10,25,50,100];this.iDraw=0;this.iDrawError=-1;this._iDisplayLength=10;this._iDisplayStart=0;this._iDisplayEnd=10;this._iRecordsDisplay=this._iRecordsTotal=0;this.bJUI=false;this.oClasses=m.oStdClasses;this.bSorted=this.bFiltered=false;this.oInit=null}function q(a){return function(){var b=[B(this[m.iApiIndex])].concat(Array.prototype.slice.call(arguments));
+this.fnFormatNumber=function(a){if(a<1E3)return a;else{var b=a+"";a=b.split("");var c="";b=b.length;for(var d=0;d<b;d++){if(d%3===0&&d!==0)c=","+c;c=a[b-d-1]+c}}return c};this.aLengthMenu=[250];this.iDraw=0;this.iDrawError=-1;this._iDisplayLength=250;this._iDisplayStart=0;this._iDisplayEnd=250;this._iRecordsDisplay=this._iRecordsTotal=0;this.bJUI=false;this.oClasses=m.oStdClasses;this.bSorted=this.bFiltered=false;this.oInit=null}function q(a){return function(){var b=[B(this[m.iApiIndex])].concat(Array.prototype.slice.call(arguments));
 return m.oApi[a].apply(this,b)}}function r(a){if(a.bInitialised===false)setTimeout(function(){r(a)},200);else{na(a);z(a);if(a.oFeatures.bSort)O(a);else{a.aiDisplay=a.aiDisplayMaster.slice();F(a);D(a)}if(a.sAjaxSource!==null&&!a.oFeatures.bServerSide){K(a,true);a.fnServerData.call(a.oInstance,a.sAjaxSource,null,function(b){for(var c=0;c<b.aaData.length;c++)w(a,b.aaData[c]);a.iInitDisplayStart=a._iDisplayStart;if(a.oFeatures.bSort)O(a);else{a.aiDisplay=a.aiDisplayMaster.slice();F(a);D(a)}K(a,false);
 typeof a.fnInitComplete=="function"&&a.fnInitComplete.call(a.oInstance,a,b)})}else{typeof a.fnInitComplete=="function"&&a.fnInitComplete.call(a.oInstance,a);a.oFeatures.bServerSide||K(a,false)}}}function u(a,b,c){n(a.oLanguage,b,"sProcessing");n(a.oLanguage,b,"sLengthMenu");n(a.oLanguage,b,"sEmptyTable");n(a.oLanguage,b,"sZeroRecords");n(a.oLanguage,b,"sInfo");n(a.oLanguage,b,"sInfoEmpty");n(a.oLanguage,b,"sInfoFiltered");n(a.oLanguage,b,"sInfoPostFix");n(a.oLanguage,b,"sSearch");if(typeof b.oPaginate!=
 "undefined"){n(a.oLanguage.oPaginate,b.oPaginate,"sFirst");n(a.oLanguage.oPaginate,b.oPaginate,"sPrevious");n(a.oLanguage.oPaginate,b.oPaginate,"sNext");n(a.oLanguage.oPaginate,b.oPaginate,"sLast")}typeof b.sEmptyTable=="undefined"&&typeof b.sZeroRecords!="undefined"&&n(a.oLanguage,b,"sZeroRecords","sEmptyTable");c&&r(a)}function y(a,b){a.aoColumns[a.aoColumns.length++]={sType:null,_bAutoType:true,bVisible:true,bSearchable:true,bSortable:true,asSorting:["asc","desc"],sSortingClass:a.oClasses.sSortable,

data/roadmap.md

@@ -53,4 +53,4 @@ Will be the fully modern release that drops maintenance legacy support in favor
 
 It is important for a project to not only know what problems it is trying to solve, but what things are out of scope. We will start to try to document that here:
 
-* We have in the past tried to add coverage tracking for all gems, this added a lot of complexity and compuation overhead and slowed things down to much. It also was of less value than we had hoped. There are alterntative ways to instrument a shared library to track across multiple applications, and single application gem utilization is easier to handle in a one of basis. It is unlikely we will support that again.
+* We have in the past tried to add coverage tracking for all gems, this added a lot of complexity and computation overhead and slowed things down to much. It also was of less value than we had hoped. There are alternative ways to instrument a shared library to track across multiple applications, and single application gem utilization is easier to handle in a one of basis. It is unlikely we will support that again.

data/test/benchmarks/benchmark.rake

@@ -5,7 +5,7 @@ namespace :benchmarks do
   # Enable and start GC before each job run. Disable GC afterwards.
   #
   # Inspired by https://www.omniref.com/ruby/2.2.1/symbols/Benchmark/bm?#annotation=4095926&line=182
-  class GCSuite
+  class GCSuite # standard:disable Lint/ConstantDefinitionInBlock
     def warming(*)
       run_gc
     end
@@ -99,11 +99,11 @@ namespace :benchmarks do
     Coverband::Collectors::Coverage.instance.reset_instance
   end
 
-  LINES = 45
-  NON_NIL_LINES = 18
+  lines = 45
+  non_nil_lines = 18
   def fake_line_numbers
-    LINES.times.map do |line|
-      coverage = line < NON_NIL_LINES ? rand(5) : nil
+    lines.times.map do |line|
+      coverage = (line < non_nil_lines) ? rand(5) : nil
     end
   end
 

data/test/coverband/adapters/file_store_test.rb

@@ -16,7 +16,7 @@ class AdaptersFileStoreTest < Minitest::Test
       previous_file_path = "#{@test_file_path}.#{::Process.pid}"
       `rm #{@test_file_path}` if File.exist?(@test_file_path)
       `rm #{previous_file_path}` if File.exist?(previous_file_path)
-      File.open(previous_file_path, "w") { |f| f.write(test_data.to_json) }
+      File.write(previous_file_path, test_data.to_json)
       @store = Coverband::Adapters::FileStore.new(@test_file_path)
     end
 

data/test/coverband/adapters/hash_redis_store_test.rb

@@ -192,4 +192,52 @@ class HashRedisStoreTest < Minitest::Test
     @store.clear_file!("app_path/dog.rb")
     assert_nil @store.get_coverage_report[:merged]["./dog.rb"]
   end
+
+  def test_get_coverage_cache
+    @store = Coverband::Adapters::HashRedisStore.new(
+      @redis,
+      redis_namespace: "coverband_test",
+      relative_file_converter: MockRelativeFileConverter,
+      get_coverage_cache: true
+    )
+    @store.get_coverage_cache.stubs(:deferred_time).returns(0)
+    @store.get_coverage_cache.clear!
+    mock_file_hash
+    yesterday = DateTime.now.prev_day.to_time
+    mock_time(yesterday)
+    @store.save_report(
+      "app_path/dog.rb" => [0, 1, 2]
+    )
+    assert_equal(
+      {
+        "first_updated_at" => yesterday.to_i,
+        "last_updated_at" => yesterday.to_i,
+        "file_hash" => "abcd",
+        "data" => [0, 1, 2]
+      },
+      @store.coverage["./dog.rb"]
+    )
+    @store.save_report(
+      "app_path/dog.rb" => [0, 1, 2]
+    )
+    assert_equal(
+      {
+        "first_updated_at" => yesterday.to_i,
+        "last_updated_at" => yesterday.to_i,
+        "file_hash" => "abcd",
+        "data" => [0, 1, 2]
+      },
+      @store.coverage["./dog.rb"]
+    )
+    sleep 0.1 # wait caching thread finish
+    assert_equal(
+      {
+        "first_updated_at" => yesterday.to_i,
+        "last_updated_at" => yesterday.to_i,
+        "file_hash" => "abcd",
+        "data" => [0, 2, 4]
+      },
+      @store.coverage["./dog.rb"]
+    )
+  end
 end

data/test/coverband/collectors/coverage_test.rb

@@ -53,7 +53,7 @@ class CollectorsCoverageTest < Minitest::Test
   end
 
   test "defaults to a redis store" do
-    assert_equal Coverband::Adapters::RedisStore, coverband.instance_variable_get("@store").class
+    assert_equal Coverband::Adapters::RedisStore, coverband.instance_variable_get(:@store).class
   end
 
   test "report_coverage raises errors in tests" do

data/test/coverband/reporters/json_test.rb

@@ -38,7 +38,7 @@ class ReportJSONTest < Minitest::Test
     json = Coverband::Reporters::JSONReport.new(@store).report
     parsed = JSON.parse(json)
 
-    expected_keys = ["never_loaded", "runtime_percentage", "lines_of_code", "lines_covered", "lines_missed", "covered_percent", "covered_strength"]
+    expected_keys = ["never_loaded", "runtime_percentage", "lines_of_code", "lines_covered", "lines_runtime", "lines_missed", "covered_percent", "covered_strength"]
 
     assert_equal parsed["files"].length, 2
     parsed["files"].keys.each do |file|

data/test/coverband/utils/source_file_test.rb

@@ -7,10 +7,10 @@ require File.expand_path("../../test_helper", File.dirname(__FILE__))
 # initial version of test pulled into Coverband from Simplecov 12/19/2018
 ####
 describe Coverband::Utils::SourceFile do
-  COVERAGE_FOR_SAMPLE_RB = [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil, nil, nil, nil, nil, nil, nil].freeze
+  coverage_for_sample_rb = [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil, nil, nil, nil, nil, nil, nil].freeze
   describe "a source file initialized with some coverage data" do
     subject do
-      Coverband::Utils::SourceFile.new(source_fixture("sample.rb"), COVERAGE_FOR_SAMPLE_RB)
+      Coverband::Utils::SourceFile.new(source_fixture("sample.rb"), coverage_for_sample_rb)
     end
 
     it "has a filename" do
@@ -70,7 +70,7 @@ describe Coverband::Utils::SourceFile do
 
   describe "simulating potential Ruby 1.9 defect -- see Issue #56" do
     subject do
-      Coverband::Utils::SourceFile.new(source_fixture("sample.rb"), COVERAGE_FOR_SAMPLE_RB + [nil])
+      Coverband::Utils::SourceFile.new(source_fixture("sample.rb"), coverage_for_sample_rb + [nil])
     end
 
     it "has 16 source lines regardless of extra data in coverage array" do
@@ -88,10 +88,10 @@ describe Coverband::Utils::SourceFile do
   end
 
   describe "a file that is never relevant" do
-    COVERAGE_FOR_NEVER_RB = [nil, nil].freeze
+    coverage_for_never_rb = [nil, nil].freeze
 
     subject do
-      Coverband::Utils::SourceFile.new(source_fixture("never.rb"), COVERAGE_FOR_NEVER_RB)
+      Coverband::Utils::SourceFile.new(source_fixture("never.rb"), coverage_for_never_rb)
     end
 
     it "has 0.0 covered_strength" do
@@ -104,10 +104,10 @@ describe Coverband::Utils::SourceFile do
   end
 
   describe "a file where nothing is ever executed mixed with skipping #563" do
-    COVERAGE_FOR_SKIPPED_RB = [nil, nil, nil, nil].freeze
+    coverage_for_skipped_rb = [nil, nil, nil, nil].freeze
 
     subject do
-      Coverband::Utils::SourceFile.new(source_fixture("skipped.rb"), COVERAGE_FOR_SKIPPED_RB)
+      Coverband::Utils::SourceFile.new(source_fixture("skipped.rb"), coverage_for_skipped_rb)
     end
 
     it "has 0.0 covered_strength" do
@@ -120,10 +120,10 @@ describe Coverband::Utils::SourceFile do
   end
 
   describe "a file where everything is skipped and missed #563" do
-    COVERAGE_FOR_SKIPPED_RB_2 = [nil, nil, 0, nil].freeze
+    coverage_for_skipped_rb_2 = [nil, nil, 0, nil].freeze
 
     subject do
-      Coverband::Utils::SourceFile.new(source_fixture("skipped.rb"), COVERAGE_FOR_SKIPPED_RB_2)
+      Coverband::Utils::SourceFile.new(source_fixture("skipped.rb"), coverage_for_skipped_rb_2)
     end
 
     it "has 0.0 covered_strength" do
@@ -136,10 +136,10 @@ describe Coverband::Utils::SourceFile do
   end
 
   describe "a file where everything is skipped/irrelevamt but executed #563" do
-    COVERAGE_FOR_SKIPPED_AND_EXECUTED_RB = [nil, nil, 1, 1, 0, nil, nil, nil].freeze
+    coverage_for_skkiped_and_executed_rb = [nil, nil, 1, 1, 0, nil, nil, nil].freeze
 
     subject do
-      Coverband::Utils::SourceFile.new(source_fixture("skipped_and_executed.rb"), COVERAGE_FOR_SKIPPED_AND_EXECUTED_RB)
+      Coverband::Utils::SourceFile.new(source_fixture("skipped_and_executed.rb"), coverage_for_skkiped_and_executed_rb)
     end
 
     it "has 0.0 covered_strength" do

data/test/fixtures/casting_invitor.rb

@@ -34,7 +34,7 @@ class CastingInviter
 
   def invalid_invitees
     @invalid_invitees ||=
-      invitee_list.map { |item| item unless item.match(EMAIL_REGEX) }.compact
+      invitee_list.reject { |item| item.match(EMAIL_REGEX) }
   end
 
   def invitee_list

data/test/fixtures/sample.rb

@@ -8,9 +8,9 @@ class Foo
     @foo
   end
 
-  #:nocov:
+  # :nocov:
   def skipped
     @foo * 2
   end
-  #:nocov:
+  # :nocov:
 end

data/test/fixtures/skipped_and_executed.rb

@@ -5,4 +5,4 @@ class Foo
     0
   end
 end
-#:nocov:
+# :nocov:

data/test/forked/rails_rake_full_stack_test.rb

@@ -11,7 +11,7 @@ class RailsRakeFullStackTest < Minitest::Test
   end
 
   # test 'rake tasks shows coverage properly within eager_loading' do
-  # this was testing gem data, which we no logner support and I dont know if this makes sense anymre
+  # this was testing gem data, which we no longer support and I dont know if this makes sense anymre
   # end
 
   test "ignored rake tasks don't add coverage" do

data/test/integration/full_stack_send_deferred_eager_test.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require File.expand_path("../test_helper", File.dirname(__FILE__))
+require "rack"
+
+class FullStackSendDeferredEagerTest < Minitest::Test
+  REDIS_STORAGE_FORMAT_VERSION = Coverband::Adapters::RedisStore::REDIS_STORAGE_FORMAT_VERSION
+  TEST_RACK_APP = "../fake_app/basic_rack.rb"
+
+  def setup
+    super
+    Coverband::Collectors::Coverage.instance.reset_instance
+    Coverband.configure do |config|
+      config.background_reporting_enabled = false
+      config.track_gems = true
+      config.defer_eager_loading_data = true
+      config.send_deferred_eager_loading_data = false
+    end
+    Coverband.start
+    Coverband::Collectors::Coverage.instance.eager_loading!
+    @rack_file = require_unique_file "fake_app/basic_rack.rb"
+    Coverband.report_coverage
+    Coverband::Collectors::Coverage.instance.runtime!
+  end
+
+  test "call app" do
+    # eager loaded class coverage starts empty
+    Coverband.eager_loading_coverage!
+    expected = {}
+    assert_equal expected, Coverband.configuration.store.coverage
+
+    Coverband::Collectors::Coverage.instance.runtime!
+    request = Rack::MockRequest.env_for("/anything.json")
+    middleware = Coverband::BackgroundMiddleware.new(fake_app_with_lines)
+    results = middleware.call(request)
+    assert_equal "Hello Rack!", results.last
+    Coverband.report_coverage
+    expected = [nil, nil, 0, nil, 0, 0, 1, nil, nil]
+    assert_equal expected, Coverband.configuration.store.coverage[@rack_file]["data"]
+
+    # eager loaded class coverage is skipped at first normal coverage report
+    Coverband.eager_loading_coverage!
+    expected = {}
+    assert_equal expected, Coverband.configuration.store.coverage
+  end
+
+  private
+
+  def fake_app_with_lines
+    @fake_app_with_lines ||= ::HelloWorld.new
+  end
+end

data/test/test_helper.rb

@@ -92,11 +92,11 @@ Mocha::Configuration.prevent(:stubbing_method_unnecessarily)
 Mocha::Configuration.prevent(:stubbing_non_existent_method)
 
 def test(name, &block)
-  test_name = "test_#{name.gsub(/\s+/, "_")}".to_sym
+  test_name = :"test_#{name.gsub(/\s+/, "_")}"
   defined = begin
     instance_method(test_name)
-            rescue
-              false
+  rescue
+    false
   end
   raise "#{test_name} is already defined in #{self}" if defined
 
@@ -172,8 +172,6 @@ ensure
   $stderr = previous_stderr
 end
 
-require "coverband"
-
 Coverband::Configuration.class_eval do
   def test_env
     true

data/test/unique_files.rb

@@ -15,7 +15,7 @@ def require_unique_file(file = "dog.rb", variables = {})
   FileUtils.mkdir_p(Pathname.new(temp_file).dirname.to_s)
   file_contents = File.read("./test/#{file}")
   file_contents = ERB.new(file_contents).result(OpenStruct.new(variables).instance_eval { binding }) if variables.any?
-  File.open(temp_file, "w") { |w| w.write(file_contents) }
+  File.write(temp_file, file_contents)
   require temp_file
   Coverband::Utils::RelativeFileConverter.convert(File.expand_path(temp_file))
 end

data/views/file_list.erb

@@ -2,23 +2,27 @@
   <% unless options[:skip_nav] %>
     <h2>
       <span class="group_name"><%= title %></span>
-      (<span class="covered_percent"><span class="<%= coverage_css_class(source_files.covered_percent) %>"><%= source_files.covered_percent.round(2) %>%</span></span>
-       covered at
-       <span class="covered_strength">
-         <span class="<%= strength_css_class(source_files.covered_strength) %>">
-           <%= source_files.covered_strength.round(2) %>
-         </span>
-      </span> hits/line)
+      <% unless page %>
+        (<span class="covered_percent"><span class="<%= coverage_css_class(source_files.covered_percent) %>"><%= source_files.covered_percent.round(2) %>%</span></span>
+        covered at
+        <span class="covered_strength">
+          <span class="<%= strength_css_class(source_files.covered_strength) %>">
+            <%= source_files.covered_strength.round(2) %>
+          </span>
+        </span> hits/line)
+      <% end %>
     </h2>
   <% end %>
   <a name="<%= title_id %>"></a>
   <div>
-    <b><%= source_files.length %></b> files in total.
-    <b><%= source_files.lines_of_code %></b> relevant lines.
-    <span class="green"><b><%= source_files.covered_lines %></b> lines covered</span> and
-    <span class="red"><b><%= source_files.missed_lines %></b> lines missed </span>
+    <% unless page %>
+      <b><%= source_files.length %></b> files in total.
+      <b><%= source_files.lines_of_code %></b> relevant lines.
+      <span class="green"><b><%= source_files.covered_lines %></b> lines covered</span> and
+      <span class="red"><b><%= source_files.missed_lines %></b> lines missed </span>
+    <% end %>
   </div>
-  <table class="file_list">
+  <table class="file_list <%= page ? "unsorted" : "sorted" %>">
     <thead>
       <tr>
         <th title="The source file name">File</th>
@@ -33,26 +37,28 @@
       </tr>
     </thead>
     <tbody>
-      <% source_files.each do |source_file| %>
-        <tr>
-          <% source_class = source_file.never_loaded ? 'strong red' : 'strong'%>
-          <td class="<%= source_class %>">
-            <%= link_to_source_file(source_file) %>
-          </td>
-          <td class="<%= coverage_css_class(source_file.covered_percent) %> strong"><%= source_file.covered_percent.round(2).to_s %> %</td>
-          <% runtime_percentage = result.runtime_relevant_coverage(source_file) %>
-          <td class="<%= "#{coverage_css_class(runtime_percentage)}" %> strong">
-            <%= "#{runtime_percentage || '0'} %" %>
-          </td>
-          <td><%= source_file.lines.count %></td>
-          <td><%= source_file.covered_lines.count + source_file.missed_lines.count %></td>
-          <td><%= source_file.covered_lines.count %></td>
-          <td>
-            <%= result.file_with_type(source_file, Coverband::RUNTIME_TYPE)&.covered_lines_count || 0 %>
-          </td>
-          <td><%= source_file.missed_lines.count %></td>
-          <td><%= source_file.covered_strength %></td>
-        </tr>
+      <% unless page %>
+        <% source_files.each do |source_file| %>
+          <tr>
+            <% source_class = source_file.never_loaded ? 'strong red' : 'strong'%>
+            <td class="<%= source_class %>">
+              <%= link_to_source_file(source_file) %>
+            </td>
+            <td class="<%= coverage_css_class(source_file.covered_percent) %> strong"><%= source_file.covered_percent.round(2).to_s %> %</td>
+            <% runtime_percentage = result.runtime_relevant_coverage(source_file) %>
+            <td class="<%= "#{coverage_css_class(runtime_percentage)}" %> strong">
+              <%= "#{runtime_percentage || '0'} %" %>
+            </td>
+            <td><%= source_file.lines.count %></td>
+            <td><%= source_file.covered_lines.count + source_file.missed_lines.count %></td>
+            <td><%= source_file.covered_lines.count %></td>
+            <td>
+              <%= result.file_with_type(source_file, Coverband::RUNTIME_TYPE)&.covered_lines_count || 0 %>
+            </td>
+            <td><%= source_file.missed_lines.count %></td>
+            <td><%= source_file.covered_strength %></td>
+          </tr>
+        <% end %>
       <% end %>
     </tbody>
   </table>

data/views/layout.erb

@@ -26,9 +26,9 @@
       </div>
 
       <div class="source_files">
-      <% result.source_files.each do |source_file| %>
-        <%= formatted_source_file_loader(result, source_file) %>
-      <% end %>
+        <% result.source_files.each do |source_file| %>
+          <%= formatted_source_file_loader(result, source_file) %>
+        <% end %>
       </div>
     </div>
   </body>