coverband 6.1.7 → 6.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3ae4783bfea151c9e3b5d58e397467085206359b6c3446df24ad136fc067ca3
-  data.tar.gz: c7491d46394412b813447b80e21ca29e1cfe62060b54a28a14a6145a8ec5eb84
+  metadata.gz: '01680ffc24d42fce1b45f90fff31a9d190b029af8a83b0a1405ed81d2785bc10'
+  data.tar.gz: 04daf91b9d7f64849d217075e71ff00d54cac2e64fd1b5c7fdd7e0b27943b56e
 SHA512:
-  metadata.gz: 2cbd8715bf8a5ea95e5705038acec36bd8549fb9ca01b99c4266919904122fb9fd81cbc3e1488d6eaa0c0bb955875c429751523843449abc0c5d01107d620085
-  data.tar.gz: f4ac2904d9cde83162aa3f1d350aeb25e337f8c86178b79668170ae00ef64df9d564e15cdd94597cb1ea6652daa244b8454cdc8c3401e14b74662527ff7ea34e
+  metadata.gz: 0de107048e072e97c1bded932a59ac9b6be2c6ac94b045118977aae38282a109772b183bed1b7ca99d7867d3fc694f326a53e2e93174bbf372e7f0ba16e8bd13
+  data.tar.gz: 57d8e1921056acb7f13e47b02caeb6207e635984a461c1952aafd0dbf4e445519d99ca8b369b60d11c3121b86da6f5f3d3d2a4e6aaf6d68fd2d3a8aa155d14fb

data/.github/workflows/main.yml

@@ -28,11 +28,18 @@ jobs:
           - gemfile: 'rails_8.0'
             ruby: '3.1'
     runs-on: ${{ matrix.os }}-latest
+    services:
+      redis:
+        image: redis:${{ matrix.redis-version }}
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
     steps:
       - uses: actions/checkout@v6
-      - uses: supercharge/redis-github-action@v2
-        with:
-          redis-version: ${{ matrix.redis-version }}
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/Gemfile

@@ -8,3 +8,6 @@ gem "rails" # latest
 gem "haml"
 gem "slim"
 gem "webrick"
+
+# Required for Ruby 3.4+ (extracted from stdlib)
+gem "cgi"

data/Gemfile.rails7.0

@@ -8,3 +8,6 @@ gem 'rails', '~>7.0.0'
 gem "haml"
 gem "slim"
 gem "webrick"
+
+# Required for Ruby 3.4+ (extracted from stdlib)
+gem "cgi"

data/Gemfile.rails7.1

@@ -7,4 +7,7 @@ gemspec
 gem 'rails', '~>7.1.0'
 gem "haml"
 gem "slim"
-gem "webrick"
+gem "webrick"
+
+# Required for Ruby 3.4+ (extracted from stdlib)
+gem "cgi"

data/Gemfile.rails7.2

@@ -8,3 +8,6 @@ gem 'rails', '~>7.2.0'
 gem "haml"
 gem "slim"
 gem "webrick"
+
+# Required for Ruby 3.4+ (extracted from stdlib)
+gem "cgi"

data/Gemfile.rails8.0

@@ -8,3 +8,6 @@ gem 'rails', '~>8.0.0'
 gem "haml"
 gem "slim"
 gem "webrick"
+
+# Required for Ruby 3.4+ (extracted from stdlib)
+gem "cgi"

data/changes.md

