coverband 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2869a30161428e6236dee380660fe39797c6fd6029225c4987d8de79cfce9019
-  data.tar.gz: 43f2998da3c1735f452c71aaf93179d714933e4f7da11d420477155a8427ab85
+  metadata.gz: a5cd2e1c2877aa5eefb57baf7b1c51c5e708ef8d5869f01b51a37c3b6e37c931
+  data.tar.gz: 4f0a6bc520d84917f989b3c13ec1c5bba2d6ab04db26fb87331cfed536b142f9
 SHA512:
-  metadata.gz: d083c07eb9c101e87f19902b9f7c531e4f06f7b7f8421912f77cd25d74340f1f6824d97059d410711b092a36e5a52dc01afa1ea30af714331fb3bdc905ac4ce7
-  data.tar.gz: e1fd6726954fdb473fc21570207923942953faa3360ca4dfea9a6fb825fbb42fef77e3b593469f5a28e42f9a1e7115f96815822405ad26d34c113f364aa8ee69
+  metadata.gz: cb077ceeb315e92dd7f51e355057d855b00701e05d8b4ef7836ff8cae624c2db71ba0ce67ac6e3be5dd5fb87182c4a68d8e8d1ab3c6e4554f2d792db9f214c65
+  data.tar.gz: 0ab9e096d137f1babd34b3cc32899095b6b3f0f87bb0a9aee7d987bf8b116b1815a3fc630ad0f1f73d4550563c2cf08a4bb9e8e20e8c9553dd9246d0dee6414a

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/main.yml

