coverband 4.2.0 → 4.2.1.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e214b1bd6119046657daa64ed6d69f77f821c6c670b72e98d307ede5f08e61f
-  data.tar.gz: 469d9470799f90b5b52d53d3a630fae75b3b6bff0390375987902331878f530e
+  metadata.gz: e20f401f319399c3eb6aab9f562105addeedd4dcea5e3de3db3e5a763e92fe5d
+  data.tar.gz: bc20a849db5868dd73a448269bc9d74e6b58674793807bcdcf36a33cecd8825b
 SHA512:
-  metadata.gz: f1b0f503941ab9dbc2dee6a184fe6d6d937a5f505a5c9112ae7343197372586d6cb42df758f24effde0ee30fb359c0e2e651c64a1f5ee4c9a588a4499683dc73
-  data.tar.gz: ee700abfe4c730011dcc5c1c8521f55a2cc7ec5149e44b08187c8d09419023160a0f7c8aaba4b2aa0bb405eb13f4aeee1d8ce9cabce4860738d4ea94cac63c04
+  metadata.gz: 5f2303765376cd244a692d1254ef8f7fe57180ee12712d3763921811c7d278fb3ffb2dfa4a1400b86b01809c0acfa8173c7569aeb65be3f860e53dad01dfbc83
+  data.tar.gz: c3456663cc5b9f9ecfce60603234f4aed32ef9f3875cb0ca60ae11e66211f70bb64c6f0b8772b5295c8065d4d8245f107d596cd21140ba7ab146c97ef8353324

data/.rubocop.yml

@@ -2,14 +2,21 @@ AllCops:
   TargetRubyVersion: 2.4
   Exclude:
     - docs/**/*
+    - test/rails4_dummy/**/*
+    - test/rails5_dummy/**/*
+    - test/fixtures/**/*
+    # Get the code passing first then we will enable for tests
+    - test/**/*
 Documentation:
   Enabled: false
 Metrics/MethodLength:
   Enabled: false
 Metrics/LineLength:
-  Max: 120
+  Max: 160
 Metrics/BlockNesting:
   Max: 5
+Metrics/BlockLength:
+  Max: 30
 Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/PerceivedComplexity:
@@ -22,38 +29,51 @@ Metrics/ModuleLength:
   Enabled: false
 Metrics/ParameterLists:
   Max: 10
-Style/AccessorMethodName:
-  Enabled: false
-Style/PredicateName:
+Naming/AccessorMethodName:
   Enabled: false
+Naming/PredicateName:
+  Enabled: true
 Style/TernaryParentheses:
   Enabled: false
 Style/MutableConstant:
   Enabled: false
+Style/IdenticalConditionalBranches:
+  Enabled: false
+Style/ClassVars:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: true
 Style/GuardClause:
   Enabled: true
 Style/NumericPredicate:
-  Enabled: false
+  Enabled: true
 Style/NumericLiterals:
   Enabled: false
 Style/NumericLiteralPrefix:
   Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
+Style/SymbolProc:
+  Enabled: false
+Style/RegexpLiteral:
+  Enabled: false
 Performance/Casecmp:
   Enabled: false
-Style/MultilineMethodCallIndentation:
+Performance/RegexpMatch:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
   Enabled: true
-Style/MultilineOperationIndentation:
+Layout/MultilineOperationIndentation:
   Enabled: true
 Lint/RescueException:
   Enabled: true
+Lint/UselessAccessModifier:
+  Enabled: true
 Lint/ShadowingOuterLocalVariable:
   Enabled: true
 Style/FormatString:
   Enabled: true
-Lint/Eval:
+Security/Eval:
   Enabled: true
-

data/.travis.yml

@@ -9,11 +9,19 @@ gemfile:
   - Gemfile.rails4
 services:
   - redis-server
+script:
+  - bundle exec rake rubocop
+  - bundle exec rake
+  - bundle exec rake forked_tests
+addons:
+  chrome: stable
 before_install:
   - echo 'this is a hack to clear default bundler and force bundler 1.17.3'
   - ls /home/travis/.rvm/gems/
   - rm /home/travis/.rvm/gems/ruby-2.3.7@global/specifications/bundler-2.0.1.gemspec || true
-  - rm /home/travis/.rvm/gems/ruby-2.5.4@global/specifications/bundler-2.0.1.gemspec || true
+  - rm /home/travis/.rvm/gems/ruby-2.4.6@global/specifications/bundler-2.0.1.gemspec || true
+  - rm /home/travis/.rvm/gems/ruby-2.5.5@global/specifications/bundler-2.0.1.gemspec || true
   - gem uninstall bundler || true
   - gem install bundler -v '1.17.3'
   - bundler --version
