coverband 5.2.5 → 5.2.6.rc.1

data/lib/coverband/collectors/translation_tracker.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require "set"
+require "singleton"
+
+module Coverband
+  module Collectors
+    module I18n
+      module KeyRegistry
+        def lookup(locale, key, scope = [], options = {})
+          separator = options[:separator] || ::I18n.default_separator
+          flat_key = ::I18n.normalize_keys(locale, key, scope, separator).join(separator)
+          Coverband.configuration.translations_tracker.track_key(flat_key)
+
+          super
+        end
+      end
+    end
+
+    ###
+    # This class tracks translation usage via I18n::Backend
+    ###
+    class TranslationTracker
+      attr_accessor :target
+      attr_reader :logger, :store, :ignore_patterns
+
+      def initialize(options = {})
+        raise NotImplementedError, "#{self.class.name} requires Rails 4 or greater" unless self.class.supported_version?
+        raise "Coverband: #{self.class.name} initialized before configuration!" if !Coverband.configured? && ENV["COVERBAND_TEST"] == "test"
+
+        @ignore_patterns = Coverband.configuration.ignore
+        @store = options.fetch(:store) { Coverband.configuration.store }
+        @logger = options.fetch(:logger) { Coverband.configuration.logger }
+        @target = options.fetch(:target) do
+          if defined?(Rails.application)
+            # I18n.eager_load!
+            # I18n.backend.send(:translations)
+            app_translation_keys = []
+            app_translation_files = ::I18n.load_path.select { |f| f.match(/config\/locales/) }
+            app_translation_files.each do |file|
+              app_translation_keys += flatten_hash(YAML.load_file(file)).keys
+            end
+            app_translation_keys.uniq
+          else
+            []
+          end
+        end
+
+        @one_time_timestamp = false
+
+        @logged_keys = Set.new
+        @keys_to_record = Set.new
+      end
+
+      def logged_keys
+        @logged_keys.to_a
+      end
+
+      def keys_to_record
+        @keys_to_record.to_a
+      end
+
+      ###
+      # This method is called on every translation usage
+      ###
+      def track_key(key)
+        if key
+          if newly_seen_key?(key)
+            @logged_keys << key
+            @keys_to_record << key if track_key?(key)
+          end
+        end
+      end
+
+      def used_keys
+        redis_store.hgetall(tracker_key)
+      end
+
+      def all_keys
+        target.uniq
+      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) }
+      end
+
+      def as_json
+        used_keys = self.used_keys
+        {
+          unused_keys: unused_keys(used_keys),
+          used_keys: used_keys
+        }.to_json
+      end
+
+      def tracking_since
+        if (tracking_time = redis_store.get(tracker_time_key))
+          Time.at(tracking_time.to_i).iso8601
+        else
+          "N/A"
+        end
+      end
+
+      def reset_recordings
+        redis_store.del(tracker_key)
+        redis_store.del(tracker_time_key)
+      end
+
+      def clear_key!(key)
+        return unless key
+
+        redis_store.hdel(tracker_key, key)
+        @logged_keys.delete(key)
+      end
+
+      def save_report
+        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)
+        end
+        @keys_to_record.clear
+      rescue => 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: #{self.class.name} failed to store, error #{e.class.name} info #{e.message}"
+      end
+
+      def self.supported_version?
+        defined?(Rails) && defined?(Rails::VERSION) && Rails::VERSION::STRING.split(".").first.to_i >= 4
+      end
+
+      protected
+
+      def newly_seen_key?(key)
+        !@logged_keys.include?(key)
+      end
+
+      def track_key?(key, options = {})
+        @ignore_patterns.none? { |pattern| key.to_s.include?(pattern) }
+      end
+
+      private
+
+      def flatten_hash(hash)
+        hash.each_with_object({}) do |(k, v), h|
+          if v.is_a? Hash
+            flatten_hash(v).map do |h_k, h_v|
+              h["#{k}.#{h_k}".to_sym] = h_v
+            end
+          else
+            h[k] = v
+          end
+        end
+      end
+
+      def redis_store
+        store.raw_store
+      end
+
+      def tracker_time_key_exists?
+        if defined?(redis_store.exists?)
+          redis_store.exists?(tracker_time_key)
+        else
+          redis_store.exists(tracker_time_key)
+        end
+      end
+
+      def tracker_key
+        "#{class_key}_tracker"
+      end
+
+      def tracker_time_key
+        "#{class_key}_tracker_time"
+      end
+
+      def class_key
+        @class_key ||= self.class.name.split("::").last
+      end
+    end
+  end
+end

