coverband 2.0.3 → 3.0.0.alpha

data/lib/coverband/collectors/coverage.rb

@@ -2,64 +2,81 @@
 
 module Coverband
   module Collectors
-    class Coverage < Base
-      def record_coverage
-        # noop
+    ###
+    # TODO: look at alternatives to semaphore
+    # StandardError seems line be better option
+    # coverband previously had RuntimeError here
+    # but runtime error can let a large number of error crash this method
+    # and this method is currently in a ensure block in middleware and threads
+    ###
+    class Coverage
+      def self.instance
+        Thread.current[:coverband_instance] ||= Coverband::Collectors::Coverage.new
       end
 
-      def stop_coverage
-        # noop
+      def reset_instance
+        @project_directory = File.expand_path(Coverband.configuration.root)
+        @file_line_usage = {}
+        @ignored_files = Set.new
+        @ignore_patterns = Coverband.configuration.ignore + ['internal:prelude', 'schema.rb']
+        @reporting_frequency = Coverband.configuration.reporting_frequency
+        @store = Coverband.configuration.store
+        @verbose  = Coverband.configuration.verbose
+        @logger   = Coverband.configuration.logger
+        @current_thread = Thread.current
+        Thread.current[:coverband_instance] = nil
+        self
       end
 
-      def report_coverage
-        unless @enabled
-          @logger.info 'coverage disabled' if @verbose
+      def report_coverage(force_report = false)
+        return if !ready_to_report? && !force_report
+        unless @store
+          @logger.debug 'no store set, no-op'
           return
         end
-
-        if failed_recently?
-          @logger.error 'coverage reporting standing-by because of recent failure' if @verbose
-          return
+        new_results = get_new_coverage_results
+        add_filtered_files(new_results)
+        @store.save_report(files_with_line_usage)
+        @file_line_usage.clear
+      rescue StandardError => err
+        if @verbose
+          @logger.error 'coverage failed to store'
+          @logger.error "error: #{err.inspect} #{err.message}"
+          @logger.error err.backtrace
         end
+      end
 
-        new_results = nil
-        @semaphore.synchronize { new_results = new_coverage(::Coverage.peek_result.dup) }
+      protected
+
+      def track_file?(file)
+        @ignore_patterns.none? do |pattern|
+          file.include?(pattern)
+        end && file.start_with?(@project_directory)
+      end
+
+      private
+
+      def add_filtered_files(new_results)
         new_results.each_pair do |file, line_counts|
           next if @ignored_files.include?(file)
           next unless track_file?(file)
           add_file(file, line_counts)
         end
+      end
 
-        if @verbose
-          @logger.debug "coverband file usage: #{file_usage.inspect}"
-          output_file_line_usage if @verbose == 'debug'
-        end
-
-        if @store
-          @store.save_report(files_with_line_usage)
-          @file_line_usage.clear
-        elsif @verbose
-          @logger.debug 'coverage report: '
-          @logger.debug @file_line_usage.inspect
-        end
-      # StandardError might be better option
-      # coverband previously had RuntimeError here
-      # but runtime error can let a large number of error crash this method
-      # and this method is currently in a ensure block in middleware
-      rescue StandardError => err
-        failed!
-        if @verbose
-          @logger.error 'coverage missing'
-          @logger.error "error: #{err.inspect} #{err.message}"
-          @logger.error err.backtrace
-        end
+      def ready_to_report?
+        (rand * 100.0) >= (100.0 - @reporting_frequency)
       end
 
-      private
+      def get_new_coverage_results
+        coverage_results = nil
+        @semaphore.synchronize { coverage_results = new_coverage(::Coverage.peek_result.dup) }
+        coverage_results
+      end
 
       def files_with_line_usage
         @file_line_usage.select do |_file_name, coverage|
-          coverage.values.any? { |value| value != 0 }
+          coverage.any? { |value| value && value.nonzero? }
         end
       end
 
@@ -93,21 +110,8 @@ module Coverband
         new_results.dup
       end
 
-      # TODO this seems like a dumb conversion for the already good coverage format
-      # coverage is 0 based other implementation matches line number
       def add_file(file, line_counts)
-        @file_line_usage[file] = Hash.new(0) unless @file_line_usage.include?(file)
-        line_counts.each_with_index do |line_count, index|
-          @file_line_usage[file][(index + 1)] = line_count if line_count
-        end
-      end
-
-      def file_usage
-        hash = {}
-        @file_line_usage.each do |file, lines|
-          hash[file] = lines.values.compact.inject(0, :+)
-        end
-        hash.sort_by { |_key, value| value }
+        @file_line_usage[file] = line_counts
       end
 
       def initialize

data/lib/coverband/configuration.rb

@@ -3,9 +3,9 @@
 module Coverband
   class Configuration
     attr_accessor :redis, :root_paths, :root,
