coverband 5.0.1 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2869a30161428e6236dee380660fe39797c6fd6029225c4987d8de79cfce9019
-  data.tar.gz: 43f2998da3c1735f452c71aaf93179d714933e4f7da11d420477155a8427ab85
+  metadata.gz: 3b98c9059d81fec16d880a8fad573126d84a01ca07a62ff5ffad37cae5291dbf
+  data.tar.gz: '01649a623307249c03338564770702c3f912a62ee478818fdb65864aba98194f'
 SHA512:
-  metadata.gz: d083c07eb9c101e87f19902b9f7c531e4f06f7b7f8421912f77cd25d74340f1f6824d97059d410711b092a36e5a52dc01afa1ea30af714331fb3bdc905ac4ce7
-  data.tar.gz: e1fd6726954fdb473fc21570207923942953faa3360ca4dfea9a6fb825fbb42fef77e3b593469f5a28e42f9a1e7115f96815822405ad26d34c113f364aa8ee69
+  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

@@ -128,10 +128,16 @@ or you can enable basic auth by setting `ENV['COVERBAND_PASSWORD']` or via your
 The coverage server can also be started standalone with a rake task:
 
 ```
- bundle exec rake coverband:coverage_server
+bundle exec rake coverband:coverage_server
 ```
 
-The web UI should then be available here: http://localhost:1022/
+The web UI should then be available here: http://localhost:9022/
+
+If you want to run on an alternative port:
+
+```
+COVERBAND_COVERAGE_PORT=8086 bundle exec rake coverband:coverage_server
+```
 
 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.
 
@@ -380,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,12 +53,18 @@ Will be the fully modern release that drops maintenance legacy support in favor
 
 # Alpha / Beta / Release Candidates
 
-### Coverband 5.0.2
+### 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

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/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.1"
+  VERSION = "5.0.2"
 end

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/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.1
+  version: 5.0.2
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-07 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -402,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
@@ -418,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
@@ -427,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
@@ -520,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
@@ -536,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
@@ -545,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