RubyGems - cover_rage - Versions diffs - 1.1.1 → 1.3.0 - Mend

cover_rage 1.1.1 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

checksums.yaml +4 -4
data/lib/cover_rage/record.rb +8 -1
data/lib/cover_rage/recorder.rb +5 -1
data/lib/cover_rage/reporters/html_reporter/index.html.erb +145 -139
data/lib/cover_rage/stores/sqlite.rb +12 -9
metadata +9 -51

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e35c3c64110ebafa0432d4ac37f2d05b19a552df8505263f751f4fb85a841525
-  data.tar.gz: 9cd16923a839fd2ddcd6f5b585d28bfc19ab40a466d810ac8a93378bf5c13b02
+  metadata.gz: 00ad4585a873585456f2c9948a88bcab8d54438b5c952a7fdb03a0e411763e3e
+  data.tar.gz: 231662f71294e8e983e7632c8ad530b3c18752f2e6d4d0a5d2ea3ea2de0edc90
 SHA512:
-  metadata.gz: b1b158a2dc50611a60482aeae2f448c9f4f8ae59f3d1ebb6ecd29bc03fea38a82a934b4b84906a4f331a7b293ccfcb4780ab7d956fe24015c42c54a8d4a52cdc
-  data.tar.gz: b06bdca3118bf5d80f7225e4792d258a18ef17a27f9255e0993a0e9523aab81e1aa88051b6c6670241ea688bfd10df10118ce9934e84e1c4379d4fcae02b7282
+  metadata.gz: '048eb40f6ed0df7c75e4f353ce17fa516345a2832d6b25497453d4bb94aa302197e8e57c5fdbe50444d3a35da91bf641d1a0bbbd2b8d911cf457988016588932'
+  data.tar.gz: 587134f993d40afb1c4b9242e030aac02ea886436a1e3912413630f1e7f4e97a403b1b2693a4af8907df23e9a4a8f91e7fa2f782089fa7609fe997ed6e45fa88

data/lib/cover_rage/record.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module CoverRage
-  Record = Data.define(:path, :revision, :source, :execution_count) do
+  Record = Data.define(:path, :revision, :source, :execution_count, :last_executed_at) do
     def self.merge(existing, current)
       records_to_save = []
       current.each do |record|
@@ -20,6 +20,13 @@ module CoverRage
       with(
         execution_count: execution_count.map.with_index do |item, index|
           item.nil? ? nil : item + other.execution_count[index]
+        end,
+        last_executed_at: last_executed_at.map.with_index do |item, index|
+          if item.nil? && other.last_executed_at[index].nil? then nil
+          elsif item.nil? then other.last_executed_at[index]
+          elsif other.last_executed_at[index].nil? then item
+          else [item, other.last_executed_at[index]].max
+          end
         end
       )
     end

data/lib/cover_rage/recorder.rb CHANGED Viewed

@@ -42,11 +42,15 @@ module CoverRage
         relative_path = filepath.delete_prefix(@path_prefix)
         revision, source = read_file_with_revision(filepath)
+        now = Time.now.to_i
+        last_executed_at = execution_count.map { |c| c&.positive? ? now : nil }
         records << Record.new(
           path: relative_path,
           revision:,
           source:,
-          execution_count:
+          execution_count:,
+          last_executed_at:
         )
       end
       return unless records.any?

data/lib/cover_rage/reporters/html_reporter/index.html.erb CHANGED Viewed

@@ -2,7 +2,6 @@
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>CoverRage</title>
     <link
@@ -15,43 +14,41 @@
         display: inline-block;
         counter-increment: line_number;
       }
-      .green {
-        background-color: rgb(221, 255, 221);
-      }
-      .red {
-        background-color: rgb(255, 212, 212);
-      }
+      .green { background-color: rgb(221, 255, 221); }
+      .blue { background-color: rgb(221, 221, 255); }
+      .red { background-color: rgb(255, 212, 212); }
       .number {
         display: inline-block;
         text-align: right;
-        margin-right: 0.5em;
         background-color: lightgray;
         padding: 0 0.5em 0 1.5em;
       }
+      .timestamp {
+        display: inline-block;
+        text-align: right;
+        margin-right: 0.5em;
+        background-color: lightgray;
+        padding: 0 0.5em;
+      }
       .nav {
         display: flex;
         list-style: none;
         padding-left: 0;
-      }
-      .nav > * {
-        margin-left: 8px;
+        gap: 8px;
       }
     </style>
   </head>
   <body>
     <main id="main"></main>