-                  :ignore, :additional_files, :percentage, :verbose,
-                  :reporter, :startup_delay, :memory_caching,
-                  :include_gems, :collector, :disable_on_failure_for,
+                  :ignore, :additional_files, :verbose,
+                  :reporter, :reporting_frequency,
+                  :disable_on_failure_for,
                   :redis_namespace, :redis_ttl,
                   :safe_reload_files
 
@@ -13,24 +13,16 @@ module Coverband
 
     def initialize
       @root = Dir.pwd
-      @redis = nil
       @root_paths = []
       @ignore = []
       @additional_files = []
-      @include_gems = false
-      @percentage = 0.0
+      @reporting_frequency = 0.0
       @verbose = false
       @reporter = 'scov'
-      if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3.0')
-        @collector = 'trace'
-      else
-        @collector = 'coverage'
-      end
       @logger = Logger.new(STDOUT)
-      @startup_delay = 0
-      @memory_caching = false
       @store = nil
-      @disable_on_failure_for = nil
+
+      # TODO: should we push these to adapter configs
       @s3_region = nil
       @s3_bucket = nil
       @s3_access_key_id = nil

data/lib/coverband/integrations/background.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Coverband
+  class Background
+    # TODO: stub to implement background thread recording
+  end
+end

data/lib/coverband/{middleware.rb → integrations/middleware.rb}

@@ -7,11 +7,9 @@ module Coverband
     end
 
     def call(env)
-      Coverband::Collectors::Base.instance.configure_sampling
-      Coverband::Collectors::Base.instance.record_coverage
       @app.call(env)
     ensure
-      Coverband::Collectors::Base.instance.report_coverage
+      Coverband::Collectors::Coverage.instance.report_coverage
     end
   end
 end

data/lib/coverband/reporters/base.rb

@@ -2,25 +2,26 @@
 
 module Coverband
   module Reporters
+    ###
+    # This is the base clase for report generation
+    # it helps with filtering, normalization, etc for final reprort generation
+    ###
     class Base
-      def self.report(store, options = {})
-        roots = get_roots
-        additional_coverage_data = options.fetch(:additional_scov_data) { [] }
+      def self.report(store, _options = {})
+        scov_style_report = get_current_scov_data_imp(store, root_paths)
 
         if Coverband.configuration.verbose
-          Coverband.configuration.logger.info "fixing root: #{roots.join(', ')}"
-          Coverband.configuration.logger.debug "additional data:\n #{additional_coverage_data}"
-        end
-
-        scov_style_report = report_scov_with_additional_data(store, additional_coverage_data, roots)
-
-        if Coverband.configuration.verbose
-          Coverband.configuration.logger.debug "report:\n #{scov_style_report.inspect}"
+          msg = "report:\n #{scov_style_report.inspect}"
+          Coverband.configuration.logger.debug msg
         end
         scov_style_report
       end
 
-      def self.get_roots
+      # protected
+      # below are all not public API
+      # but as they are class methods protected doesn't really do anything
+
+      def self.root_paths
         roots = Coverband.configuration.root_paths
         roots << "#{current_root}/"
         roots
@@ -30,19 +31,26 @@ module Coverband
         File.expand_path(Coverband.configuration.root)
       end
 
-      protected
-
       def self.fix_file_names(report_hash, roots)
-        fixed_report = {} # normalize names across servers
-        report_hash.each_pair do |key, values|
+        if Coverband.configuration.verbose
+          Coverband.configuration.logger.info "fixing root: #{roots.join(', ')}"
+        end
+
+        fixed_report = {}
+        # normalize names across servers
+        report_hash.each_pair do |key, vals|
           filename = filename_from_key(key, roots)
-          fixed_report[filename] = values
+          if fixed_report.key?(filename)
+            fixed_report[filename] = merge_arrays(fixed_report[filename], vals)
+          else
+            fixed_report[filename] = vals
+          end
         end
         fixed_report
       end
 
-      # > merge_arrays([0,0,1,0,1],[nil,0,1,0,0])
-      # [0,0,1,0,1]
+      # > merge_arrays([nil,0,0,1,0,1],[nil,nil,0,1,0,0])
+      # > [nil,0,0,1,0,1]
       def self.merge_arrays(first, second)
         merged = []
         longest = first.length > second.length ? first : second
@@ -56,20 +64,6 @@ module Coverband
         merged
       end
 
-      # > merge_existing_coverage({"file.rb" => [0,1,2,nil,nil,nil]}, {"file.rb" => [0,1,2,nil,0,1,2]})
-      # expects = {"file.rb" => [0,2,4,nil,0,1,2]}
-      def self.merge_existing_coverage(scov_style_report, existing_coverage)
-        existing_coverage.each_pair do |file_key, existing_lines|
-          next if Coverband.configuration.ignore.any? { |i| file_key.match(i) }
-          scov_style_report[file_key] = if current_line_hits = scov_style_report[file_key]
-                                          merge_arrays(current_line_hits, existing_lines)
-                                        else
-                                          existing_lines
-                                        end
-        end
-        scov_style_report
-      end
-
       def self.filename_from_key(key, roots)
         filename = key
         roots.each do |root|
