Andrew/refactor audit

src/integration_test/test.sh → integration_test/test.sh

@@ -37,7 +37,7 @@ run_basic_commands() {
     "releases -r $REPO"
     "pypi -r $REPO"
     "audit-releases -r $REPO"
-    "audit-repo -r $REPO"
+    "audit-rulesets -r $REPO"
     "audit-versions -r $REPO"
   )
 
@@ -59,7 +59,7 @@ run_pretty_commands() {
     "releases -r $REPO"
     "pypi -r $REPO"
     "audit-releases -r $REPO"
-    "audit-repo -r $REPO"
+    "audit-rulesets -r $REPO"
     "audit-versions -r $REPO"
   )
 
@@ -81,7 +81,7 @@ run_pretty_json_commands() {
     "releases -r $REPO"
     "pypi -r $REPO"
     "audit-releases -r $REPO"
-    "audit-repo -r $REPO"
+    "audit-rulesets -r $REPO"
     "audit-versions -r $REPO"
   )
 

pyproject.toml

@@ -51,6 +51,7 @@ dev = [
   "poethepoet>=0.30.0",
   "types-tabulate>=0.9.0.20241207",
   "types-aiofiles>=24.1.0.20250326",
+  "ipdb>=0.13.13",
 ]
 
 #docs = [

src/github_helper/_adapters/api_to_cli.py

@@ -1,4 +1,5 @@
 import urllib.parse
+from pprint import pformat
 
 import logistro
 
@@ -12,11 +13,12 @@ class GHAdapter:
     """Allows the CLI to transform the data as required."""
 
     def _check_options(self, formatters):
+        allowed_commands = {"repos", "audit-rulesets"}
         formats = {k for k, v in formatters.items() if v}
         invalid_formats = {"html", "url"} & formats
         if (
             (self._command == "auth-status" and formats)
-            or (self._command != "repos" and invalid_formats)
+            or (self._command not in allowed_commands and invalid_formats)
             or (self._command == "audit-releases" and self._json)
         ):
             raise NotImplementedError(
@@ -74,7 +76,7 @@ async def transform_scopes_data(self, scopes_data):
 
     async def transform_repos_data(self, repos_data):
         if self._html:
-            generated_html = str(await to_html.repos(repos_data))
+            generated_html = str(await to_html.repos_template(repos_data))
             if not self._url:
                 return generated_html
             encoded = urllib.parse.quote(generated_html)
@@ -168,10 +170,23 @@ async def transform_audit_releases_data(self, releases_data):
         )
 
     async def transform_audit_rulesets_data(self, audit_rulesets_data):
+        if self._html:
+            generated_html = str(
+                await to_html.rulesets_template(audit_rulesets_data),
+            )
+            if not self._url:
+                return generated_html
+            encoded = urllib.parse.quote(generated_html)
+            return f"data:text/html;charset=utf-8,{encoded}"
+
         if self._json:
             return to_json.format_json(audit_rulesets_data, pretty=self._pretty)
-        for rule in audit_rulesets_data:
-            rule["template"] = rule["template"][:24]
+
+        audit_rulesets_data["diffs"] = [
+            pformat(d) if not isinstance(d, str) else d
+            for d in audit_rulesets_data.get("diffs")
+        ]
+
         return to_table.format_table(audit_rulesets_data, pretty=self._pretty)
 
     async def transform_audit_versions_data(self, version_data):

src/github_helper/_adapters/to_html/__init__.py

@@ -1,198 +1,4 @@
-from collections.abc import MutableMapping
-from dataclasses import dataclass
-from pathlib import Path
+from .repos import repos_template
+from .rulesets import rulesets_template
 