data/lib/coverband/configuration.rb

@@ -9,7 +9,8 @@ module Coverband
       :test_env, :web_enable_clear, :gem_details, :web_debug, :report_on_exit,
       :simulate_oneshot_lines_coverage,
       :view_tracker, :defer_eager_loading_data,
-      :track_routes, :route_tracker
+      :track_routes, :route_tracker,
+      :track_translations, :translations_tracker
     attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id,
       :s3_secret_access_key, :password, :api_key, :service_url, :coverband_timeout, :service_dev_mode,
       :service_test_mode, :process_type, :track_views, :redis_url,
@@ -70,6 +71,8 @@ module Coverband
       @view_tracker = nil
       @track_routes = false
       @route_tracker = nil
+      @track_translations = false
+      @translations_tracker = nil
       @web_debug = false
       @report_on_exit = true
       @use_oneshot_lines_coverage = ENV["ONESHOT"] || false

data/lib/coverband/integrations/background.rb

@@ -40,6 +40,7 @@ module Coverband
             Coverband.report_coverage
             Coverband.configuration.view_tracker&.report_views_tracked
             Coverband.configuration.route_tracker&.report_routes_tracked
+            Coverband.configuration.translations_tracker&.save_report
             if Coverband.configuration.verbose
               logger.debug("Coverband: background reporting coverage (#{Coverband.configuration.store.type}). Sleeping #{sleep_seconds}s")
             end

data/lib/coverband/reporters/web.rb

@@ -42,6 +42,10 @@ module Coverband
             clear_route_tracking_route
           when %r{\/clear_route_tracking}
             clear_route_tracking
+          when %r{\/clear_translation_tracking_key}
+            clear_route_translation_key
+          when %r{\/clear_translation_tracking}
+            clear_translation_tracking
           when %r{\/clear_view_tracking_file}
             clear_view_tracking_file
           when %r{\/clear_view_tracking}
@@ -65,6 +69,8 @@ module Coverband
             [200, {"Content-Type" => "text/html"}, [view_tracker]]
           when %r{\/route_tracker}
             [200, {"Content-Type" => "text/html"}, [route_tracker]]
+          when %r{\/translations_tracker}
+            [200, {"Content-Type" => "text/html"}, [translations_tracker]]
           when %r{\/enriched_debug_data}
             [200, {"Content-Type" => "text/json"}, [enriched_debug_data]]
           when %r{\/debug_data}
@@ -109,6 +115,14 @@ module Coverband
           base_path: base_path).format_route_tracker!
       end
 
+      def translations_tracker
+        notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params["notice"])}<br/>"
+        notice = request.params["notice"] ? notice : ""
+        Coverband::Utils::HTMLFormatter.new(nil,
+          notice: notice,
+          base_path: base_path).format_translations_tracker!
+      end
+
       def view_tracker_data
         Coverband::Collectors::ViewTracker.new(store: Coverband.configuration.store).as_json
       end
@@ -200,6 +214,29 @@ module Coverband
         [302, {"Location" => "#{base_path}/route_tracker?notice=#{notice}"}, []]
       end
 
