coverband 5.0.0.rc.7 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48bac64c5afbae512ae05bd206f11e1e520097722787ebf2371e4f82a866c41a
-  data.tar.gz: a0e1ed588ab6b40b05ebcc2433f945a1a0f67d874ca8ad52f6845fe20a06b1fa
+  metadata.gz: 3b98c9059d81fec16d880a8fad573126d84a01ca07a62ff5ffad37cae5291dbf
+  data.tar.gz: '01649a623307249c03338564770702c3f912a62ee478818fdb65864aba98194f'
 SHA512:
-  metadata.gz: 3047130d731edaf94cc8fef23b8168d32175d70ea8a5daac8f48facd74e0cbe4f42cd6e622a5b7370cbd4df14ae70894c2288ff12b51cbcb45ee68dcacd31276
-  data.tar.gz: 74e499709a8270bab88c0f7bbda7c99798ef62eb6958577f8ca9dde51dbea79ce432445a57e0f0edfc13918e201a15331c1ce638ab45ebbdcdf1e40aeef485de
+  metadata.gz: c9f5bf66e7dcb8c324f77f3fcbe7760f7b8a591c7060126f27917be485e35cd8b865d939a343db98f727fdaec93c9411eb02af30cf1e035bec0626ea16913973
+  data.tar.gz: 50bdcda8675352e9a98880e35de84229e744ed2a323dd4328870f2084cde8f39befecde59aaf55810d1b71d8c9f4f224aa71de22b031e2a4bb8f44cfe9bf32a1

data/Gemfile

@@ -15,5 +15,7 @@ else
 end
 
 gem "rails", "~>5"
+gem "haml"
+gem "slim"
 # these gems are used for testing gem tracking
 gem "irb", require: false

data/Gemfile.rails4

@@ -5,3 +5,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
 gem 'rails', '~>4'
+gem "haml"
+gem "slim"

data/Gemfile.rails6

@@ -5,3 +5,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
 gem 'rails', '~>6'
+gem "haml"
+gem "slim"

data/README.md

@@ -10,7 +10,7 @@
 <p align="center">
   <a href="#key-features">Key Features</a> •
   <a href="#installation">Installation</a> •
-  <a href="#coverage-report">Coverage Report</a> •
+  <a href="#coverband-web-ui">Coverband Web UI</a> •
   <a href="#advanced-config">Advanced Config</a> •
   <a href="#license">License</a> •
   <a href="/changes.md">Change Log / Roadmap</a> •
@@ -28,7 +28,7 @@ The primary goal of Coverband is giving deep insight into your production runtim
 - Low performance overhead
 - 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
+- Splits load time (Rails eager load) and runtime metrics
 - 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
@@ -41,7 +41,7 @@ Coverband stores coverage data in Redis. The Redis endpoint is looked for in thi
 
 1. `ENV['COVERBAND_REDIS_URL']`
 2. `ENV['REDIS_URL']`