-import logistro
-from htmy import Component, Context, component, html
-
-from github_helper._adapters.to_html import _components
-from github_helper._utils import load_file
-
-_logger = logistro.getLogger(__name__)
-
-github_com = r"https://www.github.com"
-_HTML_DIR = Path(__file__).resolve().parent
-_STYLES_PATH = _HTML_DIR / "_styles"
-_JS_PATH = _HTML_DIR / "_js"
-
-
-@dataclass(frozen=True, kw_only=True, slots=True)
-class RepoRow:
-    repo: MutableMapping
-
-    def _error_printer(self, s):
-        return html.span(str(type(s).__name__), title=str(s))
-
-    async def htmy(self, context: Context) -> Component:  # noqa: ARG002
-        repo = self.repo
-        permission_msg = {
-            0: "Can read and clone this repository.",
-            1: "Can pull and also manage issues and pull requests.",
-            2: "Can read, clone, and push to this repository",
-            3: "Can also manage issues, pull requests, and some repository settings.",
-            4: "Full access to the repository, including settings and collaborators.",
-        }
-
-        _logger.debug(f"Building html row for {repo['name']}")
-        return html.tr(
-            html.td(html.span("📌" if repo["pinned"] else "")),
-            html.td(
-                html.a(
-                    repo["owner"],
-                    href=f"{github_com}/{repo['owner']}",
-                    target="_blank",
-                ),
-                class_="owner",
-            ),
-            html.td(html.span("/")),
-            html.td(
-                html.a(
-                    repo["name"],
-                    href=f"{github_com}/{repo['owner']}/{repo['name']}",
-                    target="_blank",
-                ),
-                class_="repo",
-            ),
-            html.td(html.span(repo["version"]), class_="text-center"),
-            html.td(html.span("⑂" if repo["fork"] else "")),
-            html.td(
-                html.span(repo["description"] or ""),
-                class_="description",
-            ),
-            html.td(
-                html.a(
-                    "🔧",
-                    href=f"{github_com}/{repo['owner']}/{repo['name']}/settings/access",
-                    target="_blank",
-                ),
-                *[
-                    self._error_printer(s)
-                    if isinstance(s, Exception)
-                    else html.a(
-                        s["user"],
-                        html.sup(
-                            str(s["permission"]),
-                            class_="badge",
-                        ),
-                        href=f"{github_com}/{s['user']}",
-                        class_="collaborator",
-                        target="_blank",
-                        title=permission_msg[s["permission"]],
-                    )
-                    if isinstance(s, dict)
-                    else s
-                    for s in (
-                        sorted(
-                            repo["collaborators"],
-                            key=lambda d: d["permission"],
-                            reverse=True,
-                        )
-                        if repo["collaborators"]
-                        and isinstance(repo["collaborators"][0], dict)
-                        else repo["collaborators"]
-                    )
-                ],
-                class_="collaborators",
-            ),
-            html.td(
-                html.a(
-                    "🔧",
-                    href=f"{github_com}/{repo['owner']}/{repo['name']}",
-                    target="_blank",
-                ),
-                *[html.span(s, class_=f"topic {s}") for s in repo["topics"]],
-                class_="topics",
-            ),
-            class_=(
-                "repo-row "
-                f"{repo['visibility']} "
-                f"{'archived' if repo['archived'] else ''}"
-            ),
-        )
-
-
-@component
-def repo_rows(repos, context: Context) -> Component:  # noqa: ARG001
-    return [RepoRow(repo=repo) for repo in repos]
-
-
-async def repos(repos_data):
-    _logger.debug("Building table.")
-    styles = html.style(await load_file(_STYLES_PATH / "repos.css"))
-    table = html.table(repo_rows(repos_data), class_="mx-auto")
-    modal_iframe = _components.modal(
-        "my-modal",
-        "closeModal()",
-        html.iframe(src="", height="500", class_="w-full"),
-    )
-    _logger.debug("Building page.")
-    scripts = [
-        html.script(
-            html.SafeStr(
-                "\n".join(
-                    [
-                        await load_file(_JS_PATH / "repos.js"),
-                        await load_file(_JS_PATH / "modal.js"),
-                    ],
-                ),
-            ),
-        ),
-    ]
-    content = [
-        html.div(
-            html.label(
-                html.input_(
-                    type_="checkbox",
-                    id_="toggle-public",
-                    checked=True,
-                ),
-                " Show Public",
-            ),
-            html.label(
-                html.input_(
-                    type_="checkbox",
-                    id_="toggle-private",
-                    checked=True,
-                    style="margin-left:1rem;",
-                ),
-                " Show Private",
-            ),
-            html.label(
-                html.input_(
-                    type_="checkbox",
-                    id_="toggle-archive",
-                    checked=True,
-                    style="margin-left:1rem;",
-                ),
-                " Show Archived",
-            ),
-            html.br(),
-            html.label(
-                " Owner",
-                html.input_(
-                    type_="text",
-                    id_="owner-filter",
-                    name="owner-filter",
-                    placeholder="Owner",
-                    class_="rounded shadow-sm sm:text-sm p-1",
-                ),
-            ),
-            html.label(
-                " Repo",
-                html.input_(
-                    type_="text",
-                    id_="repo-filter",
-                    name="repo-filter",
-                    placeholder="Repo",
-                    class_="rounded shadow-sm sm:text-sm p-1",
-                ),
-            ),
-            style="margin-bottom: 1rem;",
-            class_="mx-auto",
-            id_="controls",
-        ),
-        table,
-        modal_iframe,
-        *scripts,
-    ]
-    return await _components.render_page([styles], content)
+__all__ = ["repos_template", "rulesets_template"]