-    <div style="display: none">
-      <div id="page-index">
+    <template id="tmpl-index">
+      <div>
         <nav>
           <ul class="nav">
             <li><a href="#/">Index</a></li>
           </ul>
         </nav>
+        <label>stale threshold <input id="stale-threshold" type="number" min="0" value="30"> days</label>
         <table>
           <thead>
             <tr>
@@ -60,156 +57,165 @@
               <th>relevancy</th>
               <th>hit</th>
               <th>miss</th>
-              <th>coverage (%)</th>
+              <th>stale</th>
+              <th class="sortable" data-sort="coverage" style="cursor:pointer">coverage (%) ▼</th>
+              <th class="sortable" data-sort="staleness" style="cursor:pointer">staleness (%)</th>
             </tr>
           </thead>
           <tbody></tbody>
         </table>
       </div>
-      <div id="page-file">
+    </template>
+    <template id="tmpl-file">
+      <div>
         <nav>
           <ul class="nav">
             <li><a href="#/">Index</a></li>
-            <li>></li>
+            <li>&gt;</li>
             <li id="title"></li>
           </ul>
         </nav>
+        <label>stale threshold <input id="stale-threshold" type="number" min="0" value="30"> days</label>
         <pre><code id="code"></code></pre>
       </div>
-    </div>
+    </template>
     <script id="records" type="application/json"><%= records %></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
     <script>
+      const records = JSON.parse(document.getElementById("records").textContent);
       const main = document.getElementById("main");
