coverband 1.5.4 → 2.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb86a59ade80400f2e95ffbdbcbc2d8b343d07b2
-  data.tar.gz: 2f43c4ea1d6288262d660ba163061a2448f6e454
+  metadata.gz: 578fbbc18bb6563f7d6568ba1b62ca49957f08e9
+  data.tar.gz: 0b4fd748dfedd42479f770bf9d853910d589d0f4
 SHA512:
-  metadata.gz: 293e0b120e6bb341c5fabf1f91f65939e521d4dcb883488ea1de7aa1a4f2cc27e206dbcbbac40327ac8c7f809ade9adeb729a0578d9555715ea58554952549b7
-  data.tar.gz: d4bfc1ed199234e09464cbd71676a1db2bac1e9a0ef78cc53f89cace8fd65b9feb8b303d15a32778dfd336b9075b560203f67cb603fd74c069b74f9654932d9b
+  metadata.gz: 3cfc0686746b6100abeae7345fa536028d8ba7c9a4168fbfee5b62f66f71e4185bb0dfa9f93d10d97543898b1b4a16ffacd3e7413c009dff645ca012df37fdce
+  data.tar.gz: 3d5573fc51c3cb2efbbf7ea79cd4711bde18950d18324a4f2d72cb3f51f1a3a68934d29ac6a60154a9d2548f8661c47982f92af39dde49e742f7cb128f046d1e

data/.gitignore

@@ -4,6 +4,8 @@
 .config
 .yardoc
 .idea/
+.ruby-version
+.rubocop.yml
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -16,3 +18,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.byebug_history

data/.travis.yml

@@ -3,6 +3,9 @@ rvm:
   - "2.0"
   - "2.1"
   - "2.2"
+  - "2.3"
+  - "2.4"
+  - "2.5"
 services:
   - redis-server
 before_install:

data/Gemfile

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
-

data/Rakefile

@@ -1,13 +1,15 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 
 import 'test/benchmarks/benchmark.rake'
 
-task :default => :test
+task default: :test
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   # exclude benchmark from the tests as the way it functions resets code coverage during executions
-  #test.pattern = 'test/unit/*_test.rb'
+  # test.pattern = 'test/unit/*_test.rb'
   # using test files opposed to pattern as it outputs which files are run
   test.test_files = FileList['test/unit/*_test.rb']
   test.verbose = true

data/coverband.gemspec

@@ -1,34 +1,38 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'coverband/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "coverband"
+  spec.name          = 'coverband'
   spec.version       = Coverband::VERSION
-  spec.authors       = ["Dan Mayer"]
-  spec.email         = ["dan@mayerdan.com"]
-  spec.description   = %q{Rack middleware to help measure production code usage (LOC runtime usage)}
-  spec.summary       = %q{Rack middleware to help measure production code usage (LOC runtime usage)}
-  spec.homepage      = "https://github.com/danmayer/coverband"
-  spec.license       = "MIT"
+  spec.authors       = ['Dan Mayer']
+  spec.email         = ['dan@mayerdan.com']
+  spec.description   = 'Rack middleware to help measure production code usage (LOC runtime usage)'
+  spec.summary       = 'Rack middleware to help measure production code usage (LOC runtime usage)'
+  spec.homepage      = 'https://github.com/danmayer/coverband'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split("\n")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "mocha", "~> 0.14.0"
-  spec.add_development_dependency "rack"
-  spec.add_development_dependency "rack-test"
-  spec.add_development_dependency "test-unit"
-  spec.add_development_dependency 'sinatra'
-  spec.add_development_dependency 'classifier-reborn'
   spec.add_development_dependency 'aws-sdk', '~> 2'
-  spec.add_runtime_dependency "simplecov", '> 0.11.1'
-  spec.add_runtime_dependency "json"
-  # TODO make redis optional dependancy as we add additional adapters
-  spec.add_runtime_dependency "redis"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'classifier-reborn'
+  spec.add_development_dependency 'mocha', '~> 0.14.0'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'test-unit'
+  # add when debugging
+  # require 'byebug'; byebug
+  spec.add_development_dependency 'byebug'
+  spec.add_runtime_dependency 'json'
+  spec.add_runtime_dependency 'simplecov', '> 0.11.1'
+  # TODO: make redis optional dependancy as we add additional adapters
+  spec.add_runtime_dependency 'redis'
 end

