coverband 5.0.3 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbff118005d968f8d2158135273f108cbb9b867c9c13d783b5fb8a2220dd5540
-  data.tar.gz: bc7ec947e707d4feaf213a0559f110ae5d11a487ea370f5e9f6a1256c2799701
+  metadata.gz: 87c963a2d00531451c8759262e428dc9a6f46d136639672e4149550facf01da6
+  data.tar.gz: 26b11c7ad8c5fd3f1cd93167b5c9ee1d0118cd984f462702d593680d55995e99
 SHA512:
-  metadata.gz: af026a80339c3047c62c99c6ec47385288fc7a0fd1d295b646abffdd4b74ea48118f01b2caa2ef997d7dc8775ebc047ce9844189065148f82eaea10fb2bf2978
-  data.tar.gz: a4555a8209507c66efc7ba2432bb5b743cc45331fead66f038df9823a85e8a1bbf9401cd9b47a450cfd184ff399d429e193527df6745ec1770b0b0e08a863141
+  metadata.gz: 51e48c5cb61f1dafc5b7f25c57d6a25ecea36579956267f99d1c9b4343a579d469c4d46e6ea32244ebbf91af08ed0dc427653a6aa0b2f1a245995751c2ec46c4
+  data.tar.gz: 25aad7fbe0940710f58f20a64cd2b6364151861ae239c88322253dd567ddb9e2986e8268ec7d3117c8f8de8218f18aa42d04c1dcb9613bdcacff0f157d8237c6

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, 3.0, jruby, jruby-head]
+        redis-version: [4, 5, 6]
+    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,11 +7,8 @@ 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"

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
 
@@ -304,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
@@ -333,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
 
@@ -385,7 +413,6 @@ 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

data/changes.md

@@ -1,73 +1,17 @@
-# Future Roadmap
+### Coverband 5.1.0
 
-### Research Alternative Redis formats
-
-- Look at alternative storage formats for Redis
-  - [redis bitmaps](http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps/)
-  - [redis bitfield](https://stackoverflow.com/questions/47100606/optimal-way-to-store-array-of-integers-in-redis-database)
-- Add support for [zadd](http://redis.io/topics/data-types-intro) so one could determine single call versus multiple calls on a line, letting us determine the most executed code in production.
-
-### Coverband Future...
-
-Will be the fully modern release that drops maintenance legacy support in favor of increased performance, ease of use, and maintainability.
-
-- Release will be aimed as significantly simplifying ease of use
-  - near zero config setup for Rails apps
-  - add built-in support for easy loading via Railties
-  - built in support for activejob, sidekiq, and other common frameworks
-  - reduced configuration options
-- support oneshot
-- drop middleware figure out a way to kick off background without middelware
-- options on reporting
-  - background reporting
-  - or middleware reporting
-- Support for file versions
-  - md5 or release tags
-  - add coverage timerange support
-- Drop Simplecov dependency
-- improved web reporting
-  - lists current config options
-  - eventually allow updating remote config
-  - full theming
-  - list redis data dump for debugging
-- additional adapters: Memcache, S3, and ActiveRecord
-- add articles / podcasts like prontos readme https://github.com/prontolabs/pronto
-- Add detailed Gem usage report, if we collect and send gem usage we can give percentage of gem code used, which should help application developers know when to remove gem dependencies (0%) or perhaps inline single methods for little usage (using <= 5%) for example.
-- add meta data information first seen last recorded to the coverage report views (probably need to drop simplecov for that).
-  - more details in this issue: https://github.com/danmayer/coverband/issues/118
-- Make good video on setup, install, usage
-- 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)
-- 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
-- - display gems that are in loaded with 0 coverage, thanks @kbaum
-
-# Alpha / Beta / Release Candidates
-
-### Coverband 5.0.4
-
-- ?
-
-# Released
+- add support for dead method detection rake task
+- add support for tracking email view templates/partials
 
 ### Coverband 5.0.3
 
-- fix for non standard root paths for view_tracker thx @markshawtoronto 
+- 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 
+- 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
@@ -82,13 +26,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,20 @@ 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.required_ruby_version = '>= 2.3'
 
   spec.add_development_dependency "benchmark-ips"
   spec.add_development_dependency "capybara"

data/lib/coverband.rb

@@ -13,6 +13,7 @@ require "coverband/adapters/redis_store"
 require "coverband/adapters/hash_redis_store"
 require "coverband/adapters/file_store"
 require "coverband/adapters/stdout_store"
+require "coverband/adapters/null_store"
 require "coverband/utils/file_hasher"
 require "coverband/collectors/coverage"
 require "coverband/collectors/view_tracker"

data/lib/coverband/adapters/null_store.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Coverband
+  module Adapters
+    ###
+    # NullStore is for benchmarking the impacts of calculating
+    # and storing coverage data independant of Coverband/Coverage
+    #
+    # Usage:
+    # config.store = Coverband::Adapters::NullStore.new
+    ###
+    class NullStore < Base
+      def initialize(_opts = {})
+        super()
+      end
+
+      def clear!
+        # NOOP
+      end
+
+      def size
+        0
+      end
+
+      def migrate!
+        raise NotImplementedError, "NullStore doesn't support migrations"
+      end
+
+      def coverage(_local_type = nil)
+        {}
+      end
+
+      def save_report(report)
+        # NOOP
+      end
+
+      def raw_store
+        raise NotImplementedError, "NullStore doesn't support raw_store"
+      end
+    end
+  end
+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

@@ -23,7 +23,7 @@ module Coverband
         @ignore_patterns = Coverband.configuration.ignore
         @store = options.fetch(:store) { Coverband.configuration.store }
         @logger = options.fetch(:logger) { Coverband.configuration.logger }
-        @target = options.fetch(:target) { Dir.glob("#{@project_directory}/app/views/**/*.html.{erb,haml,slim}").reject { |file| file.match(/(_mailer)/) }.freeze }
+        @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)

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

