coverband 5.1.0.rcmailer.2 → 5.2.0.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 356bd2d155bece44c71e186cc25072ede61e25e3e8236c311cd2c160c93fd6b0
-  data.tar.gz: 609ac60c8757360b59ad63051e14357635bd2395b0ba9ba09add3140505415c7
+  metadata.gz: 4ede2aae4c544308de7eff72d8b0b5b4f6affc9d5802a298073ecc094c31603a
+  data.tar.gz: b508d4d3fbc9f32b034ae1d82bed9884f71db9ce2bb0a0fb8903d01e1af73f05
 SHA512:
-  metadata.gz: 929208aaadba979be02db9eb55153f91515c14bed94c94de7115255ea89413b87547518a6bbf11f250df506f8604dd1f64c9582b6536a4595943fd2692736776
-  data.tar.gz: 37ca9ec442e80223284a4b5e9ec6234d1fbff014270f7b9e905db71a9c7513e700a07417f47a123ecbc4b561b0adc075f2e68dd328763599c0f8b2676c555d08
+  metadata.gz: 2f2271547dc6da0ba6ab2f738b494419d5944e040bb248d2fddeff317459ab358a6d72a8922a85484b6c47dd1c189be6e4101f0333b5bec370cb285df082e88c
+  data.tar.gz: e0090c22100ab00c72657bb782590c19b8b20ebd3d3a2ccd8dcf20a3b11a51b4368b602deb2f324050e9274172325f6743f1601609b3d1358c1d284ff185edf3

data/.github/workflows/diagram.yml

@@ -0,0 +1,16 @@
+name: Create diagram
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - main
+jobs:
+  get_data:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@master
+      - name: Update diagram
+        uses: githubocto/repo-visualizer@main
+        with:
+          excluded_paths: "ignore,.github"

data/.github/workflows/main.yml

@@ -3,9 +3,9 @@ name: CI
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
-    branches: [master]
+    branches: [main]
   pull_request:
-    branches: [master]
+    branches: [main]
 jobs:
   test:
     strategy:
@@ -17,12 +17,12 @@ jobs:
         # 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]
+        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: supercharge/redis-github-action@1.2.0
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

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

@@ -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
@@ -282,7 +284,7 @@ Between the release of 4.0 and 4.1 our data format changed. This resets all your
 
 ### Adding Rake Tasks outside of Rails
 
-Rails apps should automaticallly include the tasks via the Railtie.
+Rails apps should automatically include the tasks via the Railtie.
 
 For non Rails apps, either add the below to your `Rakefile` or to a file included in your `Rakefile` such as `lib/tasks/coverband.rake` if you want to break it up that way.
 
@@ -337,6 +339,30 @@ 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.
 
+# 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
 
 - Coverband 3.0.X+ requires Ruby 2.3+
@@ -401,6 +427,12 @@ What is the coverage data in Redis?
 
 `Coverband.configuration.store.coverage`
 
+### Diagram
+
+A diagram of the code.
+
+![Visualization of this repo](./diagram.svg)
+
 ## Logo
 
 The Coverband logo was created by [Dave Woodall](http://davewoodall.com). Thanks Dave!

data/changes.md

@@ -1,73 +1,32 @@
-# Future Roadmap
+### Coverband 5.2.0
 
-### Research Alternative Redis formats
+- (Fumiaki MATSUSHIMA) Fix CI setting for Ruby 3.0
+- (Fumiaki MATSUSHIMA) Avoid calling coverage with the same type twice on get_coverage_report
+- (kei-s) Fix filling zero for not loaded files
+- (wonda-tea-coffee) cleanup readme / fix typos
+- support deferred eager loading data
+- (Donatas Stundys) Fix disabling views tracking
+- (Simon) Improve View tracker to track render collection too
 
-- 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 5.1.1
 
-### Coverband Future...
+- Fix early report error
+- Improved view tracker perf Hosam Aly
 
-Will be the fully modern release that drops maintenance legacy support in favor of increased performance, ease of use, and maintainability.
+### Coverband 5.1.0
 
-- 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 +41,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
@@ -155,7 +108,7 @@ Will be the fully modern release that drops maintenance legacy support in favor
 - larger changes
   - reduce memory usage
   - fix issue where reports didn't include files with 0 activity
-  - updated runtime relavent lines and runtime percentages
+  - updated runtime relevant lines and runtime percentages
   - add Oneshot coverage support for Ruby 2.6.0 thanks @zwalker
   - I would consider this our test oneshot release, please report any issues
   - improved control over memory vs functionality
@@ -187,7 +140,7 @@ Will be the fully modern release that drops maintenance legacy support in favor
 
 ### Coverband 4.2.0
 
-**NOTE:** This release introduces load time and runtime Coverage. To get the full benifit of this feature you need to reset you coverage data (`rake coverband:clear` or clear via the web UI). Until you clear the combined result is still correct, but your runtime data will be mixed with previous data. This is due to an additive change in how we store coverage. We didn't reset by default as the coverage history for some folks may be more important than runtime breakdown.
+**NOTE:** This release introduces load time and runtime Coverage. To get the full benefit of this feature you need to reset you coverage data (`rake coverband:clear` or clear via the web UI). Until you clear the combined result is still correct, but your runtime data will be mixed with previous data. This is due to an additive change in how we store coverage. We didn't reset by default as the coverage history for some folks may be more important than runtime breakdown.
 
 - loadtime vs runtime coverage
   - This fixes the coverage last seen date to exclude just load time data

data/coverband.gemspec

@@ -8,16 +8,28 @@ 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.metadata = {
+    "homepage_uri" => "https://github.com/danmayer/coverband",
+    "bug_tracker_uri" => "https://github.com/danmayer/coverband/issues",
+    "documentation_uri" => "https://github.com/danmayer/coverband",
+    "changelog_uri" => "https://github.com/danmayer/coverband/blob/main/changes.md",
+    "source_code_uri" => "https://github.com/danmayer/coverband",
+  }
 
   spec.add_development_dependency "benchmark-ips"
   spec.add_development_dependency "capybara"