coverband 4.2.4.rc.1 → 4.2.4.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bab24810b493437a363e010a7a673170bd41f7d4f2e513c337f1955952a4598
-  data.tar.gz: fbc2991ab6802666af9461ce3da1c03c07b1cc9e39a84268bc0b0854df45eb67
+  metadata.gz: 3b7fc3e6e0997909a0db557caf78e6ed4ddbf61441b80b44a35eebd195036fb3
+  data.tar.gz: 1adc60c3e2b7a805fd2c0f2863a1a7ec820593b0a918788fbf1ff18b7cfb9d52
 SHA512:
-  metadata.gz: 146c61b557cee78a7bbf9db9481860c8a8833299d580b9f2d56ab77dbc3780f8f2817fcc96a2200c90e37ba0137718c232c30c762e1482f449e325db1a81871d
-  data.tar.gz: 5c0b7a3d14539f9d65c33c88ecc9c8c42bc17a02c6c10c03e6aadb3433384b75aff6733ab4957b207b905dbd20369429ee6269922f2710856bfa428a4e998abd
+  metadata.gz: 15db51c202c98481732a6092703fab2b83ef929dfbcd1fee0620f9275ec1be208e5f399b06ec29b2162ff2ca399dfa3db37b0e8e0e87c0abe2dd76eaa09fbaa7
+  data.tar.gz: b55cf6a2ef95973910ba21ec4bd6f6fd9172f70c0e77b10dcf62780ac37abbfeaec1d44611ebd9e4f2d1a3ef85a20b5b2869054c385bbd7cee5ce9bf775b1ce5

data/README.md

