coverband 5.2.3 → 5.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 462b2cd367311f51a377ec76be8d73e4df260b6e473430c5eca87b5f834e6e98
-  data.tar.gz: f62521bd4123a1da8f07988d192e2655767d9357c0929d414d006260f6b32f41
+  metadata.gz: 4da0bd8ef3ca24dee9267fb2caf50081b3f00680c185022f204d55074b92402b
+  data.tar.gz: 8db008aa36f52d25e0a6f8cf07e057176933e88a7d0307c3dd64a5092453a73b
 SHA512:
-  metadata.gz: 48d7f783030a72a077b228d3358ed8cce0d04fd17f3b452efa30f7e6e9ba4b7904eb8c9ed2d2b5c6a54400f41af9e33c9b505c36a350157f9b97626315651233
-  data.tar.gz: 3c6b884f98122c7f5d383ddff9b31e424c4c69e12e13e868bd6c0ddab1a3913525d7d9bb3d832cd4f5fa8e5501c188da6aae957d3b0059f6a4e5cf7a683f3b68
+  metadata.gz: 15675d5cae8e7cc77df685c3696819ccee5d2fc343ca2b1ab15bc0a55cb4ed522fdb9077d457d4743b46a45475204a08e3cc925871d3ec152d267f062e53617a
+  data.tar.gz: 5fcb9ac58c7548c649f28043eb932c0dea9f1250f5f2fdfa8f822c603a6798187b68642b01e4cb7b3cc98e69eb4748a0ff59b148d22ae566855d3646dda27b97

data/.github/workflows/main.yml

@@ -1,5 +1,6 @@
 name: CI
 # Controls when the action will run.
+# Github Actions multiple gemfile support?
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
@@ -17,7 +18,10 @@ jobs:
         # 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]
+        # removing jruby again to flaky
+        # ruby: [2.3, 2.4, 2.5, 2.6, 2.7, "3.0", "3.1", jruby]
+        # need to add support for multiple gemfiles
+        ruby: ["2.7", "3.0", "3.1"]
         redis-version: [4, 5, 6]
     runs-on: ${{ matrix.os }}-latest
     steps:
@@ -27,4 +31,5 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec standardrb
       - run: bundle exec rake

data/Gemfile

@@ -4,15 +4,7 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
-
-# add when debugging
-# require 'byebug'; byebug
-unless ENV["CI"]
-  gem "pry-byebug"
-end
-
-gem "rails", "~>5"
+gem "rails", "~>6"
 gem "haml"
 gem "slim"
-# these gems are used for testing gem tracking
-gem "irb", require: false
+gem "webrick"

data/{Gemfile.rails4 → Gemfile.rails7}

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
-gem 'rails', '~>4'
+gem 'rails', '~>7'
 gem "haml"
 gem "slim"
+gem "webrick"

data/README.md

@@ -29,12 +29,10 @@ The primary goal of Coverband is giving deep insight into your production runtim
 - Low performance overhead
 - Simple setup and configuration
 - 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 runtime metrics
+- Splits code loading usage (Rails eager load) and runtime usage metrics
 - Easy to understand actionable insights from the report
-- 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
@@ -45,7 +43,7 @@ Coverband stores coverage data in Redis. The Redis endpoint is looked for in thi
 2. `ENV['REDIS_URL']`
 3. `localhost:6379`
 
