coverband 4.2.0 → 4.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e214b1bd6119046657daa64ed6d69f77f821c6c670b72e98d307ede5f08e61f
-  data.tar.gz: 469d9470799f90b5b52d53d3a630fae75b3b6bff0390375987902331878f530e
+  metadata.gz: 1c094b4a6ef2b76f771cb96aa1fbdc246dc8beea74033ffca4cb466ef96c0a08
+  data.tar.gz: 1162d9244c0e1a1b28c0fa051d7cd53d29b6a4fdfc50c1fadb7d6793229aaf8b
 SHA512:
-  metadata.gz: f1b0f503941ab9dbc2dee6a184fe6d6d937a5f505a5c9112ae7343197372586d6cb42df758f24effde0ee30fb359c0e2e651c64a1f5ee4c9a588a4499683dc73
-  data.tar.gz: ee700abfe4c730011dcc5c1c8521f55a2cc7ec5149e44b08187c8d09419023160a0f7c8aaba4b2aa0bb405eb13f4aeee1d8ce9cabce4860738d4ea94cac63c04
+  metadata.gz: d9eba70b91d87992d1e450490f7fd4545cccb5092bf093c424c51b964cb4b31ad5c8a1d49d1cc774ce6470c6466b7d3b7a7a1df92ecbc4e574a203467f621b55
+  data.tar.gz: 815c462d38f7a27b26f5d209044c53b2e0058c4ea2534db3f6663a267ad0cc435bd6c895128c5ea8f85c0aec61e4e31d9f61c426526b71423e24c941852f74be

data/.rubocop.yml

@@ -1,15 +1,23 @@
 AllCops:
   TargetRubyVersion: 2.4
   Exclude:
+    - vendor/bundle/**/*
     - 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
+Layout/LineLength:
+  Max: 160
 Metrics/BlockNesting:
   Max: 5
+Metrics/BlockLength:
+  Max: 30
 Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/PerceivedComplexity:
@@ -22,38 +30,49 @@ Metrics/ModuleLength:
   Enabled: false
 Metrics/ParameterLists:
   Max: 10
-Style/AccessorMethodName:
+Naming/AccessorMethodName:
   Enabled: false
-Style/PredicateName:
+Naming/RescuedExceptionsVariableName:
   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
-Performance/Casecmp:
+Style/SymbolProc:
   Enabled: false
-Style/MultilineMethodCallIndentation:
+Style/RegexpLiteral:
+  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

@@ -4,16 +4,24 @@ rvm:
   - "2.4"
   - "2.5"
   - "2.6.1"
+cache:
+  bundler: true
+  directories:
+  - $HOME/lua51
 gemfile:
   - Gemfile
   - Gemfile.rails4
 services:
   - redis-server