+      def clear_translation_tracking
+        if Coverband.configuration.web_enable_clear
+          tracker = Coverband::Collectors::TranslationTracker.new(store: Coverband.configuration.store)
+          tracker.reset_recordings
+          notice = "translation tracking reset"
+        else
+          notice = "web_enable_clear isn't enabled in your configuration"
+        end
+        [302, {"Location" => "#{base_path}/translations_tracker?notice=#{notice}"}, []]
+      end
+
+      def clear_translation_tracking_key
+        if Coverband.configuration.web_enable_clear
+          tracker = Coverband::Collectors::TranslationTracker.new(store: Coverband.configuration.store)
+          key = request.params["key"]
+          tracker.clear_key!(key)
+          notice = "coverage for route #{key} cleared"
+        else
+          notice = "web_enable_clear isn't enabled in your configuration"
+        end
+        [302, {"Location" => "#{base_path}/translations_tracker?notice=#{notice}"}, []]
+      end
+
       private
 
       # This method should get the root mounted endpoint
@@ -211,7 +248,7 @@ module Coverband
       # %r{\/.*\/}.match?(request.path) ? request.path.match("\/.*\/")[0] : "/"
       # ^^ the above is NOT valid Ruby 2.3/2.4 even though rubocop / standard think it is
       def base_path
-        request.path =~ %r{\/.*\/} ? request.path.match("\/.*\/")[0] : "/"
+        request.path =~ %r{\/.*\/} ? request.path.match("/.*/")[0] : "/"
       end
     end
   end

data/lib/coverband/utils/html_formatter.rb

@@ -16,8 +16,8 @@ module Coverband
       attr_reader :notice, :base_path
 
       def initialize(report, options = {})
-        @notice = options.fetch(:notice) { nil }
-        @base_path = options.fetch(:base_path) { "./" }
+        @notice = options.fetch(:notice, nil)
+        @base_path = options.fetch(:base_path, "./")
         @coverage_result = Coverband::Utils::Results.new(report) if report
       end
 
@@ -41,6 +41,10 @@ module Coverband
         format_route_tracker
       end
 
+      def format_translations_tracker!
+        format_translations_tracker
+      end
+
       def format_source_file!(filename)
         source_file = @coverage_result.file_from_path_with_type(filename)
 
@@ -65,6 +69,10 @@ module Coverband
         template("route_tracker").result(binding)
       end
 
+      def format_translations_tracker
+        template("translations_tracker").result(binding)
+      end
+
       def format(result)
         Dir[File.join(File.dirname(__FILE__), "../../../public/*")].each do |path|
           FileUtils.cp_r(path, asset_output_path)
@@ -109,7 +117,7 @@ module Coverband
       end
 
       def button(url, title, opts = {})
-        delete = opts.fetch(:delete) { false }
+        delete = opts.fetch(:delete, false)
         button_css = delete ? "coveraband-button del" : "coveraband-button"
         button = "<form action='#{url}' class='coverband-admin-form' method='post'>"
         button += "<button class='#{button_css}' type='submit'>#{title}</button>"

data/lib/coverband/utils/railtie.rb

@@ -48,6 +48,13 @@ module Coverband
           end
         end
 
+        if Coverband.configuration.track_translations
+          Coverband.configuration.translations_tracker = Coverband::Collectors::TranslationTracker.new
+
+          # plugin to i18n
+          I18n::Backend::Simple.send :include, Coverband::Collectors::I18n::KeyRegistry
+        end
+
         if Coverband.configuration.track_views
           COVERBAND_VIEW_TRACKER = if Coverband.coverband_service?
             Coverband::Collectors::ViewTrackerService.new

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 = "5.2.5"
+  VERSION = "5.2.6.rc.1"
 end

data/lib/coverband.rb

@@ -19,6 +19,7 @@ require "coverband/collectors/coverage"
 require "coverband/collectors/view_tracker"
 require "coverband/collectors/view_tracker_service"
 require "coverband/collectors/route_tracker"
+require "coverband/collectors/translation_tracker"
 require "coverband/reporters/base"
 require "coverband/reporters/console_report"
 require "coverband/integrations/background"

