coverband 4.0.1 → 4.1.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7f0d091dfa76cb111bc6e76be9f03a644c9f7c9
-  data.tar.gz: d326e418b2612a0fd5ea9d17786918d9da90a5df
+  metadata.gz: dee2efe6e6763457859da3c235858f9de0a17189
+  data.tar.gz: 441347a296e06c2189f02a26b3d966825a90e354
 SHA512:
-  metadata.gz: 55288f996b6d5bc015e368c6952daf867b5a21fa0f5a09fdd7bfad3f19f0b11c6e12ca912e6121e315b23a15ca1ac03629552811874f8176ee882b91aafed967
-  data.tar.gz: 37fc422e6b917dacbede5a143bc2504f1da47dbf528e3164e91661545aa2bccd1c70332a2e8783414986c5bbd89925804c28961f20f321bf0073d034c9f56eaa
+  metadata.gz: b9c5b36fbb46b80da1bb4ca4a098d12dbfec941059a1b7eb297d1d77f065674183df7cd115ac965289db3751f2f9595abfe81e947771c6fc4b5a9155726c8c1b
+  data.tar.gz: 68e90213cc0af16924c4e681b59e6ac8d77463921ec7ba019ac8b4bc3579805e62a0ad10e51a793a18b3bd037af09a9e13bfb9e245d8a5e9b309b2960d8a70bd

data/.travis.yml

@@ -10,4 +10,8 @@ gemfile:
 services:
   - redis-server
 before_install:
-  - gem install bundler
+  - echo 'this is a hack to clear default bundler and force bundler 1.17.3'
+  - rm /home/travis/.rvm/gems/ruby-2.3.7@global/specifications/bundler-2.0.1.gemspec || true
+  - gem uninstall bundler || true
+  - gem install bundler -v '1.17.3'
+  - bundler --version

data/README.md

@@ -6,9 +6,9 @@
 <p align="center">
   <a href="#key-features">Key Features</a> •
   <a href="#installation">Installation</a> •
-  <a href="#configuration">Configuration</a> •
-  <a href="#coverband-demo">Coverband Demo</a> •
-  <a href="#how-to-use">How To Use</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>
 </p>
@@ -28,10 +28,15 @@ The primary goal of Coverband is giving deep insight into your production runtim
 * 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
 
-
 # Installation
 