src/github_helper/_adapters/to_html/_js/repos.js

@@ -3,6 +3,7 @@ const privateCheckbox = document.getElementById('toggle-private');
 const archivedCheckbox = document.getElementById('toggle-archive');
 const ownerInput = document.getElementById('owner-filter');
 const repoInput = document.getElementById('repo-filter');
+const tbody = document.querySelector("tbody");
 
 function filterAll() {
     console.log("Filtering All.")

src/github_helper/_adapters/to_html/_js/utils.js

@@ -0,0 +1,21 @@
+const sortTableBy = (btnId, filter) => {
+    const filterBtn = document.getElementById(btnId);
+    const order = filterBtn.dataset.order === "asc" ? "desc" : "asc";
+    filterBtn.dataset.order = order;
+    isAsc = order === "asc"
+    filterBtn.textContent = `${isAsc ? "⬆️" : "⬇️"}`;
+    filterBtn.title = `Sort by ${isAsc ? "asc" : "desc"}`;
+
+    const rows = Array.from(tbody.querySelectorAll("tr"));
+
+    rows.sort((a, b) => {
+        const nameA = a.querySelector(filter).textContent.trim().toLowerCase();
+        const nameB = b.querySelector(filter).textContent.trim().toLowerCase();
+        return order === "asc"
+            ? nameA.localeCompare(nameB)
+            : nameB.localeCompare(nameA);
+    });
+
+    rows.forEach(row => tbody.appendChild(row));
+    updateVisibleRowClasses();
+}

src/github_helper/_adapters/to_html/_styles/common.css

@@ -0,0 +1,28 @@
+body {
+    overflow-x: auto;
+    width: 100%;
+}
+
+table {
+    width: max-content;
+}
+
+tr.even {
+    background-color: #f0f0f0;
+}
+
+tr.odd {
+    background-color: #ffffff;
+}
+
+.table {
+    @apply table-auto mx-auto my-4 border border-gray-300 shadow-md rounded-md overflow-hidden text-sm;
+}
+
+.table-header {
+    @apply text-center px-4 py-2 text-sm font-semibold text-gray-700 bg-gray-300 border-r;
+}
+
+.table-col {
+    @apply px-2 py-2 align-top border-t border-gray-200 border-r;
+}

src/github_helper/_adapters/to_html/_styles/repos.css

@@ -26,23 +26,6 @@ tr.repo-row td a:active {
     color: black;
 }
 
-body {
-    overflow-x: auto;
-    width: 100%;
-}
-
-table {
-    width: max-content;
-}
-
-tr.even {
-    background-color: #f0f0f0;
-}
-
-tr.odd {
-    background-color: #ffffff;
-}
-
 tr.repo-row.private {
     font-weight: 350;
 }