coverband 4.2.0.rc1 → 4.2.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6f8d36b44cdc8402a49224920afd6c7a896a88a06ca81d7237566dc3784283a
-  data.tar.gz: 5968d46ebf2badb624044a0af99ac13b3d1cf4f9aa390786da7cc52debc4fe57
+  metadata.gz: 48eecf1954fc57c470fec896c9196df70d44f5ed1fba84b57aa1fff41e97eb16
+  data.tar.gz: 1c4800d304c3c6746a6950d9a5ec7fedbf30540a657e0e645c22278804b38f8d
 SHA512:
-  metadata.gz: 8b16934f2a74fb43a2868648cc2008100a8abb7c099f087b6b3eb28fd5e9acc2aa697b8c38189e1a510efbcbc363eefb72582d70ad095c451399735299ebbf31
-  data.tar.gz: c8bdb22ed7aab4f36e3daee17ee4f070e3e529c3ce47689e9c14ef4b7499e8d3cad53140dee308b235deb5666ab13f9cc1a493fca0f93dd612374831c19ab308
+  metadata.gz: 5e71b1ebf042e029813e720a81d99ffe436fb9bc96fe1c11c650871e5ae110bb38e35aba37a430d356cec5c16dbd28cd9c73ef212b0cddc7d175f4211d067d6d
+  data.tar.gz: 32af9fc06b8c73d3900b0d12d19a0d4fac99875cc08fd65e73c395df6e0529d1d34dc5db2486d507b9f2db847a7e395d406ade4fa61347518b4e4f6e27b539e6

data/.gitignore

@@ -16,7 +16,10 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
-tmp
+/tmp/
+temp_results
 .byebug_history
 .env
 log/
+test/unique_files
+test/rails5_dummy/tmp

data/.travis.yml

@@ -3,7 +3,7 @@ rvm:
   - "2.3"
   - "2.4"
   - "2.5"
-  - "2.6"
+  - "2.6.1"
 gemfile:
   - Gemfile
   - Gemfile.rails4
@@ -11,7 +11,9 @@ 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
+  - bundler --version

data/README.md

@@ -15,24 +15,24 @@
 
 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.
 
-__Note:__ Coverband is not intended for test code coverage, for that we recommended using [SimpleCov](https://github.com/colszowka/simplecov).
+**Note:** Coverband is not intended for test code coverage, for that we recommended using [SimpleCov](https://github.com/colszowka/simplecov).
 
 ## Key Features
 
 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
-* Out of the box support for all standard code execution paths (web, cron, background jobs, rake tasks, etc)
-* Easy to understand actionable insights from the report
-* 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
+- Low performance overhead
+- Very simple setup and configuration
+- Out of the box support for all standard code execution paths (web, cron, background jobs, rake tasks, etc)
+- Easy to understand actionable insights from the report
+- 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
 
 ## Redis
 
-Coverband stores coverage data in Redis. The Redis endpoint is looked for in this order: 
+Coverband stores coverage data in Redis. The Redis endpoint is looked for in this order:
 
 1. `ENV['COVERBAND_REDIS_URL']`
 2. `ENV['REDIS_URL']`
@@ -54,7 +54,6 @@ If [tracking gem usage](#collecting-gem--library-usage), be sure to include cove
 
 The Railtie integration means you shouldn't need to do anything anything else other than ensure coverband is required after rails within your Gemfile.
 
-
 ## Sinatra
 
 For the best coverage you want this loaded as early as possible. I have been putting it directly in my `config.ru` but you could use an initializer, though you may end up missing some boot up coverage. To start collection require Coverband as early as possible.
@@ -77,7 +76,7 @@ Rails.application.routes.draw do
 end
 ```
 
-But don't forget to *protect your source code with proper authentication*. Something like this when using devise:
+But don't forget to _protect your source code with proper authentication_. Something like this when using devise:
 
 ```ruby
 Rails.application.routes.draw do
@@ -92,11 +91,12 @@ 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)
+
 > 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__)
+- **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**)
 
 ### Rake Tasks
 
@@ -118,17 +118,16 @@ Details on an example Sinatra app
 
 # 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.
+- 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.
 
