coverband 1.5.4 → 2.0.0.alpha

data/lib/coverband/collectors/coverage.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module Coverband
+  module Collectors
+    class Coverage < Base
+      def record_coverage
+        # noop
+      end
+
+      def report_coverage
+        unless @enabled
+          @logger.info 'coverage disabled' if @verbose
+          return
+        end
+
+        if failed_recently?
+          @logger.info 'coverage reporting standing-by because of recent failure' if @verbose
+          return
+        end
+
+        new_results = nil
+        @semaphore.synchronize { new_results = new_coverage(::Coverage.peek_result.dup) }
+        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
+
+        if @verbose
+          @logger.info "coverband file usage: #{file_usage.inspect}"
+          output_file_line_usage if @verbose == 'debug'
+        end
+
+        if @store
+          if @stats
+            @before_time = Time.now
+            @stats.count 'coverband.files.recorded_files', @file_line_usage.length
+          end
+
+          @store.save_report(@file_line_usage)
+          if @stats
+            @time_spent = Time.now - @before_time
+            @stats.timing 'coverband.files.recorded_time', @time_spent
+          end
+          @file_line_usage.clear
+        elsif @verbose
+          @logger.info 'coverage report: '
+          @logger.info @file_line_usage.inspect
+        end
+      rescue RuntimeError => err
+        failed!
+        if @verbose
+          @logger.info 'coverage missing'
+          @logger.info "error: #{err.inspect} #{err.message}"
+        end
+      end
+
+      protected
+
+      def set_tracer
+        # no op
+      end
+
+      def unset_tracer
+        # no op
+      end
+
+      private
+
+      def array_diff(latest, original)
+        latest.map.with_index { |v, i| v ? v - original[i] : nil }
+      end
+
+      def previous_results
+        @@previous_results
+      end
+
+      def add_previous_results(val)
+        @@previous_results = val
+      end
+
+      def new_coverage(current_coverage)
+        if previous_results
+          new_results = {}
+          current_coverage.each_pair do |file, line_counts|
+            new_results[file] = array_diff(line_counts, previous_results[file])
+          end
+        else
+          new_results = current_coverage
+        end
+
+        # if current_coverage['/Users/danmayer/projects/coverage_rails_benchmark/app/controllers/posts_controller.rb']
+        #   puts "total"
+        #   puts current_coverage['/Users/danmayer/projects/coverage_rails_benchmark/app/controllers/posts_controller.rb'].inspect
+        # end
+        #
+        #
+        # if previous_results && previous_results['/Users/danmayer/projects/coverage_rails_benchmark/app/controllers/posts_controller.rb']
+        #   puts "prev"
+        #   puts previous_results['/Users/danmayer/projects/coverage_rails_benchmark/app/controllers/posts_controller.rb'].inspect
+        # end
+        #
+        # if new_results['/Users/danmayer/projects/coverage_rails_benchmark/app/controllers/posts_controller.rb']
+        #   puts "new"
+        #   puts new_results['/Users/danmayer/projects/coverage_rails_benchmark/app/controllers/posts_controller.rb'].inspect
+        # end
+
+        add_previous_results(current_coverage)
+        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 }
+      end
+
+      def initialize
+        if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3.0')
+          raise NotImplementedError, 'not supported until Ruby 2.3.0 and later'
+        end
+        unless defined?(::Coverage)
+          # puts 'loading coverage'
+          require 'coverage'
+        end
+        if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
+          ::Coverage.start unless ::Coverage.running?
+        else
+          ::Coverage.start
+        end     
+        @semaphore = Mutex.new
+        @@previous_results = nil
+        reset_instance
+      end
+    end
+  end
+end

data/lib/coverband/collectors/trace.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Coverband
+  module Collectors
+    class Trace < Base
+
+      def reset_instance
+        super
+        @tracer_set = false
+        @trace = create_trace_point
+        self
+      end
+
+      def report_coverage
+        unless @enabled
+          @logger.info 'coverage disabled' if @verbose
+          return
+        end
+
+        unset_tracer
+
+        if failed_recently?
+          @logger.info 'coverage reporting standing-by because of recent failure' if @verbose
+          return
+        end
+
+        if @verbose
+          @logger.info "coverband file usage: #{file_usage.inspect}"
+          output_file_line_usage if @verbose == 'debug'
+        end
+
+        if @store
+          if @stats
+            @before_time = Time.now
+            @stats.count 'coverband.files.recorded_files', @file_line_usage.length
+          end
+          @store.save_report(@file_line_usage)
+          if @stats
+            @time_spent = Time.now - @before_time
+            @stats.timing 'coverband.files.recorded_time', @time_spent
+          end
+          @file_line_usage.clear
+        elsif @verbose
+          @logger.info 'coverage report: '
+          @logger.info @file_line_usage.inspect
+        end
+      rescue RuntimeError => err
+        failed!
+        if @verbose
+          @logger.info 'coverage missing'
+          @logger.info "error: #{err.inspect} #{err.message}"
+        end
+      end
+
+      protected
+
+      def set_tracer
+        unless @tracer_set
+          @trace.enable
+          @tracer_set = true
+        end
+      end
+
+      def unset_tracer
+        @trace.disable
+        @tracer_set = false
+      end
+
+      private
+
+      def add_file(file, line)
+        @file_line_usage[file] = Hash.new(0) unless @file_line_usage.include?(file)
+        @file_line_usage[file][line] += 1
+      end
+
+      def file_usage
+        hash = {}
+        @file_line_usage.each do |file, lines|
+          hash[file] = lines.values.inject(0, :+)
+        end
+        hash.sort_by { |_key, value| value }
+      end
+
+      def create_trace_point
+        TracePoint.new(*Coverband.configuration.trace_point_events) do |tp|
+          if Thread.current == @current_thread
+            file = tp.path
+            unless @ignored_files.include?(file)
+              if track_file?(file)
+                add_file(file, tp.lineno)
+              else
+                @ignored_files << file
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coverband/configuration.rb

