coverband 4.2.2 → 4.2.3.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33ec68822b5c228e86048d62ded36cfeba06adf77022d07b39cdcb897c215f6f
-  data.tar.gz: 7494e163926def8f8406da850efe02f5cd79f6ba6377abaf14ccb09aedc6ca85
+  metadata.gz: f9f8a71fc670b19d665c9234dec871025649f29f958a5cc853992a2d3e05d95a
+  data.tar.gz: 210bd1569609d05d4d480152d64ae00cfcc3a233473f13d61192207b584d8314
 SHA512:
-  metadata.gz: fda6dd49e21244819834f20e857ba2f4c8fddec4b1096a2b7ecfad7acdf6352cb2d4a8783f1cb5efc1ea2dc1ef5d03e7712f709fb928e29461dd41fc2dff76d8
-  data.tar.gz: b318161bc9c3709d41a35bb8a4e108a5ab38bea2feb095b1fc8d900f6e8a9bcfcc37dbf90392408d2efa3d510a58ceff5c69d19a422e4923049c08ee69d20c9c
+  metadata.gz: 49e039fe18d8c049524b807af2e0005d7857cc550b65c61f1814ea2fdd64b304c2d5eeb7b6b653622054b338985bec217b245b87bbf6b8139d590609f977a980
+  data.tar.gz: 4985b01cb295f64dbee3543fc721e445d9066d956a71966672185eabc6ae87549ce893993dfef3dc142775836aef2b0102f10eb234fa564a0067049376a6b331

data/Rakefile

@@ -30,7 +30,7 @@ end
 desc 'load irb with this gem'
 task :console do
   puts 'running console'
-  exec 'bundle exec console'
+  exec 'bundle console'
 end
 
 # This is really just for testing and development because without configuration

data/lib/coverband/adapters/hash_redis_store.rb

@@ -104,7 +104,8 @@ module Coverband
 
         data = coverage_data_from_redis(data_from_redis)
         hash[file] = data_from_redis.select { |meta_data_key, _value| META_DATA_KEYS.include?(meta_data_key) }.merge!('data' => data)
-        hash[file].merge!(LAST_UPDATED_KEY => hash[file][LAST_UPDATED_KEY].to_i, FIRST_UPDATED_KEY => hash[file][FIRST_UPDATED_KEY].to_i)
+        hash[file][LAST_UPDATED_KEY] = hash[file][LAST_UPDATED_KEY].blank? ? nil : hash[file][LAST_UPDATED_KEY].to_i
+        hash[file].merge!(LAST_UPDATED_KEY => hash[file][LAST_UPDATED_KEY], FIRST_UPDATED_KEY => hash[file][FIRST_UPDATED_KEY].to_i)
       end
 
       def coverage_data_from_redis(data_from_redis)

data/lib/coverband/collectors/view_tracker.rb

@@ -7,7 +7,8 @@ module Coverband
     ###
     # This class tracks view file usage via ActiveSupport::Notifications
     #
-    # This is a port of Flatfoot, a project I open sourced years ago, but am now rolling into Coverband
+    # This is a port of Flatfoot, a project I open sourced years ago,
+    # but am now rolling into Coverband
     # https://github.com/livingsocial/flatfoot
     #
     # TODO: test and ensure slim, haml, and other support
@@ -31,6 +32,7 @@ module Coverband
 
         @logged_views = []
         @views_to_record = []
+        redis_store.set(tracker_time_key, Time.now.to_i) unless redis_store.exists(tracker_time_key)
       end
 
       ###
@@ -59,26 +61,43 @@ module Coverband
       end
 
       def used_views