@@ -1,3 +1,17 @@
+### 6.1.8
+
+* Feature: Added temporal data to GetFileCoverage tool for MCP by @fabienpiette (#626)
+* Optimization: Significant performance improvements to `FileList` avoiding array allocations and reducing redundant iterations (#619, #620, #622, #623)
+* Optimization: Optimize `HTMLFormatter` with template caching (#616, #618)
+* Optimization: Optimize memory usage by removing redundant `dup` calls across `Coverband::Utils::Result` (#617, #621)
+* Optimization: Optimize `array_add` logic with in-place modification avoiding overhead in newer Ruby (#615)
+* Optimization: Optimize `ViewTracker` unused keys and path normalization (#608, #609, #613)
+* Optimization: Optimize `AbstractTracker` to use bulk Redis hset and direct Hash lookups (#610, #612)
+* Optimization: Cache Regexp in `short_name` and optimize `RelativeFileConverter` with `Regexp.union` (#606, #607)
+* Optimization: Optimize delta collector ignore check order (#611)
+* Refactoring: Extract Line class to `Coverband::Utils::SourceFile::Line` (#605, #614)
+* Fix: Improve symlink handling in file converters (#603)
+
 ### Coverband 6.1.7
 
 * add back a running demo site

data/lib/coverband/adapters/base.rb

@@ -125,14 +125,29 @@ module Coverband
         }
       end
 
-      # TODO: This should have cases reduced
       def array_add(latest, original)
-        if latest.empty? && original.empty?
-          []
-        elsif Coverband.configuration.use_oneshot_lines_coverage
-          latest.map!.with_index { |v, i| ((v + original[i] >= 1) ? 1 : 0) if v && original[i] }
+        use_oneshot = Coverband.configuration.use_oneshot_lines_coverage
+        if latest.frozen?
+          latest.map.with_index do |v, i|
+            if v && original[i]
+              if use_oneshot
+                (v + original[i] >= 1) ? 1 : 0
+              else
+                v + original[i]
+              end
+            end
+          end
         else
-          latest.map.with_index { |v, i| (v && original[i]) ? v + original[i] : nil }
+          latest.each_with_index do |v, i|
+            latest[i] = if v && original[i]
+              if use_oneshot
+                (v + original[i] >= 1) ? 1 : 0
+              else
+                v + original[i]
+              end
+            end
+          end
+          latest
         end
       end
     end

data/lib/coverband/adapters/file_store.rb

@@ -65,8 +65,7 @@ module Coverband
       end
 
       def save_report(report)
-        data = report.dup
-        data = merge_reports(data, coverage)
+        data = merge_reports(report, coverage)
         File.write(path, JSON.dump(data))
       end
 

data/lib/coverband/adapters/hash_redis_store.rb

@@ -29,6 +29,7 @@ module Coverband
 
         @ttl = opts[:ttl]
         @relative_file_converter = opts[:relative_file_converter] || Utils::RelativeFileConverter
+        @short_name_regex = /^#{Coverband.configuration.root}/
       end
 
       def supported?
@@ -171,7 +172,7 @@ module Coverband
       end
 
       def short_name(filename)
-        filename.sub(/^#{Coverband.configuration.root}/, ".")
+        filename.sub(@short_name_regex, ".")
           .gsub(%r{^\./}, "")
       end
 

data/lib/coverband/adapters/redis_store.rb

@@ -63,8 +63,7 @@ module Coverband
       # 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(nil, skip_hash_check: true))
+        data = merge_reports(report, coverage(nil, skip_hash_check: true))
         save_coverage(data)
       end
 

data/lib/coverband/adapters/web_service_store.rb

@@ -66,10 +66,9 @@ module Coverband
         # We set here vs initialize to avoid setting on the primary process vs child processes
         @pid ||= ::Process.pid
 
-        # TODO: do we need dup
         # TODO: we don't need upstream timestamps, server will track first_seen
         Thread.new do
-          data = expand_report(report.dup)
+          data = expand_report(report)
           full_package = {
             collection_type: "coverage_delta",
             collection_data: {

data/lib/coverband/collectors/abstract_tracker.rb

@@ -61,8 +61,8 @@ module Coverband
       end
 
       def unused_keys(used_keys = nil)
-        recently_used_keys = (used_keys || self.used_keys).keys
-        all_keys.reject { |k| recently_used_keys.include?(k.to_s) }
+        recently_used_keys = used_keys || self.used_keys
+        all_keys.reject { |k| recently_used_keys.key?(k.to_s) }
       end
 
       def as_json
@@ -97,8 +97,8 @@ module Coverband
         redis_store.set(tracker_time_key, Time.now.to_i) unless @one_time_timestamp || tracker_time_key_exists?
         @one_time_timestamp = true
         reported_time = Time.now.to_i
-        @keys_to_record.to_a.each do |key|
-          redis_store.hset(tracker_key, key.to_s, reported_time)
+        if @keys_to_record.any?
+          redis_store.hset(tracker_key, @keys_to_record.each_with_object({}) { |key, h| h[key.to_s] = reported_time })
         end
         @keys_to_record.clear
       rescue => e

data/lib/coverband/collectors/delta.rb

@@ -54,8 +54,8 @@ module Coverband
           # on the critical performance path, and any refactoring I come up with
           # would slow down the performance.
           ###
-          next unless @@ignore_patterns.none? { |pattern| file.match(pattern) } &&
-            file.start_with?(@@project_directory)
+          next unless file.start_with?(@@project_directory) &&
+            @@ignore_patterns.none? { |pattern| file.match(pattern) }
 
           # This handles Coverage branch support, setup by default in
           # simplecov 0.18.x
@@ -84,8 +84,8 @@ module Coverband
           # on the critical performance path, and any refactoring I come up with
           # would slow down the performance.
           ###
-          next unless @@ignore_patterns.none? { |pattern| file.match(pattern) } &&
-            file.start_with?(@@project_directory)
+          next unless file.start_with?(@@project_directory) &&
+            @@ignore_patterns.none? { |pattern| file.match(pattern) }
 
           @@stubs[file] ||= ::Coverage.line_stub(file)
           transformed_line_counts = coverage[:oneshot_lines].each_with_object(@@stubs[file].dup) { |line_number, line_counts|

data/lib/coverband/collectors/view_tracker.rb

@@ -78,8 +78,17 @@ module Coverband
         recently_used_views = used_keys.keys
         unused_views = all_keys - recently_used_views
         # since layouts don't include format we count them used if they match with ANY formats
-        unused_views = unused_views.reject { |view| view.include?("/layouts/") && recently_used_views.any? { |used_view| view.include?(used_view) } }
-        unused_views.reject { |view| @ignore_patterns.any? { |pattern| view.match?(pattern) } }
+        potential_layout_references = recently_used_views.reject { |v| v.end_with?(".erb", ".haml", ".slim") }
+
+        layout_matcher = if potential_layout_references.any?
+          Regexp.union(potential_layout_references)
+        end
+
+        unused_views.reject! do |view|
+          (layout_matcher && view.include?("/layouts/") && view.match?(layout_matcher)) ||
+            @ignore_patterns.any? { |pattern| view.match?(pattern) }
+        end
+        unused_views
       end
 
       def clear_key!(filename)
@@ -103,6 +112,7 @@ module Coverband
 
         roots.each do |root|
           normalized = normalized.gsub(root, "")
+          break if normalized.length < original_length
         end
 
         # Only remove leading slash if we actually modified the path by removing a root

data/lib/coverband/mcp/tools/get_file_coverage.rb

@@ -52,6 +52,8 @@ module Coverband
               lines_missed: file_data["lines_missed"],
               runtime_percentage: file_data["runtime_percentage"],
               never_loaded: file_data["never_loaded"],
+              first_updated_at: file_data["first_updated_at"],
+              last_updated_at: file_data["last_updated_at"],
               coverage: file_data["coverage"]
             }
           end

data/lib/coverband/reporters/json_report.rb

@@ -72,6 +72,11 @@ module Coverband
         end
       end
 
+      def format_timestamp(timestamp)
+        return nil if timestamp.nil? || timestamp == Coverband::Utils::SourceFile::NOT_AVAILABLE
+        timestamp.is_a?(Time) ? timestamp.iso8601 : timestamp.to_s
+      end
+
       def report_as_json
         return filtered_report_files.to_json if for_merged_report
 
@@ -133,6 +138,8 @@ module Coverband
             filename: source_file.filename,
             hash: Digest::SHA1.hexdigest(source_file.filename),
             never_loaded: source_file.never_loaded,
+            first_updated_at: format_timestamp(source_file.first_updated_at),
+            last_updated_at: format_timestamp(source_file.last_updated_at),
             runtime_percentage: result.runtime_relevant_coverage(source_file),
             lines_of_code: source_file.lines.count,
             lines_covered: source_file.covered_lines.count,

data/lib/coverband/utils/absolute_file_converter.rb

@@ -5,7 +5,7 @@ module Coverband
     class AbsoluteFileConverter
       def initialize(roots)
         @cache = {}
-        @roots = roots.map { |root| "#{File.expand_path(root)}/" }
+        @roots = convert_roots(roots)
       end
 
       def self.instance
@@ -24,11 +24,25 @@ module Coverband
         @cache[relative_path] ||= begin
           relative_filename = relative_path
           local_filename = relative_filename
-          @roots.each do |root|
-            relative_filename = relative_filename.sub(/^#{root}/, "./")
-            # once we have a relative path break out of the loop
-            break if relative_filename.start_with? "./"
+          @roots.each do |root, root_regexp|
+            if relative_filename.match?(root_regexp)
+              relative_filename = relative_filename.sub(root_regexp, "./")
+              # once we have a relative path break out of the loop
+              break
+            end
           end
+
+          if relative_filename == local_filename && File.exist?(local_filename)
+            real_filename = File.realpath(local_filename)
+            @roots.each do |root, root_regexp|
+              if real_filename.match?(root_regexp)
+                relative_filename = real_filename.sub(root_regexp, "./")
+                # once we have a relative path break out of the loop
+                break
+              end
+            end
+          end
+
           # the filename for our reports is expected to be a full path.
           # roots.last should be roots << current_root}/
           # a fully expanded path of config.root
@@ -36,12 +50,28 @@ module Coverband
           # above only works for app files
           # we need to rethink some of this logic
           # gems aren't at project root and can have multiple locations
-          local_root = @roots.find { |root|
+          local_root = @roots.find { |root, _root_regexp|
             File.exist?(relative_filename.gsub("./", root))
-          }
+          }&.first
           local_root ? relative_filename.gsub("./", local_root) : local_filename
         end
       end
+
+      private
+
+      def convert_roots(roots)
+        roots.flat_map { |root|
+          items = []
+          expanded = "#{File.expand_path(root)}/"
+          items << [expanded, /^#{expanded}/]
+
+          if File.exist?(root)
+            real = "#{File.realpath(root)}/"
+            items << [real, /^#{Regexp.escape(real)}/]
+          end
+          items
+        }.uniq
+      end
     end
   end
 end

data/lib/coverband/utils/file_list.rb

@@ -14,28 +14,28 @@ module Coverband
       def covered_lines
         return 0.0 if empty?
 
-        map { |f| f.covered_lines.count }.inject(:+)
+        @covered_lines ||= sum(&:covered_lines_count)
       end
 
       # Returns the count of lines that have been missed
       def missed_lines
         return 0.0 if empty?
 
-        map { |f| f.missed_lines.count }.inject(:+)
+        @missed_lines ||= sum(&:missed_lines_count)
       end
 
       # Returns the count of lines that are not relevant for coverage
       def never_lines
         return 0.0 if empty?
 
-        map { |f| f.never_lines.count }.inject(:+)
+        @never_lines ||= sum(&:never_lines_count)
       end
 
       # Returns the count of skipped lines
       def skipped_lines
         return 0.0 if empty?
 
-        map { |f| f.skipped_lines.count }.inject(:+)
+        @skipped_lines ||= sum(&:skipped_lines_count)
       end
 
       # Computes the coverage based upon lines covered and lines missed for each file
@@ -46,7 +46,9 @@ module Coverband
 
       # Returns the overall amount of relevant lines of code across all files in this list
       def lines_of_code
-        covered_lines + missed_lines
+        return 0.0 if empty?
+
+        @lines_of_code ||= sum(&:lines_of_code)
       end
 
       # Computes the coverage based upon lines covered and lines missed
@@ -68,11 +70,17 @@ module Coverband
       def covered_strength
         return 0.0 if empty? || lines_of_code.zero?
 
-        Float(map { |f| f.covered_strength * f.lines_of_code }.inject(:+) / lines_of_code)
+        Float(sum { |f| f.covered_strength * f.lines_of_code } / lines_of_code)
       end
 
       def first_seen_at
-        map(&:first_updated_at).reject { |el| el.is_a?(String) }.min
+        min = nil
+        each do |f|
+          val = f.first_updated_at
+          next if val.is_a?(String)
+          min = val if min.nil? || val < min
+        end
+        min
       end
     end
   end

data/lib/coverband/utils/html_formatter.rb

@@ -73,9 +73,12 @@ module Coverband
         template("data").result(binding)
       end
 
+      TEMPLATE_CACHE = {}
+      private_constant :TEMPLATE_CACHE
+
       # Returns the an erb instance for the template of given name
       def template(name)
-        ERB.new(File.read(File.join(File.dirname(__FILE__), "../../../views/", "#{name}.erb")))
+        TEMPLATE_CACHE[name] ||= ERB.new(File.read(File.expand_path("../../../views/#{name}.erb", __dir__)))
       end
 
       def output_path
@@ -119,7 +122,7 @@ module Coverband
 
       # Returns a table containing the given source files
       def formatted_file_list(title, result, source_files, options = {})
-        title_id = title.gsub(/^[^a-zA-Z]+/, "").gsub(/[^a-zA-Z0-9\-\_]/, "")
+        title_id = title.gsub(/^[^a-zA-Z]+/, "").gsub(/[^a-zA-Z0-9\-_]/, "")
         # Silence a warning by using the following variable to assign to `_`:
         # "warning: possibly useless use of a variable in void context"
         # The variable is used by ERB via binding.

data/lib/coverband/utils/relative_file_converter.rb

@@ -17,24 +17,39 @@ module Coverband
 
       def initialize(roots)
         @cache = {}
-        @roots = normalize(roots)
+        @roots_regexp = Regexp.union(convert_roots(roots))
       end
 
       def convert(file)
         @cache[file] ||= begin
-          relative_file = file
-          @roots.each do |root|
-            relative_file = file.gsub(/^#{root}/, ".")
-            break relative_file if relative_file.start_with?(".")
+          relative_file = file.sub(@roots_regexp, "./")
+
+          if relative_file == file && !file.start_with?(".") && File.exist?(file)
+            real_file = File.realpath(file)
+            new_relative_file = real_file.sub(@roots_regexp, "./")
+            relative_file = ((new_relative_file == real_file) ? file : new_relative_file)
           end
+
           relative_file
         end
       end
 
       private
 
-      def normalize(paths)
-        paths.map { |root| File.expand_path(root) }
+      def convert_roots(roots)
+        roots.flat_map { |root|
+          items = []
+          expanded = File.expand_path(root)
+          expanded += "/" unless expanded.end_with?("/")
+          items << /^#{Regexp.escape(expanded)}/
+
+          if File.exist?(root)
+            real = File.realpath(root)
+            real += "/" unless real.end_with?("/")
+            items << /^#{Regexp.escape(real)}/
+          end
+          items
+        }.uniq
       end
     end
   end

data/lib/coverband/utils/result.rb

@@ -51,8 +51,6 @@ module Coverband
       # the line-by-line coverage to zero (if relevant) or nil (comments / whitespace etc).
       def self.add_not_loaded_files(result, tracked_files)
         if tracked_files
-          # TODO: Can we get rid of this dup it wastes memory
-          result = result.dup
           Dir[tracked_files].each do |file|
             absolute = File.expand_path(file)
             result[absolute] ||= {

data/lib/coverband/utils/source_file/line.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+####
+# Thanks for all the help SimpleCov https://github.com/colszowka/simplecov
+# initial version pulled into Coverband from Simplecov 12/04/2018
+#
+# Representation of a source file including it's coverage data, source code,
+# source lines and featuring helpers to interpret that data.
+####
+module Coverband
+  module Utils
+    class SourceFile
+      # Representation of a single line in a source file including
+      # this specific line's source code, line_number and code coverage,
+      # with the coverage being either nil (coverage not applicable, e.g. comment
+      # line), 0 (line not covered) or >1 (the amount of times the line was
+      # executed)
+      class Line
+        # The source code for this line. Aliased as :source
+        attr_reader :src
+        # The line number in the source file. Aliased as :line, :number
+        attr_reader :line_number
+        # The coverage data for this line: either nil (never), 0 (missed) or >=1 (times covered)
+        attr_reader :coverage
+        # Whether this line was skipped
+        attr_reader :skipped
+        # The coverage data posted time for this line: either nil (never), nil (missed) or Time instance (last posted)
+        attr_reader :coverage_posted
+
+        # Lets grab some fancy aliases, shall we?
+        alias_method :source, :src
+        alias_method :line, :line_number
+        alias_method :number, :line_number
+
+        def initialize(src, line_number, coverage, coverage_posted = nil)
+          raise ArgumentError, "Only String accepted for source" unless src.is_a?(String)
+          raise ArgumentError, "Only Integer accepted for line_number" unless line_number.is_a?(Integer)
+          raise ArgumentError, "Only Integer and nil accepted for coverage" unless coverage.is_a?(Integer) || coverage.nil?
+
+          @src = src
+          @line_number = line_number
+          @coverage = coverage
+          @skipped = false
+          @coverage_posted = coverage_posted
+        end
+
+        # Returns true if this is a line that should have been covered, but was not
+        def missed?
+          !never? && !skipped? && coverage.zero?
+        end
+
+        # Returns true if this is a line that has been covered
+        def covered?
+          !never? && !skipped? && coverage.positive?
+        end
+
+        # Returns true if this line is not relevant for coverage
+        def never?
+          !skipped? && coverage.nil?
+        end
+
+        # Flags this line as skipped
+        def skipped!
+          @skipped = true
+        end
+
+        # Returns true if this line was skipped, false otherwise. Lines are skipped if they are wrapped with
+        # # :nocov: comment lines.
+        def skipped?
+          skipped
+        end
+
+        # The status of this line - either covered, missed, skipped or never. Useful i.e. for direct use
+        # as a css class in report generation
+        def status
+          return "skipped" if skipped?
+          return "never" if never?
+          return "missed" if missed?
+          "covered" if covered?
+        end
+      end
+    end
+  end
+end