-      const page_index = document.getElementById("page-index");
-      const title = document.createTextNode("");
-      document.getElementById("title").appendChild(title);
-      const code = document.getElementById("code");
-      const page_file = document.getElementById("page-file");
-      const records = JSON.parse(
-        document.getElementById("records").childNodes[0].nodeValue
-      );
-      const route = (path) => {
-        if (path.startsWith("/file/")) {
-          const filepath = path.slice(6);
-          if (records.find((record) => record.path === filepath))
-            return { page: "file", path: filepath };
+      function route() {
+        const hash = window.location.hash.slice(1);
+        if (hash.startsWith("/file/")) {
+          const path = hash.slice(6);
+          const record = records.find((r) => r.path === path);
+          if (record) return { page: "file", path, record };
         }
         return { page: "index" };
-      };
+      }
-      const render = (routing) => {
-        let page;
-        if (routing.page === "file") {
-          const record = records.find(({ path }) => path === routing.path);
-          page = page_file;
-          title.nodeValue = routing.path;
-          const digit_width =
-            Math.floor(Math.log10(Math.max(...record.execution_count))) + 1;
-          code.innerHTML = hljs
-            .highlight(
-              records.find(({ path }) => path === routing.path).source,
-              {
-                language: "ruby",
-              }
-            )
-            .value.split("\n")
-            .map((line, index) => {
-              const value = record.execution_count[index];
-              let color = "";
-              if (typeof value === "number")
-                color = value > 0 ? "green" : "red";
-              const number = typeof value === "number" ? value : "-";
-              return `<span class="line ${color}"><span class="number">${number
-                .toString()
-                .padStart(digit_width, " ")}</span>${line}</span>`;
-            })
-            .join("\n");
+      function cloneTemplate(id) {
+        return document.getElementById(id).content.cloneNode(true).firstElementChild;
+      }
+      function formatDate(posixTime) {
+        if (typeof posixTime !== "number") return "-";
+        return new Date(posixTime * 1000).toISOString().slice(0, 10);
+      }
+      function colorClass(count, lastExecutedAt, staleThresholdDays) {
+        if (typeof count !== "number") return "";
+        if (count === 0) return "red";
+        if (typeof lastExecutedAt === "number") {
+          const ageDays = (Date.now() / 1000 - lastExecutedAt) / 86400;
+          if (ageDays > staleThresholdDays) return "blue";
         }
-        if (routing.page === "index") {
-          page = page_index;
+        return "green";
+      }
+      function summarize({ path, execution_count, last_executed_at }, staleThresholdDays) {
+        let hit = 0, miss = 0, relevancy = 0, stale = 0;
+        const staleCutoff = Date.now() / 1000 - staleThresholdDays * 86400;
+        for (let i = 0; i < execution_count.length; i++) {
+          const count = execution_count[i];
+          if (count !== null) {
+            relevancy++;
+            if (count > 0) {
+              hit++;
+              const t = last_executed_at[i];
+              if (typeof t === "number" && t < staleCutoff) stale++;
+            } else {
+              miss++;
+            }
+          }
         }
-        if (main.childNodes.length === 0) main.appendChild(page);
-        else main.replaceChild(page, main.childNodes[0]);
-      };
-      const createTdTextNode = (text) => {
-        const td = document.createElement("td");
-        td.appendChild(document.createTextNode(text));
-        return td;
-      };
+        return {
+          path,
+          lines: execution_count.length,
+          relevancy,
+          hit,
+          miss,
+          stale,
+          coverage: hit / relevancy,
+          staleness: stale / relevancy,
+        };
+      }
-      page_index.querySelector("tbody").appendChild(
-        records
-          .map(({ path, revision, source, execution_count }) => {
-            const hit = execution_count.reduce(
-              (accumulator, current) =>
-                current > 0 ? accumulator + 1 : accumulator,
-              0
-            );
-            const miss = execution_count.reduce(
-              (accumulator, current) =>
-                current === 0 ? accumulator + 1 : accumulator,
-              0
-            );
-            const relevancy = execution_count.reduce(
-              (accumulator, current) =>
-                current !== null ? accumulator + 1 : accumulator,
-              0
-            );
-            const coverage = hit / relevancy;
-            return {
-              path,
-              lines: execution_count.length,
-              hit,
-              miss,
-              relevancy,
-              coverage,
-            };
-          })
-          .sort(({ coverage: a }, { coverage: b }) => {
-            if (isNaN(b)) return -1;
-            if (isNaN(a)) return 1;
-            return a - b;
+      let staleThresholdDays = 30;
+      let sortKey = "coverage";
+      let sortAsc = true;
+      function getStaleThreshold(el) {
+        const input = el.querySelector("#stale-threshold");
+        input.value = staleThresholdDays;
+        input.addEventListener("change", () => {
+          staleThresholdDays = Number(input.value) || 30;
+          render();
+        });
+        return staleThresholdDays;
+      }
+      function renderIndex() {
+        const el = cloneTemplate("tmpl-index");
+        const staleThresholdDays = getStaleThreshold(el);
+        const tbody = el.querySelector("tbody");
+        el.querySelectorAll(".sortable").forEach((th) => {
+          const key = th.dataset.sort;
+          th.textContent = th.textContent.replace(/ [▲▼]$/, "") + (sortKey === key ? (sortAsc ? " ▲" : " ▼") : "");
+          th.addEventListener("click", () => {
+            if (sortKey === key) { sortAsc = !sortAsc; } else { sortKey = key; sortAsc = true; }
+            render();
+          });
+        });
+        const rows = records.map((r) => summarize(r, staleThresholdDays)).sort((a, b) => {
+          const av = a[sortKey], bv = b[sortKey];
+          if (isNaN(bv)) return -1;
+          if (isNaN(av)) return 1;
+          return sortAsc ? av - bv : bv - av;
+        });
+        for (const { path, lines, relevancy, hit, miss, stale, coverage, staleness } of rows) {
+          const tr = tbody.insertRow();
+          tr.insertCell().innerHTML = `<a href="#/file/${path}">${path}</a>`;
+          tr.insertCell().textContent = lines;
+          tr.insertCell().textContent = relevancy;
+          tr.insertCell().textContent = hit;
+          tr.insertCell().textContent = miss;
+          tr.insertCell().textContent = stale;
+          tr.insertCell().textContent = Math.round(coverage * 10000) / 100;
+          tr.insertCell().textContent = Math.round(staleness * 10000) / 100;
+        }
+        return el;
+      }
+      function renderFile(record) {
+        const el = cloneTemplate("tmpl-file");
+        const staleThresholdDays = getStaleThreshold(el);
+        el.querySelector("#title").textContent = record.path;
+        const digitWidth = Math.floor(Math.log10(Math.max(...record.execution_count))) + 1;
+        const highlighted = hljs.highlight(record.source, { language: "ruby" }).value;
+        el.querySelector("#code").innerHTML = highlighted
+          .split("\n")
+          .map((line, i) => {
+            const count = record.execution_count[i];
+            const displayCount = typeof count === "number" ? String(count).padStart(digitWidth) : "-".padStart(digitWidth);
+            const date = formatDate(record.last_executed_at[i]).padStart(10);
+            return `<span class="line ${colorClass(count, record.last_executed_at[i], staleThresholdDays)}"><span class="number">${displayCount}</span><time class="timestamp">${date}</time>${line}</span>`;
           })
-          .reduce(
-            (fragment, { path, lines, hit, miss, relevancy, coverage }) => {
-              const tr = document.createElement("tr");
-              tr.appendChild(
-                (() => {
-                  const anchor = document.createElement("a");
-                  anchor.href = `#/file/${path}`;
-                  anchor.appendChild(document.createTextNode(path));
-                  const td = document.createElement("td");
-                  td.appendChild(anchor);
-                  return td;
-                })()
-              );
-              tr.appendChild(createTdTextNode(lines));
-              tr.appendChild(createTdTextNode(relevancy));
-              tr.appendChild(createTdTextNode(hit));
-              tr.appendChild(createTdTextNode(miss));
-              tr.appendChild(
-                createTdTextNode(Math.round(coverage * 10000) / 100)
-              );
-              fragment.appendChild(tr);
-              return fragment;
-            },
-            document.createDocumentFragment()
-          )
-      );
+          .join("\n");
+        return el;
+      }
-      document.addEventListener("DOMContentLoaded", () => {
-        const routing = route(window.location.hash.slice(1));
-        render(routing);
-      });
+      function render() {
+        const routing = route();
+        const page = routing.page === "file" ? renderFile(routing.record) : renderIndex();
+        main.replaceChildren(page);
+      }
-      window.addEventListener("popstate", (event) => {
-        const routing = route(window.location.hash.slice(1));
-        render(routing);
-      });
+      render();
+      window.addEventListener("hashchange", render);
     </script>
   </body>
 </html>

data/lib/cover_rage/stores/sqlite.rb CHANGED Viewed

@@ -11,12 +11,14 @@ module CoverRage
         @mutex = Mutex.new
         @path = path
         @db = SQLite3::Database.new(path)
+        @db.busy_handler { true }
         @db.execute <<-SQL
           create table if not exists records (
             path text primary key not null,
             revision blob not null,
             source text not null,
-            execution_count text not null
+            execution_count text not null,
+            last_executed_at text not null
           )
         SQL
         process_ext = Module.new
@@ -25,6 +27,7 @@ module CoverRage
             store.instance_variable_get(:@db).close
             pid = super()
             store.instance_variable_set(:@db, SQLite3::Database.new(path))
+            store.instance_variable_get(:@db).busy_handler { true }
             pid
           end
         end
@@ -34,22 +37,21 @@ module CoverRage
       def transaction(&)
         @mutex.synchronize do
           @db.transaction(:exclusive, &)
-        rescue SQLite3::BusyException
-          retry
         end
       end
       def update(records)
         @db.execute(
-          "insert or replace into records (path, revision, source, execution_count) values #{
-            (['(?,?,?,?)'] * records.length).join(',')
+          "insert or replace into records (path, revision, source, execution_count, last_executed_at) values #{
+            (['(?,?,?,?,?)'] * records.length).join(',')
           }",
           records.each_with_object([]) do |record, memo|
             memo.push(
               record.path,
               record.revision,
               record.source,
-              JSON.dump(record.execution_count)
+              JSON.dump(record.execution_count),
+              JSON.dump(record.last_executed_at)
             )
           end
         )
@@ -57,13 +59,14 @@ module CoverRage
       def list
         @db
-          .execute('select path, revision, source, execution_count from records')
-          .map do |(path, revision, source, execution_count)|
+          .execute('select path, revision, source, execution_count, last_executed_at from records')
+          .map do |(path, revision, source, execution_count, last_executed_at)|
             Record.new(
               path:,
               revision:,
               source:,
-              execution_count: JSON.parse(execution_count)
+              execution_count: JSON.parse(execution_count),
+              last_executed_at: JSON.parse(last_executed_at)
             )
           end
       end

metadata CHANGED Viewed

@@ -1,70 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: cover_rage
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Weihang Jian
 bindir: bin
 cert_chain: []
-date: 2024-12-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pstore
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.18'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.18'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
 description: |
   cover_rage is a Ruby code coverage tool designed to be simple and easy to use. It can be used not only for test coverage but also in production services to identify unused code.
@@ -111,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.4
 specification_version: 4
 summary: cover_rage is a Ruby code coverage tool designed to be simple and easy to
   use. It can be used not only for test coverage but also in production services to