+  - google-chrome-stable --headless --disable-gpu --remote-debugging-port=9222 http://localhost &

data/Gemfile

@@ -5,5 +5,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
 gem 'rails', '~>5'
-# this is used for testing gem tracking
+# these gems are used for testing gem tracking
+gem 'pundit'
 gem 'rainbow', require: false

data/Gemfile.rails4

@@ -7,3 +7,4 @@ gemspec
 gem 'rails', '~>4'
 # this is used for testing gem tracking
 gem 'rainbow', require: false
+gem 'pundit'

data/README.md

@@ -4,6 +4,7 @@
 
 [![Build Status](https://travis-ci.org/danmayer/coverband.svg?branch=master)](https://travis-ci.org/danmayer/coverband)
 [![Coverage Status](https://coveralls.io/repos/github/danmayer/coverband/badge.svg?branch=master)](https://coveralls.io/github/danmayer/coverband?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/1e6682f9540d75f26da7/maintainability)](https://codeclimate.com/github/danmayer/coverband/maintainability)
 
 <p align="center">
   <a href="#key-features">Key Features</a> •
@@ -24,9 +25,11 @@ A gem to measure production code usage, showing a counter for the number of time
 The primary goal of Coverband is giving deep insight into your production runtime usage of your application code, while having the least impact on performance possible.
 
 - Low performance overhead
-- Very simple setup and configuration
+- Simple setup and configuration
 - Out of the box support for all standard code execution paths (web, cron, background jobs, rake tasks, etc)
+- Splits load time (Rails eager load) and Run time metrics
 - Easy to understand actionable insights from the report
+- Tracks Gem usage
 - Development mode, offers deep insight of code usage details (number of LOC execution during single request, etc) during development.
 - Mountable web interface to easily share reports
 
@@ -52,9 +55,17 @@ gem 'coverband'
 
 If [tracking gem usage](#collecting-gem--library-usage), be sure to include coverband before other gems you would like to track.
 
+## Upgrading to Latest
+
+### No custom code or middleware required
+
+With older versions of coverband, projects would report to redis using rack or sidekiq middleware. After coverband 4.0, this should no longer be required and could cause performance issues. Reporting to redis is now automatically done within a background thread with no custom code needed.
+
+See [changelog](https://github.com/danmayer/coverband/blob/master/changes.md).
+
 ## Rails
 
-The Railtie integration means you shouldn't need to do anything anything else other than ensure coverband is required after rails within your Gemfile.
+The Railtie integration means you shouldn't need to do anything anything else other than ensure coverband is required after rails within your Gemfile. The only exception to this is gem tracking of `Bundle.require` which depends on requiring coverband within the application.rb. See [Collecting Gem / Library Usage](https://github.com/danmayer/coverband#collecting-gem--library-usage).
 
 ## Sinatra
 
@@ -64,7 +75,7 @@ For the best coverage you want this loaded as early as possible. I have been put
 require 'coverband'
 require File.dirname(__FILE__) + '/config/environment'
 
-use Coverband::Middleware
+use Coverband::BackgroundMiddleware
 run ActionController::Dispatcher.new
 ```
 
@@ -92,7 +103,7 @@ end
 
 The web endpoint is a barebones endpoint that you can either expose direct (after authentication) or you can just link to the actions you wish to expose. The index is intended as a example to showcase all the features.
 
-![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_web_update.png)
+![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_web_ui.png)
 
 > The web index as available on the Coverband Demo site
 
@@ -118,14 +129,6 @@ Index Page
 Details on an example Sinatra app
 ![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_details.png)
 
-# Verify Correct Installation
-
-- boot up your application
-- run app and hit a controller (via a web request, at least one request must complete)
-- run `rake coverband:coverage` this will show app initialization coverage
-- make another request, or enough that your reporting frequency will trigger
-- run `rake coverband:coverage` and you should see coverage increasing for the endpoints you hit.
-
 # Coverband Demo
 
 Take Coverband for a spin on the live Heroku deployed [Coverband Demo](https://coverband-demo.herokuapp.com/). The [full source code for the demo](https://github.com/danmayer/coverband_demo) is available to help with installation, configuration, and understanding of basic usage.
@@ -261,7 +264,20 @@ end
 
 The `track_gems` feature exposes a Gems tab in the report which prints out the percentage usage of each Gem. See demo [here](https://coverband-demo.herokuapp.com/coverage?#_Gems).
 
-When tracking gems, it is important that `Coverband#start` is called before the gems to be tracked are required. Since `Coverband#start` is automatically called by default when coverband is required, list coverband before the other gems to be tracked within your Gemfile. The exception to this are gems like rails and resque. Since coverband has some specific intergrations for these frameworks, these two gems should be required first.
+When tracking gems, it is important that `Coverband#start` is called before the gems to be tracked are required. The best way to do this is to require coverband before Bundle.require is called. Within rails, require coverband within the application.rb like so:
+
+```ruby
+require 'coverband'
+Bundler.require(*Rails.groups)
+```
+
+If you are using the resque integration, resque needs to be required before coverband since the integration will not run unless resque is loaded. Within the application.rb just require resque before coverband.
+
+```ruby
+require 'resque'
+require 'coverband'
+Bundler.require(*Rails.groups)
+```
 
 The track_gems config only exposes the overall usage of a gem. In order to see the detail of each file, enable the `gem_details` flag.
 
@@ -335,6 +351,7 @@ If you submit a change please make sure the tests and benchmarks are passing.
 - view test coverage: `open coverage/index.html`
 - run the benchmarks before and after your change to see impact
   - `rake benchmarks`
+  - run a single test by line number like rspec: `bundle exec m test/coverband/reporters/html_test.rb:29`
 
 ### Known Issues
 
@@ -352,6 +369,10 @@ What is the coverage data in Redis?
 
 `Coverband.configuration.store.coverage`
 
+## Logo
+
+The Coverband logo was created by [Dave Woodall](http://davewoodall.com). Thanks Dave!
+
 # License
 
 This is a MIT License project...

data/Rakefile

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
-
 import 'test/benchmarks/benchmark.rake'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
 
-task default: [:test, :benchmarks]
+task default: %i[test benchmarks]
 
 task :test
 require 'rake/testtask'
@@ -17,6 +19,12 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
+Rake::TestTask.new(:forked_tests) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/forked/**/*_test.rb']
+  test.verbose = true
+end
+
 desc 'load irb with this gem'
 task :console do
   exec 'irb -I lib -r coverband'

data/changes.md

@@ -16,6 +16,8 @@ Will be the fully modern release that drops maintenance legacy support in favor
   - add built-in support for easy loading via Railties
   - built in support for activejob, sidekiq, and other common frameworks
   - reduced configuration options
+- support oneshot
+- drop middleware figure out a way to kick off background without middelware
 - options on reporting
   - background reporting
   - or middleware reporting
@@ -54,29 +56,42 @@ This is a possible gem to host experimental or more complex features, which woul
 
 Feature Ideas:
 
+- per request coverage implemented via Ruby 2.6.0 coverage.clear https://bugs.ruby-lang.org/issues/15022
 - statsd adapters (it would allow passing in date ranges on usage)
-- move to SimpleCov console out, or make similar console tabular output
 - Possibly add ability to record code run for a given route
 - integrate recording with deploy tag or deploy timestamp
   - diff code usage across deployed versions
   - what methods increased usage or decreased
-- Improve client code api, around manual usage of sampling (like event usage)
 - ability to change the Coverband config at runtime by changing the config pushed to the Redis hash. In memory cache around the changes to only make that call periodically.
 - Opposed to just showing code usage on a route allow 'tagging' events which would record line coverage for that tag (this would allow tagging all code that modified an ActiveRecord model for example
 - additional adapters (tracepoint, ruby-profiler, etc)
-- code route tracing (entry point to all code executed for example /some_path -> code coverage of that path)
-- tagging of reported Coverage
-- allow only to collect coverage based on route (limiting or scoped coverage)
-- coverage over some other variable like a set of alpha users
+- tagged coverage reports
+  - code route tracing (entry point to all code executed for example /some_path -> code coverage of that path)
+  - deploy git hash tagging of reported Coverage
+  - allow only to collect coverage based on route (limiting or scoped coverage)
+  - coverage over some other variable like a set of alpha users
 - document how to use this on staging / selenium test suite runs
   - possible add API to pull report at end of run
 
-# Alpha
+# Alpha / Beta / Release Candidates
 
-### Coverband 4.3.0?
+### Coverband 4.2.1
 
 - further improvements on eager_loading detection
-- ?
+- fix on ignore configuration options
+- fix broken static server
+- fix issue where clear and coverage trigger coverage reports
+- improved logging
+- fix sorting of runtime coverage
+- add runtime coverage to gem summary pages
+- fix issue where reports didn't include files with 0 activity
+- add Oneshot coverage support for Ruby 2.6.0 thanks @zwalker
+   - I would consider this our test oneshot release, please report any issues
+- resolve regression on coverband rake tasks recording coverage
+- improved runtime / eager loading tracking
+- updated runtime relavent lines and runtime percentages
+- fix on gem runtime code coverage support, thanks @kbaum
+- display gems that are in loaded with 0 coverage, thanks @kbaum  
 
 # Released
 
@@ -96,7 +111,7 @@ Feature Ideas:
 - move from thread based reporter instance to process based instance
 - thanks Karl Baum for much of the above mentioned work
 - clear coverage on individual files
-- we have a logo, thanks Dave Woodall
+- we have a logo, thanks Dave Woodall, http://davewoodall.com
 
 ### Coverband 4.1.1
 

data/coverband.gemspec

@@ -28,12 +28,16 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'm'
   spec.add_development_dependency 'memory_profiler'
   spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-fork_executor'
   spec.add_development_dependency 'mocha', '~> 1.7.0'
   spec.add_development_dependency 'rack'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'resque'
-  # temporarily needed to fun tests for classifier-reborn as part of benchmarks
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'selenium-webdriver'
+  spec.add_development_dependency 'webdrivers', '~> 3.0'
+  # temporarily needed to run tests for classifier-reborn as part of benchmarks
   spec.add_development_dependency 'minitest-reporters'
 
   # TODO: used for benchmarking and tests I think we have other better benchmarking

data/lib/coverband.rb

@@ -26,10 +26,11 @@ require 'coverband/reporters/console_report'
 require 'coverband/integrations/background'
 require 'coverband/integrations/rack_server_check'
 require 'coverband/reporters/web'
-require 'coverband/integrations/middleware'
+require 'coverband/integrations/background_middleware'
 require 'coverband/integrations/background'
 
 module Coverband
+  @@configured = false
   CONFIG_FILE = './config/coverband.rb'
   RUNTIME_TYPE = nil
   EAGER_TYPE = :eager_loading
@@ -37,10 +38,6 @@ module Coverband
   TYPES = [RUNTIME_TYPE, EAGER_TYPE]
   ALL_TYPES = TYPES + [:merged]
 
-  class << self
-    attr_accessor :configuration_data
-  end
-
   def self.configure(file = nil)
     configuration_file = file || ENV.fetch('COVERBAND_CONFIG', CONFIG_FILE)
     configuration
@@ -49,45 +46,60 @@ module Coverband
     elsif File.exist?(configuration_file)
       load configuration_file
     else
-      configuration.logger&.debug('using default configuration')
+      configuration.logger.debug('using default configuration')
     end
-    coverage.reset_instance
+    @@configured = true
+    coverage_instance.reset_instance
   end
 
-  def self.report_coverage(force_report = false)
-    Coverband::Collectors::Coverage.instance.report_coverage(force_report)
+  def self.configured?
+    @@configured
+  end
+
+  def self.report_coverage
+    coverage_instance.report_coverage
   end
 
   def self.configuration
-    self.configuration_data ||= Configuration.new
+    @configuration ||= Configuration.new
   end
 
   def self.start
     Coverband::Collectors::Coverage.instance
-    # TODO Railtie sets up at_exit after forks, via middleware, perhaps this hsould be
+    # TODO: Railtie sets up at_exit after forks, via middleware, perhaps this should be
     # added if not rails or if rails but not rackserverrunning
-    AtExit.register
-    Background.start if configuration.background_reporting_enabled && !RackServerCheck.running?
+    AtExit.register unless tasks_to_ignore?
+    Background.start if configuration.background_reporting_enabled && !RackServerCheck.running? && !tasks_to_ignore?
+  end
+
+  def self.tasks_to_ignore?
+    (defined?(Rake) &&
+    Rake.respond_to?(:application) &&
+    (Rake&.application&.top_level_tasks || []).any? { |task| Coverband::Configuration::IGNORE_TASKS.include?(task) })
   end
 
   def self.eager_loading_coverage!
-    coverage.eager_loading!
+    coverage_instance.eager_loading!
+  end
+
+  def self.eager_loading_coverage(&block)
+    coverage_instance.eager_loading(&block)
   end
 
   def self.runtime_coverage!
-    coverage.runtime!
+    coverage_instance.runtime!
   end
 
-  def self.coverage
+  private_class_method def self.coverage_instance
     Coverband::Collectors::Coverage.instance
   end
-
   unless ENV['COVERBAND_DISABLE_AUTO_START']
     # Coverband should be setup as early as possible
     # to capture usage of things loaded by initializers or other Rails engines
     configure
     start
     require 'coverband/utils/railtie' if defined? ::Rails::Railtie
-    require 'coverband/integrations/resque' if defined? Resque
+    require 'coverband/integrations/resque' if defined? ::Resque
+    require 'coverband/integrations/bundler' if defined? ::Bundler
   end
 end