data/lib/coverband/utils/method_definition_scanner.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+if defined?(RubyVM::AbstractSyntaxTree)
+  module Coverband
+    module Utils
+      class MethodDefinitionScanner
+        attr_reader :path
+
+        def initialize(path)
+          @path = path
+        end
+
+        def scan
+          scan_node(RubyVM::AbstractSyntaxTree.parse_file(path), nil)
+        end
+
+        def self.scan(path)
+          new(path).scan
+        end
+
+        class MethodBody
+          def initialize(method_definition)
+            @method_definition = method_definition
+          end
+
+          def coverage?(file_coverage)
+            body_coverage =
+              file_coverage[(first_line_number - 1)..(last_line_number - 1)]
+            body_coverage.map(&:to_i).any?(&:positive?)
+          end
+
+          private
+
+          def first_line_number
+            @method_definition.first_line_number + 1
+          end
+
+          def last_line_number
+            @method_definition.last_line_number - 1
+          end
+        end
+
+        class MethodDefinition
+          attr_reader :last_line_number,
+            :first_line_number,
+            :name,
+            :class_name,
+            :file_path
+
+          def initialize(
+            first_line_number:,
+            last_line_number:,
+            name:,
+            class_name:,
+            file_path:
+          )
+            @first_line_number = first_line_number
+            @last_line_number = last_line_number
+            @name = name
+            @class_name = class_name
+            @file_path = file_path
+          end
+
+          def body
+            MethodBody.new(self)
+          end
+        end
+
+        private
+
+        def scan_node(node, class_name)
+          definitions = []
+          return definitions unless node.is_a?(RubyVM::AbstractSyntaxTree::Node)
+          current_class = node.type == :CLASS ? node.children.first.children.last : class_name
+          if node.type == :DEFN
+            definitions <<
+              MethodDefinition.new(
+                first_line_number: node.first_lineno,
+                last_line_number: node.last_lineno,
+                name: node.children.first,
+                class_name: current_class,
+                file_path: path
+              )
+          end
+          definitions + scan_children(node, current_class)
+        end
+
+        def scan_children(node, current_class)
+          node.children.flatten.compact.map { |child|
+            scan_node(child, current_class)
+          }.flatten
+        end
+      end
+    end
+  end
+end

