feat: rework max_size and cache.size config options usage, fix styles

mutantsan · mutantsan · commit 7477fe8f8b28 · 2025-11-26T13:55:33.000+02:00
diff --git a/ckanext/pygments/assets/css/pygments.css b/ckanext/pygments/assets/css/pygments.css
@@ -18,11 +18,6 @@
     display: flex;
 }
 
-body.pygments-request-pending {
-    opacity: 0.7;
-
-}
-
 .ckanext-datapreview .pgh {
     max-height: 700px;
     overflow: auto;
@@ -39,9 +34,7 @@ body.pygments-request-pending {
 
 .pgh pre {
     font-size: 1em;
-    line-height: 1.4;
-}
-
-.pgh .linenos a {
-    color: inherit !important;
+    line-height: 1.3;
+    margin: 0;
+    padding: 0.5rem;
 }
diff --git a/ckanext/pygments/assets/js/pygment-global.js b/ckanext/pygments/assets/js/pygment-global.js
diff --git a/ckanext/pygments/assets/webassets.yml b/ckanext/pygments/assets/webassets.yml
@@ -1,12 +1,3 @@
-pygments-js:
-  filter: rjsmin
-  output: ckanext-pygments/%(version)s-pygments.js
-  contents:
-    - js/pygment-global.js
-  extra:
-    preload:
-      - base/main
-
 pygments-js-htmx:
   filter: rjsmin
   output: ckanext-pygments/%(version)s-pygments-htmx.js
diff --git a/ckanext/pygments/config.py b/ckanext/pygments/config.py
@@ -3,29 +3,24 @@
 
 CONF_SUPPORTED_FORMATS = "ckanext.pygments.supported_formats"
 
-CONF_MAX_SIZE = "ckanext.pygments.max_size"
 CONF_ENABLE_HTMX = "ckanext.pygments.include_htmx_asset"
-CONF_DEFAULT_THEME = "ckanext.pygments.default_theme"
-CONF_GUESS_LEXER = "ckanext.pygments.guess_lexer"
 
+CONF_GUESS_LEXER = "ckanext.pygments.guess_lexer"
 CONF_ENABLE_CACHE = "ckanext.pygments.cache.enable"
-CONF_RES_CACHE_MAX_SIZE = "ckanext.pygments.cache.preview_max_size"
+CONF_RES_CACHE_MAX_SIZE = "ckanext.pygments.cache.max_size"
 CONF_CACHE_TTL = "ckanext.pygments.cache.ttl"
 
 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"
+CONF_DEFAULT_MAX_SIZE = "ckanext.pygments.default.max_size"
+CONF_DEFAULT_THEME = "ckanext.pygments.default.theme"
 
 
 def is_format_supported(fmt: str) -> bool:
     return fmt in [fmt.strip().lower() for fmt in tk.config[CONF_SUPPORTED_FORMATS].split(",")]
 
 
-def bytes_to_render() -> int:
-    """Check how many bytes from file we are going to render as preview"""
-    return tk.config[CONF_MAX_SIZE]
-
-
 def include_htmx_asset() -> bool:
     """Include HTMX library asset. Enable it, if no other library do it."""
     return tk.asbool(tk.config[CONF_ENABLE_HTMX])
@@ -69,3 +64,8 @@ def get_default_description() -> str:
 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])
+
+
+def get_default_max_size() -> int:
+    """Get the default max size for preview rendering."""
+    return tk.config[CONF_DEFAULT_MAX_SIZE]
diff --git a/ckanext/pygments/config_declaration.yaml b/ckanext/pygments/config_declaration.yaml
@@ -7,23 +7,12 @@ groups:
         default: sql, html, xhtml, htm, xslt, py, pyw, pyi, jy, sage, sc, rs, rs.in, rst, rest, md, markdown, xml, xsl, rss, xslt, xsd, wsdl, wsf, json, jsonld, yaml, yml, dtd, php, inc, rdf, ttl, js, txt
         editable: true
 
