feat: add show_line_numbers config option, remove anchor line numbers, fix caching, fix double request with htmx, refactor

Author: mutantsan

ckanext/__init__.py

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # this is a namespace package
 try:
     import pkg_resources

ckanext/pygments/assets/css/pygments.css

@@ -8,11 +8,6 @@
     gap: 0.5rem;
 }
 
-
-.pygments-highlight h2 {
-    display: none;
-}
-
 #pygments-spinner {
     gap: 0.25rem;
     display: none;
@@ -28,7 +23,25 @@ body.pygments-request-pending {
 
 }
 
-.pygments_highlight {
+.ckanext-datapreview .pgh {
     max-height: 700px;
     overflow: auto;
 }
+
+.ckanext-datapreview[disabled] {
+    pointer-events: none;
+    opacity: 0.5;
+}
+
+.pgh {
+    width: 100%;
+}
+
+.pgh pre {
+    font-size: 1em;
+    line-height: 1.4;
+}
+
+.pgh .linenos a {
+    color: inherit !important;
+}

ckanext/pygments/assets/js/pygment-line-highlight.js

@@ -3,7 +3,6 @@ pygments-js:
   output: ckanext-pygments/%(version)s-pygments.js
   contents:
     - js/pygment-global.js
-    - js/pygment-line-highlight.js
   extra:
     preload:
       - base/main

ckanext/pygments/assets/webassets.yml

@@ -45,8 +45,8 @@ def set_data(
                 cache_ttl,
                 data,
             )
-        except Exception as e:
-            log.exception("Pygments: failed to save data to Redis: %s", e)
+        except Exception:
+            log.exception("Pygments: failed to save data to Redis")
 
     def invalidate(self, resource_id: str, resource_view_id: str | None = None) -> None:
         """Invalidate cache by key"""

ckanext/pygments/cache.py

@@ -14,6 +14,7 @@
 
 CONF_DEFAULT_VIEW_NAME = "ckanext.pygments.default.view_name"
 CONF_DEFAULT_DESCRIPTION = "ckanext.pygments.default.description"
+CONF_DEFAULT_SHOW_LINE_NUMBERS = "ckanext.pygments.default.show_line_numbers"
 
 
 def is_format_supported(fmt: str) -> bool:
@@ -63,3 +64,8 @@ def get_default_view_name() -> str:
 def get_default_description() -> str:
     """Get the default description"""
     return tk.config[CONF_DEFAULT_DESCRIPTION]
+
+
+def get_default_show_line_numbers() -> bool:
+    """Get the default setting for showing line numbers."""
+    return tk.asbool(tk.config[CONF_DEFAULT_SHOW_LINE_NUMBERS])

ckanext/pygments/config.py

@@ -61,3 +61,9 @@ groups:
         description: Default description
         default: ""
         editable: true
+
+      - key: ckanext.pygments.default.show_line_numbers
+        description: Show Line Numbers by Default
+        default: false
+        type: bool
+        editable: true

ckanext/pygments/config_declaration.yaml

@@ -76,3 +76,13 @@ fields:
   - field_name: ckanext.pygments.default.description
     label: Default description
     form_display: text.html
+
+  - field_name: ckanext.pygments.default.show_line_numbers
+    label: Show Line Numbers by Default
+    preset: select
+    required: true
+    choices:
+      - value: true
+        label: Yes
+      - value: false
+        label: No

ckanext/pygments/config_schema.yaml

@@ -1,14 +1,11 @@
 from __future__ import annotations
 
-from typing import Any, Dict
-
 from ckan.logic.schema import validator_args
+from ckan import types
 
 import ckanext.pygments.config as pygment_config
 from ckanext.pygments.utils import get_list_of_themes
 
-Schema = Dict[str, Any]
-
 
 @validator_args
 def get_preview_schema(
@@ -19,7 +16,8 @@ def get_preview_schema(
     one_of,
     int_validator,
     pygment_max_size,
-) -> Schema:
+    boolean_validator,
+) -> types.Schema:
     return {
         "file_url": [ignore_empty, unicode_safe, url_validator],
         "theme": [
@@ -32,4 +30,8 @@ def get_preview_schema(
             int_validator,
             pygment_max_size,
         ],
+        "show_line_numbers": [
+            default(pygment_config.get_default_show_line_numbers()),
+            boolean_validator,
+        ],
     }

ckanext/pygments/logic/schema.py

@@ -4,7 +4,8 @@
 
 import ckan.plugins as p
 import ckan.plugins.toolkit as tk
-import ckan.types as types
+from ckan import types
+from ckan.common import CKANConfig
 from ckan.types import Context, DataDict
 
 import ckanext.pygments.cache as pygment_cache
@@ -25,7 +26,7 @@ class PygmentsPlugin(p.SingletonPlugin):
 
     # IConfigurer
 
-    def update_config(self, config_):
+    def update_config(self, config_: CKANConfig) -> None:
         tk.add_template_directory(config_, "templates")
         tk.add_resource("assets", "pygments")
 
@@ -43,9 +44,7 @@ def info(self) -> dict[str, Any]:
         }
 
     def can_view(self, data_dict: DataDict) -> bool:
-        return pygment_config.is_format_supported(
-            data_dict["resource"].get("format", "").lower()
-        )
+        return pygment_config.is_format_supported(data_dict["resource"].get("format", "").lower())
 
     def view_template(self, context: Context, data_dict: DataDict) -> str:
         return "pygments/pygment_preview.html"
@@ -54,12 +53,9 @@ def form_template(self, context: Context, data_dict: DataDict) -> str:
         return "pygments/pygment_form.html"
 
     def setup_template_variables(self, context: Context, data_dict: DataDict) -> None:
-        data_dict["resource_view"].setdefault(
-            "title", pygment_config.get_default_view_name()
-        )
-        data_dict["resource_view"].setdefault(
-            "description", pygment_config.get_default_description()
-        )
+        data_dict["resource_view"].setdefault("title", pygment_config.get_default_view_name())
+        data_dict["resource_view"].setdefault("description", pygment_config.get_default_description())
+        data_dict["resource_view"].setdefault("show_line_numbers", pygment_config.get_default_show_line_numbers())
 
     # IResourceController