data/lib/coverband/utils/railtie.rb

@@ -21,7 +21,7 @@ module Coverband
 
     config.after_initialize do
       unless Coverband.tasks_to_ignore?
-        Coverband.configure
+        Coverband.configure unless Coverband.configured?
         Coverband.eager_loading_coverage!
         Coverband.report_coverage
         Coverband.runtime_coverage!
@@ -50,6 +50,7 @@ module Coverband
     config.before_configuration do
       unless ENV["COVERBAND_DISABLE_AUTO_START"]
         begin
+          Coverband.configure unless Coverband.configured?
           Coverband.start
         rescue Redis::CannotConnectError => error
           Coverband.configuration.logger.info "Redis is not available (#{error}), Coverband not configured"

data/lib/coverband/utils/tasks.rb

@@ -9,11 +9,25 @@ namespace :coverband do
     Coverband::Reporters::ConsoleReport.report(Coverband.configuration.store)
   end
 
+  if defined?(RubyVM::AbstractSyntaxTree)
+    require "coverband/utils/dead_methods"
+
+    desc "Output all dead methods"
+    task :dead_methods do
+      Coverband::Utils::DeadMethods.output_all
+    end
+  end
+
   desc "report runtime Coverband code coverage"
   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", 9022).to_i
+    if Rake::Task.task_defined?("environment")
+      Rake.application["environment"].invoke
+    end
+    if Coverband.configuration.store.is_a?(Coverband::Adapters::FileStore)
+      Coverband.configuration.store.merge_mode = true
+    end
+    Rack::Server.start app: Coverband::Reporters::Web.new,
+                       Port: ENV.fetch("COVERBAND_COVERAGE_PORT", 9022).to_i
   end
 
   ###

data/lib/coverband/version.rb

@@ -2,8 +2,8 @@
 
 ###
 # ensure we properly do release candidate versioning; https://github.com/danmayer/coverband/issues/288
-# 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
+# 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.3"
+  VERSION = '5.1.1'
 end

data/roadmap.md