-      - key: ckanext.pygments.max_size
-        type: int
-        description: Specify how many bytes we are going to render from file. Default to 1MB
-        default: 1048576
-        editable: true
-
       - key: ckanext.pygments.include_htmx_asset
         description: Include HTMX asset
         default: true
         type: bool
         editable: true
 
-      - key: ckanext.pygments.default_theme
-        description: Default theme for preview
-        default: default
-        editable: true
-
       - key: ckanext.pygments.guess_lexer
         description: Try to guess the Lexer for a format
         default: true
@@ -38,7 +27,7 @@ groups:
         type: bool
         editable: true
 
-      - key: ckanext.pygments.cache.preview_max_size
+      - key: ckanext.pygments.cache.max_size
         description: Specify what is the maximum size of a preview we are going to cache
         default: 20971520 # 20MB
         type: int
@@ -67,3 +56,14 @@ groups:
         default: false
         type: bool
         editable: true
+
+      - key: ckanext.pygments.default.max_size
+        description: Default maximum file size to render in bytes
+        default: 1048576 # 1MB
+        type: int
+        editable: true
+
+      - key: ckanext.pygments.default.theme
+        description: Default theme for preview
+        default: default
+        editable: true
diff --git a/ckanext/pygments/config_schema.yaml b/ckanext/pygments/config_schema.yaml
@@ -15,11 +15,6 @@ fields:
       required: 1
       data-module-load-url: "/api/action/pygments_formats_list"
 
-  - field_name: ckanext.pygments.max_size
-    label: Max Size
-    help_text: Specify how many bytes we are going to render from file. Default to 1MB
-    input_type: number
-
   - field_name: ckanext.pygments.include_htmx_asset
     label: Include HTMX Asset
     help_text: Include HTMX asset
@@ -31,7 +26,7 @@ fields:
       - value: false
         label: No
 
-  - field_name: ckanext.pygments.default_theme
+  - field_name: ckanext.pygments.default.theme
     label: Default Theme
     help_text: Default theme for preview
     preset: select
@@ -60,8 +55,8 @@ fields:
       - value: false
         label: No
 
-  - field_name: ckanext.pygments.cache.preview_max_size
-    label: Preview Max Size
+  - field_name: ckanext.pygments.cache.max_size
+    label: Cache Max Size
     help_text: Specify what is the maximum size of a preview we are going to cache. Default is 20MB
     input_type: number
 
@@ -86,3 +81,8 @@ fields:
         label: Yes
       - value: false
         label: No
+
+  - field_name: ckanext.pygments.default.max_size
+    label: Default Max Size
+    help_text: Specify how many bytes we are going to render from file. Default to 1MB
+    input_type: number
diff --git a/ckanext/pygments/helpers.py b/ckanext/pygments/helpers.py
@@ -13,7 +13,7 @@ def pygments_get_preview_theme_options() -> list[dict[str, str]]:
 
 
 def pygments_get_default_max_size() -> int:
-    return pygment_config.bytes_to_render()
+    return pygment_config.get_default_max_size()
 
 
 def pygments_include_htmx_asset() -> bool:
