Merge pull request #13 from okfn/10-nnew-admin-confg

Add new admin conf

Author: germankay

README.md

@@ -131,7 +131,7 @@ See [Troubleshooting procedure](/docs/Troubleshooting.md)
 
 This extension allows customization of the dashboard title displayed on dataset pages.
 
-### `ckanext.bcie.dashboard_title`
+### `ckanext.dashboard.title`
 
 - **Type:** `string`
 - **Default:** `"Dashboard"`
@@ -143,13 +143,13 @@ This extension allows customization of the dashboard title displayed on dataset
 To customize the title:
 
 ```ini
-ckanext.bcie.dashboard_title = Project Monitoring
+ckanext.dashboard.title = Project Monitoring
 ```
 
 To hide the title completely:
 
 ```ini
-ckanext.bcie.dashboard_title = 
+ckanext.dashboard.title = 
 ```
 
 > Note: This setting is read directly from the CKAN configuration file. If you wish to expose it in the sysadmin UI (`/admin/config`), you will need to register a config validator in the plugin.

ckanext/dashboard/helpers.py

@@ -15,6 +15,8 @@ def get_dataset_dashboard(package_id):
 def get_dashboard_title_from_config():
     """Gets the dashboard title from the .ini configuration"""
     # If exists and it's empty, we assume users wants not to display the title
-    title = t.config.get('ckanext.bcie.dashboard_title', t._('Dashboard'))
+    title = t.config.get('ckanext.dashboard.title', '')
+    print(f"Dashboard title from config: {title}")  # Debugging output
+    log.debug(f"Dashboard title from config: {title}")
 
     return title

ckanext/dashboard/plugin.py

@@ -1,3 +1,5 @@
+import logging
+
 from ckan import plugins as p
 from ckan.lib.plugins import DefaultTranslation
 from ckan.plugins import toolkit
@@ -10,6 +12,9 @@
 from ckanext.dashboard import helpers as h
 
 
+log = logging.getLogger(__name__)
+
+
 class DashboardPlugin(p.SingletonPlugin, DefaultTranslation):
     """Plugin for managing dashboards in CKAN"""
     p.implements(p.IConfigurer)
@@ -26,6 +31,14 @@ def update_config(self, config_):
         toolkit.add_public_directory(config_, "public")
         toolkit.add_resource("assets", "dashboard")
 
+        title_config = config_.get("ckanext.dashboard_title", config_.get("ckanext.dashboard.title", ""))
+        log.debug(f"Setting default dashboard title: {title_config}")
+
+        config_.setdefault(
+            "ckanext.dashboard.title",
+            title_config
+        )
+
     def get_blueprint(self):
         return dashboard_bp
 

ckanext/dashboard/templates/admin/config.html

@@ -0,0 +1,16 @@
+{% ckan_extends %}
+{% import 'macros/form.html' as form %}
+
+{% block admin_form %}
+  {{ super() }}
+
+  <h2>{{ _('Dashboard Configuration') }}</h2>
+  <div class="group-fields">
+    {{ form.input(
+        'ckanext.dashboard.title',
+        label=_('Dashboard Title'),
+        value=data.get('ckanext.dashboard.title') or h.get_dashboard_title_from_config(),
+        error=errors['ckanext.dashboard.title']
+    ) }}
+  </div>
+{% endblock %}

ckanext/dashboard/tests/test_title.py

@@ -21,15 +21,20 @@ def setup_data():
 class TestTitle:
     """ Test the dashboard title """
 
-    @pytest.mark.ckan_config("ckanext.bcie.dashboard_title", "My dash title")
+    @pytest.mark.ckan_config("ckanext.dashboard.title", "My dash title")
     def test_title_exists(self, app, setup_data):
         headers = {'Authorization': setup_data.user['token']}
         response = app.get(url_for("dataset.read", id=setup_data.dataset["name"]), headers=headers)
         assert "dashboard-title-class" in response
         assert 'My dash title' in response
+        html = response.data.decode('utf-8')
+        assert "dashboard-title-class" in html
+        assert "My dash title" in html
 
-    @pytest.mark.ckan_config("ckanext.bcie.dashboard_title", "")
+    @pytest.mark.ckan_config("ckanext.dashboard.title", "")
     def test_empty_title(self, app, setup_data):
         headers = {'Authorization': setup_data.user['token']}
         response = app.get(url_for("dataset.read", id=setup_data.dataset["name"]), headers=headers)
         assert "dashboard-title-class" not in response
+        html = response.data.decode('utf-8')
+        assert "dashboard-title-class" not in html