data/test/coverband/collectors/translation_tracker_test.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require File.expand_path("../../test_helper", File.dirname(__FILE__))
+require "ostruct"
+
+class TranslationTrackerTest < Minitest::Test
+  # NOTE: using struct vs open struct as open struct has a special keyword method that overshadows the method value on Ruby 2.x
+  Payload = Struct.new(:path, :method)
+
+  def tracker_key
+    Coverband::Collectors::TranslationTracker.expects(:supported_version?).at_least_once.returns(true)
+    Coverband::Collectors::TranslationTracker.new.send(:tracker_key)
+  end
+
+  def tracker_time_key
+    Coverband::Collectors::TranslationTracker.expects(:supported_version?).at_least_once.returns(true)
+    Coverband::Collectors::TranslationTracker.new.send(:tracker_time_key)
+  end
+
+  def setup
+    super
+    fake_store.raw_store.del(tracker_key)
+  end
+
+  test "init correctly" do
+    Coverband::Collectors::TranslationTracker.expects(:supported_version?).returns(true)
+    tracker = Coverband::Collectors::TranslationTracker.new(store: fake_store, roots: "dir")
+    assert_equal nil, tracker.target.first
+    assert !tracker.store.nil?
+    assert_equal [], tracker.target
+    assert_equal [], tracker.logged_keys
+  end
+
+  test "track standard translation keys" do
+    store = fake_store
+    translation_key = "en.views.pagination.truncate"
+    store.raw_store.expects(:hset).with(tracker_key, translation_key, anything)
+    tracker = Coverband::Collectors::TranslationTracker.new(store: store, roots: "dir")
+
+    tracker.track_key(translation_key.to_sym)
+    tracker.save_report
+    assert_equal [translation_key.to_sym], tracker.logged_keys
+  end
+
+  test "report used_keys" do
+    store = fake_store
+    translation_key = "en.views.pagination.truncate"
+    tracker = Coverband::Collectors::TranslationTracker.new(store: store, roots: "dir")
+    tracker.track_key(:"en.views.pagination.truncate")
+    tracker.save_report
+    assert_equal [translation_key], tracker.used_keys.keys
+  end
+
+  test "report unused_keys" do
+    store = fake_store
+    app_keys = [
+      "en.views.pagination.truncate",
+      "en.views.pagination.next"
+    ]
+    tracker = Coverband::Collectors::TranslationTracker.new(store: store, roots: "dir", target: app_keys)
+    tracker.track_key(:"en.views.pagination.truncate")
+    tracker.save_report
+    assert_equal [app_keys.last], tracker.unused_keys
+  end
+
+  test "reset store" do
+    store = fake_store
+    store.raw_store.expects(:del).with(tracker_key)
+    store.raw_store.expects(:del).with(tracker_time_key)
+    tracker = Coverband::Collectors::TranslationTracker.new(store: store, roots: "dir")
+    tracker.track_key(:"en.views.pagination.truncate")
+    tracker.reset_recordings
+  end
+
+  test "clear_key" do
+    store = fake_store
+    translation_key = "en.views.pagination.truncate"
+    tracker = Coverband::Collectors::TranslationTracker.new(store: store, roots: "dir")
+    tracker.track_key(translation_key.to_sym)
+    tracker.save_report
+    assert_equal [translation_key.to_s], tracker.used_keys.keys
+    tracker.clear_key!(translation_key.to_s)
+    assert_equal [], tracker.store.raw_store.hgetall(tracker_key).keys
+  end
+
+  protected
+
+  def fake_store
+    @fake_store ||= Coverband::Adapters::RedisStore.new(Coverband::Test.redis, redis_namespace: "coverband_test")
+  end
+end

data/views/nav.erb

@@ -33,9 +33,14 @@
       <a href='<%= base_path %>view_tracker'>Views Tracker</a>
     </li>
   <% end %>
-    <% if Coverband.configuration.track_routes %>
+  <% if Coverband.configuration.track_routes %>
     <li class='<%= nav_options[:active_link] == 'route_tracker' ? 'active' : '' %>'>
       <a href='<%= base_path %>route_tracker'>Route Tracker</a>
     </li>
   <% end %>