@@ -67,7 +67,7 @@ See [changelog](https://github.com/danmayer/coverband/blob/master/changes.md).
 
 ## Rails
 
-The Railtie integration means you shouldn't need to do anything 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. 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).
 
 ## Sinatra
 
@@ -114,7 +114,7 @@ The web endpoint is a barebones endpoint that you can either expose direct (afte
 - **force coverage collection:** This triggers coverage collection on the current webserver process
 - **clear coverage report:** This will clear the coverage data. This wipes out all collected data (**dangerous**)
 - View individual file details
-- **clear individual file coverage:** This will clear the details of the file you are looking at. This is helpful if you don't want to loose all Coverage data but made a change that you expect would impact a particular file.
+- **clear individual file coverage:** This will clear the details of the file you are looking at. This is helpful if you don't want to lose all Coverage data but made a change that you expect would impact a particular file.
 
 ### Rake Tasks
 
@@ -278,22 +278,6 @@ rake coverband:clear         # reset coverband coverage data
 rake coverband:coverage      # report runtime coverband code coverage
 ```
 
-### Forcing Coverband to Track Coverage on files loaded during boot `safe_reload_files`
-
-Coverband will report code usage for anything `required` or `loaded` after calling `Coverband.start` which happens automatically when coverband is required. This means some of the files loaded before coverband such as the Rails application.rb will be reported as having no coverage.
-
-The `safe_reload_files` reload option in the configuration options can help to ensure you can track any files regardless of loading before Coverband. For example if I wanted to show the coverage of `config/coverband.rb`, which has to be loaded before calling `Coverband.start`, I could do that by adding that path to the `safe_reload_files` option.
-
-```
-Coverband.configure do |config|
-  # ... a bunch of other options
-  # using the new safe reload to enforce files loaded
-  config.safe_reload_files = ['config/coverband.rb']
-end
-```
-
-By adding any files above you will get reporting on those files as part of your coverage runtime report. The files are reloaded when Coverband first starts, you can also trigger a reload via the web interface.
-
 ### 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.
@@ -386,7 +370,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
-- coverage doesn't show for Rails `config/application.rb` or `config/boot.rb` as they get loaded when loading the Rake environment prior to starting the `Coverage` library. See [reload files section](#forcing-coverband-to-track-coverage-on-files-loaded-during-boot-safe_reload_files).
 
 ### Debugging Redis Store
 

data/lib/coverband/adapters/redis_store.rb

@@ -77,7 +77,9 @@ module Coverband
       def coverage(local_type = nil, opts = {})
         local_type ||= opts.key?(:override_type) ? opts[:override_type] : type
         data = redis.get type_base_key(local_type)
-        data ? JSON.parse(data) : {}
+        data = data ? JSON.parse(data) : {}
+        data.delete_if { |file_path, file_data| file_hash(file_path) != file_data['file_hash'] } unless opts[:skip_hash_check]
+        data
       end
 
       # Note: This could lead to slight race on redis
@@ -86,7 +88,7 @@ module Coverband
       # and the tradeoff has always been acceptable
       def save_report(report)
         data = report.dup
-        data = merge_reports(data, coverage)
+        data = merge_reports(data, coverage(nil, skip_hash_check: true))
         save_coverage(data)
       end
 

data/lib/coverband/collectors/coverage.rb

@@ -71,7 +71,7 @@ module Coverband
       ###
       def track_file?(file)
         @ignore_patterns.none? do |pattern|
-          file.include?(pattern)
+          file.match(pattern)
         end && (file.start_with?(@project_directory) ||
                 (@track_gems &&
                  Coverband.configuration.gem_paths.any? { |path| file.start_with?(path) }))

data/lib/coverband/configuration.rb

@@ -30,6 +30,7 @@ module Coverband
                     'db:drop',
                     'db:seed',
                     'db:setup',
+                    'db:test:prepare',
                     'db:structure:dump',
                     'db:structure:load',
                     'db:version']
@@ -37,7 +38,7 @@ module Coverband
     # Heroku when building assets runs code from a dynamic directory
     # /tmp was added to avoid coverage from /tmp/build directories during
     # heroku asset compilation
-    IGNORE_DEFAULTS = %w[vendor .erb$ .slim$ /tmp internal:prelude schema.rb]
+    IGNORE_DEFAULTS = %w[vendor/ .erb$ .slim$ /tmp internal:prelude schema.rb]
 
     # Add in missing files which were never loaded
     # we need to know what all paths to check for unloaded files
@@ -153,7 +154,7 @@ module Coverband
 
       # by default we ignore vendor where many deployments put gems
       # we will remove this default if track_gems is set
-      @ignore.delete('vendor')
+      @ignore.delete('vendor/')
       # while we want to allow vendored gems we don't want to track vendored ruby STDLIB
       @ignore << 'vendor/ruby-*' unless @ignore.include?('vendor/ruby-*')
       add_group('App', root)

data/lib/coverband/version.rb

@@ -5,5 +5,5 @@
 # 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 = '4.2.4.rc.1'
+  VERSION = '4.2.4.rc.2'
 end

data/test/coverband/adapters/hash_redis_store_test.rb

@@ -123,7 +123,6 @@ class HashRedisStoreTest < Minitest::Test
     assert_equal [0, nil, 1, 2], @store.coverage['./dog.rb']['data']
     @store.instance_eval { @file_hash_cache = {} }
     mock_file_hash(hash: '123')
-    $debug = true
     assert_nil @store.coverage['./dog.rb']
   end
 

data/test/coverband/adapters/redis_store_test.rb

@@ -36,6 +36,14 @@ unless ENV['COVERBAND_HASH_REDIS_STORE']
       assert current_time <= @store.coverage['app_path/dog.rb']['last_updated_at']
     end
 
+    def test_file_hash_change
+      mock_file_hash(hash: 'abc')
+      @store.save_report('app_path/dog.rb' => [0, nil, 1, 2])
+      assert_equal [0, nil, 1, 2], @store.coverage['app_path/dog.rb']['data']
+      mock_file_hash(hash: '123')
+      assert_nil @store.coverage['app_path/dog.rb']
+    end
+
     def test_store_coverage_by_type
       mock_file_hash
       expected = basic_coverage

data/test/coverband/collectors/coverage_test.rb

@@ -82,6 +82,15 @@ class CollectorsCoverageTest < Minitest::Test
     assert_equal false, @coverband.send(:track_file?, heroku_build_file)
   end
 
+  # verifies a fix where we were storing, merging, and tracking ignored files
+  # then just filtering them out of the final report
+  test 'ignores uses regex same as reporter does' do
+    regex_file = Coverband.configuration.current_root + '/config/initializers/fake.rb'
+    assert_equal true, @coverband.send(:track_file?, regex_file)
+    @coverband.instance_variable_set(:@ignore_patterns, ['config/initializers/*'])
+    assert_equal false, @coverband.send(:track_file?, regex_file)
+  end
+
   test 'one shot line coverage disabled for ruby >= 2.6' do
     return unless Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
 

data/test/coverband/collectors/view_tracker_test.rb

@@ -32,6 +32,26 @@ class ReporterTest < Minitest::Test
     assert_equal [file_path], tracker.logged_views
   end
 
+  test 'track partials that include the word vendor in the path' do
+    Coverband::Collectors::ViewTracker.expects(:supported_version?).returns(true)
+    store = fake_store
+    file_path = "#{File.expand_path(Coverband.configuration.root)}/vendor_relations/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
+    file_path = "#{File.expand_path(Coverband.configuration.root)}/vendor/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 Hash.new, tracker.used_views
+  end
+
   test 'track layouts' do
     Coverband::Collectors::ViewTracker.expects(:supported_version?).returns(true)
     store = fake_store

data/test/coverband/configuration_test.rb

@@ -18,7 +18,7 @@ class BaseTest < Minitest::Test
 
   test 'ignore works with equal' do
     coverband = Coverband::Collectors::Coverage.instance.reset_instance
-    expected = ['vendor', '.erb$', '.slim$', '/tmp', 'internal:prelude', 'schema.rb', 'config/envionments']
+    expected = ['vendor/', '.erb$', '.slim$', '/tmp', 'internal:prelude', 'schema.rb', 'config/envionments']
     assert_equal expected, Coverband.configuration.ignore
   end
 
@@ -27,7 +27,7 @@ class BaseTest < Minitest::Test
       config.ignore += ['config/initializers']
     end
     coverband = Coverband::Collectors::Coverage.instance.reset_instance
-    expected = ['vendor',
+    expected = ['vendor/',
                 '.erb$',
                 '.slim$',
                 '/tmp',

data/test/rails5_dummy/config/coverband.rb

@@ -3,7 +3,7 @@
 Coverband.configure do |config|
   config.root              = Dir.pwd
   config.store             = Coverband::Adapters::RedisStore.new(Redis.new(db: 2, url: ENV['REDIS_URL']), redis_namespace: 'coverband_test') if defined? Redis
-  config.ignore            = %w[vendor .erb$ .slim$]
+  config.ignore            = %w[.erb$ .slim$]
   config.root_paths        = []
   config.logger            = Rails.logger
   config.verbose           = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 4.2.4.rc.1
+  version: 4.2.4.rc.2
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-20 00:00:00.000000000 Z
+date: 2019-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3