data/lib/coverband.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'json'
-# todo move to only be request if using redis store
+# TODO: move to only be request if using redis store
 require 'redis'
 
 require 'coverband/version'
@@ -8,7 +10,9 @@ require 'coverband/configuration'
 require 'coverband/adapters/redis_store'
 require 'coverband/adapters/memory_cache_store'
 require 'coverband/adapters/file_store'
-require 'coverband/base'
+require 'coverband/collectors/base'
+require 'coverband/collectors/trace'
+require 'coverband/collectors/coverage'
 require 'coverband/baseline'
 require 'coverband/reporters/base'
 require 'coverband/reporters/simple_cov_report'
@@ -23,27 +27,19 @@ module Coverband
     attr_accessor :configuration_data
   end
 
-  # this method is left for backwards compatibility with existing configs
-  def self.parse_baseline(baseline_file = './tmp/coverband_baseline.json')
-    Coverband::Baseline.parse_baseline(baseline_file)
-  end
-
   def self.configure(file = nil)
     configuration
     if block_given?
       yield(configuration)
+    elsif File.exist?(CONFIG_FILE)
+      file ||= CONFIG_FILE
+      require file
     else
-      if File.exists?(CONFIG_FILE)
-        file ||= CONFIG_FILE
-        require file
-      else
-        raise ArgumentError, "configure requires a block or the existance of a #{CONFIG_FILE} in your project"
-      end
+      raise ArgumentError, "configure requires a block or the existance of a #{CONFIG_FILE} in your project"
     end
   end
 
   def self.configuration
     self.configuration_data ||= Configuration.new
   end
-
 end

data/lib/coverband/adapters/file_store.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Coverband
   module Adapters
     class FileStore
       attr_accessor :path
 
-      def initialize(path, opts = {})
+      def initialize(path, _opts = {})
         @path = path
 
         config_dir = File.dirname(@path)
@@ -11,18 +13,16 @@ module Coverband
       end
 
       def clear!
-        if File.exist?(path)
-          File.delete(path)
-        end
+        File.delete(path) if File.exist?(path)
       end
 
       def save_report(report)
         results = existing_data(path)
         report.each_pair do |file, values|
-          if results.has_key?(file)
+          if results.key?(file)
             # convert the keys to "3" opposed to 3
             values = JSON.parse(values.to_json)
-            results[file].merge!( values ){|k, old_v, new_v| old_v.to_i + new_v.to_i}
+            results[file].merge!(values) { |_k, old_v, new_v| old_v.to_i + new_v.to_i }
           else
             results[file] = values
           end
@@ -53,7 +53,6 @@ module Coverband
           {}
         end
       end
-
     end
   end
 end

data/lib/coverband/adapters/memory_cache_store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coverband
   module Adapters
     class MemoryCacheStore
@@ -20,10 +22,11 @@ module Coverband
         store.save_report(filtered_files) if filtered_files.any?
       end
 
+      # rubocop:disable Lint/IneffectiveAccessModifier
       private
 
       def self.files_cache
-        @files_cache ||= Hash.new
+        @files_cache ||= {}
       end
 
       def files_cache
@@ -31,16 +34,16 @@ module Coverband
       end
 
       def filter(files)
-        files.each_with_object(Hash.new) do |(file, lines), filtered_file_hash|
-          #first time we see a file, we pre-init the in memory cache to whatever is in store(redis)
+        files.each_with_object({}) do |(file, lines), filtered_file_hash|
+          # first time we see a file, we pre-init the in memory cache to whatever is in store(redis)
           line_cache = files_cache[file] ||= Set.new(store.covered_lines_for_file(file))
           lines.reject! do |line|
-            line_cache.include?(line) ? true : (line_cache << line and false)
+            line_cache.include?(line) ? true : (line_cache << line && false)
           end
           filtered_file_hash[file] = lines if lines.any?
         end
       end
