Use new homepage_actions() plugin hook

Refs #4 Refs simonw/datasette#2298
datasette · Mar 13, 2024 · d870d29 · d870d29
1 parent 58d9bd2
commit d870d29
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 42 deletions.
diff --git a/datasette_metadata_editable/__init__.py b/datasette_metadata_editable/__init__.py
@@ -255,38 +255,21 @@ def register_routes():
 
 
 @hookimpl
-async def extra_body_script(
-    template, database, table, columns, view_name, request, datasette
-):
-    if not request or not await datasette.permission_allowed(
-        request.actor, PERMISSION_EDIT_METADATA, default=False
-    ):
-        return ""
-    if view_name == "index":
-        url = "/-/datasette-metadata-editable/edit?"
-        return f"""
-          const editMetadata = document.createElement("a")
-          editMetadata.textContent = "Edit metadata"
-          editMetadata.setAttribute('href', {json.dumps(url)})
-
-          const metadataElement = document.querySelector('.metadata-description');
-          if(metadataElement)
-              metadataElement.appendChild(editMetadata)
-          else
-            (document.querySelector('.page-header') || document.querySelector('h1')).after(editMetadata)
-        """
-    return ""
-
-
-@hookimpl
-def extra_js_urls(template, database, table, columns, view_name, request, datasette):
-    if view_name in {"table", "query", "database"}:
+def homepage_actions(datasette, actor):
+    async def inner():
+        if not await datasette.permission_allowed(
+            actor, PERMISSION_EDIT_METADATA, default=False
+        ):
+            return []
         return [
-            datasette.urls.path(
-                "/-/static-plugins/datasette-metadata-editable/plugin.js"
-            )
+            {
+                "href": datasette.urls.path("/-/datasette-metadata-editable/edit"),
+                "label": "Edit instance metadata",
+            }
         ]
 
+    return inner
+
 
 @hookimpl
 def database_actions(datasette, actor, database):

diff --git a/pyproject.toml b/pyproject.toml
@@ -11,7 +11,7 @@ classifiers=[
 ]
 requires-python = ">=3.8"
 dependencies = [
-    "datasette>=1.0a7",
+    "datasette>=1.0a13",
     "markdown2>=2.4.10",
     "nh3==0.2.14",
     "sqlite-migrate>=0.1b0",

diff --git a/tests/test_metadata_editable.py b/tests/test_metadata_editable.py
@@ -13,13 +13,48 @@ async def test_plugin_is_installed():
     assert "datasette-metadata-editable" in installed_plugins
 
 
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "path,expected_url",
+    (
+        ("/", "/-/datasette-metadata-editable/edit"),
+        (
+            "/test_action_menus",
+            "/-/datasette-metadata-editable/edit?db=test_action_menus",
+        ),
+        (
+            "/test_action_menus/foo",
+            "/-/datasette-metadata-editable/edit?db=test_action_menus&amp;table=foo",
+        ),
+    ),
+)
+async def test_action_menus(path, expected_url):
+    datasette = Datasette(
+        config={"permissions": {"datasette-metadata-editable-edit": {"id": ["root"]}}},
+    )
+    db = datasette.add_memory_database("test_action_menus")
+    await db.execute_write("create table if not exists foo (id integer primary key)")
+    fragment = '"{}"'.format(expected_url)
+    # Anonymous
+    anon_response = await datasette.client.get(path)
+    assert fragment not in anon_response.text
+    # User but not the root user
+    user_response = await datasette.client.get(
+        path, cookies={"ds_actor": datasette.client.actor_cookie({"id": "user"})}
+    )
+    assert fragment not in user_response.text
+    # root user
+    root_response = await datasette.client.get(
+        path, cookies={"ds_actor": datasette.client.actor_cookie({"id": "root"})}
+    )
+    assert fragment in root_response.text
+
+
 @pytest.mark.asyncio
 async def test_basic(snapshot):
     datasette = Datasette(
         memory=True,
-        metadata={
-            "permissions": {"datasette-metadata-editable-edit": {"id": ["root"]}}
-        },
+        config={"permissions": {"datasette-metadata-editable-edit": {"id": ["root"]}}},
     )
     assert datasette.metadata("title") is None
 
@@ -62,9 +97,7 @@ async def all_entries():
 async def test_edit_table():
     datasette = Datasette(
         memory=True,
-        metadata={
-            "permissions": {"datasette-metadata-editable-edit": {"id": ["root"]}}
-        },
+        config={"permissions": {"datasette-metadata-editable-edit": {"id": ["root"]}}},
     )
     db = datasette.add_memory_database("test-db-with-hyphens")
     await db.execute_write(
@@ -172,9 +205,7 @@ async def test_metadata_survives_server_restart(tmpdir):
         sqlite_utils.Database(path).vacuum()
     datasette = Datasette(
         [one, two],
-        metadata={
-            "permissions": {"datasette-metadata-editable-edit": {"id": ["root"]}}
-        },
+        config={"permissions": {"datasette-metadata-editable-edit": {"id": ["root"]}}},
         internal=internal,
     )
     db = datasette.get_database("one")
@@ -218,9 +249,7 @@ async def test_metadata_survives_server_restart(tmpdir):
     # Now restart the server
     datasette2 = Datasette(
         [one, two],
-        metadata={
-            "permissions": {"datasette-metadata-editable-edit": {"id": ["root"]}}
-        },
+        config={"permissions": {"datasette-metadata-editable-edit": {"id": ["root"]}}},
         internal=internal,
         pdb=True,
     )