diff --git a/ckanext/pygments/logic/schema.py b/ckanext/pygments/logic/schema.py
@@ -15,7 +15,7 @@ def get_preview_schema(
     default,
     one_of,
     int_validator,
-    pygment_max_size,
+    is_positive_integer,
     boolean_validator,
 ) -> types.Schema:
     return {
@@ -25,10 +25,10 @@ def get_preview_schema(
             unicode_safe,
             one_of(get_list_of_themes()),
         ],
-        "size": [
-            default(pygment_config.bytes_to_render()),
+        "max_size": [
+            default(pygment_config.get_default_max_size()),
             int_validator,
-            pygment_max_size,
+            is_positive_integer,
         ],
         "show_line_numbers": [
             default(pygment_config.get_default_show_line_numbers()),
diff --git a/ckanext/pygments/logic/validators.py b/ckanext/pygments/logic/validators.py
diff --git a/ckanext/pygments/plugin.py b/ckanext/pygments/plugin.py
@@ -14,7 +14,6 @@
 
 
 @tk.blanket.helpers
-@tk.blanket.validators
 @tk.blanket.config_declarations
 @tk.blanket.blueprints
 @tk.blanket.actions
@@ -56,6 +55,7 @@ def setup_template_variables(self, context: Context, data_dict: DataDict) -> Non
         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())
+        data_dict["resource_view"].setdefault("max_size", pygment_config.get_default_max_size())
 
     # IResourceController
 
diff --git a/ckanext/pygments/templates/package/snippets/resource_view.html b/ckanext/pygments/templates/package/snippets/resource_view.html
@@ -1,8 +1,9 @@
 {% ckan_extends %}
 
 {% block resource_view %}
+    {% if resource_view.view_type == "pygments_view" %}
     <div class="pygments-info">
-        {% if g.userobj.sysadmin and h.pygments_is_cache_enabled() and resource_view.view_type == "pygments_view" %}
+        {% if g.userobj.sysadmin and h.pygments_is_cache_enabled()%}
             {% set clear_cache_url = h.url_for('pygments.clear_resource_cache', resource_id=resource.id) %}
 
             {% if resource_view.file_url %}
@@ -22,6 +23,7 @@
             <span>{{ _("Current") }}: {{ h.pygments_printable_file_size(h.pygments_get_resource_view_cache_size(resource.id, resource_view.id if resource_view.file_url else "")) }}</span>
         {% endif %}
     </div>
+    {% endif %}
 
     {{ super() }}
 {% endblock %}
diff --git a/ckanext/pygments/templates/pygments/config.html b/ckanext/pygments/templates/pygments/config.html
@@ -2,6 +2,7 @@
 
 {% block before_form %}
     <form method="POST" action="{{ h.url_for('pygments.clear_cache') }}" class="mb-3">
+        {{ h.csrf_input() }}
 
         <div class="pygments-info">
             <button type="submit" name="invalidate-all-cache" value="clear_cache" class="btn btn-primary">
diff --git a/ckanext/pygments/templates/pygments/pygment_form.html b/ckanext/pygments/templates/pygments/pygment_form.html
@@ -21,12 +21,12 @@
 }}
 
 {% call form.input(
-    'size',
-    id='field-size',
+    'max_size',
+    id='field-max_size',
     label=_('Max size to render'),
-    value=data.size or h.pygments_get_default_max_size(),
-    error=errors.size) %}
-        {{ form.info(_('Specifies how many bytes from file we are going to render with ckanext-pygment. Set to `-1` if you want to disable a limit. This can cause the page to load very slowly.', classes=['info-help-tight'])) }}
+    value=data.max_size or h.pygments_get_default_max_size(),
+    error=errors.max_size) %}
+        {{ form.info(_('Specifies how many bytes from file we are going to render. Set to `-1` if you want to disable a limit. <i class="fa fa-warning"></i> This can cause the page to load very slowly.', classes=['info-help-tight'])) }}
 {% endcall %}
 
 {% call form.select(
diff --git a/ckanext/pygments/templates/pygments/pygment_preview.html b/ckanext/pygments/templates/pygments/pygment_preview.html
@@ -2,14 +2,13 @@
     'pygments.highlight',
     resource_id=resource.id,
     theme=resource_view.theme,
-    chunk_size=resource_view.size,
+    max_size=resource_view.max_size,
     file_url=resource_view.file_url,
     resource_view_id=resource_view.id if resource_view.file_url else '',
     show_line_numbers=resource_view.show_line_numbers
 ) %}
 
 <div
-    data-module="pygment-global"
     hx-target="this"
     hx-trigger="load delay:1ms, htmx:afterRequest from:.btn-pygment-refresh"
     hx-get="{{ preview_url }}"
@@ -20,8 +19,6 @@
     </span>
 </div>
 
-{% asset 'pygments/pygments-js' %}
-
 {% if h.pygments_include_htmx_asset() %}
     {% asset "pygments/pygments-js-htmx" %}
 {% endif %}
diff --git a/ckanext/pygments/utils.py b/ckanext/pygments/utils.py
diff --git a/ckanext/pygments/views.py b/ckanext/pygments/views.py
diff --git a/pyproject.toml b/pyproject.toml