-Coverband should be near zero config for Rails apps, if you have an issue with that, please [file an issue](https://github.com/danmayer/coverband/issues).
+## Redis
+
+Coverband stores coverage data in Redis. The Redis endpoint is looked for in this order: 
+
+1. `ENV['COVERBAND_REDIS_URL']`
+2. `ENV['REDIS_URL']`
+3. `localhost`
 
 ## Gem Installation
 
@@ -43,10 +48,8 @@ gem 'coverband'
 
 ## Rails
 
-The Railtie integration means you shouldn't need to do anything anything else.
+The Railtie integration means you shouldn't need to do anything anything else. If you have an issue with that, please [file an issue](https://github.com/danmayer/coverband/issues).
 
-* By default Coverband will try to stored data to Redis
-	* Redis endpoint is looked for in this order: `ENV['COVERBAND_REDIS_URL']`, `ENV['REDIS_URL']`, or `localhost`
 
 ## Sinatra
 
@@ -60,65 +63,54 @@ use Coverband::Middleware
 run ActionController::Dispatcher.new
 ```
 
-# Report Generation
+# Coverage Report
 
-There are two primary ways to generate and view the report
+Coverband comes with a mountable rack app for viewing reports. For Rails this can be done in `config/routes.rb` with:
 
-## Rake Tasks
+```ruby
+Rails.application.routes.draw do
+  mount Coverband::Reporters::Web.new, at: '/coverage'
+end
+```
 
-After installing the gem in Rails you should have these Rake tasks
+But don't forget to *protect your source code with proper authentication*. Something like this when using devise:
 
-```bash
-rake -T coverband
-rake coverband:coverage      # report runtime Coverband code coverage
-rake coverband:clear         # reset Coverband coverage data, helpful for development, debugging, etc
+```ruby
+Rails.application.routes.draw do
+  authenticate :user, lambda { |u| u.admin? } do
+    mount Coverband::Reporters::Web.new, at: '/coverage'
+  end
+end
 ```
 
-You can view the report different ways, but the easiest is the Rake task which opens the SimpleCov formatted HTML.
-
-`rake coverband:coverage`
+### Coverband Web Endpoint
 
-This should auto-open in your browser, but if it doesn't the output file should be in `coverage/index.html`
+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.
 
-## Viewing the Report in App
+![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_web_update.png)
+> The web index as available on the Coverband Demo site
 
-First setup Coverband to [write reports to S3](#writing-coverband-results-to-s3) you can host the S3 file with a built in rack app in Coverband. Just configure your Rails route `config/routes.rb`
+* __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__)
 
-```
-Rails.application.routes.draw do
-  # ... lots of routes
-  mount Coverband::Reporters::Web.new, at: '/coverage'
-end
-```
+### Rake Tasks
 
-__NOTE__: ADD PASSWORD PROTECTION OR YOU CAN EXPOSE ALL YOUR SOURCE CODE
+The rake task generates a report locally and opens a browser pointing to `coverage/index.html`.
 
-It is easy to add basic protection around the coverage data, below shows how you can use devise or basic auth, by adding a bit of code to your `config/routes.rb` file.
+`rake coverband:coverage`
 
-```
-# protect with existing Rails devise configuration
-devise_constraint = lambda do |request|
-  request.env['warden'] && request.env['warden'].authenticate? && request.env['warden'].user.admin?
-end
+This is mostly useful in your local development environment.
 
-# protect with http basic auth
-# curl --user foo:bar http://localhost:3000/coverage
-Rails.application.routes.draw do
-  # ... lots of routes
+##### Example Output
 
-  # Create a Rack wrapper around the Coverband Web Reporter to support & prompt the user for basic authentication.
-  AuthenticatedCoverband = Rack::Builder.new do 
-    use Rack::Auth::Basic do |username, password|
-      username == 'foo' && password == 'bar'
-    end
+Since Coverband is [Simplecov](https://github.com/colszowka/simplecov) output compatible it should work with any of the `SimpleCov::Formatter`'s available. The output below is produced using the default Simplecov HTML formatter.
 
-    run Coverband::Reporters::Web.new 
-  end
+Index Page
+![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_index.png)
 
-  # Connect the wrapper app to your desired endpoint.
-  mount AuthenticatedCoverband, at: '/coverage'
-end
-```
+Details on an example Sinatra app
+![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_details.png)
 
 # Verify Correct Installation
 
@@ -132,57 +124,19 @@ end
 
 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.
 
-# How To Use
-
-Below is my Coverband workflow, which hopefully will help other best use this library.
-
-* <a href="#installation">Install Coverband</a>
-* Start your app and hit a few endpoints
-* Validate data collection and code coverage with  `rake coverband:coverage`
-* If you see app startup and recent visits showing, setup is correct
-* I generally configure the mountable web endpoint to [view the data via the web-app](https://github.com/danmayer/coverband#viewing--hosting-s3-coverband-results-in-app)
-* After Coverband has been verified to be working on production, I let it run for a few weeks.
-* Then I view the report and start submitting PRs for the team to review delete large related sets of code that no longer are in use.
-
-### 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.png)
-> The web index as available on the Coverband Demo site
-
-* __collect data, update report, & view:__ This does everything need to view up to date Coverage 
-   * it triggers a coverage collection on the current webserver process
-   * it generates a new html coverage report and pushes it to S3
-   * it then loads that report for you to view
-* __view coverage report:__ Don't need to update the data just view the current report
-* __update coverage data (collect coverage):__ This triggers coverage collection on the current webserver process
-* __update coverage report (rebuild report):__ This will rebuild the HTML report from the latest available data
-* __clear coverage report:__ This will clear the coverage data. This wipes out all collected data (__dangerous__)
-* __reload Coverband files:__ This has Coverband reload files as configured (force reload of some files that might not capture Coverage on boot)
 
 ### Example apps
 
-- [Rails 5.2.x App](https://github.com/danmayer/coverage_demo)
+- [Rails 5.2.x App](https://github.com/danmayer/coverband_demo)
 - [Sinatra app](https://github.com/danmayer/churn-site)
 - [Non Rack Ruby app](https://github.com/danmayer/coverband_examples)
 
-### Example Output
-
-Since Coverband is [Simplecov](https://github.com/colszowka/simplecov) output compatible it should work with any of the `SimpleCov::Formatter`'s available. The output below is produced using the default Simplecov HTML formatter.
+# Advanced Config
 
-Index Page
-![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_index.png)
-
-Details on a example Sinatra app
-![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_details.png)
 
-### Advanced Coverband Config
-
-You may need to configure Coverband you can either do that passing in all configuration options to `Coverband.configure` in block format, or a simpler style is to call `Coverband.configure` with no params which will load `config/coverband.rb` expecting it to configure the app correctly.
+If you need to configure coverband, this can be done by creating a `config/coverband.rb` file relative to your project root.
 
 * See [lib/coverband/configuration.rb](https://github.com/danmayer/coverband/blob/master/lib/coverband/configuration.rb) for all options
-* I strongly recommend setting up the S3 report adapter, which can't be automatically configured
 * By default Coverband will try to stored data to Redis
 	* Redis endpoint is looked for in this order: `ENV['COVERBAND_REDIS_URL']`, `ENV['REDIS_URL']`, or `localhost`
 
@@ -191,6 +145,8 @@ You may need to configure Coverband you can either do that passing in all config
 ```ruby
 #config/coverband.rb
 Coverband.configure do |config|
+  config.store = Coverband::Adapters::RedisStore.new(Redis.new(url: ENV['MY_REDIS_URL']))
+  config.logger = Rails.logger
   # configure S3 integration
   config.s3_bucket = 'coverband-demo'
   config.s3_region = 'us-east-1'
@@ -205,6 +161,22 @@ Coverband.configure do |config|
 end
 ```
 
+### 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.
+
+```
+config.ignore =	['config/application.rb',
+                   'config/boot.rb',
+                   'config/puma.rb',
+                   'config/schedule.rb',
+                   'config/environments/test.rb',
+                   'config/environments/development.rb',
+                   'config/environments/staging.rb',
+                   'config/environments/production.rb',
+                   'lib/tasks/*']
+```
+
 ### 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.
@@ -228,7 +200,7 @@ ENV['AWS_SECRET_ACCESS_KEY']
 
 ### Clear Coverage
 
-Now that Coverband uses MD5 hashes there should be no reason to manually clear coverage unless one is testing, changing versions, possibly debugging Coberband itself.
+Now that Coverband uses MD5 hashes there should be no reason to manually clear coverage unless one is testing, changing versions, possibly debugging Coverband itself.
 
 `rake coverband:clear`
 
@@ -254,9 +226,9 @@ rake coverband:coverage      # report runtime coverband code coverage
 
 ### Forcing Coverband to Track Coverage on files loaded during boot `safe_reload_files`
 
-The way Coverband is built it will record and report code usage in production for anything `required` or `loaded` after calling `Coverband.start`. This means some of Rails initial files and Gems are loaded before you can generally call `Coverband.start` for example if you use the `application.rb` to initialize and start Coverband, that file will be reported as having no coverage, as it can't possibly start Coverband before the file is loaded. 
+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.
 
-The `safe_reload_files` reload option in the configuration options can help to ensure you can track any files you want regardless of them 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.
+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.
 
 ```
 Coverband.configure do |config|
@@ -265,12 +237,12 @@ Coverband.configure do |config|
   config.safe_reload_files = ['config/coverband.rb']
 end
 ```
-By adding any files above you will get reporting on those files as part of your coverage runtime report.
+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
 
-By default Coverband has assumed you are trying to track your application code usage not all the supporting framework and library (Gems) code usage. There has been some good points and reasons folks want to track library usage, for example to find out which Gems they aren't actually using in production. See some of the discussion on [issue 21](https://github.com/danmayer/coverband/issues/21).
+By default Coverband has assumed you are trying to track your application code usage and not all the supporting framework and library (Gems) code usage. There are reasons to track library usage though such as finding out which Gems aren't actually being used within production. See some of the discussion on [issue 21](https://github.com/danmayer/coverband/issues/21).
 
 How to collect gem usage with Coverband:
 
@@ -305,31 +277,6 @@ If you are trying to debug locally wondering what code is being run during a req
       ...
      [517, 1617], [516, 38577]]
 
-
-### Conflicting .Simplecov: Issue with Missing or 0% Coverage Report
-
-If you use SimpleCov to generate code coverage for your tests. You might have setup a `.simplecov` file to help control and focus it's output. Often the settings you want for your test's code coverage report are different than what you want Coverband to be reporting on. Since Coverband uses the SimpleCov HTML formatter to prepare it's report.
-
-So if you had something like this in a `.simplecov` file in the root of your project, as reported in [issue 83](https://github.com/danmayer/coverband/issues/83)
-
-```
-require 'simplecov'
-
-SimpleCov.start do
-  add_filter 'app/admin'
-  add_filter '/spec/'
-  add_filter '/config/'
-  add_filter '/vendor/'
-  add_filter 'userevents'
-end
-```
-
-You could see some confusing results... To avoid this issue Coverband has a Rake task that will ignore all Simplecov filters.
-
-`rake coverband:coverage_no_filters`
-
-This will build the report after disabling any `.simplecov` applied settings.
-
 # Prerequisites
 
 * Coverband 3.0.X+ requires Ruby 2.3+
@@ -361,8 +308,7 @@ If you submit a change please make sure the tests and benchmarks are passing.
 
 * __total fail__ on front end code, 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
-* If you have SimpleCov filters, you need to clear them prior to generating your coverage report. As the filters will be applied to Coverband as well and can often filter out everything we are recording.
-* 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.
+* 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).
 
 ### Debugging Redis Store
 

data/changes.md

@@ -24,7 +24,6 @@ Will be the fully modern release that drops maintenance legacy support in favor
   - add coverage timerange support
 - Drop Simplecov dependency
 - improved web reporting
-  - no longer relying directly on HTML in S3 but dynamically generated from any adapter
   - lists current config options
   - eventually allow updating remote config
   - full theming
@@ -32,7 +31,6 @@ Will be the fully modern release that drops maintenance legacy support in favor
 - additional adapters: Memcache, S3, and ActiveRecord
 - add articles / podcasts like prontos readme https://github.com/prontolabs/pronto
 - Add detailed Gem usage report, if we collect and send gem usage we can give percentage of gem code used, which should help application developers know when to remove gem dependencies (0%) or perhaps inline single methods for little usage (using <= 5%) for example.
-- add additional config / protection options on Coverage clear
 - add meta data information first seen last recorded to the coverage report views (probably need to drop simplecov for that).
   - more details in this issue: https://github.com/danmayer/coverband/issues/118
 - Make good video on setup, install, usage
@@ -66,7 +64,7 @@ Feature Ideas:
 
 ### Coverband 4.0.2.alpha
 
-- ?
+- default disabled web clear, add config option to allow it
 
 # Released
 

data/coverband.gemspec

@@ -24,7 +24,6 @@ Gem::Specification.new do |spec|
   # to test sdk 2 use this one
   spec.add_development_dependency 'aws-sdk-s3', '~> 1'
   spec.add_development_dependency 'benchmark-ips'
-  spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'capybara'
   spec.add_development_dependency 'm'
   spec.add_development_dependency 'memory_profiler'
@@ -33,8 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rack'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'simplecov'
-
+  spec.add_development_dependency 'resque'
 
   # TODO: used for benchmarking and tests I think we have other better benchmarking
   # perhaps time to drop this and refactor.

data/lib/coverband.rb

@@ -5,6 +5,7 @@ require 'json'
 require 'redis'
 
 require 'coverband/version'
+require 'coverband/at_exit'
 require 'coverband/configuration'
 require 'coverband/adapters/base'
 require 'coverband/adapters/redis_store'
@@ -25,6 +26,7 @@ require 'coverband/integrations/rack_server_check'
 require 'coverband/reporters/web'
 require 'coverband/integrations/middleware'
 require 'coverband/integrations/background'
+require 'coverband/integrations/resque' if defined? Resque
 
 module Coverband
   CONFIG_FILE = './config/coverband.rb'
@@ -51,6 +53,7 @@ module Coverband
 
   def self.start
     Coverband::Collectors::Coverage.instance
+    AtExit.register
     Background.start if configuration.background_reporting_enabled && !RackServerCheck.running?
   end
 

data/lib/coverband/adapters/redis_store.rb

@@ -6,7 +6,12 @@ module Coverband
     # RedisStore store a merged coverage file to redis
     ###
     class RedisStore < Base
-      BASE_KEY = 'coverband3_1'
+      ###
+      # This key isn't related to the coverband version, but to the interal format
+      # used to store data to redis. It is changed only when breaking changes to our
+      # redis format are required.
+      ###
+      REDIS_STORAGE_FORMAT_VERSION = 'coverband3_1'
 
       def initialize(redis, opts = {})
         super()
@@ -24,7 +29,7 @@ module Coverband
       attr_reader :redis
 
       def base_key
-        @base_key ||= [BASE_KEY, @redis_namespace].compact.join('.')
+        @base_key ||= [REDIS_STORAGE_FORMAT_VERSION, @redis_namespace].compact.join('.')
       end
 
       def save_coverage(data)

data/lib/coverband/at_exit.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Coverband
+  class AtExit
+    @semaphore = Mutex.new
+
+    def self.register
+      return if @at_exit_registered
+      @semaphore.synchronize do
+        return if @at_exit_registered
+        @at_exit_registered = true
+        at_exit do
+          ::Coverband::Background.stop
+          Coverband::Collectors::Coverage.instance.report_coverage(true)
+          Coverband.configuration.logger&.debug('Coverband: Reported coverage before exit')
+        end
+      end
+    end
+  end
+end

data/lib/coverband/configuration.rb

@@ -7,7 +7,8 @@ module Coverband
                   :reporter, :reporting_frequency,
                   :redis_namespace, :redis_ttl,
                   :safe_reload_files, :background_reporting_enabled,
-                  :background_reporting_sleep_seconds, :test_env
+                  :background_reporting_sleep_seconds, :test_env,
+                  :web_enable_clear
 
     attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id, :s3_secret_access_key
 
@@ -28,6 +29,7 @@ module Coverband
       @background_reporting_enabled = true
       @background_reporting_sleep_seconds = 30
       @test_env = nil
+      @web_enable_clear = false
 
       # TODO: should we push these to adapter configs
       @s3_region = nil

data/lib/coverband/integrations/background.rb

@@ -18,7 +18,6 @@ module Coverband
 
       logger = Coverband.configuration.logger
       @semaphore.synchronize do
-        binding.pry if defined?($debug) && $debug
         return if @thread
         logger&.debug('Coverband: Starting background reporting')
         sleep_seconds = Coverband.configuration.background_reporting_sleep_seconds
@@ -29,12 +28,6 @@ module Coverband
             sleep(sleep_seconds)
           end
         end
-        binding.pry if defined?($debug) && $debug
-      end
-      at_exit do
-        stop
-        Coverband::Collectors::Coverage.instance.report_coverage(true)
-        logger&.debug('Coverband: Reported coverage before exit')
       end
     end
   end

data/lib/coverband/integrations/middleware.rb

@@ -9,10 +9,11 @@ module Coverband
     def call(env)
       @app.call(env)
     ensure
+      AtExit.register
       if Coverband.configuration.background_reporting_enabled
-        Coverband::Background.start
+        Background.start
       else
-        Coverband::Collectors::Coverage.instance.report_coverage
+        Collectors::Coverage.instance.report_coverage
       end
     end
   end

data/lib/coverband/integrations/resque.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+Resque.after_fork do |job|
+  Coverband.start
+end
+
+module Coverband
+  module ResqueWorker
+    def perform
+      super
+    ensure
+      Coverband::Collectors::Coverage.instance.report_coverage(true)
+    end
+  end
+end
+
+Resque::Job.prepend(Coverband::ResqueWorker)
+

data/lib/coverband/reporters/web.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-require 'rack'
+begin
+  require 'rack'
+rescue LoadError
+end
 
 module Coverband
   module Reporters
@@ -32,7 +35,7 @@ module Coverband
           case request.path_info
           when /.*\.(css|js|gif|png)/
             @static.call(env)
-          when %r{\/}
+          when %r{\/$}
             [200, { 'Content-Type' => 'text/html' }, [index]]
           else
             [404, { 'Content-Type' => 'text/html' }, ['404 error!']]
@@ -57,8 +60,12 @@ module Coverband
       end
 
       def clear
-        Coverband.configuration.store.clear!
-        notice = 'coverband coverage cleared'
+        if Coverband.configuration.web_enable_clear
+          Coverband.configuration.store.clear!
+          notice = 'coverband coverage cleared'
+        else
+          notice = 'web_enable_clear isnt enabled in your configuration'
+        end
         [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
       end
 

data/lib/coverband/utils/html_formatter.rb

@@ -56,7 +56,7 @@ module Coverband
 
       def asset_output_path
         return @asset_output_path if defined?(@asset_output_path) && @asset_output_path
-        @asset_output_path = File.join(output_path, 'assets', Coverband::VERSION)
+        @asset_output_path = File.join(output_path)
         FileUtils.mkdir_p(@asset_output_path)
         @asset_output_path
       end
@@ -123,8 +123,10 @@ module Coverband
         "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>"
       end
 
+      # a bug that existed in simplecov was not checking that root was at the start of the file name
+      # I had previously patched this in my local Rails app
       def shortened_filename(source_file)
-        source_file.filename.sub(Coverband.configuration.root, '.').gsub(/^\.\//, '')
+        source_file.filename.sub(%r{^#{Coverband.configuration.root}}, '.').gsub(/^\.\//, '')
       end
 
       def link_to_source_file(source_file)

data/lib/coverband/utils/tasks.rb

@@ -3,27 +3,17 @@
 namespace :coverband do
   Coverband.configure
 
-  ###
-  # NOTE: If your project has set many simplecov filters.
-  # You might want to override them and clear the filters.
-  # Or run the task `coverage_no_filters` below.
-  ###
-  desc 'report runtime Coverband code coverage'
-  task coverage: :environment do
-    if Coverband.configuration.reporter == 'scov'
-      Coverband::Reporters::HTMLReport.report(Coverband.configuration.store)
-    else
-      Coverband::Reporters::ConsoleReport.report(Coverband.configuration.store)
-    end
+  def environment
+    Rake.application['environment'].invoke if Rake::Task.task_defined?('environment')
   end
 
-  desc 'report runtime coverband code coverage after disabling simplecov filters'
-  task coverage_no_filters: :environment do
+  desc 'report runtime Coverband code coverage'
+  task :coverage do
+    environment
     if Coverband.configuration.reporter == 'scov'
-      clear_simplecov_filters
       Coverband::Reporters::HTMLReport.report(Coverband.configuration.store)
     else
-      puts 'coverage without filters only makes sense for SimpleCov reports'
+      Coverband::Reporters::ConsoleReport.report(Coverband.configuration.store)
     end
   end
 
@@ -31,7 +21,8 @@ namespace :coverband do
   # clear data helpful for development or after configuration issues
   ###
   desc 'reset Coverband coverage data, helpful for development, debugging, etc'
-  task clear: :environment do
+  task :clear do
+    environment
     Coverband.configuration.store.clear!
   end
 end

data/lib/coverband/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coverband
-  VERSION = '4.0.1'
+  VERSION = '4.1.0.alpha'
 end

data/test/test_helper.rb

@@ -14,17 +14,12 @@ require 'mocha/minitest'
 require 'ostruct'
 require 'json'
 require 'redis'
+require 'resque'
 require 'pry-byebug'
 $VERBOSE = original_verbosity
 
 Coveralls.wear!
 
-SimpleCov.start do
-  add_filter 'specs/ruby/1.9.1/gems/'
-  add_filter '/test/'
-  add_filter '/config/'
-end
-
 module Coverband
   module Test
     def self.reset

data/test/unit/adapters_redis_store_test.rb

@@ -3,7 +3,7 @@
 require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class RedisTest < Minitest::Test
-  BASE_KEY = Coverband::Adapters::RedisStore::BASE_KEY
+  REDIS_STORAGE_FORMAT_VERSION = Coverband::Adapters::RedisStore::REDIS_STORAGE_FORMAT_VERSION
 
   def setup
     super
@@ -46,7 +46,7 @@ class RedisTest < Minitest::Test
   end
 
   def test_clear
-    @redis.expects(:del).with(BASE_KEY).once
+    @redis.expects(:del).with(REDIS_STORAGE_FORMAT_VERSION).once
     @store.clear!
   end
 

data/test/unit/at_exit_test.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class AtExitTest < Minitest::Test
+  test 'only registers once' do
+    Coverband::AtExit.instance_eval { @at_exit_registered = nil }
+    Coverband::AtExit.expects(:at_exit).yields.once.returns(true)
+    2.times { Coverband::AtExit.register }
+  end
+end
+
+

data/test/unit/background_test.rb

@@ -22,7 +22,6 @@ class BackgroundTest < Minitest::Test
     Thread.expects(:new).yields.returns(ThreadDouble.new)
     Coverband::Background.expects(:loop).yields
     Coverband::Background.expects(:sleep).with(30)
-    Coverband::Background.expects(:at_exit).returns(false)
     Coverband::Collectors::Coverage.instance.expects(:report_coverage).once
     2.times { Coverband::Background.start }
   end

data/test/unit/configuration_test.rb

@@ -20,4 +20,27 @@ class BaseTest < Minitest::Test
     coverband = Coverband::Collectors::Coverage.instance.reset_instance
     assert_equal ['vendor', 'internal:prelude', 'schema.rb'], coverband.instance_variable_get('@ignore_patterns')
   end
+
+  test 's3 options' do
+    Coverband::Collectors::Coverage.instance.reset_instance
+    Coverband.configure do |config|
+      config.s3_bucket = 'bucket'
+      config.s3_region = 'region'
+      config.s3_access_key_id = 'key_id'
+      config.s3_secret_access_key = 'secret'
+    end
+    assert_equal 'bucket', Coverband.configuration.s3_bucket
+    assert_equal 'region', Coverband.configuration.s3_region
+    assert_equal 'key_id', Coverband.configuration.s3_access_key_id
+    assert_equal 'secret', Coverband.configuration.s3_secret_access_key
+  end
+
+  test 'store raises issues' do
+    Coverband::Collectors::Coverage.instance.reset_instance
+    assert_raises RuntimeError do
+      Coverband.configure do |config|
+        config.store = 'fake'
+      end
+    end
+  end
 end

data/test/unit/full_stack_test.rb

@@ -4,10 +4,11 @@ require File.expand_path('../test_helper', File.dirname(__FILE__))
 require 'rack'
 
 class FullStackTest < Minitest::Test
-  BASE_KEY = Coverband::Adapters::RedisStore::BASE_KEY
+  REDIS_STORAGE_FORMAT_VERSION = Coverband::Adapters::RedisStore::REDIS_STORAGE_FORMAT_VERSION
   TEST_RACK_APP = '../fake_app/basic_rack.rb'
 
   def setup
+    super
     Coverband::Collectors::Coverage.instance.reset_instance
     Coverband.configure do |config|
       config.reporting_frequency = 100.0
@@ -35,11 +36,6 @@ class FullStackTest < Minitest::Test
     sleep(0.1)
     expected = [nil, nil, 1, nil, 1, 1, 2, nil, nil]
     assert_equal expected, Coverband.configuration.store.coverage[@rack_file]['data']
-
-    # expected = nil
-    # TODO: read the html to test it matches expectations? or return data as a hash?
-    # actual = Coverband::Reporters::HTMLReport.report(Coverband.configuration.store, open_report: false)
-    # assert_equal expected, actual
   end
 
   private

data/test/unit/middleware_test.rb

@@ -4,7 +4,7 @@ require File.expand_path('../test_helper', File.dirname(__FILE__))
 require 'rack'
 
 class MiddlewareTest < Minitest::Test
-  BASE_KEY = Coverband::Adapters::RedisStore::BASE_KEY
+  REDIS_STORAGE_FORMAT_VERSION = Coverband::Adapters::RedisStore::REDIS_STORAGE_FORMAT_VERSION
 
   def setup
     super

data/test/unit/reports_console_test.rb

@@ -3,7 +3,7 @@
 require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class HTMLReportTest < Minitest::Test
-  BASE_KEY = Coverband::Adapters::RedisStore::BASE_KEY
+  REDIS_STORAGE_FORMAT_VERSION = Coverband::Adapters::RedisStore::REDIS_STORAGE_FORMAT_VERSION
 
   def setup
     super

data/test/unit/reports_html_test.rb

@@ -3,7 +3,7 @@
 require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class ReportHTMLTest < Minitest::Test
-  BASE_KEY = Coverband::Adapters::RedisStore::BASE_KEY
+  REDIS_STORAGE_FORMAT_VERSION = Coverband::Adapters::RedisStore::REDIS_STORAGE_FORMAT_VERSION
 
   def setup
     super
@@ -12,7 +12,7 @@ class ReportHTMLTest < Minitest::Test
     @store.clear!
   end
 
-  test 'generate scov report' do
+  test 'generate scov html report' do
     Coverband.configure do |config|
       config.reporter          = 'scov'
       config.store             = @store
@@ -23,7 +23,24 @@ class ReportHTMLTest < Minitest::Test
     @store.send(:save_report, basic_coverage)
 
     html = Coverband::Reporters::HTMLReport.report(@store,
-                                                       html: true, open_report: false)
+                                                   html: true,
+                                                   open_report: false)
     assert_match 'Generated by', html
   end
+
+  test 'generate scov report file' do
+    Coverband.configure do |config|
+      config.reporter          = 'scov'
+      config.store             = @store
+      config.s3_bucket         = nil
+      config.ignore            = ['notsomething.rb']
+    end
+    mock_file_hash
+    @store.send(:save_report, basic_coverage)
+
+    Coverband::Utils::HTMLFormatter.any_instance.expects(:format!).once
+    Coverband::Reporters::HTMLReport.report(@store,
+                                            html: false,
+                                            open_report: false)
+  end
 end

data/test/unit/reports_web_test.rb

@@ -21,18 +21,31 @@ if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.2.0')
         Coverband.configuration.s3_bucket = nil
       end
 
-      # TODO: add tests for all endpoints
       test 'renders index content' do
         get '/'
         assert last_response.ok?
         assert_match 'Coverband Admin', last_response.body
       end
 
-      test 'renders show content' do
-        Coverband::Reporters::HTMLReport.expects(:report).returns('content')
+      test 'renders 404' do
         get '/show'
-        assert last_response.ok?
-        assert_equal 'content', last_response.body
+        assert last_response.not_found?
+        assert_equal '404 error!', last_response.body
+      end
+
+      test 'clears coverband' do
+        post '/clear'
+        assert_equal 301, last_response.status
+      end
+
+      test 'collect_coverage' do
+        post '/collect_coverage'
+        assert_equal 301, last_response.status
+      end
+
+      test 'reload_files' do
+        post '/reload_files'
+        assert_equal 301, last_response.status
       end
     end
   end

data/test/unit/resque_worker_test.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class ResqueWorkerTest < Minitest::Test
+  def enqueue_and_run_job
+    Resque.enqueue(TestResqueJob)
+    queue = ENV['QUEUE'] ='resque_coverband'
+    Resque::Worker.new.work_one_job
+  end
+
+  def setup
+    super
+    Coverband.configure do |config|
+      config.background_reporting_enabled = false
+    end
+    Coverband.start
+    redis = Coverband.configuration.store.send(:redis)
+    Resque.redis = redis
+  end
+
+  test 'resque job coverage' do
+    resque_job_file = File.expand_path('./test_resque_job.rb', File.dirname(__FILE__))
+    require resque_job_file
+
+    #report after loading the file in parent process
+    Coverband::Collectors::Coverage.instance.report_coverage(true)
+
+    enqueue_and_run_job
+
+    puts "assert_equal 1, Coverband.configuration.store.coverage['#{resque_job_file}']['data'][4]"
+    assert_equal 1, Coverband.configuration.store.coverage[resque_job_file]['data'][4]
+  end
+end
+

data/test/unit/test_resque_job.rb

@@ -0,0 +1,7 @@
+class TestResqueJob
+  @queue = :resque_coverband
+
+  def self.perform
+    "resque job perform"
+  end
+end

data/views/layout.erb

@@ -18,7 +18,9 @@
         <a href='<%= base_path %>'>Coverband Admin</a> &nbsp;
         <%= button("#{base_path}collect_coverage", 'force coverage collection') %> &nbsp;
         <%= button("#{base_path}reload_files", 'reload Coverband files') %> &nbsp;
-        <%= button("#{base_path}clear", 'clear coverage report', delete: true) %>
+        <% if Coverband.configuration.web_enable_clear %>
+          <%= button("#{base_path}clear", 'clear coverage report', delete: true) %>
+        <% end %>
       </div>
       <% if notice.to_s.length > 0 %>
       <div class="notice"><%= notice %></div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0.alpha
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-30 00:00:00.000000000 Z
+date: 2019-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -39,20 +39,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +152,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: resque
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -258,11 +244,13 @@ files:
 - lib/coverband/adapters/base.rb
 - lib/coverband/adapters/file_store.rb
 - lib/coverband/adapters/redis_store.rb
+- lib/coverband/at_exit.rb
 - lib/coverband/collectors/coverage.rb
 - lib/coverband/configuration.rb
 - lib/coverband/integrations/background.rb
 - lib/coverband/integrations/middleware.rb
 - lib/coverband/integrations/rack_server_check.rb
+- lib/coverband/integrations/resque.rb
 - lib/coverband/reporters/base.rb
 - lib/coverband/reporters/console_report.rb
 - lib/coverband/reporters/html_report.rb
@@ -331,6 +319,7 @@ files:
 - test/unit/adapters_base_test.rb
 - test/unit/adapters_file_store_test.rb
 - test/unit/adapters_redis_store_test.rb
+- test/unit/at_exit_test.rb
 - test/unit/background_test.rb
 - test/unit/collectors_coverage_test.rb
 - test/unit/configuration_test.rb
@@ -344,6 +333,8 @@ files:
 - test/unit/reports_console_test.rb
 - test/unit/reports_html_test.rb
 - test/unit/reports_web_test.rb
+- test/unit/resque_worker_test.rb
+- test/unit/test_resque_job.rb
 - test/unit/utils/file_list_test.rb
 - test/unit/utils/lines_classifier_test.rb
 - test/unit/utils/result_test.rb
@@ -368,12 +359,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Rack middleware to help measure production code usage (LOC runtime usage)
@@ -409,6 +400,7 @@ test_files:
 - test/unit/adapters_base_test.rb
 - test/unit/adapters_file_store_test.rb
 - test/unit/adapters_redis_store_test.rb
+- test/unit/at_exit_test.rb
 - test/unit/background_test.rb
 - test/unit/collectors_coverage_test.rb
 - test/unit/configuration_test.rb
@@ -422,6 +414,8 @@ test_files:
 - test/unit/reports_console_test.rb
 - test/unit/reports_html_test.rb
 - test/unit/reports_web_test.rb
+- test/unit/resque_worker_test.rb
+- test/unit/test_resque_job.rb
 - test/unit/utils/file_list_test.rb
 - test/unit/utils/lines_classifier_test.rb
 - test/unit/utils/result_test.rb