-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
-  - gem uninstall bundler || true
-  - gem install bundler -v '1.17.3'
-  - bundler --version
+script:
+  - sudo ./lua/install.sh 
+  - $HOME/lua51/bin/busted lua/test/*
+  - bundle exec rake rubocop
+  - COVERBAND_HASH_REDIS_STORE=t bundle exec rake
+  - COVERBAND_HASH_REDIS_STORE=t bundle exec rake forked_tests
+  - bundle exec rake
+  - bundle exec rake forked_tests
+  # remove this for now as it is flaky
+  # passes locally on 2.3.5 on travis passes sometimes on 2.4 and always on 2.6.1
+  #- bundle exec rake benchmarks:memory
+  - bundle exec rake benchmarks

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at danmayer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -5,5 +5,7 @@ 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 'irb', require: false
+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,15 +4,18 @@
 
 [![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)
+[![Discord Shield](https://img.shields.io/discord/609509533999562753)](https://discord.gg/KAH38EV)
+
 
 <p align="center">
   <a href="#key-features">Key Features</a> •
   <a href="#installation">Installation</a> •
   <a href="#coverage-report">Coverage Report</a> •
-  <a href="#verify-correct-installation">Verify Correct Installation</a> •
   <a href="#advanced-config">Advanced Config</a> •
   <a href="#license">License</a> •
-  <a href="/changes.md">Change Log / Roadmap</a>
+  <a href="/changes.md">Change Log / Roadmap</a> •
+  <a href="/CODE_OF_CONDUCT.md">Code of Conduct</a>
 </p>
 
 A gem to measure production code usage, showing a counter for the number of times each line of code that is executed. Coverband allows easy configuration to collect and report on production code usage. It reports in the background via a thread or can be used as Rack middleware, or manually configured to meet any need.
@@ -24,9 +27,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 (still in experimental stages and not recommended for production)
 - 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 +57,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 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 +77,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
 ```
 
@@ -88,17 +101,20 @@ Rails.application.routes.draw do
 end
 ```
 
+or you can enable basic auth by setting `ENV['COVERBAND_PASSWORD']` or via your configuration `config.password = 'my_pass'`
+
 ### Coverband Web Endpoint
 
 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
 
 - **force coverage collection:** This triggers coverage collection on the current webserver process
-- **reload Coverband files:** This has Coverband reload files as configured (force reload of some files that might not capture Coverage on boot). This can be used to reload files on demand.
 - **clear coverage report:** This will clear the coverage data. This wipes out all collected data (**dangerous**)
+- View individual file details
+- **clear individual file coverage:** This will clear the details of the file you are looking at. This is helpful if you don't want to lose all Coverage data but made a change that you expect would impact a particular file.
 
 ### Rake Tasks
 
@@ -118,14 +134,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.
@@ -156,14 +164,34 @@ Coverband.configure do |config|
   config.s3_access_key_id = ENV['AWS_ACCESS_KEY_ID']
   config.s3_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
 
-  # config options false, true, or 'debug'. Always use false in production
+  # config options false, true. (defaults to false)
   # true and debug can give helpful and interesting code usage information
-  # they both increase the performance overhead of the gem a little.
-  # they can also help with initially debugging the installation.
+  # and is safe to use if one is investigating issues in production, but it will slightly
+  # hit perf.
   config.verbose = false
+
+  # default false. button at the top of the web interface which clears all data
+  config.web_enable_clear = true
+
+  # default false. Experimental support for tracking view layer tracking.
+  # Does not track line-level usage, only indicates if an entire file
+  # is used or not.
+  config.track_views = true
 end
 ```
 
+### Working with environment variables
+
+Do you use figaro, mc-settings, dotenv or something else to inject environment variables into your app? If so ensure you have that done BEFORE coverband is required. 
+
+For example if you use dotenv, you need to do this, see https://github.com/bkeepers/dotenv#note-on-load-order
+
+```
+gem 'dotenv-rails', require: 'dotenv/rails-now'
+gem 'coverband'
+gem 'other-gem-that-requires-env-variables'
+```
+
 ### Ignoring Files
 
 Sometimes you have files that are known to be valuable perhaps in other environments or something that is just run very infrequently. Opposed to having to mentally filter them out of the report, you can just have them ignored in the Coverband reporting by using `config.ignore` as shown below. Ignore takes a string but can also match with regex rules see how below ignores all rake tasks as an example.
@@ -173,11 +201,21 @@ config.ignore +=  ['config/application.rb',
                    'config/boot.rb',
                    'config/puma.rb',
                    'config/schedule.rb',
-                   'bin/*'
+                   'bin/*',
                    'config/environments/*',
                    'lib/tasks/*']
 ```
 
+### View Tracking
+
+Coverband allows an optional feature to track all view files that are used by an application.
+
+To opt-in to this feature... enable the feature in your Coverband config.
+
+`config.track_views = true`
+
+![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_view_tracker.png)
+
 ### Writing Coverband Results to S3
 
 If you add some additional Coverband configuration your coverage html report will be written directly to S3, update `config/coverband.rb` like below.
@@ -199,13 +237,21 @@ ENV['AWS_ACCESS_KEY_ID']
 ENV['AWS_SECRET_ACCESS_KEY']
 ```
 
-### Coverage Data Migration
+### Avoiding Cache Stampede
 
-Between the release of 4.0 and 4.1 our data format changed. This resets all your coverage data. If you want to restore your previous coverage data, feel free to migrate.
+If you have many servers and they all hit Redis at the same time you can see spikes in your Redis CPU, and memory. This is do to a concept called [cache stampede](https://en.wikipedia.org/wiki/Cache_stampede). It is better to spread out the reporting across your servers. A simple way to do this is to add a random wiggle on your background reporting. This configuration option allows a wiggle. The right amount of wiggle depends on the numbers of servers you have and how willing you are to have delays in your coverage reporting. I would recommend at least 1 second per server. 
 
-`rake coverband:migrate`
+Add a wiggle (in seconds) to the background thread to avoid all your servers reporting at the same time:
 
-- We will be working to support migrations going forward, when possible
+`config.reporting_wiggle = 30`
+
+### Redis Hash Store
+
+Coverband on very high volume sites with many server processes reporting can have a race condition. To resolve the race condition and reduce Ruby memory overhead we have introduced a new Redis storage option. This moves the some of the work from the Ruby processes to Redis. It is worth noting because of this, it has a larger demands on the Redis server. So adjust your Redis instance accordingly. To help reduce the extra redis load you can also change the background reporting time period. 
+
+* set the new Redis store: `config.store = Coverband::Adapters::HashRedisStore.new(Redis.new(url: redis_url))`
+* adjust from default 30s reporting `config.background_reporting_sleep_seconds = 120`
+* reminder it is recommended to have a unique Redis per workload (background jobs, caching, Coverband), for this store, it may be more important to have a dedicated Redis.
 
 ### Clear Coverage
 
@@ -213,6 +259,14 @@ Now that Coverband uses MD5 hashes there should be no reason to manually clear c
 
 `rake coverband:clear`
 
+### Coverage Data Migration
+
+Between the release of 4.0 and 4.1 our data format changed. This resets all your coverage data. If you want to restore your previous coverage data, feel free to migrate.
+
+`rake coverband:migrate`
+
+- We will be working to support migrations going forward, when possible
+
 ### Adding Rake Tasks outside of Rails
 
 Rails apps should automaticallly include the tasks via the Railtie.
@@ -233,35 +287,34 @@ rake coverband:clear         # reset coverband coverage data
 rake coverband:coverage      # report runtime coverband code coverage
 ```
 
-### Forcing Coverband to Track Coverage on files loaded during boot `safe_reload_files`
+### Collecting Gem / Library Usage
 
-Coverband will report code usage for anything `required` or `loaded` after calling `Coverband.start` which happens automatically when coverband is required. This means some of the files loaded before coverband such as the Rails application.rb will be reported as having no coverage.
+__WARNING:__ Gem Tracking is still in experimental stages and not recommended for production. We have some performance issues when view reports on large applications. Gem tracing also during background thread data collection has HIGH memory requirements, during report merging (seemingly around 128mb of extra memory, which is crazy). We recommend deploying WITHOUT `track_gems` first and only enabling it after confirming that Coverband is working and performing well.
 
-The `safe_reload_files` reload option in the configuration options can help to ensure you can track any files regardless of loading before Coverband. For example if I wanted to show the coverage of `config/coverband.rb`, which has to be loaded before calling `Coverband.start`, I could do that by adding that path to the `safe_reload_files` option.
+Gem usage can be tracked by enabling the `track_gems` config.
 
 ```
 Coverband.configure do |config|
-  # ... a bunch of other options
-  # using the new safe reload to enforce files loaded
-  config.safe_reload_files = ['config/coverband.rb']
+  config.track_gems = true
 end
 ```
 
-By adding any files above you will get reporting on those files as part of your coverage runtime report. The files are reloaded when Coverband first starts, you can also trigger a reload via the web interface.
-
-### Collecting Gem / Library Usage
+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).
 
-Gem usage can be tracked by enabling the `track_gems` config.
+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:
 
-```
-Coverband.configure do |config|
-  config.track_gems = true
-end
+```ruby
+require 'coverband'
+Bundler.require(*Rails.groups)
 ```
 
-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).
+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.
 
-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.
+```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.
 
@@ -287,33 +340,23 @@ Coverband.start
 
 ### Verbose Debug / Development Mode
 
-Note: To debug issues getting Coverband working. I recommend running in development mode, by turning verbose logging on `config.verbose = true` and passing in the Rails.logger `config.logger = Rails.logger` to the Coverband config. This makes it easy to follow in development mode. Be careful to not leave these on in production as they will affect performance.
+Note: To debug issues getting Coverband working. I recommend running in development mode, by turning verbose logging on `config.verbose = true` and passing in the Rails.logger `config.logger = Rails.logger` to the Coverband config. We respect the log level, and I would recommend log level info generally, but if you are investigating a prolbem Coverband logs additional data at the `debug` level. This makes it easy to follow in development mode. Be careful to not leave these on in production as they will affect performance.
 
 ---
 
-If you are trying to debug locally wondering what code is being run during a request. The verbose modes `config.verbose = true` and `config.verbose = 'debug'` can be useful. With true set it will output the number of lines executed per file, to the passed in log. The files are sorted from least used file to most active file. I have even run that mode in production without much of a problem. The debug verbose mode outputs both file usage and provides the number of calls per line of code. For example if you see something like below which indicates that the `application_helper` has 43150 lines executed. That might seem odd. Then looking at the breakdown of `application_helper` we can see that line `516` was executed 38,577 times. That seems bad, and is likely worth investigating perhaps memoizing or cacheing is required.
-
-    config.verbose = 'debug'
-
-    coverband file usage:
-      [["/Users/danmayer/projects/app_name/lib/facebook.rb", 6],
-      ["/Users/danmayer/projects/app_name/app/models/some_modules.rb", 9],
-      ...
-      ["/Users/danmayer/projects/app_name/app/models/user.rb", 2606],
-      ["/Users/danmayer/projects/app_name/app/helpers/application_helper.rb",
-      43150]]
-
-    file:
-      /Users/danmayer/projects/app_name/app/helpers/application_helper.rb =>
-      [[448, 1], [202, 1],
-      ...
-     [517, 1617], [516, 38577]]
+If you are trying to debug locally wondering what code is being run during a request. The verbose modes `config.verbose = true` && `Rails.logger.level = :debug`. With true set it will output the number of lines executed per file, to the passed in log.
 
 # Prerequisites
 
 - Coverband 3.0.X+ requires Ruby 2.3+
 - Coverband currently requires Redis for production usage
 
+### Ruby and Rails Version Support
+
+We will match Heroku & Ruby's support lifetime, supporting the last 3 major Ruby releases. For details see [supported runtimes](https://devcenter.heroku.com/articles/ruby-support#supported-runtimes). 
+
+For Rails, we will follow the policy of the [Rails team maintenance policy](https://guides.rubyonrails.org/maintenance_policy.html). We officially support the last two major release versions, while providing minimal support (major bugs / security fixes) for an additional version. This means at the moment we primaryly target Rails 6.x, 5.x, and will try to keep current functionality working for Rails 4.x but may release new features that do not work on that target.
+
 # Contributing To Coverband
 
 If you are working on adding features, PRs, or bugfixes to Coverband this section should help get you going.
@@ -335,12 +378,14 @@ 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
 
-- **total fail** on front end code, because of the precompiled template step basically coverage doesn't work well for `erb`, `slim`, and the like.
+- **total fail** on front end code, for line for line coverage, because of the precompiled template step basically coverage doesn't work well for `erb`, `slim`, and the like.
   - related it will try to report something, but the line numbers reported for `ERB` files are often off and aren't considered useful. I recommend filtering out .erb using the `config.ignore` option. The default configuration excludes these files
-- coverage doesn't show for Rails `config/application.rb` or `config/boot.rb` as they get loaded when loading the Rake environment prior to starting the `Coverage` library. See [reload files section](#forcing-coverband-to-track-coverage-on-files-loaded-during-boot-safe_reload_files).
+  - **NOTE:** We now have file level coverage for view files, but don't support line level detail
+  - The view file detection doesn't workf or mailers at the moment only for web related views / JSON templates. This is due to how Rails active mailer notifications work. 
 
 ### Debugging Redis Store
 
@@ -352,6 +397,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,14 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
-
 import 'test/benchmarks/benchmark.rake'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test]
 
-task default: [:test, :benchmarks]
+task 'test:all': %i[rubocop test forked_tests benchmarks:memory benchmarks]
 
 task :test
 require 'rake/testtask'
@@ -17,9 +21,16 @@ 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'
+  puts 'running console'
+  exec 'bundle console'
 end
 
 # This is really just for testing and development because without configuration
@@ -28,3 +39,8 @@ desc 'start webserver'
 task :server do
   exec 'rackup -I lib'
 end
+
+desc 'publish gem with 2 factor auth, reminder how'
+task :publish_gem do
+  exec 'gem push pkg/coverband-4.2.3.XXX.gem'
+end