@@ -1,15 +1,13 @@
+# frozen_string_literal: true
+
 module Coverband
   class Configuration
-
     attr_accessor :redis, :root_paths, :root,
                   :ignore, :additional_files, :percentage, :verbose, :reporter,
-                  :stats, :logger, :startup_delay, :trace_point_events,
-                  :include_gems, :memory_caching, :s3_bucket, :coverage_file, :store,
-                  :disable_on_failure_for
-
-    # deprecated, but leaving to allow old configs to 'just work'
-    # remove for 2.0
-    attr_accessor :coverage_baseline
+                  :stats, :startup_delay, :trace_point_events,
+                  :include_gems, :memory_caching, :s3_bucket, :coverage_file,
+                  :collector, :disable_on_failure_for
+    attr_writer :logger, :store
 
     def initialize
       @root = Dir.pwd
@@ -22,6 +20,7 @@ module Coverband
       @percentage = 0.0
       @verbose = false
       @reporter = 'scov'
+      @collector = 'trace'
       @logger = Logger.new(STDOUT)
       @startup_delay = 0
       @trace_point_events = [:line]
@@ -35,7 +34,7 @@ module Coverband
       @logger ||= Logger.new(STDOUT)
     end
 
-    #TODO considering removing @redis / @coveragefile and have user set store directly
+    # TODO: considering removing @redis / @coveragefile and have user set store directly
     def store
       return @store if @store
       if redis
@@ -45,6 +44,5 @@ module Coverband
       end
       @store
     end
-
   end
 end

data/lib/coverband/middleware.rb

@@ -1,17 +1,17 @@
+# frozen_string_literal: true
+
 module Coverband
   class Middleware
-
     def initialize(app)
       @app = app
     end
 
     def call(env)
-      Coverband::Base.instance.configure_sampling
-      Coverband::Base.instance.record_coverage
+      Coverband::Collectors::Base.instance.configure_sampling
+      Coverband::Collectors::Base.instance.record_coverage
       @app.call(env)
     ensure
-      Coverband::Base.instance.report_coverage
+      Coverband::Collectors::Base.instance.report_coverage
     end
-
   end
 end

data/lib/coverband/reporters/base.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Coverband
   module Reporters
     class Base
-
       def self.report(store, options = {})
         roots = get_roots
         additional_coverage_data = options.fetch(:additional_scov_data) { [] }
@@ -32,7 +33,7 @@ module Coverband
       protected
 
       def self.fix_file_names(report_hash, roots)
-        fixed_report = {} #normalize names across servers
+        fixed_report = {} # normalize names across servers
         report_hash.each_pair do |key, values|
           filename = filename_from_key(key, roots)
           fixed_report[filename] = values
@@ -46,12 +47,10 @@ module Coverband
         merged = []
         longest = first.length > second.length ? first : second
 
-        longest.each_with_index do |line, index|
-          if first[index] || second[index]
-            merged[index] = (first[index].to_i + second[index].to_i)
-          else
-            merged[index] = nil
-          end
+        longest.each_with_index do |_line, index|
+          merged[index] = if first[index] || second[index]
+                            (first[index].to_i + second[index].to_i)
+                          end
         end
 
         merged
@@ -61,12 +60,12 @@ module Coverband
       # 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) }
-          if current_line_hits = scov_style_report[file_key]
-            scov_style_report[file_key] = merge_arrays(current_line_hits, existing_lines)
-          else
-            scov_style_report[file_key] = existing_lines
-          end
+          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
@@ -87,18 +86,17 @@ module Coverband
       # {"/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.exists?(filename)
-
-          count = File.foreach(filename).inject(0) { |c, line| c + 1 }
+        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)) }
+            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) }
+            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}
+          { filename => line_array }
         else
           Coverband.configuration.logger.info "file #{filename} not found in project"
           nil
@@ -115,19 +113,18 @@ module Coverband
         # this logic should be pushed to base report
         ###
         store.covered_files.each do |key|
-          next if Coverband.configuration.ignore.any?{ |i| key.match(i) }
+          next if Coverband.configuration.ignore.any? { |i| key.match(i) }
           line_data = line_hash(store, key, roots)
 
-          if 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
+          next unless line_data
+          line_key = line_data.keys.first
+          previous_line_hash = scov_style_report[line_key]
 
-            scov_style_report.merge!(line_data)
+          if previous_line_hash
+            line_data[line_key] = merge_arrays(line_data[line_key], previous_line_hash)
           end
+
+          scov_style_report.merge!(line_data)
         end
 
         scov_style_report = fix_file_names(scov_style_report, roots)
@@ -143,8 +140,6 @@ module Coverband
 
         scov_style_report
       end
-
     end
   end
 end
-

data/lib/coverband/reporters/console_report.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Coverband
   module Reporters
     class ConsoleReport < Base
-
       def self.report(store, options = {})
         scov_style_report = super(store, options)
 
@@ -10,8 +11,6 @@ module Coverband
         end
         scov_style_report
       end
-
     end
   end
 end
-