@@ -0,0 +1,56 @@
+# Future Roadmap
+
+### Research Alternative Redis formats
+
+- Look at alternative storage formats for Redis
+  - [redis bitmaps](http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps/)
+  - [redis bitfield](https://stackoverflow.com/questions/47100606/optimal-way-to-store-array-of-integers-in-redis-database)
+- Add support for [zadd](http://redis.io/topics/data-types-intro) so one could determine single call versus multiple calls on a line, letting us determine the most executed code in production.
+
+### Coverband Future...
+
+Will be the fully modern release that drops maintenance legacy support in favor of increased performance, ease of use, and maintainability.
+
+- Release will be aimed as significantly simplifying ease of use
+  - near zero config setup for Rails apps
+  - add built-in support for easy loading via Railties
+  - built in support for activejob, sidekiq, and other common frameworks
+  - reduced configuration options
+- support oneshot
+- drop middleware figure out a way to kick off background without middelware
+- options on reporting
+  - background reporting
+  - or middleware reporting
+- Support for file versions
+  - md5 or release tags
+  - add coverage timerange support
+- Drop Simplecov dependency
+- improved web reporting
+  - lists current config options
+  - eventually allow updating remote config
+  - full theming
+  - list redis data dump for debugging
+- additional adapters: Memcache, S3, and ActiveRecord
+- add articles / podcasts like prontos readme https://github.com/prontolabs/pronto
+- Add detailed Gem usage report, if we collect and send gem usage we can give percentage of gem code used, which should help application developers know when to remove gem dependencies (0%) or perhaps inline single methods for little usage (using <= 5%) for example.
+- add meta data information first seen last recorded to the coverage report views (probably need to drop simplecov for that).
+  - more details in this issue: https://github.com/danmayer/coverband/issues/118
+- Make good video on setup, install, usage
+- 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)
+- 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
+- - display gems that are in loaded with 0 coverage, thanks @kbaum
+
+# Alpha / Beta / Release Candidates
+
+### Coverband 5.?.?

data/test/coverband/adapters/null_store_test.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require File.expand_path("../../test_helper", File.dirname(__FILE__))
+
+class AdaptersNullStoreTest < Minitest::Test
+  def test_covered_lines_when_no_file
+    @store = Coverband::Adapters::NullStore.new("")
+    expected = {}
+    assert_equal expected, @store.coverage
+  end
+
+  describe "Coverband::Adapters::NullStore" do
+    def setup
+      super
+      @store = Coverband::Adapters::NullStore.new(@test_file_path)
+    end
+
+    def test_coverage
+      assert_equal @store.coverage, {}
+    end
+
+    def test_covered_lines_when_null
+      assert_nil @store.coverage["none.rb"]
+    end
+
+    def test_covered_files
+      assert_equal @store.covered_files.include?("dog.rb"), false
+    end
+
+    def test_clear
+      assert_nil @store.clear!
+    end
+
+    def test_save_report
+      @store.send(:save_report, "cat.rb" => [0, 1])
+      assert_equal @store.coverage, {}
+    end
+  end
+end

data/test/coverband/collectors/view_tracker_test.rb

@@ -42,6 +42,16 @@ class ReporterTest < Minitest::Test
     assert_equal [file_path], tracker.used_views.keys
   end
 
+  test "track partials that include the word _mailer in the path" do
+    Coverband::Collectors::ViewTracker.expects(:supported_version?).returns(true)
+    store = fake_store
+    file_path = "#{File.expand_path(Coverband.configuration.root)}/_mailer/file"
+    tracker = Coverband::Collectors::ViewTracker.new(store: store, roots: "dir")
+    tracker.track_views("name", "start", "finish", "id", identifier: file_path)
+    tracker.report_views_tracked
+    assert_equal [file_path], tracker.used_views.keys
+  end
+
   test "ignore partials that include the folder vendor in the path" do
     Coverband::Collectors::ViewTracker.expects(:supported_version?).returns(true)
     store = fake_store

data/test/coverband/utils/dead_methods_test.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require File.expand_path("../../test_helper", File.dirname(__FILE__))
+
+if defined?(RubyVM::AbstractSyntaxTree)
+  require "coverband/utils/dead_methods"
+  module Coverband
+    module Utils
+      class DeadMethodsTest < Minitest::Test
+        attr_accessor :coverband
+
+        def setup
+          super
+          @coverband = Coverband::Collectors::Coverage.instance
+        end
+
+        def test_dog_dead_methods
+          file_path = require_unique_file
+          coverage = [nil, nil, 1, 1, 0, nil, nil]
+          dead_methods =
+            DeadMethods.scan(file_path: file_path, coverage: coverage)
+          assert_equal(1, dead_methods.length)
+          dead_method = dead_methods.first
+          assert_equal(4, dead_method.first_line_number)
+          assert_equal(6, dead_method.last_line_number)
+          assert_equal(file_path, dead_method.file_path)
+        end
+
+        def test_all_dead_methods
+          require_unique_file
+          @coverband.report_coverage
+          dead_methods = DeadMethods.scan_all
+          dead_method = dead_methods.find { |method| method.class_name == :Dog }
+          assert(dead_method)
+          assert_equal(4, dead_method.first_line_number)
+          assert_equal(6, dead_method.last_line_number)
+        end
+
+        def test_output_all
+          require_unique_file
+          @coverband.report_coverage
+          DeadMethods.output_all
+        end
+
+        def test_dog_methods_not_dead
+          file = require_unique_file
+          coverage = [nil, nil, 1, 1, 1, nil, nil]
+          assert_empty(DeadMethods.scan(file_path: file, coverage: coverage))
+        end
+      end
+    end
+  end
+end

data/test/coverband/utils/method_definition_scanner_test.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require File.expand_path("../../test_helper", File.dirname(__FILE__))
+
+if defined?(RubyVM::AbstractSyntaxTree)
+  require "coverband/utils/method_definition_scanner"
+  module Coverband
+    module Utils
+      class MethodBodyTest < Minitest::Test
+        def test_no_method_body_coverage
+          method_body =
+            MethodDefinitionScanner::MethodBody.new(
+              MethodDefinitionScanner::MethodDefinition.new(
+                first_line_number: 4,
+                last_line_number: 6,
+                name: :bark,
+                class_name: :Dog,
+                file_path: "./test/dog.rb"
+              )
+            )
+          refute(method_body.coverage?([nil, nil, 1, 1, 0, nil, 1]))
+        end
+
+        def test_method_body_coverage
+          method_body =
+            MethodDefinitionScanner::MethodBody.new(
+              MethodDefinitionScanner::MethodDefinition.new(
+                first_line_number: 4,
+                last_line_number: 6,
+                name: :bark,
+                class_name: :Dog,
+                file_path: "./test/dog.rb"
+              )
+            )
+          assert(method_body.coverage?([nil, nil, 1, 1, 1, nil, 1]))
+        end
+      end
+
+      class MethodDefinitionScannerTest < Minitest::Test
+        def test_scan
+          method_definitions = MethodDefinitionScanner.scan("./test/dog.rb")
+          assert(method_definitions)
+          assert_equal(1, method_definitions.length)
+          method_definition = method_definitions.first # assert_equal(4, method.first_line)
+          assert_equal(4, method_definition.first_line_number)
+          assert_equal(6, method_definition.last_line_number)
+          assert_equal(:bark, method_definition.name)
+          assert_equal(:Dog, method_definition.class_name)
+        end
+
+        def test_scan_large_class
+          method_definitions =
+            MethodDefinitionScanner.scan("./test/fixtures/casting_invitor.rb")
+          method_first_line_numbers =
+            method_definitions.map(&:first_line_number)
+          assert_equal(
+            [6, 13, 17, 35, 40, 44, 48, 52],
+            method_first_line_numbers
+          )
+          method_last_line_numbers = method_definitions.map(&:last_line_number)
+          assert_equal(
+            [11, 15, 31, 38, 42, 46, 50, 59],
+            method_last_line_numbers
+          )
+          method_names = method_definitions.map(&:name)
+          assert_equal(
+            %i[
+              initialize
+              valid?
+              deliver
+              invalid_invitees
+              invitee_list
+              valid_message?
+              valid_invitees?
+              create_invitation
+            ],
+            method_names
+          )
+          class_names = method_definitions.map(&:class_name)
+          assert_equal(8.times.map { :CastingInviter }, class_names)
+        end
+      end
+    end
+  end
+end

data/test/fixtures/casting_invitor.rb

@@ -0,0 +1,60 @@
+class CastingInviter
+  EMAIL_REGEX = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/
+
+  attr_reader :message, :invitees, :casting
+
+  def initialize(attributes = {})
+    @message = attributes[:message] || ""
+    @invitees = attributes[:invitees] || ""
+    @sender = attributes[:sender]
+    @casting = attributes[:casting]
+  end
+
+  def valid?
+    valid_message? && valid_invitees?
+  end
+
+  def deliver
+    if valid?
+      invitee_list.each do |email|
+        invitation = create_invitation(email)
+        Mailer.invitation_notification(invitation, @message)
+      end
+    else
+      failure_message =
+        "Your #{
+          @casting
+        } message couldn’t be sent. Invitees emails or message are invalid"
+      invitation = create_invitation(@sender)
+      Mailer.invitation_notification(invitation, failure_message)
+    end
+  end
+
+  private
+
+  def invalid_invitees
+    @invalid_invitees ||=
+      invitee_list.map { |item| item unless item.match(EMAIL_REGEX) }.compact
+  end
+
+  def invitee_list
+    @invitee_list ||= @invitees.gsub(/\s+/, "").split(/[\n,;]+/)
+  end
+
+  def valid_message?
+    @message.present?
+  end
+
+  def valid_invitees?
+    invalid_invitees.empty?
+  end
+
+  def create_invitation(email)
+    Invitation.create(
+      casting: @casting,
+      sender: @sender,
+      invitee_email: email,
+      status: "pending"
+    )
+  end
+end

