coverband 4.2.5 → 5.0.0.rc.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c2fdaf2248e86dd0c59b8d7926bd83a992069fe6e638711efd3a01077e2575b
-  data.tar.gz: 0d8ffca83bae42e7fd765670c3b9ea7581565e3ff6239a9b4db3439676240050
+  metadata.gz: c83a78e28c79671ef144ffa38e40ee061a873ef6a207437f01923188c17d3cf0
+  data.tar.gz: 80a3c0a46cfb55a5972139e034733d9fb6541f0d547caff1f004203b9ddb0484
 SHA512:
-  metadata.gz: 60f57e795d4bd9b4fca1dd40bf739b26f0efd8ff6779901763ce74a01d3f0c9672c2f0a72c5cac151a6b5906311b9a64fcadd69a39d00f82a6ec8bc7a2e2cded
-  data.tar.gz: 0654e82634038d1a734c815780a1dac3bbc44add9e65f97ba5ed5f2024d328e96f9ca16e7467d3b5d58045370e8516a02480587b0ecb31a7f84960f9cd961eff
+  metadata.gz: 0b2f9965e62d911acc562c73df79f4ba13ca0df48bb18258a9069b71d3323f9167385b11fe25772d32d23575338e98e04f721dd57f6562ca40171e39f1cae591
+  data.tar.gz: 6ca2447bbddf8ac8bd6a92e4544a2e38b5a7bf84d49e9e02230ef3a2e0044436ce70d9907dad8a7d163cf909369ad4f089af49bb6a50da5b62982e3001aa48bd

data/.standard.yml

@@ -0,0 +1,25 @@
+ruby_version: 2.3
+fix: false # default: false
+parallel: true # default: false
+format: progress # default: Standard::Formatter
+default_ignores: false # default: true
+
+ignore: # default: []
+  - "lib/**/*":
+      - Style/IdenticalConditionalBranches # these are just easier to read sometimes
+      - Style/IfInsideElse # these are just easier to read sometimes
+      - Standard/SemanticBlocks # not valid in older Ruby
+      - Style/Alias # This isn't always right and alias and alias_method can have different usage
+      - Style/RedundantRegexpEscape # fix later, enforcement changed
+      - Layout/ArrayAlignment # WTF all of master broken from a few changes in rubo
+      - Performance/RegexpMatch # Rubocop / standardrb have this WRONG for Ruby 2.3/2.4 not compatiable
+  - "vendor/**/*"
+  - "pkg/**/*"
+  - "test/**/*":
+      - Layout/AlignHash
+      - Style/GlobalVars
+      - Lint/InterpolationCheck # a test is verifying comments
+      - Standard/SemanticBlocks # not valid in older Ruby
+      - Layout/ArrayAlignment # ruby 2.3 / modern seem to dissagree on rubocop/standardrb
+  - "test/benchmarks/benchmark.rake":
+      - Lint/UselessAssignment # oddity of memory benchmarking

data/.travis.yml

@@ -15,6 +15,7 @@ env:
     # --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:
@@ -36,7 +37,7 @@ services:
 script:
   - sudo ./lua/install.sh
   - $HOME/lua51/bin/busted lua/test/*
-  - bundle exec rake rubocop
+  - bundle exec standardrb
   - COVERBAND_HASH_REDIS_STORE=t bundle exec rake
   - COVERBAND_HASH_REDIS_STORE=t bundle exec rake forked_tests
   - bundle exec rake

data/Gemfile

@@ -1,21 +1,19 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
 
 # add when debugging
 # require 'byebug'; byebug
-if ENV['CI']
+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]
+  gem "pry-byebug", platforms: [:mri, :mingw, :x64_mingw]
 end
 
-gem 'rails', '~>5'
+gem "rails", "~>5"
 # these gems are used for testing gem tracking
-gem 'irb', require: false
-gem 'pundit'
-gem 'rainbow', require: false
+gem "irb", require: false

data/Gemfile.rails4

@@ -5,6 +5,3 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
 gem 'rails', '~>4'
-# this is used for testing gem tracking
-gem 'rainbow', require: false
-gem 'pundit'

data/Gemfile.rails6

@@ -5,6 +5,3 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
 gem 'rails', '~>6'
-# this is used for testing gem tracking
-gem 'rainbow', require: false
-gem 'pundit'

data/README.md

@@ -30,7 +30,6 @@ The primary goal of Coverband is giving deep insight into your production runtim
 - Out of the box support for all standard code execution paths (web, cron, background jobs, rake tasks, etc)
 - Splits load time (Rails eager load) and Run time metrics
 - Easy to understand actionable insights from the report
-- Tracks Gem usage (still in experimental stages and not recommended for production)
 - 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
 
@@ -54,8 +53,6 @@ Add this line to your application's `Gemfile`, remember to `bundle install` afte
 gem 'coverband'
 ```
 
-If [tracking gem usage](#collecting-gem--library-usage), be sure to include coverband before other gems you would like to track.
-
 ## Upgrading to Latest
 
 ### No custom code or middleware required
@@ -66,7 +63,7 @@ See [changelog](https://github.com/danmayer/coverband/blob/master/changes.md).
 
 ## Rails
 
-The Railtie integration means you shouldn't need to do anything else other than ensure coverband is required after rails within your Gemfile. The only exception to this is gem tracking of `Bundle.require` which depends on requiring coverband within the application.rb. See [Collecting Gem / Library Usage](https://github.com/danmayer/coverband#collecting-gem--library-usage).
+The Railtie integration means you shouldn't need to do anything else other than ensure Coverband is required after Rails within your Gemfile.
 
 ## Sinatra
 
@@ -117,14 +114,14 @@ The web endpoint is a barebones endpoint that you can either expose direct (afte
 
 ### JRuby Support
 
-Coverband is compatible with JRuby. If you want to run on JRuby note that I haven't benchmarked and I believe the perf impact on oldre versions of JRuby could be significant, improved Coverage support is in [JRuby master](https://github.com/jruby/jruby/pull/6180), and will be in the next release.
+Coverband is compatible with JRuby. If you want to run on JRuby note that I haven't benchmarked and I believe the perf impact on older versions of JRuby could be significant, improved Coverage support is in [JRuby master](https://github.com/jruby/jruby/pull/6180), and will be in the next release.
 
-* older versions of JRuby need tracing enabled to work (and this could cause bad performance)
-  * run Jruby with the `--debug` option
-  * add into your `.jrubyrc` the `debug.fullTrace=true` setting
-* For best performance the `oneshot_lines` is recommended, and in the latest releases should have very low overhead
-* See JRuby support in a Rails app configured to run via JRuby, in [Coverband Demo](https://github.com/coverband-service/coverband_demo)
-* JRuby is tested via CI against Rails 5 and 6 
+- older versions of JRuby need tracing enabled to work (and this could cause bad performance)
+  - run Jruby with the `--debug` option
+  - add into your `.jrubyrc` the `debug.fullTrace=true` setting
+- For best performance the `oneshot_lines` is recommended, and in the latest releases should have very low overhead
+- See JRuby support in a Rails app configured to run via JRuby, in [Coverband Demo](https://github.com/coverband-service/coverband_demo)
+- JRuby is tested via CI against Rails 5 and 6
 
 ### Rake Tasks
 
@@ -168,11 +165,6 @@ Below is an example config file for a Rails 5 app:
 Coverband.configure do |config|
   config.store = Coverband::Adapters::RedisStore.new(Redis.new(url: ENV['MY_REDIS_URL']))
   config.logger = Rails.logger
-  # configure S3 integration
-  config.s3_bucket = 'coverband-demo'
-  config.s3_region = 'us-east-1'
-  config.s3_access_key_id = ENV['AWS_ACCESS_KEY_ID']
-  config.s3_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
 
   # config options false, true. (defaults to false)
   # true and debug can give helpful and interesting code usage information
@@ -228,27 +220,6 @@ To opt-in to this feature... enable the feature in your Coverband config.
 
 ![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_view_tracker.png)
 
-### Writing Coverband Results to S3
-
-If you add some additional Coverband configuration your coverage html report will be written directly to S3, update `config/coverband.rb` like below.
-
-```
-  # configure S3 integration
-  config.s3_bucket = 'coverband-demo'
-  config.s3_region = 'us-east-1'
-  config.s3_access_key_id = ENV['AWS_ACCESS_KEY_ID']
-  config.s3_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
-```
-
-Alternatively, Coverband if you don't set via the `config.s3_*` accessor methods will look for the standard S3 environment variables.
-
-```
-ENV['AWS_BUCKET']
-ENV['AWS_REGION']
-ENV['AWS_ACCESS_KEY_ID']
-ENV['AWS_SECRET_ACCESS_KEY']
-```
-
 ### Fixing Coverage Only Shows Loading Hits
 
 If all your coverage is being counted as loading or eager_loading coverage, and nothing is showing as runtime Coverage the initialization hook failed for some reason. The most likely reason for this issue is manually calling `eager_load!` on some Plugin/Gem. If you or a plugin is altering the Rails initialization process, you can manually flip Coverband to runtime coverage by calling these two lines, in an `after_initialize` block, in `application.rb`.
@@ -322,46 +293,6 @@ rake coverband:clear         # reset coverband coverage data
 rake coverband:coverage      # report runtime coverband code coverage
 ```
 
-### Collecting Gem / Library Usage
-
-**WARNING:** Gem Tracking is still in experimental stages and not recommended for production. We have some performance issues when view reports on large applications. Gem tracing also during background thread data collection has HIGH memory requirements, during report merging (seemingly around 128mb of extra memory, which is crazy). We recommend deploying WITHOUT `track_gems` first and only enabling it after confirming that Coverband is working and performing well.
-
-Gem usage can be tracked by enabling the `track_gems` config.
-
-```
-Coverband.configure do |config|
-  config.track_gems = true
-end
-```
-
-The `track_gems` feature exposes a Gems tab in the report which prints out the percentage usage of each Gem. See demo [here](https://coverband-demo.herokuapp.com/coverage?#_Gems).
-
-When tracking gems, it is important that `Coverband#start` is called before the gems to be tracked are required. The best way to do this is to require coverband before Bundle.require is called. Within rails, require coverband within the application.rb like so:
-
-```ruby
-require 'coverband'
-Bundler.require(*Rails.groups)
-```
-
-If you are using the resque integration, resque needs to be required before coverband since the integration will not run unless resque is loaded. Within the application.rb just require resque before coverband.
-
-```ruby
-require 'resque'
-require 'coverband'
-Bundler.require(*Rails.groups)
-```
-
-The track_gems config only exposes the overall usage of a gem. In order to see the detail of each file, enable the `gem_details` flag.
-
-```
-Coverband.configure do |config|
-  config.track_gems = true
-  config.gem_details = true
-end
-```
-
-This flag exposes line by line usage of gem files. Unfortunately due to the way the coverband report is currently rendered, enabling `gem_details` slows down viewing of the coverage report in the browser and is not yet recommended.
-
 ### Manually Starting Coverband
 
 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.
@@ -381,6 +312,22 @@ Note: To debug issues getting Coverband working. I recommend running in developm
 
 If you are trying to debug locally wondering what code is being run during a request. The verbose modes `config.verbose = true` && `Rails.logger.level = :debug`. With true set it will output the number of lines executed per file, to the passed in log.
 
+### Solving: stack level too deep errors
+
+If you start seeing SystemStackError: stack level too deep errors from background jobs after installing Coverband, this means there is another patch for ResqueWorker that conflicts with Coverband's patch in your application. To fix this, change coverband gem line in your Gemfile to the following:
+
+```
+gem 'coverband', require: ['alternative_coverband_patch', 'coverband']
+```
+
+If you currently have require: false, remove the 'coverband' string from the require array above so the gem line becomes like this:
+
+```
+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.
+
 # Prerequisites
 
 - Coverband 3.0.X+ requires Ruby 2.3+

data/Rakefile

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-import 'test/benchmarks/benchmark.rake'
-require 'rubocop/rake_task'
+require "bundler/gem_tasks"
+import "test/benchmarks/benchmark.rake"
+require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
@@ -11,40 +11,40 @@ task default: %i[test]
 task 'test:all': %i[rubocop test forked_tests benchmarks:memory benchmarks]
 
 task :test
-require 'rake/testtask'
+require "rake/testtask"
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
+  test.libs << "lib" << "test"
   # exclude benchmark from the tests as the way it functions resets code coverage during executions
   # test.pattern = 'test/unit/*_test.rb'
   # using test files opposed to pattern as it outputs which files are run
-  test.test_files = FileList['test/integration/**/*_test.rb', 'test/coverband/**/*_test.rb']
+  test.test_files = FileList["test/integration/**/*_test.rb", "test/coverband/**/*_test.rb"]
   test.verbose = true
 end
 
 Rake::TestTask.new(:forked_tests) do |test|