@@ -82,64 +76,25 @@ module Coverband
         filename
       end
 
-      # > line_hash(store, 'hearno/script/tester.rb', ['/app/', '/Users/danmayer/projects/hearno/'])
-      # {"/Users/danmayer/projects/hearno/script/tester.rb"=>[1, nil, 1, 2, nil, nil, nil]}
-      def self.line_hash(store, key, roots)
-        filename = filename_from_key(key, roots)
-        if File.exist?(filename)
-          count = File.foreach(filename).inject(0) { |c, _line| c + 1 }
-          line_array = Array.new(count, nil)
-
-          lines_hit = store.covered_lines_for_file(key)
-          if lines_hit.is_a?(Array)
-            line_array.each_with_index { |_, index| line_array[index] = 1 if lines_hit.include?((index + 1)) }
-          else
-            line_array.each_with_index { |_, index| line_array[index] = (line_array[index].to_i + lines_hit[(index + 1).to_s].to_i) if lines_hit.keys.include?((index + 1).to_s) }
-          end
-          { filename => line_array }
-        else
-          Coverband.configuration.logger.info "file #{filename} not found in project"
-          nil
-        end
-      end
-
+      ###
+      # why do we need to merge covered files data?
+      # basically because paths on machines or deployed hosts could be different, so
+      # two different keys could point to the same filename or `line_key`
+      # this logic should be pushed to base report
+      # TODO: think we are filtering based on ignore while sending to the store
+      # and as we pull it out here
+      ###
       def self.get_current_scov_data_imp(store, roots)
         scov_style_report = {}
-
-        ###
-        # why do we need to merge covered files data?
-        # basically because paths on machines or deployed hosts could be different, so
-        # two different keys could point to the same filename or `line_key`
-        # this logic should be pushed to base report
-        ###
-        store.covered_files.each do |key|
+        store.coverage.each_pair do |key, line_data|
           next if Coverband.configuration.ignore.any? { |i| key.match(i) }
-          line_data = line_hash(store, key, roots)
-
           next unless line_data
-          line_key = line_data.keys.first
-          previous_line_hash = scov_style_report[line_key]
-
-          if previous_line_hash
-            line_data[line_key] = merge_arrays(line_data[line_key], previous_line_hash)
-          end
-
-          scov_style_report.merge!(line_data)
+          scov_style_report[key] = line_data
         end
 
         scov_style_report = fix_file_names(scov_style_report, roots)
         scov_style_report
       end
-
-      def self.report_scov_with_additional_data(store, additional_scov_data, roots)
-        scov_style_report = get_current_scov_data_imp(store, roots)
-
-        additional_scov_data.each do |data|
-          scov_style_report = merge_existing_coverage(scov_style_report, data)
-        end
-
-        scov_style_report
-      end
     end
   end
 end

data/lib/coverband/reporters/console_report.rb

@@ -2,6 +2,9 @@
 
 module Coverband
   module Reporters
+    ###
+    # Console Report allows for simple reporting via the command line.
+    ###
     class ConsoleReport < Base
       def self.report(store, options = {})
         scov_style_report = super(store, options)

data/lib/coverband/reporters/simple_cov_report.rb

@@ -7,12 +7,12 @@ module Coverband
         begin
           require 'simplecov'
         rescue StandardError
-          Coverband.configuration.logger.error 'coverband requires simplecov in order to generate a report, when configured for the scov report style.'
+          msg = 'coverband requires simplecov to generate a report, when config.reporter=scov'
+          Coverband.configuration.logger.error msg
           return
         end
 
         scov_style_report = super(store, options)
-
         open_report = options.fetch(:open_report) { true }
 
         # set root to show files if user has simplecov profiles
@@ -43,7 +43,8 @@ module Coverband
           access_key_id: Coverband.configuration.s3_access_key_id,
           secret_access_key: Coverband.configuration.s3_secret_access_key
         }
-        S3ReportWriter.new(Coverband.configuration.s3_bucket, s3_writer_options).persist! if Coverband.configuration.s3_bucket
+        Coverband::Utils::S3ReportWriter.new(Coverband.configuration.s3_bucket,
+                                                s3_writer_options).persist! if Coverband.configuration.s3_bucket
       end
     end
   end

data/lib/coverband/reporters/web.rb

@@ -9,10 +9,10 @@ module Coverband
       attr_reader :request
 
       def initialize