+    <% if Coverband.configuration.track_translations %>
+    <li class='<%= nav_options[:active_link] == 'translations_tracker' ? 'active' : '' %>'>
+      <a href='<%= base_path %>translations_tracker'>Translations Tracker</a>
+    </li>
+  <% end %>
 </ul>

data/views/translations_tracker.erb

@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <title>Coverband Info: <%= Coverband::VERSION %></title>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+        <script src='<%= assets_path('dependencies.js') %>' type='text/javascript'></script>
+    <script src='<%= assets_path('application.js') %>' type='text/javascript'></script>
+    <link href='<%= assets_path('application.css') %>' media='screen, projection, print' rel='stylesheet' type='text/css'>
+    <link rel="icon" type="image/png" href="<%= assets_path('favicon.png') %>" />
+  </head>
+
+  <body>
+    <div id="wrapper" style="">
+      <%= display_nav(active_link: 'translations_tracker') %>
+      <div id="content">
+        <% tracker = Coverband::Collectors::TranslationTracker.new(store: Coverband.configuration.store) %>
+        <h4>
+          <% if Coverband.configuration.web_enable_clear %>
+            <%= button("#{base_path}clear_translation_tracking", 'reset translation tracker', delete: true) %>
+          <% end %>
+        </h4>
+        <h2>Unused Translations: (<%= tracker.unused_keys.length %>)</h2>
+        <p>These Translations have not been rendered since recording started at <%= tracker.tracking_since %></p>
+        <ul>
+        <% tracker.unused_keys.each do |key| %>
+          <li class="unused-keys"><%= key %></li>
+        <% end %>
+        </ul>
+
+        <h2>Used Translations: (<%= tracker.used_keys.length %>)</h2>
+        <p>These Translations have been rendered at least once</p>
+        <ul>
+        <% tracker.used_keys.each_pair do |key, time_at| %>
+          <li class="used-keys">
+            <%= key %>
+            <span class="last_seen_at">last activity recorded <%= Time.at(time_at.to_i)%></span>
+            <% if Coverband.configuration.web_enable_clear %>
+              <%= button("#{base_path}clear_translations_tracking_key?key=#{key}", 'reset tracked key', delete: true) %>
+            <% end %>
+          </li>
+        <% end %>
+        </ul>
+      </div>
+      <div id="footer">
+        Generated by <a href="http://github.com/danmayer/coverband">Coverband</a> v<%= Coverband::VERSION %>
+      </div>
+    </div>
+  </body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 5.2.5
+  version: 5.2.6.rc.1
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-21 00:00:00.000000000 Z
+date: 2022-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -302,6 +302,7 @@ files:
 - lib/coverband/collectors/coverage.rb
 - lib/coverband/collectors/delta.rb
 - lib/coverband/collectors/route_tracker.rb
+- lib/coverband/collectors/translation_tracker.rb
 - lib/coverband/collectors/view_tracker.rb
 - lib/coverband/collectors/view_tracker_service.rb
 - lib/coverband/configuration.rb
@@ -381,6 +382,7 @@ files:
 - test/coverband/collectors/coverage_test.rb
 - test/coverband/collectors/delta_test.rb
 - test/coverband/collectors/route_tracker_test.rb
+- test/coverband/collectors/translation_tracker_test.rb
 - test/coverband/collectors/view_tracker_test.rb
 - test/coverband/configuration_test.rb
 - test/coverband/coverband_test.rb
@@ -494,6 +496,7 @@ files:
 - views/settings.erb
 - views/source_file.erb
 - views/source_file_loader.erb
+- views/translations_tracker.erb
 - views/view_tracker.erb
 homepage: https://github.com/danmayer/coverband
 licenses:
@@ -515,9 +518,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.32
 signing_key:
@@ -541,6 +544,7 @@ test_files:
 - test/coverband/collectors/coverage_test.rb
 - test/coverband/collectors/delta_test.rb
 - test/coverband/collectors/route_tracker_test.rb
+- test/coverband/collectors/translation_tracker_test.rb
 - test/coverband/collectors/view_tracker_test.rb
 - test/coverband/configuration_test.rb
 - test/coverband/coverband_test.rb