-
+      # rubocop:enable Lint/IneffectiveAccessModifier
     end
   end
 end

data/lib/coverband/adapters/redis_store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coverband
   module Adapters
     class RedisStore
@@ -5,10 +7,6 @@ module Coverband
 
       def initialize(redis, opts = {})
         @redis = redis
-        #remove check for coverband 2.0
-        @_sadd_supports_array = recent_gem_version? && recent_server_version?
-        #possibly drop array storage for 2.0
-        @store_as_array = opts.fetch(:array){ false }
       end
 
       def clear!
@@ -17,20 +15,10 @@ module Coverband
       end
 
       def save_report(report)
-        if @store_as_array
-          redis.pipelined do
-            store_array(BASE_KEY, report.keys)
-
-            report.each do |file, lines|
-              store_array("#{BASE_KEY}.#{file}", lines.keys)
-            end
-          end
-        else
-          store_array(BASE_KEY, report.keys)
+        store_array(BASE_KEY, report.keys)
 
-          report.each do |file, lines|
-            store_map("#{BASE_KEY}.#{file}", lines)
-          end
+        report.each do |file, lines|
+          store_map("#{BASE_KEY}.#{file}", lines)
         end
       end
 
@@ -47,55 +35,27 @@ module Coverband
       end
 
       def covered_lines_for_file(file)
-        if @store_as_array
-          @redis.smembers("#{BASE_KEY}.#{file}").map(&:to_i)
-        else
-          @redis.hgetall("#{BASE_KEY}.#{file}")
-        end
+        @redis.hgetall("#{BASE_KEY}.#{file}")
       end
 
       private
 
       attr_reader :redis
 
-      def sadd_supports_array?
-        @_sadd_supports_array
-      end
-
       def store_map(key, values)
         unless values.empty?
           existing = redis.hgetall(key)
-          #in redis all keys are strings
-          values = Hash[values.map{|k,val| [k.to_s,val] } ]
-          values.merge!( existing ){|k, old_v, new_v| old_v.to_i + new_v.to_i}
+          # in redis all keys are strings
+          values = Hash[values.map { |k, val| [k.to_s, val] }]
+          values.merge!(existing) { |_k, old_v, new_v| old_v.to_i + new_v.to_i }
           redis.mapped_hmset(key, values)
         end
       end
 
       def store_array(key, values)
-        if sadd_supports_array?
-          redis.sadd(key, values) if (values.length > 0)
-        else
-          values.each do |value|
-            redis.sadd(key, value)
-          end
-        end
+        redis.sadd(key, values) unless values.empty?
         values
       end
-
-      def recent_server_version?
-        info_data = redis.info
-        if info_data.is_a?(Hash)
-          Gem::Version.new(info_data['redis_version']) >= Gem::Version.new('2.4')
-        else
-          #guess supported
-          true
-        end
-      end
-
-      def recent_gem_version?
-        Gem::Version.new(Redis::VERSION) >= Gem::Version.new('3.0')
-      end
     end
   end
 end

data/lib/coverband/baseline.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Coverband
   class Baseline
-
     def self.record
       require 'coverage'
       Coverage.start
@@ -8,12 +9,12 @@ module Coverband
 
       project_directory = File.expand_path(Coverband.configuration.root)
       results = Coverage.result