-  if RUBY_PLATFORM == 'java'
-    puts 'forked tests not supported on JRuby'
+  if RUBY_PLATFORM == "java"
+    puts "forked tests not supported on JRuby"
   else
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList['test/forked/**/*_test.rb']
+    test.libs << "lib" << "test"
+    test.test_files = FileList["test/forked/**/*_test.rb"]
     test.verbose = true
   end
 end
 
-desc 'load irb with this gem'
+desc "load irb with this gem"
 task :console do
-  puts 'running console'
-  exec 'bundle console'
+  puts "running console"
+  exec "bundle console"
 end
 
 # This is really just for testing and development because without configuration
 # Coverband can't do much
-desc 'start webserver'
+desc "start webserver"
 task :server do
-  exec 'rackup -I lib'
+  exec "rackup -I lib"
 end
 
-desc 'publish gem with 2 factor auth, reminder how'
+desc "publish gem with 2 factor auth, reminder how"
 task :publish_gem do
-  exec 'gem push pkg/coverband-4.2.3.XXX.gem'
+  exec "gem push pkg/coverband-4.2.3.XXX.gem"
 end

data/changes.md

@@ -7,7 +7,7 @@
   - [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 4.X
+### Coverband Future...
 
 Will be the fully modern release that drops maintenance legacy support in favor of increased performance, ease of use, and maintainability.
 
@@ -51,42 +51,40 @@ Will be the fully modern release that drops maintenance legacy support in favor
 - add gem_details_safe list to report on details on some gems
 - - display gems that are in loaded with 0 coverage, thanks @kbaum
 
-### Coverband_jam_session
-
-This is a possible gem to host experimental or more complex features, which would require tuning, configuration, and performance trade offs. If something is really valuable it could be promoted into the main line.
-
-Feature Ideas:
-
-- per request coverage implemented via Ruby 2.6.0 coverage.clear https://bugs.ruby-lang.org/issues/15022
-- statsd adapters (it would allow passing in date ranges on usage)
-- Possibly add ability to record code run for a given route
-- integrate recording with deploy tag or deploy timestamp
-  - diff code usage across deployed versions
-  - what methods increased usage or decreased
-- ability to change the Coverband config at runtime by changing the config pushed to the Redis hash. In memory cache around the changes to only make that call periodically.
-- Opposed to just showing code usage on a route allow 'tagging' events which would record line coverage for that tag (this would allow tagging all code that modified an ActiveRecord model for example
-- additional adapters (tracepoint, ruby-profiler, etc)
-- tagged coverage reports
-  - code route tracing (entry point to all code executed for example /some_path -> code coverage of that path)
-  - deploy git hash tagging of reported Coverage
-  - allow only to collect coverage based on route (limiting or scoped coverage)
-  - coverage over some other variable like a set of alpha users
-- document how to use this on staging / selenium test suite runs
-  - possible add API to pull report at end of run
-
 # Alpha / Beta / Release Candidates
 
 ### Coverband 5.0.0
 
-- ?
+- Full JRuby support
+- Reduced footprint
+  - drops S3 support
+  - drops static report support
+  - drops gem support
+  - only loaded web reporter files when required
+- improved load order allowing more time for ENV vars (better dotenv, figaro, rails secrets support)
+- improved resque patching pattern
+- improved default ignores
+- additional adapters
+  - supports web-service adapter for http coverage collection
+  - support log/file adapter
+- reduce logs / errors / alerts on bad startup configurations
 
 # Released
 
+###Coverband 4.2.7
+
+- Ignore patterns too aggressive #382, thanks @thijsnado
+- Stack level too deep error when running certain activejob jobs #367, thanks @kejordan and @hanslauwers
+
+###Coverband 4.2.6
+
+- Address Redis exists deprecation warning by baffers
+
 ### Coverband 4.2.5
 
-* alpha support of jRuby
-* fix for rails 4.0 by rswaminathan
-* do not error on branch coverage / simplecov compatibility by desertcart
+- alpha support of jRuby
+- fix for rails 4.0 by rswaminathan
+- do not error on branch coverage / simplecov compatibility by desertcart
 
 ### Coverband 4.2.4
 
@@ -110,19 +108,18 @@ Feature Ideas:
 - improved messaging around non-loaded files
 - fix on last updated nil issue
 - view tracker improvements
-   - clear all
-   - reset individual file
-   - timestamps on last seen activity
-
+  - clear all
+  - reset individual file
+  - timestamps on last seen activity
 
 ### Coverband 4.2.2
 
 - new experimental hash redis store for high volume collection
-(hundreds of clients), thanks @kbaum
+  (hundreds of clients), thanks @kbaum
 - view_tracker supports tracking view layer files like `.html.erb`
 - documentation improvements, thanks @brossetti1, @jjb, @kbaum
 - we now have discordapp for discussions, thanks @kbaum,
-https://discordapp.com/channels/609509533999562753/609509533999562756
+  https://discordapp.com/channels/609509533999562753/609509533999562756
 - perf fix on Rails initialization, thanks @skangg
 - simplified logging
 

data/config.ru

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require ::File.expand_path('../lib/coverband', __FILE__)
+require ::File.expand_path("../lib/coverband", __FILE__)
 run Coverband::Reporters::Web.new

data/coverband.gemspec

@@ -1,49 +1,45 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'coverband/version'
+require "coverband/version"
 
 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.homepage      = 'https://github.com/danmayer/coverband'
-  spec.license       = 'MIT'
+  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.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.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"]
 
-  # to test support for sdk 1, uncomment this line
-  # spec.add_development_dependency 'aws-sdk', '~> 1'
-  # to test sdk 2 use this one
-  spec.add_development_dependency 'aws-sdk-s3', '~> 1'
-  spec.add_development_dependency 'benchmark-ips'
-  spec.add_development_dependency 'capybara'
-  spec.add_development_dependency 'm'
-  spec.add_development_dependency 'memory_profiler'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'minitest-fork_executor'
-  spec.add_development_dependency 'mocha', '~> 1.7.0'
-  spec.add_development_dependency 'rack'
-  spec.add_development_dependency 'rack-test'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'resque'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "m"
+  spec.add_development_dependency "memory_profiler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-fork_executor"
+  spec.add_development_dependency "mocha", "~> 1.7.0"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "resque"
+  spec.add_development_dependency "standardrb"
 
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'minitest-profile'
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "minitest-profile"
+  spec.add_development_dependency "webmock"
 
   # TODO: Remove when other production adapters exist
   # because the default configuration of redis store, we really do require
   # redis now. I was reluctant to add this, but until we offer another production
   # quality adapter, I think this is more honest about requirements and reduces confusion
   # without this there was a race condition on calling coverband configure before redis was loaded
-  spec.add_runtime_dependency 'redis'
+  spec.add_runtime_dependency "redis"
 end