coverband 4.2.1 → 4.2.2.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0736c0a54102da0309de53707d866be707e72f0c977855bcf69586d281c9d2fe
-  data.tar.gz: 4616a0e6a769500797b89e751d8a8b96fa11ad11237c20bf359d592853e5e194
+  metadata.gz: ca39325a3a42ab0820e60c4162eb0d9aa22d9f2cd0a085cd315aff45445a06a7
+  data.tar.gz: 2695638a09c7e6c673cfaba58cd94f59e8997cdf92ca8067bb565f25d8fa907d
 SHA512:
-  metadata.gz: c16f4e0351ffdd49ba3732c203b9932d4ee2ee8e9890b59f0c8d1e0beafcb2e8632d5a47ffc946248813284ebcac727785ceba3e38a6f041b0f5c000c42870f2
-  data.tar.gz: a1119724f958c01dfdb333efe95ed43acc6f2c1396d24efe7a208d8606e33d8de687d73a1099a3a20d5a37dbcef6b43c4ba36fb9d9d194d0a584e02957fdd016
+  metadata.gz: 830ddef421419a22aa741d53f78b169e9d1d52fe6b30c72757993e09008bc0a07dd733d67e0381b2eea951410e7217fdb6046e6c19901e44fab211334f84859c
+  data.tar.gz: 1df3167a89d98df21658b21b06a7d7c3472b9ccd2eed53b95dc3edf243ee2b066cb780fd9885f823998a09e2deb501a502a3fb73284306318be0539614f63996

data/.travis.yml

@@ -11,18 +11,11 @@ services:
   - redis-server
 script:
   - bundle exec rake rubocop
+  - 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
-before_install:
-  - echo 'this is a hack to clear default bundler and force bundler 1.17.3'
-  - ls /home/travis/.rvm/gems/
-  - rm /home/travis/.rvm/gems/ruby-2.3.7@global/specifications/bundler-2.0.1.gemspec || true
-  - rm /home/travis/.rvm/gems/ruby-2.4.6@global/specifications/bundler-2.0.1.gemspec || true
-  - rm /home/travis/.rvm/gems/ruby-2.5.5@global/specifications/bundler-2.0.1.gemspec || true
-  - gem uninstall bundler || true
-  - gem install bundler -v '1.17.3'
-  - bundler --version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at danmayer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/README.md

@@ -12,7 +12,8 @@
   <a href="#coverage-report">Coverage Report</a> •
   <a href="#advanced-config">Advanced Config</a> •
   <a href="#license">License</a> •
-  <a href="/changes.md">Change Log / Roadmap</a>
+  <a href="/changes.md">Change Log / Roadmap</a> •
+  <a href="/CODE_OF_CONDUCT.md">Code of Conduct</a>
 </p>
 
 A gem to measure production code usage, showing a counter for the number of times each line of code that is executed. Coverband allows easy configuration to collect and report on production code usage. It reports in the background via a thread or can be used as Rack middleware, or manually configured to meet any need.
@@ -161,10 +162,10 @@ Coverband.configure do |config|
   config.s3_access_key_id = ENV['AWS_ACCESS_KEY_ID']
   config.s3_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
 
-  # config options false, true, or 'debug'. Always use false in production
+  # config options false, true. (defaults to false)
   # true and debug can give helpful and interesting code usage information