data/test/test_helper.rb

@@ -3,6 +3,7 @@
 original_verbosity = $VERBOSE
 $VERBOSE = nil
 require "rubygems"
+require "pry-byebug" unless ENV["CI"]
 require "simplecov"
 require "coveralls"
 require "minitest/autorun"

data/test/unique_files.rb

@@ -20,10 +20,10 @@ def require_unique_file(file = "dog.rb", variables = {})
   Coverband::Utils::RelativeFileConverter.convert(File.expand_path(temp_file))
 end
 
-@@dogs = 0
 def require_class_unique_file
-  @@dogs += 1
-  require_unique_file("dog.rb.erb", dog_number: @@dogs)
+  @dogs ||= 0
+  @dogs += 1
+  require_unique_file("dog.rb.erb", dog_number: @dogs)
 end
 
 def remove_unique_files

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 5.0.3
+  version: 5.1.1
 platform: ruby
 authors:
 - Dan Mayer
 - Karl Baum
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -270,11 +270,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".jrubyrc"
 - ".standard.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.rails4
 - Gemfile.rails6
@@ -290,6 +293,7 @@ files:
 - lib/coverband/adapters/base.rb
 - lib/coverband/adapters/file_store.rb
 - lib/coverband/adapters/hash_redis_store.rb