+        full_path = Gem::Specification.find_by_name('simplecov-html').full_gem_path
         @static = Rack::Static.new(self,
-          root: File.expand_path('public', Gem::Specification.find_by_name('simplecov-html').full_gem_path),
-          urls: [/.*\.css/, /.*\.js/, /.*\.gif/, /.*\.png/]
-        )
+                                   root: File.expand_path('public', full_path),
+                                   urls: [/.*\.css/, /.*\.js/, /.*\.gif/, /.*\.png/])
       end
 
       def call(env)
@@ -20,60 +20,63 @@ module Coverband
 
         if request.post?
           case request.path_info
-          when /\/collect_update_and_view/
+          when %r{\/collect_update_and_view}
             collect_update_and_view
-          when /\/clear/
+          when %r{\/clear}
             clear
-          when /\/update_report/
+          when %r{\/update_report}
             update_report
-          when /\/collect_coverage/
+          when %r{\/collect_coverage}
             collect_coverage
-          when /\/reload_files/
+          when %r{\/reload_files}
             reload_files
           else
-            [404, {'Content-Type' => 'text/html'}, ['404 error!']]
+            [404, { 'Content-Type' => 'text/html' }, ['404 error!']]
           end
         else
           case request.path_info
           when /.*\.(css|js|gif|png)/
             @static.call(env)
-          when /\/show/
-            [200, {'Content-Type' => 'text/html'}, [show]]
-          when /\//
-            [200, {'Content-Type' => 'text/html'}, [index]]
+          when %r{\/show}
+            [200, { 'Content-Type' => 'text/html' }, [show]]
+          when %r{\/}
+            [200, { 'Content-Type' => 'text/html' }, [index]]
           else
-            [404, {'Content-Type' => 'text/html'}, ['404 error!']]
+            [404, { 'Content-Type' => 'text/html' }, ['404 error!']]
           end
         end
       end
 
-      # todo move to file or template
+      # TODO: move to file or template
       def index
-        html = "<html>"
-        html += "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params['notice'])}<br/>" if request.params['notice']
-        html += "<ul>"
-        html += "<li><a href='#{base_path}'>Coverband Web Admin Index</a></li>"
-        html += "<li>#{button("#{base_path}collect_update_and_view",'collect data, update report, & view')}</li>"
-        html += "<li><a href='#{base_path}show'>view coverage report</a></li>"
-        html += "<li>#{button("#{base_path}collect_coverage",'update coverage data (collect coverage)')}</li>"
-        html += "<li>#{button("#{base_path}update_report",'update coverage report (rebuild report)')}</li>"
-        html += "<li>#{button("#{base_path}clear",'clear coverage report')}</li>"
-        html += "<li>#{button("#{base_path}reload_files",'reload Coverband files')}</li>"
-        html += "</ul>"
-        html += "<br/>"
-        html += "version: #{Coverband::VERSION}<br/>"
-        html += "<a href='https://github.com/danmayer/coverband'>Coverband</a>"
-        html += "</html>"
-        html
+        notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params['notice'])}<br/>"
+        notice = request.params['notice'] ? notice : ''
+        %(
+<html>
+  #{notice}
+  <ul>
+    <li><a href='#{base_path}'>Coverband Web Admin Index</a></li>
+    <li>#{button("#{base_path}collect_update_and_view", 'collect data, update report, & view')}</li>
+    <li><a href='#{base_path}show'>view coverage report</a></li>
+    <li>#{button("#{base_path}collect_coverage", 'update coverage data (collect coverage)')}</li>
+    <li>#{button("#{base_path}update_report", 'update coverage report (rebuild report)')}</li>
+    <li>#{button("#{base_path}clear", 'clear coverage report')}</li>
+    <li>#{button("#{base_path}reload_files", 'reload Coverband files')}</li>
+  </ul>
+  <br/>
+  version: #{Coverband::VERSION}<br/>
+  <a href='https://github.com/danmayer/coverband'>Coverband</a>
+</html>
+)
       end
 
       def show
         html = s3.get_object(bucket: Coverband.configuration.s3_bucket, key: 'coverband/index.html').body.read
-        # hack the static HTML assets to link to the path where this was mounted
+        # HACK: the static HTML assets to link to the path where this was mounted
         html = html.gsub("src='", "src='#{base_path}")
         html = html.gsub("href='", "href='#{base_path}")
-        html = html.gsub("loading.gif", "#{base_path}loading.gif")
-        html = html.gsub("/images/", "#{base_path}images/")
+        html = html.gsub('loading.gif', "#{base_path}loading.gif")
+        html = html.gsub('/images/', "#{base_path}images/")
         html
       end
 
@@ -90,7 +93,7 @@ module Coverband
       end
 
       def collect_coverage
-        Coverband::Collectors::Base.instance.report_coverage
+        Coverband::Collectors::Coverage.instance.report_coverage
         notice = 'coverband coverage collected'
         [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
       end