datasette-ripgrep for datasette>=1.0a20

Refs simonw/datasette#2577

Author: simonw

README.md

@@ -33,19 +33,15 @@ The `rg` executable needs to be [installed](https://github.com/BurntSushi/ripgre
 
 This plugin requires configuration: it needs to a `path` setting so that it knows where to run searches.
 
-Create a `metadata.json` file that looks like this:
-
-```json
-{
-    "plugins": {
-        "datasette-ripgrep": {
-            "path": "/path/to/your/files"
-        }
-    }
-}
+Create a `datasette.yaml` file that looks like this:
+
+```yaml
+plugins:
+  datasette-ripgrep:
+    path: /path/to/your/files
 ```
 
-Now run Datasette using `datasette -m metadata.json`. The plugin will add an interface at `/-/ripgrep` for running searches.
+Now run Datasette using `datasette --config datasette.yaml`. The plugin will add an interface at `/-/ripgrep` for running searches.
 
 ## Plugin configuration
 

datasette_ripgrep/__init__.py

@@ -166,13 +166,11 @@ async def view_file(request, datasette):
 
 
 async def check_permission(request, datasette):
-    if (
-        await datasette.permission_allowed(
-            request.actor,
-            "view-instance",
-            default=None,
-        )
-    ) is False:
+    can_view = await datasette.allowed(
+        action="view-instance",
+        actor=request.actor,
+    )
+    if not can_view:
         raise Forbidden("view-instance denied")
 
 

setup.py

@@ -26,15 +26,14 @@ def get_long_description():
     },
     license="Apache License, Version 2.0",
     classifiers=[
-        "Framework :: Datasette",
-        "License :: OSI Approved :: Apache Software License",
+        "Framework :: Datasette"
     ],
     version=VERSION,
     packages=["datasette_ripgrep"],
     entry_points={"datasette": ["ripgrep = datasette_ripgrep"]},
     package_data={"datasette_ripgrep": ["templates/*.html"]},
-    install_requires=["datasette"],
+    install_requires=["datasette>=1.0a21"],
     extras_require={"test": ["pytest", "pytest-asyncio", "httpx"]},
     tests_require=["datasette-ripgrep[test]"],
-    python_requires=">=3.7",
+    python_requires=">=3.10",
 )

tests/test_ripgrep.py

@@ -24,7 +24,7 @@ def datasette(src):
     return Datasette(
         [],
         memory=True,
-        metadata={
+        config={
             "plugins": {
                 "datasette-ripgrep": {
                     "path": str(src),
@@ -212,7 +212,7 @@ async def test_menu_link(datasette):
 
 @pytest.mark.asyncio
 @pytest.mark.parametrize(
-    "metadata,authenticated,path,expected_status",
+    "config_overrides,authenticated,path,expected_status",
     [
         # Deny all access
         ({"allow": False}, False, "/-/ripgrep", 403),
@@ -231,19 +231,19 @@ async def test_menu_link(datasette):
         ({"allow": {"id": "user"}}, True, "/-/ripgrep/view/one.txt", 200),
     ],
 )
-async def test_permissions(src, metadata, authenticated, path, expected_status):
+async def test_permissions(src, config_overrides, authenticated, path, expected_status):
     datasette = Datasette(
         [],
         memory=True,
-        metadata={
+        config={
             **{
                 "plugins": {
                     "datasette-ripgrep": {
                         "path": str(src),
                     }
                 },
             },
-            **metadata,
+            **config_overrides,
         },
     )
     cookies = {}
@@ -256,16 +256,16 @@ async def test_permissions(src, metadata, authenticated, path, expected_status):
 @pytest.mark.asyncio
 @pytest.mark.parametrize("configured", (True, False))
 async def test_configuration(configured):
-    metadata = {}
+    config = {}
     if configured:
-        metadata = {
+        config = {
             "plugins": {
                 "datasette-ripgrep": {
                     "path": "/tmp",
                 }
             }
         }
-    datasette = Datasette(memory=True, metadata=metadata)
+    datasette = Datasette(memory=True, config=config)
     response = await datasette.client.get("/-/ripgrep")
     if not configured:
         assert response.status_code == 500