-
 ### Example apps
 
 - [Rails 5.2.x App](https://github.com/danmayer/coverband_demo)
@@ -137,14 +136,12 @@ Take Coverband for a spin on the live Heroku deployed [Coverband Demo](https://c
 
 # Advanced Config
 
-
 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
-* 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`
+- See [lib/coverband/configuration.rb](https://github.com/danmayer/coverband/blob/master/lib/coverband/configuration.rb) for all options
+- 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`
 
- Below is an example config file for a Rails 5 app:
+Below is an example config file for a Rails 5 app:
 
 ```ruby
 #config/coverband.rb
@@ -170,14 +167,12 @@ end
 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.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',
+                   'bin/*'
+                   'config/environments/*',
                    'lib/tasks/*']
 ```
 
@@ -208,8 +203,7 @@ Between the release of 4.0 and 4.1 our data format changed. This resets all your
 
 `rake coverband:migrate`
 
-* We will be working to support migrations going forward, when possible
-
+- We will be working to support migrations going forward, when possible
 
 ### Clear Coverage
 
@@ -250,8 +244,8 @@ 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. The files are reloaded when Coverband first starts, you can also trigger a reload via the web interface.
 
+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
 
@@ -278,6 +272,17 @@ end
 
 This flag exposes line by line usage of gem files. Unfortunately due to the way the coverband report is currently rendered, enabling `gem_details` slows down viewing of the coverage report in the browser and is not yet recommended.
 
+### Manually Starting Coverband
+
+Coverband starts on require of the the library which is usually done within the Gemfile. This can be disabled by setting the `COVERBAND_DISABLE_AUTO_START` environment variable. This environment variable can be useful to toggle coverband on and off in certain environments.
+
+In order to start coverband manually yourself when this flag is enabled, call `Coverband.configure` followed by `Coverband.start`.
+
+```ruby
+Coverband.configure
+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.
@@ -304,8 +309,8 @@ If you are trying to debug locally wondering what code is being run during a req
 
 # Prerequisites
 
-* Coverband 3.0.X+ requires Ruby 2.3+
-* Coverband currently requires Redis for production usage
+- Coverband 3.0.X+ requires Ruby 2.3+
+- Coverband currently requires Redis for production usage
 
 # Contributing To Coverband
 
@@ -322,18 +327,18 @@ If you are working on adding features, PRs, or bugfixes to Coverband this sectio
 
 If you submit a change please make sure the tests and benchmarks are passing.
 
-* run tests: 
-   * `bundle exec rake` 
-   * `BUNDLE_GEMFILE=Gemfile.rails4 bundle exec rake` (Same tests using rails 4 instead of 5)
-* view test coverage: `open coverage/index.html`
-* run the benchmarks before and after your change to see impact
-   * `rake benchmarks` 
+- run tests:
+  - `bundle exec rake`
+  - `BUNDLE_GEMFILE=Gemfile.rails4 bundle exec rake` (Same tests using rails 4 instead of 5)
+- view test coverage: `open coverage/index.html`
+- run the benchmarks before and after your change to see impact
+  - `rake benchmarks`
 
 ### 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.
-  * 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).
+- **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
+- 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/Rakefile

@@ -13,7 +13,7 @@ Rake::TestTask.new(:test) do |test|
   # exclude benchmark from the tests as the way it functions resets code coverage during executions
   # test.pattern = 'test/unit/*_test.rb'
   # using test files opposed to pattern as it outputs which files are run
-  test.test_files = FileList['test/**/*_test.rb']
+  test.test_files = FileList['test/integration/**/*_test.rb', 'test/coverband/**/*_test.rb']
   test.verbose = true
 end
 

data/changes.md

@@ -36,7 +36,17 @@ Will be the fully modern release that drops maintenance legacy support in favor
 - Make good video on setup, install, usage
 - See if we can add support for views / templates
   - using this technique https://github.com/ioquatix/covered
-- Better default grouping (could use groups features for gems for rails controllers, models, lib, etc)  	
+- Better default grouping (could use groups features for gems for rails controllers, models, lib, etc)
+- Improved logging for easier debugging and development
+  - drop the verbose mode and better support standard logger levels
+- Possibly setup a build assets system
+  - my JS rules expanded the compressed JS at the top of application.js, basically we want to stitch together JS
+  - I guess we could also load multiple JS files as most of the JS is just default compressed JS and a tiny amount of actual app JS.
+- lazy load for Coverband results
+- view layer file coverage
+- move all code to work with relative paths leaving only stdlib Coverage working on full paths
+- add gem_safe_lists to track only some gems
+- add gem_details_safe list to report on details on some gems
 
 ### Coverband_jam_session
 
@@ -63,41 +73,47 @@ Feature Ideas:
 
 # Alpha
 
-### Coverband 4.2.0.alpha
+### Coverband 4.2.0.rc
 
-???
+For this release your combined coverage is OK, but your runtime coverage will be incorrect until you reset your coverage. This is due to an additive change in how we store coverage. We didn't reset by default as the coverage history for some folks may be more important than runtime breakdown.
 
-### Coverband 4.1.0.beta
-
-- default disabled web clear, add config option to allow it
-- out of the box support for resque
-- readme improvements
-- fix on regression of merging directory changing deployments
-  - fixes for duplicate root paths 
-- pilot release of Gems tracking (disabled by default)
-	- todos
-	  - support multiple gem paths (various version managers setup multiple gem paths)
-	  - speed up page load by allowing multiple pages
-- added web settings and debug views
-   - added support for seeing coverage data size consumed in redis 
-- support coverage data migrations from 4.0.x to 4.1.0
-- fixes for heroku /tmp asset building
+- loadtime vs runtime coverage
+  - This fixes the coverage last seen date to exclude just load time data
+  - now you can see boot time coverage vs code hit during production execution
+  - list view shows runtime percentage and runtime hits
+  - file view shows line hits load, runtime, and combined
+- perf speedup on gem details views
+- ajax load code views for more responsive pages on large projects
+- fix for issues with COVERBAND_DISABLE_AUTO_START
+- silence warnings
+- 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
 
 # Released
 
+### Coverband 4.2.0
+
+### Coverband 4.1.1
+
+- fix bug on info page when using namespaces
+- fix bug related to forking Ruby processes (Resque for example)
+  - bug caused negative line hits
+  - bug seemed to cause memory leaks (not entirely sure how)
+- various test improvements
+- fix bad requests on coverband web admin to `/coverage/favicon.png`
+- improved documentation
+
 ### Coverband 4.1.0
 
 - default disabled web clear, add config option to allow it
 - out of the box support for resque
 - readme improvements
 - fix on regression of merging directory changing deployments
-  - fixes for duplicate root paths 
-- pilot release of Gems tracking (disabled by default)
-	- todos
-	  - support multiple gem paths (various version managers setup multiple gem paths)
-	  - speed up page load by allowing multiple pages
+  - fixes for duplicate root paths
+- pilot release of Gems tracking (disabled by default) - todos - support multiple gem paths (various version managers setup multiple gem paths) - speed up page load by allowing multiple pages
 - added web settings and debug views
-   - added support for seeing coverage data size consumed in redis 
+  - added support for seeing coverage data size consumed in redis
 - support coverage data migrations from 4.0.x to 4.1.0
 - fixes for heroku /tmp asset building
 

data/coverband.gemspec

@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   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 'minitest-reporters'
 
   # TODO: used for benchmarking and tests I think we have other better benchmarking
   # perhaps time to drop this and refactor.

data/lib/coverband.rb

@@ -3,7 +3,6 @@
 require 'logger'
 require 'json'
 require 'redis'
-
 require 'coverband/version'
 require 'coverband/at_exit'
 require 'coverband/configuration'
@@ -19,7 +18,7 @@ require 'coverband/utils/gem_list'
 require 'coverband/utils/source_file'
 require 'coverband/utils/file_groups'
 require 'coverband/utils/lines_classifier'
-require 'coverband/utils/railtie' if defined? ::Rails::Railtie
+require 'coverband/utils/results'
 require 'coverband/collectors/coverage'
 require 'coverband/reporters/base'
 require 'coverband/reporters/html_report'
@@ -29,10 +28,14 @@ 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'
+  RUNTIME_TYPE = nil
+  EAGER_TYPE = :eager_loading
+  MERGED_TYPE = :merged
+  TYPES = [RUNTIME_TYPE, EAGER_TYPE]
+  ALL_TYPES = TYPES + [:merged]
 
   class << self
     attr_accessor :configuration_data
@@ -48,6 +51,7 @@ module Coverband
     else
       configuration.logger&.debug('using default configuration')
     end
+    coverage.reset_instance
   end
 
   def self.report_coverage(force_report = false)
@@ -60,14 +64,30 @@ module Coverband
 
   def self.start
     Coverband::Collectors::Coverage.instance
+    # TODO Railtie sets up at_exit after forks, via middleware, perhaps this hsould be
+    # added if not rails or if rails but not rackserverrunning
     AtExit.register
     Background.start if configuration.background_reporting_enabled && !RackServerCheck.running?
   end
 
+  def self.eager_loading_coverage!
+    coverage.eager_loading!
+  end
+
+  def self.runtime_coverage!
+    coverage.runtime!
+  end
+
+  def self.coverage
+    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
   end
 end

data/lib/coverband/adapters/base.rb

@@ -4,6 +4,7 @@ module Coverband
   module Adapters
     class Base
       include Coverband::Utils::FilePathHelper
+      attr_accessor :type
 
       def initialize
         @file_hash_cache = {}
@@ -13,6 +14,10 @@ module Coverband
         raise 'abstract'
       end
 
+      def clear_file!(_file)
+        raise 'abstract'
+      end
+
       def migrate!
         raise 'abstract'
       end
@@ -39,6 +44,11 @@ module Coverband
         get_report
       end
 
+      def get_coverage_report
+        data = Coverband.configuration.store.split_coverage(Coverband::TYPES)
+        data.merge(Coverband::MERGED_TYPE => Coverband.configuration.store.merged_coverage(Coverband::TYPES))
+      end
+
       def covered_files
         coverage.keys || []
       end
@@ -50,6 +60,18 @@ module Coverband
 
       protected
 
+      def split_coverage(types)
+        types.reduce({}) do |data, type|
+          data.update(type => get_report(type))
+        end
+      end
+
+      def merged_coverage(types)
+        types.reduce({}) do |data, type|
+          merge_reports(data, get_report(type), skip_expansion: true)
+        end
+      end
+
       def save_coverage
         raise 'abstract'
       end
@@ -65,10 +87,11 @@ module Coverband
       def expand_report(report)
         expanded = {}
         report_time = Time.now.to_i
+        updated_time = self.type == Coverband::EAGER_TYPE ? nil : report_time
         report.each_pair do |key, line_data|
           extended_data = {
             'first_updated_at' => report_time,
-            'last_updated_at' => report_time,
+            'last_updated_at' => updated_time,
             'file_hash' => file_hash(key),
             'data' => line_data
           }