coverband 4.2.1 → 4.2.2

data/lib/coverband/collectors/view_tracker.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module Coverband
+  module Collectors
+    ###
+    # 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
+    # https://github.com/livingsocial/flatfoot
+    #
+    # TODO: test and ensure slim, haml, and other support
+    ###
+    class ViewTracker
+      DEFAULT_TARGET = Dir.glob('app/views/**/*.html.erb').reject { |file| file.match(/(_mailer)/) }
+      attr_accessor :target, :logged_views, :views_to_record
+      attr_reader :logger, :roots, :store, :ignore_patterns
+
+      def initialize(options = {})
+        raise NotImplementedError, 'View Tracker requires Rails 4 or greater' unless self.class.supported_version?
+
+        @project_directory = File.expand_path(Coverband.configuration.root)
+        @ignore_patterns = Coverband.configuration.ignore
+        @store = options.fetch(:store) { Coverband.configuration.store }
+        @logger = options.fetch(:logger) { Coverband.configuration.logger }
+        @target = options.fetch(:target) { DEFAULT_TARGET }
+
+        @roots = options.fetch(:roots) { Coverband.configuration.all_root_patterns }
+        @roots = @roots.split(',') if @roots.is_a?(String)
+
+        @logged_views = []
+        @views_to_record = []
+      end
+
+      ###
+      # This method is called on every render call, so we try to reduce method calls
+      # and ensure high performance
+      ###
+      def track_views(_name, _start, _finish, _id, payload)
+        if (file = payload[:identifier])
+          if newly_seen_file?(file)
+            logged_views << file
+            views_to_record << file if track_file?(file)
+          end
+        end
+
+        ###
+        # Annoyingly while you get full path for templates
+        # notifications only pass part of the path for layouts dropping any format info
+        # such as .html.erb or .js.erb
+        # http://edgeguides.rubyonrails.org/active_support_instrumentation.html#render_partial-action_view
+        ###
+        return unless (layout_file = payload[:layout])
+        return unless newly_seen_file?(layout_file)
+
+        logged_views << layout_file
+        views_to_record << layout_file if track_file?(layout_file, layout: true)
+      end
+
+      def used_views
+        views = redis_store.smembers(tracker_key)
+        normalized_views = []
+        views.each do |view|
+          roots.each do |root|
+            view = view.gsub(/#{root}/, '')
+          end
+          normalized_views << view
+        end
+        normalized_views
+      end
+
+      def unused_views
+        recently_used_views = used_views
+        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 reset_recordings
+        redis_store.del(tracker_key)
+      end
+
+      def self.supported_version?
+        defined?(Rails) && defined?(Rails::VERSION) && Rails::VERSION::STRING.split('.').first.to_i >= 4
+      end
+
+      def report_views_tracked
+        views_to_record.each do |file|
+          redis_store.sadd(tracker_key, file)
+        end
+        self.views_to_record = []
+      rescue StandardError => e
+        # we don't want to raise errors if Coverband can't reach redis.
+        # This is a nice to have not a bring the system down
+        logger&.error "Coverband: view_tracker failed to store, error #{e.class.name}"
+      end
+
+      protected
+
+      def newly_seen_file?(file)
+        return false if logged_views.include?(file)
+
+        true
+      end
+
+      def track_file?(file, options = {})
+        @ignore_patterns.none? do |pattern|
+          file.include?(pattern)
+        end && (file.start_with?(@project_directory) || options[:layout])
+      end
+
+      private
+
+      def redis_store
+        store.raw_store
+      end
+
+      def tracker_key
+        'render_tracker'
+      end
+    end
+  end
+end

data/lib/coverband/configuration.rb

@@ -8,7 +8,7 @@ module Coverband
                   :background_reporting_enabled,
                   :background_reporting_sleep_seconds, :test_env,
                   :web_enable_clear, :gem_details, :web_debug, :report_on_exit,
-                  :simulate_oneshot_lines_coverage
+                  :simulate_oneshot_lines_coverage, :track_views, :view_tracker
 
     attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id, :s3_secret_access_key, :password
     attr_reader :track_gems, :ignore, :use_oneshot_lines_coverage
@@ -30,6 +30,10 @@ module Coverband
     # heroku asset compilation
     IGNORE_DEFAULTS = %w[vendor .erb$ .slim$ /tmp internal:prelude schema.rb]
 
+    # Add in missing files which were never loaded
+    # we need to know what all paths to check for unloaded files
+    TRACKED_DEFAULT_PATHS = %w[app lib config]
+
     def initialize
       reset
     end
@@ -38,6 +42,7 @@ module Coverband
       @root = Dir.pwd
       @root_paths = []
       @ignore = IGNORE_DEFAULTS.dup
+      @seach_paths = TRACKED_DEFAULT_PATHS.dup
       @additional_files = []
       @verbose = false
       @reporter = 'scov'
@@ -49,6 +54,7 @@ module Coverband
       @web_enable_clear = false
       @track_gems = false
       @gem_details = false
+      @track_views = false
       @groups = {}
       @web_debug = false
       @report_on_exit = true
@@ -106,6 +112,20 @@ module Coverband
       @store = store
     end
 
+    ###
+    # Search Paths
+    ###
+    def tracked_search_paths
+      "#{Coverband.configuration.current_root}/{#{@seach_paths.join(',')}}/**/*.{rb}"
+    end
+
+    ###
+    # Don't allow the to override defaults
+    ###
+    def search_paths=(path_array)
+      @seach_paths = (@seach_paths + path_array).uniq
+    end
+
     ###
     # Don't allow the ignore to override things like gem tracking
     ###

data/lib/coverband/integrations/background.rb

@@ -27,11 +27,12 @@ module Coverband
       @semaphore.synchronize do
         return if running?
 
-        logger.debug('Coverband: Starting background reporting')
+        logger.debug('Coverband: Starting background reporting') if Coverband.configuration.verbose
         sleep_seconds = Coverband.configuration.background_reporting_sleep_seconds
         @thread = Thread.new do
           loop do
             Coverband.report_coverage
+            Coverband.configuration.view_tracker&.report_views_tracked
             if Coverband.configuration.verbose
               logger.debug("Coverband: background reporting coverage (#{Coverband.configuration.store.type}). Sleeping #{sleep_seconds}s")
             end

data/lib/coverband/reporters/base.rb

@@ -8,8 +8,6 @@ module Coverband
     ###
     class Base
       class << self
-        include Coverband::Utils::FilePathHelper
-
         DATA_KEY = 'data'
 
         def report(store, _options = {})
@@ -17,6 +15,7 @@ module Coverband
           scov_style_report = get_current_scov_data_imp(store, all_roots)
 
           # These are extremelhy verbose but useful during coverband development, not generally for users
+          # Only avaiable by uncommenting this mode is never released
           # if Coverband.configuration.verbose
           #   # msg = "report:\n #{scov_style_report.inspect}"
           #   # Coverband.configuration.logger.debug msg
@@ -30,7 +29,7 @@ module Coverband
         ###
         def fix_reports(reports)
           # list all files, even if not tracked by Coverband (0% coverage)
-          tracked_glob = "#{Coverband.configuration.current_root}/{app,lib,config}/**/*.{rb}"
+          tracked_glob = Coverband.configuration.tracked_search_paths
           filtered_report_files = {}
 
           reports.each_pair do |report_name, report_data|
@@ -50,13 +49,13 @@ module Coverband
         protected
 
         def fix_file_names(report_hash, roots)
-          Coverband.configuration.logger.info "fixing root: #{roots.join(', ')}" if Coverband.configuration.verbose
+          Coverband.configuration.logger.debug "fixing root: #{roots.join(', ')}" if Coverband.configuration.verbose
 
           # normalize names across servers
           report_hash.each_with_object({}) do |(name, report), fixed_report|
             fixed_report[name] = {}
             report.each_pair do |key, vals|
-              filename = relative_path_to_full(key, roots)
+              filename = Coverband::Utils::AbsoluteFileConverter.convert(key)
               fixed_report[name][filename] = if fixed_report[name].key?(filename) && fixed_report[name][filename][DATA_KEY] && vals[DATA_KEY]
                                                merged_data = merge_arrays(fixed_report[name][filename][DATA_KEY], vals[DATA_KEY])
                                                vals[DATA_KEY] = merged_data

data/lib/coverband/reporters/console_report.rb

@@ -10,6 +10,7 @@ module Coverband
         scov_style_report = super(store, options)
 
         scov_style_report.each_pair do |file, usage|
+          # TODO: In Coverband 5 deprecate none hash format
           if usage.is_a?(Hash)
             Coverband.configuration.logger.info "#{file}: #{usage['data']}"
           else

data/lib/coverband/reporters/web.rb

@@ -47,6 +47,8 @@ module Coverband
             @static.call(env)
           when %r{\/settings}
             [200, { 'Content-Type' => 'text/html' }, [settings]]
+          when %r{\/view_tracker}
+            [200, { 'Content-Type' => 'text/html' }, [view_tracker]]
           when %r{\/debug_data}
             [200, { 'Content-Type' => 'text/json' }, [debug_data]]
           when %r{\/load_file_details}
@@ -73,6 +75,10 @@ module Coverband
         Coverband::Utils::HTMLFormatter.new(nil, base_path: base_path).format_settings!
       end
 
+      def view_tracker
+        Coverband::Utils::HTMLFormatter.new(nil, base_path: base_path).format_view_tracker!
+      end
+
       def debug_data
         Coverband.configuration.store.get_coverage_report.to_json
       end

data/lib/coverband/utils/absolute_file_converter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Coverband
+  module Utils
+    class AbsoluteFileConverter
+      def initialize(roots)
+        @cache = {}
+        @roots = roots.map { |root| "#{File.expand_path(root)}/" }
+      end
+
+      def self.instance
+        @instance ||= new(Coverband.configuration.all_root_paths)
+      end
+
+      def self.reset
+        @instance = nil
+      end
+
+      def self.convert(relative_path)
+        instance.convert(relative_path)
+      end
+
+      def convert(relative_path)
+        @cache[relative_path] ||= begin
+                                    relative_filename = relative_path
+                                    local_filename = relative_filename
+                                    @roots.each do |root|
+                                      relative_filename = relative_filename.sub(/^#{root}/, './')
+                                      # once we have a relative path break out of the loop
+                                      break if relative_filename.start_with? './'
+                                    end
+                                    # the filename for our reports is expected to be a full path.
+                                    # roots.last should be roots << current_root}/
+                                    # a fully expanded path of config.root
+                                    # filename = filename.gsub('./', roots.last)
+                                    # above only works for app files
+                                    # we need to rethink some of this logic
+                                    # gems aren't at project root and can have multiple locations
+                                    local_root = @roots.find do |root|
+                                      File.exist?(relative_filename.gsub('./', root))
+                                    end
+                                    local_root ? relative_filename.gsub('./', local_root) : local_filename
+                                  end
+      end
+    end
+  end
+end

data/lib/coverband/utils/file_hasher.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Coverband
+  module Utils
+    class FileHasher
+      @cache = {}
+
+      def self.hash(file, path_converter: AbsoluteFileConverter.instance)
+        @cache[file] ||= begin
+                           file = path_converter.convert(file)
+                           Digest::MD5.file(file).hexdigest if File.exist?(file)
+                         end
+      end
+    end
+  end
+end

data/lib/coverband/utils/html_formatter.rb

@@ -33,6 +33,10 @@ module Coverband
         format_settings
       end
 
+      def format_view_tracker!
+        format_view_tracker
+      end
+
       def format_source_file!(filename)
         source_file = @coverage_result.file_from_path_with_type(filename)
 
@@ -49,6 +53,10 @@ module Coverband
         template('settings').result(binding)
       end
 
+      def format_view_tracker
+        template('view_tracker').result(binding)
+      end
+
       def format(result)
         Dir[File.join(File.dirname(__FILE__), '../../../public/*')].each do |path|
           FileUtils.cp_r(path, asset_output_path)
@@ -104,6 +112,10 @@ module Coverband
         button + '</form>'
       end
 
+      def display_nav(nav_options = {})
+        template('nav').result(binding)
+      end
+
       # Returns the html for the given source_file
       def formatted_source_file(result, source_file)
         template('source_file').result(binding)

data/lib/coverband/utils/railtie.rb

@@ -5,9 +5,6 @@ module Coverband
     def eager_load!
       Coverband.eager_loading_coverage!
       super
-    ensure
-      Coverband.report_coverage
-      Coverband.runtime_coverage!
     end
   end
   Rails::Engine.prepend(RailsEagerLoad)
@@ -15,6 +12,21 @@ module Coverband
   class Railtie < Rails::Railtie
     initializer 'coverband.configure' do |app|
       app.middleware.use Coverband::BackgroundMiddleware
+
+      if Coverband.configuration.track_views
+        CoverbandViewTracker = Coverband::Collectors::ViewTracker.new
+        Coverband.configuration.view_tracker = CoverbandViewTracker
+
+        ActiveSupport::Notifications.subscribe(/render_partial.action_view|render_template.action_view/) do |name, start, finish, id, payload|
+          CoverbandViewTracker.track_views(name, start, finish, id, payload) unless name.include?('!')
+        end
+      end
+    end
+
+    config.after_initialize do
+      Coverband.eager_loading_coverage!
+      Coverband.report_coverage
+      Coverband.runtime_coverage!
     end
 
     rake_tasks do

data/lib/coverband/utils/relative_file_converter.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Coverband
+  module Utils
+    class RelativeFileConverter
+      def self.instance
+        @instance ||= new(Coverband.configuration.all_root_paths)
+      end
+
+      def self.reset
+        @instance = nil
+      end
+
+      def self.convert(file)
+        instance.convert(file)
+      end
+
+      def initialize(roots)
+        @cache = {}
+        @roots = normalize(roots)
+      end
+
+      def convert(file)
+        @cache[file] ||= begin
+                           relative_file = file
+                           @roots.each do |root|
+                             relative_file = file.gsub(/^#{root}/, '.')
+                             break relative_file if relative_file.start_with?('.')
+                           end
+                           relative_file
+                         end
+      end
+
+      private
+
+      def normalize(paths)
+        paths.map { |root| File.expand_path(root) }
+      end
+    end
+  end
+end

data/lib/coverband/utils/s3_report.rb

@@ -26,8 +26,8 @@ module Coverband
         begin
           require 'aws-sdk-s3'
         rescue StandardError
-          err_msg = 'coverband requires aws-sdk in order use S3Report.'
-          Coverband.configuration.logger.error err_msg
+          err_msg = 'Coverband requires aws-sdk in order use S3Report.'
+          Coverband.configuration.logger&.error err_msg
           return
         end
       end

data/lib/coverband/utils/source_file.rb

@@ -10,8 +10,6 @@
 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,
@@ -246,7 +244,7 @@ module Coverband
       end
 
       def relative_path
-        full_path_to_relative(filename)
+        RelativeFileConverter.convert(filename)
       end
 
       def gem?

data/lib/coverband/utils/tasks.rb

@@ -15,6 +15,7 @@ namespace :coverband do
 
   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
 

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.1'
+  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,6 +23,7 @@ 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'
@@ -28,6 +32,8 @@ 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'

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/test/benchmarks/benchmark.rake

@@ -27,30 +27,11 @@ namespace :benchmarks do
     end
   end
 
-  def classifier_dir
-    File.join(File.dirname(__FILE__), 'classifier-reborn')
-  end
-
-  def clone_classifier
-    system "git clone https://github.com/jekyll/classifier-reborn.git #{classifier_dir}" unless Dir.exist? classifier_dir
-  end
-
   # desc 'setup standard benchmark'
   task :setup do
-    clone_classifier
-    $LOAD_PATH.unshift(File.join(classifier_dir, 'lib'))
     require 'benchmark'
     require 'benchmark/ips'
 
-    # TODO: ok this is interesting and weird
-    # basically the earlier I require coverage and
-    # then require files the larger perf impact
-    # this is somewhat expected but can lead to significant perf diffs
-    # for example moving `require 'classifier-reborn'` below the coverage.start
-    # results in 1.5x slower vs "difference falls within error"
-    # moving from 5 second of time to 12 still shows slower based on when classifier is required
-    # make sure to be plugged in while benchmarking ;) Otherwise you get very unreliable results
-    require 'classifier-reborn'
     if ENV['COVERAGE'] || ENV['ONESHOT']
       require 'coverage'
       ::Coverage.start(oneshot_lines: !!ENV['ONESHOT'])
@@ -91,32 +72,7 @@ namespace :benchmarks do
     end
   end
 
-  def bayes_classification
-    b = ClassifierReborn::Bayes.new 'Interesting', 'Uninteresting'
-    b.train_interesting 'here are some good words. I hope you love them'
-    b.train_uninteresting 'here are some bad words, I hate you'
-    b.classify 'I hate bad words and you' # returns 'Uninteresting'
-  end
-
-  def lsi_classification
-    lsi = ClassifierReborn::LSI.new
-    strings = [['This text deals with dogs. Dogs.', :dog],
-               ['This text involves dogs too. Dogs! ', :dog],
-               ['This text revolves around cats. Cats.', :cat],
-               ['This text also involves cats. Cats!', :cat],
-               ['This text involves birds. Birds.', :bird]]
-    strings.each { |x| lsi.add_item x.first, x.last }
-    lsi.search('dog', 3)
-    lsi.find_related(strings[2], 2)
-    lsi.classify 'This text is also about dogs!'
-  end
-
   def work
-    5.times do
-      bayes_classification
-      lsi_classification
-    end
-
     # simulate many calls to the same line
     10_000.times { Dog.new.bark }
   end
@@ -140,9 +96,11 @@ namespace :benchmarks do
     Coverband::Collectors::Coverage.instance.reset_instance
   end
 
+  LINES = 45
+  NON_NIL_LINES = 18
   def fake_line_numbers
-    24.times.each_with_object({}) do |line, line_hash|
-      line_hash[(line + 1).to_s] = rand(5)
+    LINES.times.map do |line|
+      coverage = (line < NON_NIL_LINES) ? rand(5) : nil
     end
   end
 
@@ -165,8 +123,8 @@ namespace :benchmarks do
     ###
     # this is a hack because in the benchmark we don't have real files
     ###
-    def store.file_hash(file)
-      @file_hash_cache[file] || @file_hash_cache[file] = Digest::MD5.file(__FILE__).hexdigest
+    def store.file_hash(_file)
+      @file_hash ||= Digest::MD5.file(__FILE__).hexdigest
     end
 
     def store.full_path_to_relative(file)
@@ -183,7 +141,13 @@ namespace :benchmarks do
     5.times { store.save_report(report) }
     Benchmark.ips do |x|
       x.config(time: 15, warmup: 5)
-      x.report('store_reports') { store.save_report(report) }
+      x.report('store_reports_all') { store.save_report(report) }
+    end
+    keys_subset = report.keys.first(100)
+    report_subset = report.select { |key, _value| keys_subset.include?(key) }
+    Benchmark.ips do |x|
+      x.config(time: 20, warmup: 5)
+      x.report('store_reports_subset') { store.save_report(report_subset) }
     end
   end
 
@@ -415,6 +379,18 @@ namespace :benchmarks do
     `open tmp/timeseries.jpg`
   end
 
+  desc 'benchmark initialization of rails'
+  task :init_rails do
+    require 'benchmark'
+    require 'benchmark/ips'
+    Benchmark.ips do |x|
+      x.config(time: 60, warmup: 0)
+      x.report('init_rails') do
+        system('bundle exec rake init_rails -f ./test/benchmarks/init_rails.rake')
+      end
+    end
+  end
+
   desc 'compare Coverband Ruby Coverage with Filestore with normal Ruby'
   task :compare_file do
     puts 'comparing Coverage loaded/not, this takes some time for output...'