+- lib/coverband/adapters/null_store.rb
 - lib/coverband/adapters/redis_store.rb
 - lib/coverband/adapters/stdout_store.rb
 - lib/coverband/adapters/web_service_store.rb
@@ -309,11 +313,13 @@ files:
 - lib/coverband/reporters/html_report.rb
 - lib/coverband/reporters/web.rb
 - lib/coverband/utils/absolute_file_converter.rb
+- lib/coverband/utils/dead_methods.rb
 - lib/coverband/utils/file_hasher.rb
 - lib/coverband/utils/file_list.rb
 - lib/coverband/utils/html_formatter.rb
 - lib/coverband/utils/jruby_ext.rb
 - lib/coverband/utils/lines_classifier.rb
+- lib/coverband/utils/method_definition_scanner.rb
 - lib/coverband/utils/railtie.rb
 - lib/coverband/utils/relative_file_converter.rb
 - lib/coverband/utils/result.rb
@@ -353,6 +359,7 @@ files:
 - public/images/ui-icons_cd0a0a_256x240.png
 - public/loading.gif
 - public/magnify.png
+- roadmap.md
 - test/benchmarks/.gitignore
 - test/benchmarks/benchmark.rake
 - test/benchmarks/coverage_fork.sh
@@ -363,6 +370,7 @@ files:
 - test/coverband/adapters/base_test.rb
 - test/coverband/adapters/file_store_test.rb
 - test/coverband/adapters/hash_redis_store_test.rb
+- test/coverband/adapters/null_store_test.rb
 - test/coverband/adapters/redis_store_test.rb
 - test/coverband/adapters/web_service_store_test.rb
 - test/coverband/at_exit_test.rb
@@ -382,10 +390,12 @@ files:
 - test/coverband/reporters/html_test.rb
 - test/coverband/reporters/web_test.rb
 - test/coverband/utils/absolute_file_converter_test.rb
+- test/coverband/utils/dead_methods_test.rb
 - test/coverband/utils/file_hasher_test.rb
 - test/coverband/utils/file_list_test.rb
 - test/coverband/utils/html_formatter_test.rb
 - test/coverband/utils/lines_classifier_test.rb
+- test/coverband/utils/method_definition_scanner_test.rb
 - test/coverband/utils/relative_file_converter_test.rb
 - test/coverband/utils/result_test.rb
 - test/coverband/utils/results_test.rb