@@ -0,0 +1,30 @@
+name: CI
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        # need to figure out how to use redis on macos github actions
+        # os: [ubuntu, macos]
+        os: [ubuntu]
+        # remove until I sort out CI issues for truffle
+        # truffleruby,
+        # truffleruby-head,
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, jruby, jruby-head]
+        redis-version: [5]
+    runs-on: ${{ matrix.os }}-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: supercharge/redis-github-action@1.1.0
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rake

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+See our [code of conduct](https://github.com/danmayer/coverband/blob/master/CODE_OF_CONDUCT.md)

data/Gemfile

@@ -7,13 +7,12 @@ gemspec
 
 # add when debugging
 # require 'byebug'; byebug
-if ENV["CI"]
-  # skipping pry-byebug as it has issues on Ruby 2.3 on travis
-  # and we don't really need it on CI
-else
-  gem "pry-byebug", platforms: [:mri, :mingw, :x64_mingw]
+unless ENV["CI"]
+  gem "pry-byebug"
 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/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2018 Dan Mayer
+Copyright (c) 2010-2020 Dan Mayer
 
 MIT License
 

data/README.md

@@ -2,7 +2,7 @@
 
 # Coverband
 
-[![Build Status](https://travis-ci.org/danmayer/coverband.svg?branch=master)](https://travis-ci.org/danmayer/coverband)
+[![GithubCI](https://github.com/danmayer/coverband/workflows/CI/badge.svg)](https://github.com/danmayer/coverband/actions)
 [![Coverage Status](https://coveralls.io/repos/github/danmayer/coverband/badge.svg?branch=master)](https://coveralls.io/github/danmayer/coverband?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/1e6682f9540d75f26da7/maintainability)](https://codeclimate.com/github/danmayer/coverband/maintainability)
 [![Discord Shield](https://img.shields.io/discord/609509533999562753)](https://discord.gg/KAH38EV)
@@ -12,6 +12,7 @@
   <a href="#installation">Installation</a> •
   <a href="#coverband-web-ui">Coverband Web UI</a> •
   <a href="#advanced-config">Advanced Config</a> •
+  <a href="#newer-features">Newer Features</a> •
   <a href="#license">License</a> •
   <a href="/changes.md">Change Log / Roadmap</a> •
   <a href="/CODE_OF_CONDUCT.md">Code of Conduct</a>
@@ -33,6 +34,7 @@ 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
 
 ## Redis
@@ -65,7 +67,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. 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.
+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'
@@ -91,7 +93,7 @@ run ActionController::Dispatcher.new
 
   - Clear coverage report
 
-    This will clear the coverage data. This wipes out all collected data. 
+    This will clear the coverage data. This wipes out all collected data.
 
   - Clear individual file coverage
 
@@ -128,10 +130,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.
 
@@ -298,6 +306,8 @@ rake coverband:coverage      # report runtime coverband code coverage
 
 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.
 
+**NOTE:** That any value set for `COVERBAND_DISABLE_AUTO_START` is considered true, it does not match the string content but only checks the presence of the ENV variable.
+
 In order to start coverband manually yourself when this flag is enabled, call `Coverband.configure` followed by `Coverband.start`.
 
 ```ruby
@@ -327,7 +337,31 @@ If you currently have require: false, remove the 'coverband' string from the req
 gem 'coverband', require: ['alternative_coverband_patch']
 ```
 
-This conflict happens when a ruby method is patched twice, once using module prepend, and once using method aliasing. See this ruby issue for details. The fix is to apply all patches the same way. Coverband by default will apply its patch using prepend, but you can change that to  method aliasing by adding require: ['alternative_coverband_patch'] to the gem line as shown above.
+This conflict happens when a ruby method is patched twice, once using module prepend, and once using method aliasing. See this ruby issue for details. The fix is to apply all patches the same way. Coverband by default will apply its patch using prepend, but you can change that to method aliasing by adding require: ['alternative_coverband_patch'] to the gem line as shown above.
+
+# Newer Features
+
+### Dead Method Scanning (ruby 2.6+)
+
+Rake task that outputs dead methods based on current coverage data:
+
+```
+bundle exec rake coverband:dead_methods
+```
+
+Outputs:
+
+```
+---------------------------------------------------------------------------------------------------
+| file                                  | class           | method                  | line_number |
+| ./config/routes.rb                    | AdminConstraint | matches?                | 20          |
+| ./app/controllers/home_controller.rb  | HomeController  | trigger_jobs            | 8           |
+| ./app/controllers/home_controller.rb  | HomeController  | data_tracer             | 14          |
+| ./app/controllers/posts_controller.rb | PostsController | edit                    | 22          |
+| ./app/controllers/posts_controller.rb | PostsController | destroy_bad_dangerously | 73          |
+---------------------------------------------------------------------------------------------------
+```
+
 
 # Prerequisites
 
@@ -379,7 +413,9 @@ If you submit a change please make sure the tests and benchmarks are passing.
 - **total fail** on front end code, for line for line coverage, because of the precompiled template step basically coverage doesn't work well for `erb`, `slim`, and the like.
   - related it will try to report something, but the line numbers reported for `ERB` files are often off and aren't considered useful. I recommend filtering out .erb using the `config.ignore` option. The default configuration excludes these files
   - **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,23 @@ Will be the fully modern release that drops maintenance legacy support in favor
 
 # Alpha / Beta / Release Candidates
 
-### Coverband 5.0.2
+### Coverband 5.0.4
 
-- ?
+- add support for tracking email view templates/partials
 
 # Released
 
+### Coverband 5.0.3
+
+- fix for non standard root paths for view_tracker thx @markshawtoronto
+- support basic auth for Rack prior to 2.0 thx @kadru
+
+### 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
@@ -71,13 +82,7 @@ Will be the fully modern release that drops maintenance legacy support in favor
   - drops static report support
   - drops gem support
   - only loaded web reporter files when required
-- configuration improvements
-	- improved load order allowing more time for ENV vars (better dotenv, figaro, rails secrets support)
-	- 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
+- configuration improvements - improved load order allowing more time for ENV vars (better dotenv, figaro, rails secrets support) - 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

data/coverband.gemspec

@@ -8,16 +8,18 @@ Gem::Specification.new do |spec|
   spec.name = "coverband"
   spec.version = Coverband::VERSION
   spec.authors = ["Dan Mayer", "Karl Baum"]
-  spec.email = ["dan@mayerdan.com"]
-  spec.description = "Rack middleware to measure production code usage (LOC runtime usage)"
-  spec.summary = "Rack middleware to measure production code usage (LOC runtime usage)"
+  spec.email = %w[dan@mayerdan.com]
+  spec.description =
+    "Rack middleware to measure production code usage (LOC runtime usage)"
+  spec.summary =
+    "Rack middleware to measure production code usage (LOC runtime usage)"
   spec.homepage = "https://github.com/danmayer/coverband"
   spec.license = "MIT"
 
   spec.files = `git ls-files`.split("\n").reject { |f| f.start_with?("docs") }
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = %w[lib]
 
   spec.add_development_dependency "benchmark-ips"
   spec.add_development_dependency "capybara"

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/at_exit.rb

@@ -20,6 +20,9 @@ module Coverband
             # skip reporting
           else
             Coverband.report_coverage
+            # to ensure we track mailer views we now need to report views tracking
+            # at exit as well for rake tasks and background tasks that can trigger email
+            Coverband.configuration.view_tracker&.report_views_tracked
           end
         end
       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}") }
 
         @roots = options.fetch(:roots) { Coverband.configuration.all_root_patterns }
         @roots = @roots.split(",") if @roots.is_a?(String)
@@ -65,18 +63,29 @@ module Coverband
         normalized_views = {}
         views.each_pair do |view, time|
           roots.each do |root|
-            view = view.gsub(/#{root}/, "")
+            view = view.gsub(root, "")
           end
           normalized_views[view] = time
         end
         normalized_views
       end
 
+      def all_views
+        all_views = []
+        target.each do |view|
+          roots.each do |root|
+            view = view.gsub(root, "")
+          end
+          all_views << view
+        end
+        all_views.uniq
+      end
+
       def unused_views
         recently_used_views = used_views.keys
-        all_views = target.reject { |view| recently_used_views.include?(view) }
+        unused_views = all_views.reject { |view| recently_used_views.include?(view) }
         # since layouts don't include format we count them used if they match with ANY formats
-        all_views.reject { |view| view.match(/\/layouts\//) && recently_used_views.any? { |used_view| view.include?(used_view) } }
+        unused_views.reject { |view| view.match(/\/layouts\//) && recently_used_views.any? { |used_view| view.include?(used_view) } }
       end
 
       def as_json

data/lib/coverband/reporters/web.rb

@@ -23,7 +23,8 @@ module Coverband
       def check_auth
         return true unless Coverband.configuration.password
 
-        auth_header = request.get_header("HTTP_AUTHORIZATION")
+        # support rack 1.6.x and rack 2.0 (get_header)
+        auth_header = request.respond_to?(:get_header) ? request.get_header("HTTP_AUTHORIZATION") : request.env["HTTP_AUTHORIZATION"]
         return unless auth_header
 
         Coverband.configuration.password == Base64.decode64(auth_header.split[1]).split(":")[1]

data/lib/coverband/utils/dead_methods.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: ntrue
+
+require "coverband/utils/method_definition_scanner"
+
+module Coverband
+  module Utils
+    module ArrayToTableInConsole
+      refine Array do
+        def to_table
+          column_sizes =
+            reduce([]) { |lengths, row|
+              row.each_with_index.map do |iterand, index|
+                [lengths[index] || 0, iterand.to_s.length].max
+              end
+            }
+          puts head =
+                 "-" * (column_sizes.inject(&:+) + (3 * column_sizes.count) + 1)
+          each do |row|
+            row = row.fill(nil, row.size..(column_sizes.size - 1))
+            row =
+              row.each_with_index.map { |v, i|
+                v.to_s + " " * (column_sizes[i] - v.to_s.length)
+              }
+            puts "| " + row.join(" | ") + " |"
+          end
+          puts head
+        end
+      end
+    end
+
+    class DeadMethods
+      using ArrayToTableInConsole
+      def self.scan(file_path:, coverage:)
+        MethodDefinitionScanner.scan(file_path).reject do |method_definition|
+          method_definition.body.coverage?(coverage)
+        end
+      end
+
+      def self.scan_all
+        coverage = Coverband.configuration.store.coverage
+        coverage.flat_map do |file_path, coverage|
+          scan(file_path: file_path, coverage: coverage["data"])
+        end
+      end
+
+      def self.output_all
+        rows =
+          scan_all.each_with_object(
+            [%w[file class method line_number]]
+          ) { |dead_method, rows|
+            rows <<
+              [
+                dead_method.file_path,
+                dead_method.class_name,
+                dead_method.name,
+                dead_method.first_line_number
+              ]
+          }
+        rows.to_table
+      end
+    end
+  end
+end