-      results = results.reject { |key, val| !key.match(project_directory) || Coverband.configuration.ignore.any? { |pattern| key.match(/#{pattern}/) } }
+      results = results.reject { |key, _val| !key.match(project_directory) || Coverband.configuration.ignore.any? { |pattern| key.match(/#{pattern}/) } }
 
       Coverband.configuration.store.save_report(convert_coverage_format(results))
     end
 
-    def self.parse_baseline(back_compat = nil)
+    def self.parse_baseline(_back_compat = nil)
       Coverband.configuration.store.coverage
     end
 
@@ -33,12 +34,11 @@ module Coverband
       results.each_pair do |file, data|
         lines_map = {}
         data.each_with_index do |hits, index|
-          lines_map[(index+1)] = hits unless hits.nil?
+          lines_map[(index + 1)] = hits unless hits.nil?
         end
         file_map[file] = lines_map
       end
       file_map
     end
-
   end
 end

data/lib/coverband/collectors/base.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Coverband
+  module Collectors
+    class Base
+      def self.instance
+        if Coverband.configuration.collector == 'trace'
+          Thread.current[:coverband_instance] ||= Coverband::Collectors::Trace.new
+        elsif Coverband.configuration.collector == 'coverage'
+          Thread.current[:coverband_instance] ||= Coverband::Collectors::Coverage.new
+        else
+          raise 'select valid collector [trace, coverage]'
+        end
+      end
+
+      def start
+        @enabled = true
+        record_coverage
+      end
+
+      def stop
+        @enabled = false
+        unset_tracer
+      end
+
+      def sample
+        configure_sampling
+        record_coverage
+        result = yield
+        report_coverage
+        result
+      end
+
+      def save
+        @enabled = true
+        report_coverage
+        @enabled = false
+      end
+
+      def reset_instance
+        @project_directory = File.expand_path(Coverband.configuration.root)
+        @enabled = false
+        @disable_on_failure_for = Coverband.configuration.disable_on_failure_for
+        @file_line_usage = {}
+        @ignored_files = Set.new
+        @startup_delay = Coverband.configuration.startup_delay
+        @ignore_patterns = Coverband.configuration.ignore + ['internal:prelude', 'schema.rb']
+        @ignore_patterns += ['gems'] unless Coverband.configuration.include_gems
+        @sample_percentage = Coverband.configuration.percentage
+        @store = Coverband.configuration.store
+        @store = Coverband::Adapters::MemoryCacheStore.new(@store) if Coverband.configuration.memory_caching
+        @stats    = Coverband.configuration.stats
+        @verbose  = Coverband.configuration.verbose
+        @logger   = Coverband.configuration.logger
+        @current_thread = Thread.current
+        Thread.current[:coverband_instance] = nil
+        self
+      end
+
+      def configure_sampling
+        if @startup_delay != 0 || (rand * 100.0) > @sample_percentage
+          @startup_delay -= 1 if @startup_delay > 0
+          @enabled = false
+        else
+          @enabled = true
+        end
+      end
+
+      def record_coverage
+        if @enabled && !failed_recently?
+          set_tracer
+        else
+          unset_tracer
+        end
+        # support old ruby before &. safe digging
+        @stats.increment "coverband.request.recorded.#{@enabled}" if @stats
+      rescue RuntimeError => err
+        failed!
+        if @verbose
+          @logger.info 'error stating recording coverage'
+          @logger.info "error: #{err.inspect} #{err.message}"
+        end
+      end
+
+      def report_coverage
+        raise 'abstract'
+      end
+
+      protected
+
+      def track_file?(file)
+        @ignore_patterns.none? { |pattern| file.include?(pattern) } && file.start_with?(@project_directory)
+      end
+
+      def set_tracer
+        raise 'abstract'
+      end
+
+      def unset_tracer
+        raise 'abstract'
+      end
+
+      def output_file_line_usage
+        @logger.info 'coverband debug coverband file:line usage:'
+        @file_line_usage.sort_by { |_key, value| value.length }.each do |pair|
+          file = pair.first
+          lines = pair.last
+          @logger.info "file: #{file} => #{lines.sort_by { |_key, value| value }}"
+        end
+      end
+
+      private
+
+      def failed_at_thread_key
+        "__#{self.class.name}__failed_at"
+      end
+
+      def failed_at
+        Thread.current[failed_at_thread_key]
+      end
+
+      def failed_at=(time)
+        Thread.current[failed_at_thread_key] = time
+      end
+
+      def failed!
+        self.failed_at = Time.now
+      end
+
+      def failed_recently?
+        return false unless @disable_on_failure_for && failed_at
+        failed_at + @disable_on_failure_for > Time.now
+      end
+
+      def initialize
+        reset_instance
+      end
+    end
+  end
+end