-3. `localhost`
+3. `localhost:6379`
 
 The redis store can also be explicitly defined within the coverband.rb. See [advanced config](#advanced-config).
 
@@ -53,8 +53,6 @@ Add this line to your application's `Gemfile`, remember to `bundle install` afte
 gem 'coverband'
 ```
 
-## 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.
@@ -67,7 +65,7 @@ The Railtie integration means you shouldn't need to do anything else other than
 
 ## 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.
+For the best coverage you want this loaded as early as possible. We recommend requiring cover band directly in the `config.ru`.  Requiring coverband within an initializer could also work, but you may end up missing some boot up coverage. To start collection require Coverband as early as possible.
 
 ```ruby
 require 'coverband'
@@ -77,7 +75,33 @@ use Coverband::BackgroundMiddleware
 run ActionController::Dispatcher.new
 ```
 
-# Coverage Report
+## Coverband Web UI
+
+![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_web_ui.png)
+
+> The web index as available on the [Coverband Demo site](https://coverband-demo.herokuapp.com/coverage?#_Coverage)
+
+- View overall coverage information
+
+- Drill into individual file coverage
+
+- View individual file details
+
+- Clear Coverage - disabled by default as it could be considered a dangerous operation in production. Enable with `config.web_enable_clear` or leave off and clear from [rake task](#clear-coverage).
+
+  - Clear coverage report
+
+    This will clear the coverage data. This wipes out all collected data. 
+
+  - 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.
+
+- Force coverage collection
+
+  This triggers coverage collection on the current webserver process. Useful in development but confusing in production environments where many ruby processes are usually running.
+
+### Mounting as a Rack App
 
 Coverband comes with a mountable rack app for viewing reports. For Rails this can be done in `config/routes.rb` with:
 
@@ -97,49 +121,29 @@ 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'`
+or you can enable basic auth by setting `ENV['COVERBAND_PASSWORD']` or via your configuration `config.password = <YOUR_COMPLEX_UNGUESSABLE_PASSWORD>`
 
-### Coverband Web Endpoint
+### Standalone
 
-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.
+The coverage server can also be started standalone with a rake task:
 
-![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
-- **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.
-
-### JRuby Support
-
-Coverband is compatible with JRuby. If you want to run on JRuby note that I haven't benchmarked and I believe the perf impact on older versions of JRuby could be significant, improved Coverage support is in [JRuby master](https://github.com/jruby/jruby/pull/6180), and will be in the next release.
-
-- older versions of JRuby need tracing enabled to work (and this could cause bad performance)
-  - run Jruby with the `--debug` option
-  - add into your `.jrubyrc` the `debug.fullTrace=true` setting
-- For best performance the `oneshot_lines` is recommended, and in the latest releases should have very low overhead
-- See JRuby support in a Rails app configured to run via JRuby, in [Coverband Demo](https://github.com/coverband-service/coverband_demo)
-- JRuby is tested via CI against Rails 5 and 6
-
-### Rake Tasks
-
-The rake task generates a report locally and opens a browser pointing to `coverage/index.html`.
-
-`rake coverband:coverage`
+```
+bundle exec rake coverband:coverage_server
+```
 
-This is mostly useful in your local development environment.
+The web UI should then be available here: http://localhost:9022/
 
-##### Example Output
+If you want to run on an alternative port:
 
-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.
+```
+COVERBAND_COVERAGE_PORT=8086 bundle exec rake coverband:coverage_server
+```
 
-Index Page
-![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_index.png)
+This is especially useful for projects that are api only and cannot support the mounted rack app. To get production coverage, point coverband at your production redis server and ensure to checkout the production version of your project code locally.
 
-Details on an example Sinatra app
-![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_details.png)
+```
+ COVERBAND_REDIS_URL=redis://username:password:redis_production_server:2322 bundle exec rake coverband:coverage_server
+```
 
 # Coverband Demo
 
@@ -245,7 +249,7 @@ end
 
 ### Avoiding Cache Stampede
 
-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.
+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. Note, the default wiggle is set to 30 seconds.
 
 Add a wiggle (in seconds) to the background thread to avoid all your servers reporting at the same time:
 
@@ -253,11 +257,12 @@ Add a wiggle (in seconds) to the background thread to avoid all your servers rep
 
 ### 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.
+Coverband on very high volume sites with many server processes reporting can have a race condition which can cause hit counts to be inaccurate. 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 frequency.
 
-- 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.
+- Use a dedicated coverband redis instance: `config.store = Coverband::Adapters::HashRedisStore.new(Redis.new(url: redis_url))`
+- Adjust from default 30s reporting `config.background_reporting_sleep_seconds = 120`
+
+See more discussion [here](https://github.com/danmayer/coverband/issues/384).
 
 ### Clear Coverage
 
@@ -265,6 +270,8 @@ Now that Coverband uses MD5 hashes there should be no reason to manually clear c
 
 `rake coverband:clear`
 
+This can also be done through the web if `config.web_enable_clear` is enabled.
+
 ### 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.
@@ -306,7 +313,7 @@ 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. 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.
+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 problem 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.
 
 ---
 
@@ -339,6 +346,17 @@ We will match Heroku & Ruby's support lifetime, supporting the last 3 major Ruby
 
 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.
 
+### JRuby Support
+
+Coverband is compatible with JRuby. If you want to run on JRuby note that I haven't benchmarked and I believe the perf impact on older versions of JRuby could be significant. Improved Coverage support is in [JRuby master](https://github.com/jruby/jruby/pull/6180), and will be in the next release.
+
+- older versions of JRuby need tracing enabled to work (and this could cause bad performance)
+  - run Jruby with the `--debug` option
+  - add into your `.jrubyrc` the `debug.fullTrace=true` setting
+- For best performance the `oneshot_lines` is recommended, and in the latest releases should have very low overhead
+- See JRuby support in a Rails app configured to run via JRuby, in [Coverband Demo](https://github.com/coverband-service/coverband_demo)
+- JRuby is tested via CI against Rails 5 and 6
+
 # Contributing To Coverband
 
 If you are working on adding features, PRs, or bugfixes to Coverband this section should help get you going.
@@ -368,6 +386,9 @@ If you submit a change please make sure the tests and benchmarks are passing.
   - 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
   - **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.
+- **Coverage does NOT work when used alongside Scout APM Auto Instrumentation**
+  - In an environment that uses Scout's `AUTO_INSTRUMENT=true` (usually production or staging) it stops reporting any coverage, it will show one or two files that have been loaded at the start but everything else will show up as having 0% coverage
+  - Bug tracked here: https://github.com/scoutapp/scout_apm_ruby/issues/343
 
 ### Debugging Redis Store
 

data/changes.md

@@ -53,6 +53,22 @@ Will be the fully modern release that drops maintenance legacy support in favor
 
 # Alpha / Beta / Release Candidates
 
+### Coverband 5.0.3
+
+- ?
+
+# Released
+
+### Coverband 5.0.2
+
+- change default port of local server
+- update on readme about issue with scout app, thanks @mrbongiolo 
+- fix on configuration page not loading when redis can't load
+
+### Coverband 5.0.1
+
+- fix for race condition on view tracker redis configuration setting ensuring it is set after it is configured... bug only impacted apps that have multiple redis connections for the same system and have Coverband not on the default REDIS_URL
+
 ### Coverband 5.0.0
 
 - Full JRuby support
@@ -66,21 +82,23 @@ Will be the fully modern release that drops maintenance legacy support in favor
 	- all config options can be set via coverband config, not requiring ENV var support
 	- deprecation notices on soon to be removed config options
 	- config exceptions on invalid configuration combinations
+	- additional testing around configurations
+	- improved defaults and reduced configuration options
 - improved resque patching pattern
 - improved default ignores
 - additional adapters
   - supports web-service adapter for http coverage collection
   - support log/file adapter
+  - extendable pattern to support any additional backends
 - reduce logs / errors / alerts on bad startup configurations
+- fix: #301 runtime vs eagerload should always remain correct
 
-# Released
-
-###Coverband 4.2.7
+### Coverband 4.2.7
 
 - Ignore patterns too aggressive #382, thanks @thijsnado
 - Stack level too deep error when running certain activejob jobs #367, thanks @kejordan and @hanslauwers
 
-###Coverband 4.2.6
+### Coverband 4.2.6
 
 - Address Redis exists deprecation warning by baffers
 
@@ -263,7 +281,7 @@ Will be a stable and fast release that drops maintenance legacy support in favor
   - implemented for Redis and File store
 - improved mountable web interface
 
-# 2.0.3
+### 2.0.3
 
 - don''t include docs in the gemfile thanks @bquorning
 - pipeline_redis to reduce network overhead thanks @Kallin

data/coverband.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "memory_profiler"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-fork_executor"
+  spec.add_development_dependency "minitest-stub-const"
   spec.add_development_dependency "mocha", "~> 1.7.0"
   spec.add_development_dependency "rack"
   spec.add_development_dependency "rack-test"

data/lib/coverband/adapters/base.rb

@@ -40,7 +40,11 @@ module Coverband
       end
 
       def size_in_mib
-        format("%<size>.2f", size: (size.to_f / 2**20))
+        if size
+          format("%<size>.2f", size: (size.to_f / 2**20))
+        else
+          "N/A"
+        end
       end
 
       def save_report(_report)

data/lib/coverband/adapters/file_store.rb

@@ -20,7 +20,7 @@ module Coverband
     # files matching the path pattern, in this case `log/coverage.log.*`
     #
     # run: `bundle exec rake coverband:coverage_server`
-    # open http://localhost:1022/
+    # open http://localhost:9022/
     #
     # one could also build a report via code, the output is suitable to feed into SimpleCov
     #

data/lib/coverband/adapters/redis_store.rb

@@ -44,7 +44,7 @@ module Coverband
       end
 
       def size
-        @redis.get(base_key).bytesize
+        @redis.get(base_key) ? @redis.get(base_key).bytesize : "N/A"
       end
 
       ###

data/lib/coverband/collectors/view_tracker.rb

@@ -10,22 +10,20 @@ module Coverband
     # This is a port of Flatfoot, a project I open sourced years ago,
     # but am now rolling into Coverband
     # https://github.com/livingsocial/flatfoot
-    #
-    # TODO: test and ensure slim, haml, and other support
     ###
     class ViewTracker
-      DEFAULT_TARGET = Dir.glob("app/views/**/*.html.erb").reject { |file| file.match(/(_mailer)/) }
       attr_accessor :target, :logged_views, :views_to_record
       attr_reader :logger, :roots, :store, :ignore_patterns
 
       def initialize(options = {})
         raise NotImplementedError, "View Tracker requires Rails 4 or greater" unless self.class.supported_version?
+        raise "Coverband: view tracker initialized before configuration!" if !Coverband.configured? && ENV["COVERBAND_TEST"] == "test"
 
         @project_directory = File.expand_path(Coverband.configuration.root)
         @ignore_patterns = Coverband.configuration.ignore
         @store = options.fetch(:store) { Coverband.configuration.store }
         @logger = options.fetch(:logger) { Coverband.configuration.logger }
-        @target = options.fetch(:target) { DEFAULT_TARGET }
+        @target = options.fetch(:target) { Dir.glob("#{@project_directory}/app/views/**/*.html.{erb,haml,slim}").reject { |file| file.match(/(_mailer)/) }.freeze }
 
         @roots = options.fetch(:roots) { Coverband.configuration.all_root_patterns }
         @roots = @roots.split(",") if @roots.is_a?(String)

data/lib/coverband/configuration.rb

@@ -130,7 +130,7 @@ module Coverband
 
     def store
       @store ||= if service?
-        raise "invalid configuration: unclear default store coverband expects either api_key or redis_url" if redis_url
+        raise "invalid configuration: unclear default store coverband expects either api_key or redis_url" if ENV["COVERBAND_REDIS_URL"]
         require "coverband/adapters/web_service_store"
         Coverband::Adapters::WebServiceStore.new(service_url)
       else

data/lib/coverband/reporters/console_report.rb

@@ -8,14 +8,8 @@ module Coverband
     class ConsoleReport < Base
       def self.report(store, options = {})
         scov_style_report = super(store, options)
-
-        scov_style_report.each_pair do |file, usage|
-          # TODO: In Coverband 5 deprecate none hash format
-          if usage.is_a?(Hash)
-            Coverband.configuration.logger.info "#{file}: #{usage["data"]}"
-          else
-            Coverband.configuration.logger.info "#{file}: #{usage}"
-          end
+        scov_style_report[:merged].each_pair do |file, usage|
+          Coverband.configuration.logger.info "#{file}: #{usage["data"]}"
         end
         scov_style_report
       end

data/lib/coverband/utils/railtie.rb

@@ -13,7 +13,21 @@ module Coverband
     initializer "coverband.configure" do |app|
       begin
         app.middleware.use Coverband::BackgroundMiddleware
+      rescue Redis::CannotConnectError => error
+        Coverband.configuration.logger.info "Redis is not available (#{error}), Coverband not configured"
+        Coverband.configuration.logger.info "If this is a setup task like assets:precompile feel free to ignore"
+      end
+    end
 
+    config.after_initialize do
+      unless Coverband.tasks_to_ignore?
+        Coverband.configure
+        Coverband.eager_loading_coverage!
+        Coverband.report_coverage
+        Coverband.runtime_coverage!
+      end
+
+      begin
         if Coverband.configuration.track_views
           COVERBAND_VIEW_TRACKER = if Coverband.coverband_service?
             Coverband::Collectors::ViewTrackerService.new
@@ -33,15 +47,6 @@ module Coverband
       end
     end
 
-    config.after_initialize do
-      unless Coverband.tasks_to_ignore?
-        Coverband.configure
-        Coverband.eager_loading_coverage!
-        Coverband.report_coverage
-        Coverband.runtime_coverage!
-      end
-    end
-
     config.before_configuration do
       unless ENV["COVERBAND_DISABLE_AUTO_START"]
         begin

data/lib/coverband/utils/tasks.rb

@@ -13,7 +13,7 @@ namespace :coverband do
   task :coverage_server do
     Rake.application["environment"].invoke if Rake::Task.task_defined?("environment")
     Coverband.configuration.store.merge_mode = true if Coverband.configuration.store.is_a?(Coverband::Adapters::FileStore)
-    Rack::Server.start app: Coverband::Reporters::Web.new, Port: ENV.fetch("COVERBAND_COVERAGE_PORT", 1022).to_i
+    Rack::Server.start app: Coverband::Reporters::Web.new, Port: ENV.fetch("COVERBAND_COVERAGE_PORT", 9022).to_i
   end
 
   ###

data/lib/coverband/version.rb

@@ -5,5 +5,5 @@
 # use format '4.2.1.rc.1' ~> 4.2.1.rc to prerelease versions like v4.2.1.rc.2 and v4.2.1.rc.3
 ###
 module Coverband
-  VERSION = "5.0.0.rc.7"
+  VERSION = "5.0.2"
 end

data/test/coverband/configuration_test.rb

@@ -89,17 +89,29 @@ class BaseTest < Minitest::Test
     end
   end
 
-  test "store raises when api key and redis_url" do
+  test "store raises when api key and coverband redis env" do
     Coverband::Collectors::Coverage.instance.reset_instance
     Coverband.configuration.reset
-    assert_raises RuntimeError do
-      Coverband.configure do |config|
-        config.api_key = "test-key"
-        config.redis_url = "redis://localhost:3333"
+
+    env = ENV.to_hash.merge("COVERBAND_REDIS_URL" => "redis://localhost:3333")
+    Object.stub_const(:ENV, env) do
+      assert_raises RuntimeError do
+        Coverband.configure do |config|
+          config.api_key = "test-key"
+        end
       end
     end
   end
 
+  test "store doesnt raises when api key and redis_url" do
+    Coverband::Collectors::Coverage.instance.reset_instance
+    Coverband.configuration.reset
+    Coverband.configure do |config|
+      config.api_key = "test-key"
+      config.redis_url = "redis://localhost:3333"
+    end
+  end
+
   test "use_oneshot_lines_coverage" do
     refute Coverband.configuration.use_oneshot_lines_coverage
 

data/test/coverband/reporters/web_test.rb

@@ -22,13 +22,13 @@ if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.2.0")
       test "renders index content" do
         get "/"
         assert last_response.ok?
-        assert_match "Coverband Admin", last_response.body
+        assert_match "Coverband Home", last_response.body
       end
 
       test "renders index content for empty path" do
         get ""
         assert last_response.ok?
-        assert_match "Coverband Admin", last_response.body
+        assert_match "Coverband Home", last_response.body
       end
 
       test "renders 404" do

data/test/forked/rails_full_stack_test.rb

@@ -35,7 +35,7 @@ class RailsFullStackTest < Minitest::Test
       end
 
       # Test eager load data stored separately
-      dummy_controller = "./test/rails#{Rails::VERSION::MAJOR}_dummy/app/controllers/dummy_controller.rb"
+      dummy_controller = "./app/controllers/dummy_controller.rb"
       store.type = :eager_loading
       eager_expected = [1, 1, 0, nil, nil]
       results = store.coverage[dummy_controller]["data"]

data/test/forked/rails_full_stack_views_test.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require File.expand_path("../rails_test_helper", File.dirname(__FILE__))
+
+class RailsFullStackTest < Minitest::Test
+  include Capybara::DSL
+  include Capybara::Minitest::Assertions
+
+  def setup
+    super
+    rails_setup
+    Coverband.report_coverage
+  end
+
+  def teardown
+    super
+    Capybara.reset_sessions!
+    Capybara.use_default_driver
+  end
+
+  test "verify erb haml slim support" do
+    visit "/dummy_view/show"
+    assert_content("I am no dummy view tracker text")
+    Coverband.report_coverage
+    Coverband.configuration.view_tracker&.report_views_tracked
+    visit "/coverage/view_tracker"
+    assert_content("Used Views: (1)")
+    assert_selector("li.used-views", text: "dummy_view/show.html.erb")
+    assert_selector("li.unused-views", text: "dummy_view/show_haml.html.haml")
+    assert_selector("li.unused-views", text: "dummy_view/show_slim.html.slim")
+
+    visit "/dummy_view/show_haml"
+    assert_content("I am haml text")
+    Coverband.report_coverage
+    Coverband.configuration.view_tracker&.report_views_tracked
+    visit "/coverage/view_tracker"
+    assert_content("Used Views: (2)")
+    assert_selector("li.used-views", text: "dummy_view/show_haml.html.haml")
+
+    visit "/dummy_view/show_slim"
+    assert_content("I am slim text")
+    Coverband.report_coverage
+    Coverband.configuration.view_tracker&.report_views_tracked
+    visit "/coverage/view_tracker"
+    assert_content("Used Views: (3)")
+    assert_selector("li.used-views", text: "dummy_view/show_slim.html.slim")
+  end
+end

data/test/forked/rails_view_tracker_stack_test.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require File.expand_path("../rails_test_helper", File.dirname(__FILE__))
+
+class RailsWithoutConfigStackTest < Minitest::Test
+  def setup
+    super
+    setup_server
+  end
+
+  def teardown
+    super
+    shutdown_server
+  end
+
+  test "check view tracker" do
+    output = `sleep 7 && curl http://localhost:9999/dummy_view/show`
+    assert output.match(/rendered view/)
+    assert output.match(/I am no dummy view tracker text/)
+    output = `sleep 1 && curl http://localhost:9999/coverage/view_tracker`
+    assert output.match(/Used Views: \(1\)/)
+    assert output.match(/dummy_view\/show/)
+  end
+
+  private
+
+  # NOTE: We aren't leveraging Capybara because it loads all of our other test helpers and such,
+  # which in turn Configures coverband making it impossible to test the configuration error
+  def setup_server
+    ENV["RAILS_ENV"] = "test"
+    require "rails"
+    fork do
+      exec "cd test/rails#{Rails::VERSION::MAJOR}_dummy && COVERBAND_TEST=test bundle exec rackup config.ru -p 9999 --pid /tmp/testrack.pid"
+    end
+  end
+
+  def shutdown_server
+    if File.exist?("/tmp/testrack.pid")
+      pid = `cat /tmp/testrack.pid`&.strip&.to_i
+      Process.kill("HUP", pid)
+      sleep 1
+    end
+  end
+end

data/test/rails4_dummy/app/controllers/dummy_view_controller.rb

@@ -0,0 +1,16 @@
+class DummyViewController < ActionController::Base
+  def show
+    @text = "I am no dummy view tracker text"
+    render layout: false
+  end
+
+  def show_haml
+    @text = "I am haml text"
+    render layout: false
+  end
+
+  def show_slim
+    @text = "I am slim text"
+    render layout: false
+  end
+end

data/test/rails4_dummy/app/views/dummy_view/show.html.erb

@@ -0,0 +1,5 @@
+rendered view
+
+<div>
+  <%= @text %>
+</div>

data/test/rails4_dummy/app/views/dummy_view/show_haml.html.haml

@@ -0,0 +1,4 @@
+rendered haml view
+
+#foo
+  = @text

data/test/rails4_dummy/app/views/dummy_view/show_slim.html.slim

@@ -0,0 +1,4 @@
+rendered slim view
+
+#content
+  = @text

data/test/rails4_dummy/config/application.rb

@@ -10,5 +10,6 @@ Bundler.require(*Rails.groups)
 module Rails4Dummy
   class Application < Rails::Application
     config.eager_load = true
+    config.consider_all_requests_local = true
   end
 end

data/test/rails4_dummy/config/routes.rb

@@ -1,4 +1,7 @@
 Rails.application.routes.draw do
   get "dummy/show"
+  get "dummy_view/show", to: "dummy_view#show"
+  get "dummy_view/show_haml", to: "dummy_view#show_haml"
+  get "dummy_view/show_slim", to: "dummy_view#show_slim"
   mount Coverband::Reporters::Web.new, at: "/coverage"
 end

data/test/rails5_dummy/app/controllers/dummy_view_controller.rb

@@ -0,0 +1,16 @@
+class DummyViewController < ActionController::Base
+  def show
+    @text = "I am no dummy view tracker text"
+    render layout: false
+  end
+
+  def show_haml
+    @text = "I am haml text"
+    render layout: false
+  end
+
+  def show_slim
+    @text = "I am slim text"
+    render layout: false
+  end
+end

data/test/rails5_dummy/app/views/dummy_view/show.html.erb

@@ -0,0 +1,5 @@
+rendered view
+
+<div>
+  <%= @text %>
+</div>

data/test/rails5_dummy/app/views/dummy_view/show_haml.html.haml

@@ -0,0 +1,4 @@
+rendered haml view
+
+#foo
+  = @text

data/test/rails5_dummy/app/views/dummy_view/show_slim.html.slim

@@ -0,0 +1,4 @@
+rendered slim view
+
+#content
+  = @text

data/test/rails5_dummy/config/application.rb

@@ -2,11 +2,13 @@
 
 require "rails"
 require "action_controller/railtie"
+require "action_view/railtie"
 require "coverband"
 Bundler.require(*Rails.groups)
 
 module Rails5Dummy
   class Application < Rails::Application
     config.eager_load = true
+    config.consider_all_requests_local = true
   end
 end

data/test/rails5_dummy/config/coverband.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 Coverband.configure do |config|
-  config.root = Dir.pwd
+  # NOTE: we reuse this config in each of the fake rails projects
+  # the below ensures the root is set to the correct fake project
+  config.root = ::File.expand_path("../../../", __FILE__).to_s + "/rails#{Rails::VERSION::MAJOR}_dummy"
   config.store = Coverband::Adapters::RedisStore.new(Redis.new(db: 2, url: ENV["REDIS_URL"]), redis_namespace: "coverband_test") if defined? Redis
   config.ignore = %w[.erb$ .slim$]
   config.root_paths = []

data/test/rails5_dummy/config/routes.rb

@@ -1,4 +1,7 @@
 Rails.application.routes.draw do
   get "dummy/show"
+  get "dummy_view/show", to: "dummy_view#show"
+  get "dummy_view/show_haml", to: "dummy_view#show_haml"
+  get "dummy_view/show_slim", to: "dummy_view#show_slim"
   mount Coverband::Reporters::Web.new, at: "/coverage"
 end

data/test/rails6_dummy/app/controllers/dummy_view_controller.rb

@@ -0,0 +1,16 @@
+class DummyViewController < ActionController::Base
+  def show
+    @text = "I am no dummy view tracker text"
+    render layout: false
+  end
+
+  def show_haml
+    @text = "I am haml text"
+    render layout: false
+  end
+
+  def show_slim
+    @text = "I am slim text"
+    render layout: false
+  end
+end

data/test/rails6_dummy/app/views/dummy_view/show.html.erb

@@ -0,0 +1,5 @@
+rendered view
+
+<div>
+  <%= @text %>
+</div>

data/test/rails6_dummy/app/views/dummy_view/show_haml.html.haml

@@ -0,0 +1,4 @@
+rendered haml view
+
+#foo
+  = @text

data/test/rails6_dummy/app/views/dummy_view/show_slim.html.slim

@@ -0,0 +1,4 @@
+rendered slim view
+
+#content
+  = @text

data/test/rails6_dummy/config/application.rb

@@ -10,5 +10,6 @@ Bundler.require(*Rails.groups)
 module Rails6Dummy
   class Application < Rails::Application
     config.eager_load = true
+    config.consider_all_requests_local = true
   end
 end

data/test/rails6_dummy/config/routes.rb

@@ -1,4 +1,7 @@
 Rails.application.routes.draw do
   get "dummy/show"
+  get "dummy_view/show", to: "dummy_view#show"
+  get "dummy_view/show_haml", to: "dummy_view#show_haml"
+  get "dummy_view/show_slim", to: "dummy_view#show_slim"
   mount Coverband::Reporters::Web.new, at: "/coverage"
 end

data/test/test_helper.rb

@@ -6,6 +6,7 @@ require "rubygems"
 require "simplecov"
 require "coveralls"
 require "minitest/autorun"
+require "minitest/stub_const"
 require "mocha/minitest"
 require "ostruct"
 require "json"

data/views/nav.erb

@@ -1,7 +1,7 @@
 
 <div id="header">
-  <a href='<%= base_path %>'>Coverband Admin</a> &nbsp;
-  <a href='<%= base_path %>settings'>Info</a> &nbsp;
+  <a href='<%= base_path %>'>Coverband Home</a> &nbsp;
+  <a href='<%= base_path %>settings'>Configuration</a> &nbsp;
   <% if Coverband.configuration.web_enable_clear %>
     <%= button("#{base_path}clear", 'clear coverage report', delete: true) %>
   <% end %>

data/views/settings.erb

@@ -11,8 +11,8 @@
   <body>
     <div id="wrapper" style="">
       <div id="header">
-        <a href='<%= base_path %>'>Coverband Admin</a> &nbsp;
-        <a href='<%= base_path %>settings'>Info</a> &nbsp;
+        <a href='<%= base_path %>'>Coverband Home</a> &nbsp;
+        <a href='<%= base_path %>settings'>Configuration</a> &nbsp;
       </div>
       <div id="content">
         <dl>

data/views/view_tracker.erb

@@ -26,7 +26,7 @@
         <p>These views have not been rendered since recording started at <%= tracker.tracking_since %></p>
         <ul>
         <% tracker.unused_views.each do |view_file| %>
-          <li><%= view_file %></li>
+          <li class="unused-views"><%= view_file %></li>
         <% end %>
         </ul>
 
@@ -34,7 +34,7 @@
         <p>These views have been rendered at least once</p>
         <ul>
         <% tracker.used_views.each_pair do |view_file, time_at| %>
-          <li>
+          <li class="used-views">
             <%= view_file %>
             <span class="last_seen_at">last activity recorded <%= Time.at(time_at.to_i)%></span>
             <% if Coverband.configuration.web_enable_clear %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc.7
+  version: 5.0.2
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-29 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-stub-const
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -388,11 +402,17 @@ files:
 - test/fixtures/skipped_and_executed.rb
 - test/fixtures/utf-8.rb
 - test/forked/rails_full_stack_test.rb
+- test/forked/rails_full_stack_views_test.rb
 - test/forked/rails_rake_full_stack_test.rb
+- test/forked/rails_view_tracker_stack_test.rb
 - test/integration/full_stack_test.rb
 - test/jruby_check.rb
 - test/rails4_dummy/Rakefile
 - test/rails4_dummy/app/controllers/dummy_controller.rb
+- test/rails4_dummy/app/controllers/dummy_view_controller.rb
+- test/rails4_dummy/app/views/dummy_view/show.html.erb
+- test/rails4_dummy/app/views/dummy_view/show_haml.html.haml
+- test/rails4_dummy/app/views/dummy_view/show_slim.html.slim
 - test/rails4_dummy/config.ru
 - test/rails4_dummy/config/application.rb
 - test/rails4_dummy/config/boot.rb
@@ -404,6 +424,10 @@ files:
 - test/rails4_dummy/tmp/.keep
 - test/rails5_dummy/Rakefile
 - test/rails5_dummy/app/controllers/dummy_controller.rb
+- test/rails5_dummy/app/controllers/dummy_view_controller.rb
+- test/rails5_dummy/app/views/dummy_view/show.html.erb
+- test/rails5_dummy/app/views/dummy_view/show_haml.html.haml
+- test/rails5_dummy/app/views/dummy_view/show_slim.html.slim
 - test/rails5_dummy/config.ru
 - test/rails5_dummy/config/application.rb
 - test/rails5_dummy/config/coverband.rb
@@ -413,6 +437,10 @@ files:
 - test/rails5_dummy/tmp/.keep
 - test/rails6_dummy/Rakefile
 - test/rails6_dummy/app/controllers/dummy_controller.rb
+- test/rails6_dummy/app/controllers/dummy_view_controller.rb
+- test/rails6_dummy/app/views/dummy_view/show.html.erb
+- test/rails6_dummy/app/views/dummy_view/show_haml.html.haml
+- test/rails6_dummy/app/views/dummy_view/show_slim.html.slim
 - test/rails6_dummy/config.ru
 - test/rails6_dummy/config/application.rb
 - test/rails6_dummy/config/boot.rb
@@ -448,9 +476,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
@@ -506,11 +534,17 @@ test_files:
 - test/fixtures/skipped_and_executed.rb
 - test/fixtures/utf-8.rb
 - test/forked/rails_full_stack_test.rb
+- test/forked/rails_full_stack_views_test.rb
 - test/forked/rails_rake_full_stack_test.rb
+- test/forked/rails_view_tracker_stack_test.rb
 - test/integration/full_stack_test.rb
 - test/jruby_check.rb
 - test/rails4_dummy/Rakefile
 - test/rails4_dummy/app/controllers/dummy_controller.rb
+- test/rails4_dummy/app/controllers/dummy_view_controller.rb
+- test/rails4_dummy/app/views/dummy_view/show.html.erb
+- test/rails4_dummy/app/views/dummy_view/show_haml.html.haml
+- test/rails4_dummy/app/views/dummy_view/show_slim.html.slim
 - test/rails4_dummy/config.ru
 - test/rails4_dummy/config/application.rb
 - test/rails4_dummy/config/boot.rb
@@ -522,6 +556,10 @@ test_files:
 - test/rails4_dummy/tmp/.keep
 - test/rails5_dummy/Rakefile
 - test/rails5_dummy/app/controllers/dummy_controller.rb
+- test/rails5_dummy/app/controllers/dummy_view_controller.rb
+- test/rails5_dummy/app/views/dummy_view/show.html.erb
+- test/rails5_dummy/app/views/dummy_view/show_haml.html.haml
+- test/rails5_dummy/app/views/dummy_view/show_slim.html.slim
 - test/rails5_dummy/config.ru
 - test/rails5_dummy/config/application.rb
 - test/rails5_dummy/config/coverband.rb
@@ -531,6 +569,10 @@ test_files:
 - test/rails5_dummy/tmp/.keep
 - test/rails6_dummy/Rakefile
 - test/rails6_dummy/app/controllers/dummy_controller.rb
+- test/rails6_dummy/app/controllers/dummy_view_controller.rb
+- test/rails6_dummy/app/views/dummy_view/show.html.erb
+- test/rails6_dummy/app/views/dummy_view/show_haml.html.haml
+- test/rails6_dummy/app/views/dummy_view/show_slim.html.slim
 - test/rails6_dummy/config.ru
 - test/rails6_dummy/config/application.rb
 - test/rails6_dummy/config/boot.rb