-The redis store can also be explicitly defined within the coverband.rb. See [advanced config](#advanced-config).
+The redis store can also be explicitly defined within the `config/coverband.rb`. See [advanced config](#advanced-config).
 
 ## Gem Installation
 
@@ -162,12 +160,12 @@ Take Coverband for a spin on the live Heroku deployed [Coverband Demo](https://c
 If you need to configure coverband, this can be done by creating a `config/coverband.rb` file relative to your project root.
 
 - See [lib/coverband/configuration.rb](https://github.com/danmayer/coverband/blob/master/lib/coverband/configuration.rb) for all options
-- By default Coverband will try to stored data to Redis \* Redis endpoint is looked for in this order: `ENV['COVERBAND_REDIS_URL']`, `ENV['REDIS_URL']`, or `localhost`
+- By default Coverband will try to store data to Redis \* Redis endpoint is looked for in this order: `ENV['COVERBAND_REDIS_URL']`, `ENV['REDIS_URL']`, or `localhost`
 
 Below is an example config file for a Rails 5 app:
 
 ```ruby
-#config/coverband.rb
+# config/coverband.rb NOT in the initializers
 Coverband.configure do |config|
   config.store = Coverband::Adapters::RedisStore.new(Redis.new(url: ENV['MY_REDIS_URL']))
   config.logger = Rails.logger
@@ -239,7 +237,7 @@ config.after_initialize do
 end
 ```
 
-or if you know you are manually calling eager load anywhere in your initialization process immediately adfter call those two lines. A user reported an issue after calling `ResqueWeb::Engine.eager_load!` for example.
+or if you know you are manually calling eager load anywhere in your initialization process immediately after call those two lines. A user reported an issue after calling `ResqueWeb::Engine.eager_load!` for example.
 
 ```ruby
 Rails.application.routes.draw do
@@ -341,7 +339,7 @@ This conflict happens when a ruby method is patched twice, once using module pre
 
 ### Redis Sizing Info
 
-A few folks have asked about what size of Redis is. needed to run coverband. I have some of our largest services with hundreds of servers on cache.m3.medium with plenty of room to spare. I run most apps on the smallest AWS Redis instances available and bump up only if needed or if I am forced to be on a shared Redis instance, which I try to avoid. On Heroku, I have used it with most of the 3rd party and also been fine on the smallest Redis instances, if you have hundreds of dynos you would likely need to scale up. Also note there is a tradeoff one can make, `Coverband::Adapters::HashRedisStore` will use LUA on Redis and increase the Redis load, while being nicer to your app servers and avoid potential lost data during race conditions. While the `Coverband::Adapters::RedisStore` uses in app memory and merging and has lower load on Redis.
+A few folks have asked about what size of Redis is needed to run coverband. I have some of our largest services with hundreds of servers on cache.m3.medium with plenty of room to spare. I run most apps on the smallest AWS Redis instances available and bump up only if needed or if I am forced to be on a shared Redis instance, which I try to avoid. On Heroku, I have used it with most of the 3rd party and also been fine on the smallest Redis instances, if you have hundreds of dynos you would likely need to scale up. Also note there is a tradeoff one can make, `Coverband::Adapters::HashRedisStore` will use LUA on Redis and increase the Redis load, while being nicer to your app servers and avoid potential lost data during race conditions. While the `Coverband::Adapters::RedisStore` uses in app memory and merging and has lower load on Redis.
 
 # Newer Features
 
@@ -376,7 +374,7 @@ Outputs:
 
 We will match Heroku & Ruby's support lifetime, supporting the last 3 major Ruby releases. For details see [supported runtimes](https://devcenter.heroku.com/articles/ruby-support#supported-runtimes).
 
-For Rails, we will follow the policy of the [Rails team maintenance policy](https://guides.rubyonrails.org/maintenance_policy.html). We officially support the last two major release versions, while providing minimal support (major bugs / security fixes) for an additional version. This means at the moment we primaryly target Rails 6.x, 5.x, and will try to keep current functionality working for Rails 4.x but may release new features that do not work on that target.
+For Rails, we will follow the policy of the [Rails team maintenance policy](https://guides.rubyonrails.org/maintenance_policy.html). We officially support the last two major release versions, while providing minimal support (major bugs / security fixes) for an additional version. This means at the moment we primarily target Rails 6.x, 5.x, and will try to keep current functionality working for Rails 4.x but may release new features that do not work on that target.
 
 ### JRuby Support
 
@@ -420,6 +418,9 @@ If you submit a change please make sure the tests and benchmarks are passing.
 - **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
+- **Coverband, [Elastic APM](https://github.com/elastic/apm-agent-ruby) and resque**
+  - In an environment that uses the Elastic APM ruby agent, resque jobs will fail with `Transactions may not be nested. Already inside #<ElasticAPM::Transaction>` if the `elastic-apm` gem is loaded _before_ the `coverband` gem
+  - Put `coverage` ahead of `elastic-apm` in your Gemfile
 
 ### Debugging Redis Store
 

data/changes.md

@@ -1,3 +1,15 @@
+### Coverband 5.2.5
+
+- (colemanja91/danmayer) experimental support for route tracking, opt-in
+- remove deprecations for old coverband, rails, and ruby versions out of support
+   - Note: official support is now:
+      - Ruby: 2.7.6, 3.0.4, 3.1.2 (min versions)
+      - Rails: 6.0.x, 6.1.x, 7.0.x, 7.1.x
+
+### Coverband 5.2.4
+
+- add install task with example configuration file
+
 ### Coverband 5.2.3
 
 - fix for thread error bubbling up

data/coverband.gemspec

@@ -20,15 +20,15 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w[lib]
-  
-  spec.required_ruby_version = '>= 2.3'
+
+  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",
+    "source_code_uri" => "https://github.com/danmayer/coverband"
   }
 
   spec.add_development_dependency "benchmark-ips"