-  # they both increase the performance overhead of the gem a little.
-  # they can also help with initially debugging the installation.
+  # and is safe to use if one is investigating issues in production, but it will slightly
+  # hit perf.
   config.verbose = false
 end
 ```
@@ -307,27 +308,11 @@ Coverband.start
 
 ### Verbose Debug / Development Mode
 
-Note: To debug issues getting Coverband working. I recommend running in development mode, by turning verbose logging on `config.verbose = true` and passing in the Rails.logger `config.logger = Rails.logger` to the Coverband config. This makes it easy to follow in development mode. Be careful to not leave these on in production as they will affect performance.
+Note: To debug issues getting Coverband working. I recommend running in development mode, by turning verbose logging on `config.verbose = true` and passing in the Rails.logger `config.logger = Rails.logger` to the Coverband config. We respect the log level, and I would recommend log level info generally, but if you are investigating a prolbem Coverband logs additional data at the `debug` level. This makes it easy to follow in development mode. Be careful to not leave these on in production as they will affect performance.
 
 ---
 
-If you are trying to debug locally wondering what code is being run during a request. The verbose modes `config.verbose = true` and `config.verbose = 'debug'` can be useful. With true set it will output the number of lines executed per file, to the passed in log. The files are sorted from least used file to most active file. I have even run that mode in production without much of a problem. The debug verbose mode outputs both file usage and provides the number of calls per line of code. For example if you see something like below which indicates that the `application_helper` has 43150 lines executed. That might seem odd. Then looking at the breakdown of `application_helper` we can see that line `516` was executed 38,577 times. That seems bad, and is likely worth investigating perhaps memoizing or cacheing is required.
-
-    config.verbose = 'debug'
-
-    coverband file usage:
-      [["/Users/danmayer/projects/app_name/lib/facebook.rb", 6],
-      ["/Users/danmayer/projects/app_name/app/models/some_modules.rb", 9],
-      ...
-      ["/Users/danmayer/projects/app_name/app/models/user.rb", 2606],
-      ["/Users/danmayer/projects/app_name/app/helpers/application_helper.rb",
-      43150]]
-
-    file:
-      /Users/danmayer/projects/app_name/app/helpers/application_helper.rb =>
-      [[448, 1], [202, 1],
-      ...
-     [517, 1617], [516, 38577]]
+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.
 
 # Prerequisites
 

data/changes.md

@@ -49,7 +49,7 @@ Will be the fully modern release that drops maintenance legacy support in favor
 - 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 
+- - display gems that are in loaded with 0 coverage, thanks @kbaum
 
 ### Coverband_jam_session
 
@@ -76,6 +76,12 @@ Feature Ideas:
 
 # Alpha / Beta / Release Candidates
 
+### Coverband 4.2.2
+
+- ?
+
+# Released
+
 ### Coverband 4.2.1
 
 - larger changes
@@ -83,14 +89,13 @@ Feature Ideas:
   - fix issue where reports didn't include files with 0 activity
   - updated runtime relavent 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
-     - oneshot support is the best memory and speed if you are on Ruby 2.6.*
-     - simulated_oneshot works for Ruby prior to 2.6.*, keeps lower runtime memory, at a trade of only being able to detect eager_load or runtime hits not both
-     - full hit tracking (The previous and current default), this uses more memory than other options, but provides full robust data
+  - I would consider this our test oneshot release, please report any issues
+  - improved control over memory vs functionality
+    - oneshot support is the best memory and speed if you are on Ruby 2.6.\*
+    - simulated_oneshot works for Ruby prior to 2.6.\*, keeps lower runtime memory, at a trade of only being able to detect eager_load or runtime hits not both
+    - full hit tracking (The previous and current default), this uses more memory than other options, but provides full robust data
 
-
-- small changes fixes
+* small changes fixes
   - further improvements on eager_loading detection, thanks @kbaum
   - fix on ignore configuration options
   - fix broken static server
@@ -112,9 +117,6 @@ Feature Ideas:
   - additional benchmarks to ensure proper memory handling, thanks @kbaum
   - default redis TTL, thanks @jjb
 
-
-# Released
-
 ### 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.

data/coverband.gemspec

@@ -35,12 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'resque'
   spec.add_development_dependency 'rubocop'
-  # temporarily needed to run tests for classifier-reborn as part of benchmarks
-  spec.add_development_dependency 'minitest-reporters'
 
-  # TODO: used for benchmarking and tests I think we have other better benchmarking
-  # perhaps time to drop this and refactor.
-  spec.add_development_dependency 'classifier-reborn'
   spec.add_development_dependency 'coveralls'
   # add when debugging
   # require 'byebug'; byebug

data/lib/coverband/adapters/base.rb

@@ -3,8 +3,6 @@
 module Coverband
   module Adapters
     class Base
-      include Coverband::Utils::FilePathHelper
-
       DATA_KEY = 'data'
       FIRST_UPDATED_KEY = 'first_updated_at'
       LAST_UPDATED_KEY = 'last_updated_at'
@@ -14,7 +12,6 @@ module Coverband
       attr_accessor :type
 
       def initialize
-        @file_hash_cache = {}
         @type = Coverband::RUNTIME_TYPE
       end
 
@@ -46,14 +43,8 @@ module Coverband
         format('%.2f', (size.to_f / 2**20))
       end
 
-      # Note: This could lead to slight race on redis
-      # where multiple processes pull the old coverage and add to it then push
-      # the Coverband 2 had the same issue,
-      # and the tradeoff has always been acceptable
-      def save_report(report)
-        data = report.dup
-        data = merge_reports(data, coverage)
-        save_coverage(data)
+      def save_report(_report)
+        raise 'abstract'
       end
 
       def get_coverage_report
@@ -65,6 +56,10 @@ module Coverband
         coverage.keys || []
       end
 
+      def raw_store
+        raise ABSTRACT_KEY
+      end
+
       protected
 
       def split_coverage(types)
@@ -93,7 +88,7 @@ module Coverband
       end
 
       def file_hash(file)
-        @file_hash_cache[file] ||= Digest::MD5.file(file).hexdigest
+        Coverband::Utils::FileHasher.hash(file)
       end
 
       # TODO: modify to extend report inline?
@@ -108,7 +103,7 @@ module Coverband
             FILE_HASH => file_hash(key),
             DATA_KEY => line_data
           }
-          expanded[full_path_to_relative(key)] = extended_data
+          expanded[Utils::RelativeFileConverter.convert(key)] = extended_data
         end
         expanded
       end

data/lib/coverband/adapters/file_store.rb

@@ -36,13 +36,19 @@ module Coverband
         end
       end
 
+      def save_report(report)
+        data = report.dup
+        data = merge_reports(data, coverage)
+        File.open(path, 'w') { |f| f.write(data.to_json) }
+      end
+
+      def raw_store
+        raise NotImplementedError, "FileStore doesn't support raw_store"
+      end
+
       private
 
       attr_accessor :path
-
-      def save_coverage(report)
-        File.open(path, 'w') { |f| f.write(report.to_json) }
-      end
     end
   end
 end

data/lib/coverband/adapters/hash_redis_store.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module Coverband
+  module Adapters
+    class HashRedisStore < Base
+      FILE_KEY = 'file'
+      FILE_LENGTH_KEY = 'file_length'
+      META_DATA_KEYS = [DATA_KEY, FIRST_UPDATED_KEY, LAST_UPDATED_KEY].freeze
+      ###
+      # This key isn't related to the coverband version, but to the interal format
+      # used to store data to redis. It is changed only when breaking changes to our
+      # redis format are required.
+      ###
+      REDIS_STORAGE_FORMAT_VERSION = 'coverband_hash_3_3'
+
+      attr_reader :redis_namespace
+
+      def initialize(redis, opts = {})
+        super()
+        @redis_namespace = opts[:redis_namespace]
+        @format_version = REDIS_STORAGE_FORMAT_VERSION
+        @redis = redis
+        raise 'HashRedisStore requires redis >= 2.6.0' unless supported?
+
+        @ttl = opts[:ttl] || -1
+        @relative_file_converter = opts[:relative_file_converter] || Utils::RelativeFileConverter
+      end
+
+      def supported?
+        Gem::Version.new(@redis.info['redis_version']) >= Gem::Version.new('2.6.0')
+      end
+
+      def clear!
+        old_type = type
+        Coverband::TYPES.each do |type|
+          self.type = type
+          file_keys = files_set
+          @redis.del(*file_keys) if file_keys.any?
+          @redis.del(files_key)
+        end
+        self.type = old_type
+      end
+
+      def clear_file!(file)
+        file_hash = file_hash(file)
+        relative_path_file = @relative_file_converter.convert(file)
+        Coverband::TYPES.each do |type|
+          @redis.del(key(relative_path_file, type, file_hash: file_hash))
+        end
+        @redis.srem(files_key, relative_path_file)
+      end
+
+      def save_report(report)
+        report_time = Time.now.to_i
+        updated_time = type == Coverband::EAGER_TYPE ? nil : report_time
+        script_id = hash_incr_script
+        @redis.pipelined do
+          keys = report.map do |file, data|
+            relative_file = @relative_file_converter.convert(file)
+            file_hash = file_hash(relative_file)
+            key = key(relative_file, file_hash: file_hash)
+            script_input = save_report_script_input(
+              key: key,
+              file: relative_file,
+              file_hash: file_hash,
+              data: data,
+              report_time: report_time,
+              updated_time: updated_time
+            )
+            @redis.evalsha(script_id, script_input[:keys], script_input[:args])
+            key
+          end
+          @redis.sadd(files_key, keys) if keys.any?
+        end
+      end
+
+      def coverage(local_type = nil)
+        files_set(local_type).each_with_object({}) do |key, hash|
+          add_coverage_for_file(key, hash)
+        end
+      end
+
+      def raw_store
+        @redis
+      end
+
+      private
+
+      def add_coverage_for_file(key, hash)
+        data_from_redis = @redis.hgetall(key)
+
+        return if data_from_redis.empty?
+
+        file = data_from_redis[FILE_KEY]
+        return unless file_hash(file) == data_from_redis[FILE_HASH]
+
+        data = coverage_data_from_redis(data_from_redis)
+        hash[file] = data_from_redis.select { |meta_data_key, _value| META_DATA_KEYS.include?(meta_data_key) }.merge!('data' => data)
+        hash[file].merge!(LAST_UPDATED_KEY => hash[file][LAST_UPDATED_KEY].to_i, FIRST_UPDATED_KEY => hash[file][FIRST_UPDATED_KEY].to_i)
+      end
+
+      def coverage_data_from_redis(data_from_redis)
+        max = data_from_redis[FILE_LENGTH_KEY].to_i - 1
+        Array.new(max + 1) do |index|
+          line_coverage = data_from_redis[index.to_s]
+          line_coverage.nil? ? nil : line_coverage.to_i
+        end
+      end
+
+      def save_report_script_input(key:, file:, file_hash:, data:, report_time:, updated_time:)
+        data.each_with_index
+            .each_with_object(keys: [key], args: [report_time, updated_time, file, file_hash, @ttl, data.length]) do |(coverage, index), hash|
+          if coverage
+            hash[:keys] << index
+            hash[:args] << coverage
+          end
+        end
+      end
+
+      def hash_incr_script
+        @hash_incr_script ||= @redis.script(:load, <<~LUA)
+          local first_updated_at = table.remove(ARGV, 1)
+          local last_updated_at = table.remove(ARGV, 1)
+          local file = table.remove(ARGV, 1)
+          local file_hash = table.remove(ARGV, 1)
+          local ttl = table.remove(ARGV, 1)
+          local file_length = table.remove(ARGV, 1)
+          local hash_key = table.remove(KEYS, 1)
+          redis.call('HMSET', hash_key, '#{LAST_UPDATED_KEY}', last_updated_at, '#{FILE_KEY}', file, '#{FILE_HASH}', file_hash, '#{FILE_LENGTH_KEY}', file_length)
+          redis.call('HSETNX', hash_key, '#{FIRST_UPDATED_KEY}', first_updated_at)
+          for i, key in ipairs(KEYS) do
+            if ARGV[i] == '-1' then
+              redis.call("HSET", hash_key, key, ARGV[i])
+            else
+              redis.call("HINCRBY", hash_key, key, ARGV[i])
+            end
+          end
+          if ttl ~= '-1' then
+            redis.call("EXPIRE", hash_key, ttl)
+          end
+        LUA
+      end
+
+      def values_from_redis(local_type, files)
+        return files if files.empty?
+
+        @redis.mget(*files.map { |file| key(file, local_type) }).map do |value|
+          value.nil? ? {} : JSON.parse(value)
+        end
+      end
+
+      def relative_paths(files)
+        files&.map! { |file| full_path_to_relative(file) }
+      end
+
+      def files_set(local_type = nil)
+        @redis.smembers(files_key(local_type))
+      end
+
+      def files_key(local_type = nil)
+        "#{key_prefix(local_type)}.files"
+      end
+
+      def key(file, local_type = nil, file_hash:)
+        [key_prefix(local_type), file, file_hash].join('.')
+      end
+
+      def key_prefix(local_type = nil)
+        local_type ||= type
+        [@format_version, @redis_namespace, local_type].compact.join('.')
+      end
+    end
+  end
+end

data/lib/coverband/adapters/redis_store.rb

@@ -61,7 +61,7 @@ module Coverband
           exit 0
         end
         relative_path_report = previous_data.each_with_object({}) do |(key, vals), fixed_report|
-          fixed_report[full_path_to_relative(key)] = vals
+          fixed_report[Utils::RelativeFileConverter.convert(key)] = vals
         end
         clear!
         reset_base_key
@@ -80,6 +80,20 @@ module Coverband
         data ? JSON.parse(data) : {}
       end
 
+      # Note: This could lead to slight race on redis
+      # where multiple processes pull the old coverage and add to it then push
+      # the Coverband 2 had the same issue,
+      # and the tradeoff has always been acceptable
+      def save_report(report)
+        data = report.dup
+        data = merge_reports(data, coverage)
+        save_coverage(data)
+      end
+
+      def raw_store
+        @redis
+      end
+
       private
 
       attr_reader :redis

data/lib/coverband/collectors/coverage.rb

@@ -22,8 +22,8 @@ module Coverband
         @project_directory = File.expand_path(Coverband.configuration.root)
         @ignore_patterns = Coverband.configuration.ignore
         @store = Coverband.configuration.store
-        @verbose  = Coverband.configuration.verbose
-        @logger   = Coverband.configuration.logger
+        @verbose = Coverband.configuration.verbose
+        @logger = Coverband.configuration.logger
         @test_env = Coverband.configuration.test_env
         @track_gems = Coverband.configuration.track_gems
         Delta.reset
@@ -55,11 +55,9 @@ module Coverband
           @store.save_report(files_with_line_usage)
         end
       rescue StandardError => e
-        if @verbose
-          @logger.error 'coverage failed to store'
-          @logger.error "error: #{e.inspect} #{e.message}"
-          @logger.error e.backtrace
-        end
+        @logger&.error 'coverage failed to store'
+        @logger&.error "Coverband Error: #{e.inspect} #{e.message}"
+        e.backtrace.each { |line| @logger&.error line } if @verbose
         raise e if @test_env
       end
 

data/lib/coverband/collectors/view_tracker.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module Coverband
+  module Collectors
+    ###
+    # This class tracks view file usage via ActiveSupport::Notifications
+    #
+    # This is a port of Flatfoot, a project I open sourced years ago, but am now rolling into Coverband
+    # https://github.com/livingsocial/flatfoot
+    #
+    # TODO: test and ensure slim, haml, and other support
+    ###
+    class ViewTracker
+      DEFAULT_TARGET = Dir.glob('app/views/**/*.html.erb').reject { |file| file.match(/(_mailer)/) }
+      attr_accessor :target, :logged_views, :views_to_record
+      attr_reader :logger, :roots, :store, :ignore_patterns
+
+      def initialize(options = {})
+        raise NotImplementedError, 'View Tracker requires Rails 4 or greater' unless self.class.supported_version?
+
+        @project_directory = File.expand_path(Coverband.configuration.root)
+        @ignore_patterns = Coverband.configuration.ignore
+        @store = options.fetch(:store) { Coverband.configuration.store }
+        @logger = options.fetch(:logger) { Coverband.configuration.logger }
+        @target = options.fetch(:target) { DEFAULT_TARGET }
+
+        @roots = options.fetch(:roots) { Coverband.configuration.all_root_patterns }
+        @roots = @roots.split(',') if @roots.is_a?(String)
+
+        @logged_views = []
+        @views_to_record = []
+      end
+
+      ###
+      # This method is called on every render call, so we try to reduce method calls
+      # and ensure high performance
+      ###
+      def track_views(_name, _start, _finish, _id, payload)
+        if (file = payload[:identifier])
+          if newly_seen_file?(file)
+            logged_views << file
+            views_to_record << file if track_file?(file)
+          end
+        end
+
+        ###
+        # Annoyingly while you get full path for templates
+        # notifications only pass part of the path for layouts dropping any format info
+        # such as .html.erb or .js.erb
+        # http://edgeguides.rubyonrails.org/active_support_instrumentation.html#render_partial-action_view
+        ###
+        return unless (layout_file = payload[:layout])
+        return unless newly_seen_file?(layout_file)
+
+        logged_views << layout_file
+        views_to_record << layout_file if track_file?(layout_file, layout: true)
+      end
+
+      def used_views
+        views = redis_store.smembers(tracker_key)
+        normalized_views = []
+        views.each do |view|
+          roots.each do |root|
+            view = view.gsub(/#{root}/, '')
+          end
+          normalized_views << view
+        end
+        normalized_views
+      end
+
+      def unused_views
+        recently_used_views = used_views
+        all_views = target.reject { |view| recently_used_views.include?(view) }
+        # since layouts don't include format we count them used if they match with ANY formats
+        all_views.reject { |view| view.match(/\/layouts\//) && recently_used_views.any? { |used_view| view.include?(used_view) } }
+      end
+
+      def reset_recordings
+        redis_store.del(tracker_key)
+      end
+
+      def self.supported_version?
+        defined?(Rails) && defined?(Rails::VERSION) && Rails::VERSION::STRING.split('.').first.to_i >= 4
+      end
+
+      def report_views_tracked
+        views_to_record.each do |file|
+          redis_store.sadd(tracker_key, file)
+        end
+        self.views_to_record = []
+      rescue StandardError => e
+        # we don't want to raise errors if Coverband can't reach redis.
+        # This is a nice to have not a bring the system down
+        logger&.error "Coverband: view_tracker failed to store, error #{e.class.name}"
+      end
+
+      protected
+
+      def newly_seen_file?(file)
+        return false if logged_views.include?(file)
+
+        true
+      end
+
+      def track_file?(file, options = {})
+        @ignore_patterns.none? do |pattern|
+          file.include?(pattern)
+        end && (file.start_with?(@project_directory) || options[:layout])
+      end
+
+      private
+
+      def redis_store
+        store.raw_store
+      end
+
+      def tracker_key
+        'render_tracker'
+      end
+    end
+  end
+end