@@ -396,6 +406,7 @@ files:
 - test/fake_app/basic_rack.rb
 - test/fixtures/app/controllers/sample_controller.rb
 - test/fixtures/app/models/user.rb
+- test/fixtures/casting_invitor.rb
 - test/fixtures/never.rb
 - test/fixtures/sample.rb
 - test/fixtures/skipped.rb
@@ -465,7 +476,7 @@ homepage: https://github.com/danmayer/coverband
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -473,15 +484,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Rack middleware to measure production code usage (LOC runtime usage)
 test_files:
@@ -495,6 +506,7 @@ test_files:
 - test/coverband/adapters/base_test.rb
 - test/coverband/adapters/file_store_test.rb
 - test/coverband/adapters/hash_redis_store_test.rb
+- test/coverband/adapters/null_store_test.rb
 - test/coverband/adapters/redis_store_test.rb
 - test/coverband/adapters/web_service_store_test.rb
 - test/coverband/at_exit_test.rb
@@ -514,10 +526,12 @@ test_files:
 - test/coverband/reporters/html_test.rb
 - test/coverband/reporters/web_test.rb
 - test/coverband/utils/absolute_file_converter_test.rb
+- test/coverband/utils/dead_methods_test.rb
 - test/coverband/utils/file_hasher_test.rb
 - test/coverband/utils/file_list_test.rb
 - test/coverband/utils/html_formatter_test.rb
 - test/coverband/utils/lines_classifier_test.rb
+- test/coverband/utils/method_definition_scanner_test.rb
 - test/coverband/utils/relative_file_converter_test.rb
 - test/coverband/utils/result_test.rb
 - test/coverband/utils/results_test.rb
@@ -528,6 +542,7 @@ test_files:
 - test/fake_app/basic_rack.rb
 - test/fixtures/app/controllers/sample_controller.rb
 - test/fixtures/app/models/user.rb
+- test/fixtures/casting_invitor.rb
 - test/fixtures/never.rb
 - test/fixtures/sample.rb
 - test/fixtures/skipped.rb

data/.travis.yml

@@ -1,48 +0,0 @@
-language: ruby
-rvm:
-  - "2.3"
-  - "2.4"
-  - "2.5"
-  - "2.6.1"
-  - "2.7"
-  - jruby-9.2.6.0
-gemfile:
-  - Gemfile
-  - Gemfile.rails4
-  - Gemfile.rails6
-env:
-  global:
-    # --dev improves JRuby startup time
-    # See https://github.com/jruby/jruby/wiki/Improving-startup-time
-    - JRUBY_OPTS="--dev"
-    - JAVA_OPTS="--add-opens java.base/{java.security.cert=ALL-UNNAMED --add-opens java.base/java.security=ALL-UNNAMED --add-opens java.base/java.util.zip=ALL-UNNAMED"
-
-jobs:
-  exclude:
-    - rvm: "2.3"
-      gemfile: Gemfile.rails6
-    - rvm: "2.4"
-      gemfile: Gemfile.rails6
-    - rvm: "2.7"
-      gemfile: Gemfile.rails4
-    - rvm: jruby-9.2.6.0
-      gemfile: Gemfile.rails4
-
-cache:
-  bundler: true
-  directories:
-    - $HOME/lua51
-services:
-  - redis-server
-script:
-  - sudo ./lua/install.sh
-  - $HOME/lua51/bin/busted lua/test/*
-  - bundle exec standardrb
-  - COVERBAND_HASH_REDIS_STORE=t bundle exec rake
-  - COVERBAND_HASH_REDIS_STORE=t bundle exec rake forked_tests
-  - bundle exec rake
-  - bundle exec rake forked_tests
-  # remove this for now as it is flaky
-  # passes locally on 2.3.5 on travis passes sometimes on 2.4 and always on 2.6.1
-  #- bundle exec rake benchmarks:memory
-  - bundle exec rake benchmarks