-        views = redis_store.smembers(tracker_key)
-        normalized_views = []
-        views.each do |view|
+        views = redis_store.hgetall(tracker_key)
+        normalized_views = {}
+        views.each_pair do |view, time|
           roots.each do |root|
             view = view.gsub(/#{root}/, '')
           end
-          normalized_views << view
+          normalized_views[view] = time
         end
         normalized_views
       end
 
       def unused_views
-        recently_used_views = used_views
+        recently_used_views = used_views.keys
         all_views = target.reject { |view| recently_used_views.include?(view) }
         # since layouts don't include format we count them used if they match with ANY formats
         all_views.reject { |view| view.match(/\/layouts\//) && recently_used_views.any? { |used_view| view.include?(used_view) } }
       end
 
+      def tracking_since
+        if (tracking_time = redis_store.get(tracker_time_key))
+          Time.at(tracking_time.to_i).iso8601
+        else
+          'N/A'
+        end
+      end
+
       def reset_recordings
         redis_store.del(tracker_key)
+        redis_store.del(tracker_time_key)
+      end
+
+      def clear_file!(filename)
+        return unless filename
+
+        filename = "#{@project_directory}/#{filename}"
+        redis_store.hdel(tracker_key, filename)
+        logged_views.delete(filename)
       end
 
       def self.supported_version?
@@ -86,8 +105,9 @@ module Coverband
       end
 
       def report_views_tracked
+        reported_time = Time.now.to_i
         views_to_record.each do |file|
-          redis_store.sadd(tracker_key, file)
+          redis_store.hset(tracker_key, file, reported_time)
         end
         self.views_to_record = []
       rescue StandardError => e
@@ -117,7 +137,11 @@ module Coverband
       end
 
       def tracker_key
-        'render_tracker'
+        'render_tracker_2'
+      end
+
+      def tracker_time_key
+        'render_tracker_time'
       end
     end
   end

data/lib/coverband/configuration.rb

@@ -109,6 +109,11 @@ module Coverband
     def store=(store)
       raise 'Pass in an instance of Coverband::Adapters' unless store.is_a?(Coverband::Adapters::Base)
 
+      # Default to 5 minutes if using the hash redis store
+      # This is a safer default for the high server volumes that need the hash store
+      # it should avoid overloading the redis with lots of load
+      @background_reporting_sleep_seconds = 300 if store.is_a?(Coverband::Adapters::HashRedisStore)
+
       @store = store
     end
 

data/lib/coverband/reporters/web.rb

@@ -34,6 +34,10 @@ module Coverband
 
         if request.post?
           case request.path_info
+          when %r{\/clear_view_tracking_file}
+            clear_view_tracking_file
+          when %r{\/clear_view_tracking}
+            clear_view_tracking
           when %r{\/clear_file}
             clear_file
           when %r{\/clear}
@@ -76,7 +80,11 @@ module Coverband
       end
 
       def view_tracker
-        Coverband::Utils::HTMLFormatter.new(nil, base_path: base_path).format_view_tracker!
+        notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params['notice'])}<br/>"
+        notice = request.params['notice'] ? notice : ''
+        Coverband::Utils::HTMLFormatter.new(nil,
+                                            notice: notice,
+                                            base_path: base_path).format_view_tracker!
       end
 
       def debug_data
@@ -112,6 +120,29 @@ module Coverband
         [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
       end
 
+      def clear_view_tracking
+        if Coverband.configuration.web_enable_clear
+          tracker = Coverband::Collectors::ViewTracker.new(store: Coverband.configuration.store)
+          tracker.reset_recordings
+          notice = 'view tracking reset'
+        else
+          notice = 'web_enable_clear isnt enabled in your configuration'
+        end
+        [301, { 'Location' => "#{base_path}/view_tracker?notice=#{notice}" }, []]
+      end
+
+      def clear_view_tracking_file
+        if Coverband.configuration.web_enable_clear
+          tracker = Coverband::Collectors::ViewTracker.new(store: Coverband.configuration.store)
+          filename = request.params['filename']
+          tracker.clear_file!(filename)
+          notice = "coverage for file #{filename} cleared"
+        else
+          notice = 'web_enable_clear isnt enabled in your configuration'
+        end
+        [301, { 'Location' => "#{base_path}/view_tracker?notice=#{notice}" }, []]
+      end
+
       private
 
       # This method should get the root mounted endpoint

data/lib/coverband/utils/result.rb

@@ -55,11 +55,14 @@ module Coverband
       # the line-by-line coverage to zero (if relevant) or nil (comments / whitespace etc).
       def self.add_not_loaded_files(result, tracked_files)
         if tracked_files
+          # TODO: Can we get rid of this dup it wastes memory
           result = result.dup
           Dir[tracked_files].each do |file|
             absolute = File.expand_path(file)
-
-            result[absolute] ||= Coverband::Utils::LinesClassifier.new.classify(File.foreach(absolute))
+            result[absolute] ||= {
+              'data' => Array.new(File.foreach(absolute).count) { 0 },
+              'never_loaded' => true
+            }
           end
         end
 

data/lib/coverband/utils/source_file.rb

@@ -87,6 +87,8 @@ module Coverband
       attr_reader :first_updated_at
       # the date this version of the file last saw any coverage activity
       attr_reader :last_updated_at
+      # meta data that the file was never loaded during boot or runtime
+      attr_reader :never_loaded
       NOT_AVAILABLE = 'not available'
 
       def initialize(filename, file_data)
@@ -97,6 +99,7 @@ module Coverband
           @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']
+          @never_loaded = file_data['never_loaded'] || false
         else
           # TODO: Deprecate this code path this was backwards compatability from 3-4
           @coverage = file_data

data/lib/coverband/version.rb

@@ -5,5 +5,5 @@
 # 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.2'
+  VERSION = '4.2.3.rc.1'
 end

data/public/application.css

@@ -687,6 +687,10 @@ a.src_link {
   background: url("./magnify.png") no-repeat left 50%;
   padding-left: 18px; }
 
+.red a.src_link {
+    color: #990000;
+   }
+
 tr, td {
   margin: 0;
   padding: 0; }
@@ -784,6 +788,10 @@ td {
   display: inline-block;
 }
 
+.last_seen_at {
+  font-size: 8px;
+}
+
 .notice {
   color: #856404;
   background-color: #fff3cd;

data/test/coverband/adapters/hash_redis_store_test.rb

@@ -134,13 +134,17 @@ class HashRedisStoreTest < Minitest::Test
     @store.save_report(data)
     assert_equal 1, @store.coverage.length
     assert_equal [0, nil, 1, 2], @store.coverage['./dog.rb']['data']
+    # eager_loading doesn't set last_updated_at
+    assert_nil @store.coverage['./dog.rb']['last_updated_at']
     @store.type = Coverband::RUNTIME_TYPE
     data = {
       'app_path/cat.rb' => [1, 2, 0, 1, 5]
     }
+    current_time = Time.now.to_i
     @store.save_report(data)
     assert_equal 1, @store.coverage.length
     assert_equal [1, 2, 0, 1, 5], @store.coverage['./cat.rb']['data']
+    assert current_time <= @store.coverage['./cat.rb']['last_updated_at']
   end
 
   def test_coverage_type

data/test/coverband/adapters/redis_store_test.rb

@@ -33,8 +33,10 @@ unless ENV['COVERBAND_HASH_REDIS_STORE']
       @store.coverage.each_pair do |key, data|
         assert_equal expected[key], data['data']
       end
+      current_time = Time.now.to_i
       @store.save_report(basic_coverage.dup)
       assert_equal [0, 2, 4], @store.coverage['app_path/dog.rb']['data']
+      assert current_time <= @store.coverage['app_path/dog.rb']['last_updated_at']
     end
 
     def test_store_coverage_by_type
@@ -46,7 +48,6 @@ unless ENV['COVERBAND_HASH_REDIS_STORE']
       @store.coverage.each_pair do |key, data|
         assert_equal expected[key], data['data']
       end
-
       @store.type = Coverband::RUNTIME_TYPE
       assert_equal [], @store.coverage.keys
     end
@@ -56,9 +57,13 @@ unless ENV['COVERBAND_HASH_REDIS_STORE']
       assert_equal Coverband::RUNTIME_TYPE, @store.type
       @store.type = :eager_loading
       @store.save_report('app_path/dog.rb' => [0, 1, 1])
+      # eager_loading doesn't set last_updated_at
+      assert_nil @store.coverage['app_path/dog.rb']['last_updated_at']
       @store.type = Coverband::RUNTIME_TYPE
+      current_time = Time.now.to_i
       @store.save_report('app_path/dog.rb' => [1, 0, 1])
       assert_equal [1, 1, 2], @store.get_coverage_report[:merged]['app_path/dog.rb']['data']
+      assert current_time <= @store.coverage['app_path/dog.rb']['last_updated_at']
       assert_equal Coverband::RUNTIME_TYPE, @store.type
     end
 

data/test/coverband/collectors/view_tracker_test.rb

@@ -2,16 +2,20 @@ require File.expand_path('../../test_helper', File.dirname(__FILE__))
 
 class ReporterTest < Minitest::Test
 
+  def tracker_key
+    'render_tracker_2'
+  end
+
   def setup
     super
-    fake_store.raw_store.del('render_tracker')
+    fake_store.raw_store.del(tracker_key)
   end
 
   test "init correctly" do
     Coverband::Collectors::ViewTracker.expects(:supported_version?).returns(true)
-    tracker = Coverband::Collectors::ViewTracker.new(:store => "store", :roots => 'dir')
+    tracker = Coverband::Collectors::ViewTracker.new(:store => fake_store, :roots => 'dir')
     assert_equal 'dir', tracker.roots.first
-    assert_equal 'store', tracker.store
+    assert tracker.store != nil
     assert_equal [], tracker.target
     assert_equal [], tracker.logged_views
   end
@@ -20,7 +24,7 @@ class ReporterTest < Minitest::Test
     Coverband::Collectors::ViewTracker.expects(:supported_version?).returns(true)
     store = fake_store
     file_path = "#{File.expand_path(Coverband.configuration.root)}/file"
-    store.raw_store.expects(:sadd).with('render_tracker', file_path)
+    store.raw_store.expects(:hset).with(tracker_key, file_path, anything)
     tracker = Coverband::Collectors::ViewTracker.new(store: store, roots: 'dir')
     tracker.track_views('name', 'start', 'finish', 'id', {:identifier => file_path})
     tracker.report_views_tracked
@@ -31,7 +35,7 @@ class ReporterTest < Minitest::Test
     Coverband::Collectors::ViewTracker.expects(:supported_version?).returns(true)
     store = fake_store
     file_path = "#{File.expand_path(Coverband.configuration.root)}/layout"
-    store.raw_store.expects(:sadd).with('render_tracker', file_path)
+    store.raw_store.expects(:hset).with(tracker_key, file_path, anything)
     tracker = Coverband::Collectors::ViewTracker.new(store: store, roots: 'dir')
     tracker.track_views('name', 'start', 'finish', 'id', {:layout => file_path})
     tracker.report_views_tracked
@@ -45,7 +49,7 @@ class ReporterTest < Minitest::Test
     tracker = Coverband::Collectors::ViewTracker.new(store: store, roots: 'dir')
     tracker.track_views('name', 'start', 'finish', 'id', {:identifier => file_path})
     tracker.report_views_tracked
-    assert_equal [file_path], tracker.used_views
+    assert_equal [file_path], tracker.used_views.keys
   end
 
   test "report unused partials" do
@@ -62,12 +66,24 @@ class ReporterTest < Minitest::Test
   test "reset store" do
     Coverband::Collectors::ViewTracker.expects(:supported_version?).returns(true)
     store = fake_store
-    store.raw_store.expects(:del).with('render_tracker')
+    store.raw_store.expects(:del).with(tracker_key)
+    store.raw_store.expects(:del).with('render_tracker_time')
     tracker = Coverband::Collectors::ViewTracker.new(store: store, roots: 'dir')
     tracker.track_views('name', 'start', 'finish', 'id', {:identifier => 'file'})
     tracker.reset_recordings
   end
 
+  test "clear_file" do
+    Coverband::Collectors::ViewTracker.expects(:supported_version?).returns(true)
+    store = fake_store
+    file_path = "#{File.expand_path(Coverband.configuration.root)}/file"
+    store.raw_store.expects(:hdel).with(tracker_key, file_path)
+    tracker = Coverband::Collectors::ViewTracker.new(store: store, roots: 'dir')
+    tracker.track_views('name', 'start', 'finish', 'id', {:identifier => file_path})
+    tracker.clear_file!('file')
+    assert_equal [], tracker.logged_views
+  end
+
   protected
 
   def fake_store

data/test/coverband/reporters/html_test.rb

@@ -36,6 +36,19 @@ class ReportHTMLTest < Minitest::Test
     assert_match 'app/models/user.rb', html
   end
 
+  test 'files with no Coverage but in project details page list warning' do
+    @store.send(:save_report, basic_coverage_full_path)
+
+    filename = basic_coverage_file_full_path
+    base_path = Dir.pwd
+    # in project, but not in coverage data
+    html = Coverband::Reporters::HTMLReport.new(Coverband.configuration.store,
+                                                filename: "#{Dir.pwd}/test/fixtures/app/models/user.rb",
+                                                base_path: base_path,
+                                                open_report: false).file_details
+    assert_match 'This file was never loaded', html
+  end
+
   test 'generate static HTML report file' do
     @store.send(:save_report, basic_coverage)
 

data/test/coverband/utils/source_file_test.rb

@@ -62,6 +62,10 @@ describe Coverband::Utils::SourceFile do
     it 'has 80% covered_percent' do
       assert_equal 80.0, subject.covered_percent
     end
+
+    it 'working for nil last_updated_at' do
+      assert_equal "not available", subject.last_updated_at
+    end
   end
 
   describe 'simulating potential Ruby 1.9 defect -- see Issue #56' do

data/views/file_list.erb

@@ -35,7 +35,8 @@
     <tbody>
       <% source_files.each do |source_file| %>
         <tr>
-          <td class="strong">
+          <% 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>

data/views/nav.erb

@@ -10,7 +10,7 @@
   <% end %>
 </div>
 <% if notice.to_s.length > 0 %>
-<div class="notice"><%= notice %></div>
+  <div class="notice"><%= notice %></div>
 <% end %>
 <div class="timestamp">Generated <%= timeago(Time.now) %></div>
 <br/>

data/views/source_file.erb

@@ -15,6 +15,13 @@
       <% if Coverband.configuration.web_enable_clear %>
         <%= button("#{base_path}clear_file?filename=#{source_file.relative_path}", 'clear file coverage') %> &nbsp;
       <% end %>
+
+      <% if source_file.never_loaded %>
+        <br/>
+        <span class="red">
+          <strong>This file was never loaded during app runtime or loading!</strong>
+        </span>
+      <% end %>
     </h4>
     <div>
       <b><%= source_file.lines_of_code %></b> relevant lines.

data/views/view_tracker.erb

@@ -3,6 +3,7 @@
   <head>
     <title>Coverband Info: <%= Coverband::VERSION %></title>
     <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+        <script src='<%= assets_path('dependencies.js') %>' type='text/javascript'></script>
     <script src='<%= assets_path('application.js') %>' type='text/javascript'></script>
     <link href='<%= assets_path('application.css') %>' media='screen, projection, print' rel='stylesheet' type='text/css'>
     <link rel="icon" type="image/png" href="<%= assets_path('favicon.png') %>" />
@@ -13,8 +14,13 @@
       <%= display_nav(show_coverage_link: true) %>
       <div id="content">
         <% tracker = Coverband::Collectors::ViewTracker.new(store: Coverband.configuration.store) %>
+        <h3>
+          <% if Coverband.configuration.web_enable_clear %>
+            <%= button("#{base_path}clear_view_tracking", 'reset view tracker', delete: true) %>
+          <% end %>
+        </h3>
         <h2>Unused Views: (<%= tracker.unused_views.length %>)</h2>
-        <p>These views have never been rendered</p>
+        <p>These views have not been rendered since recording started at <%= tracker.tracking_since %></p>
         <ul>
         <% tracker.unused_views.each do |view_file| %>
           <li><%= view_file %></li>
@@ -24,8 +30,14 @@
         <h2>Used Views: (<%= tracker.used_views.length %>)</h2>
         <p>These views have been rendered at least once</p>
         <ul>
-        <% tracker.used_views.each do |view_file| %>
-          <li><%= view_file %></li>
+        <% tracker.used_views.each_pair do |view_file, time_at| %>
+          <li>
+            <%= view_file %>
+            <span class="last_seen_at">last activity recorded <%= Time.at(time_at.to_i)%></span>
+            <% if Coverband.configuration.web_enable_clear %>
+              <%= button("#{base_path}clear_view_tracking_file?filename=#{view_file}", 'reset tracked file', delete: true) %>
+            <% end %>
+          </li>
         <% end %>
         </ul>
       </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 4.2.2
+  version: 4.2.3.rc.1
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2019-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -426,9 +426,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: