datasette-edit-schema 0.8a1__tar.gz → 0.8a2__tar.gz

{datasette-edit-schema-0.8a1 → datasette_edit_schema-0.8a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: datasette-edit-schema
-Version: 0.8a1
+Version: 0.8a2
 Summary: Datasette plugin for modifying table schemas
 Author: Simon Willison
 License: Apache-2.0

{datasette-edit-schema-0.8a1 → datasette_edit_schema-0.8a2}/datasette_edit_schema/__init__.py

@@ -1,7 +1,7 @@
 from datasette import hookimpl
 from datasette.events import CreateTableEvent, AlterTableEvent, DropTableEvent
 from datasette.utils.asgi import Response, NotFound, Forbidden
-from datasette.utils import sqlite3
+from datasette.utils import sqlite3, tilde_decode, tilde_encode
 from urllib.parse import quote_plus, unquote_plus
 import sqlite_utils
 import textwrap
@@ -40,7 +40,7 @@ def table_actions(datasette, actor, database, table):
         return [
             {
                 "href": datasette.urls.path(
-                    "/-/edit-schema/{}/{}".format(database, quote_plus(table))
+                    "/-/edit-schema/{}/{}".format(database, tilde_encode(table))
                 ),
                 "label": "Edit table schema",
                 "description": "Rename the table, add and remove columns...",
@@ -216,6 +216,7 @@ async def edit_schema_database(request, datasette):
             {
                 "database": database,
                 "tables": tables,
+                "tilde_encode": tilde_encode,
             },
             request=request,
         )
@@ -307,7 +308,7 @@ async def edit_schema_create_table(request, datasette):
 
 
 async def edit_schema_table(request, datasette):
-    table = unquote_plus(request.url_vars["table"])
+    table = tilde_decode(request.url_vars["table"])
     databases = get_databases(datasette)
     database_name = request.url_vars["database"]
 
@@ -548,16 +549,14 @@ async def edit_schema_table(request, datasette):
                         info["foreign_key"].other_column,
                     ),
                     "value": "{}.{}".format(
-                        info["foreign_key"].other_table,
-                        info["foreign_key"].other_column,
+                        tilde_encode(info["foreign_key"].other_table),
+                        tilde_encode(info["foreign_key"].other_column),
                     ),
                     "selected": True,
                 }
             )
             seen.add(
-                "{}:{}".format(
-                    info["foreign_key"].other_table, info["foreign_key"].other_column
-                )
+                (info["foreign_key"].other_table, info["foreign_key"].other_column)
             )
         # Now add suggestions
         for suggested_table, suggested_column in info["suggestions"]:
@@ -570,19 +569,24 @@ async def edit_schema_table(request, datasette):
                         "name": "{}.{} (suggested)".format(
                             suggested_table, suggested_column
                         ),
-                        "value": "{}.{}".format(suggested_table, suggested_column),
+                        "value": "{}.{}".format(
+                            tilde_encode(suggested_table),
+                            tilde_encode(suggested_column),
+                        ),
                         "selected": False,
                     }
                 )
-                seen.add("{}:{}".format(suggested_table, suggested_column))
+                seen.add((suggested_table, suggested_column))
                 info["suggested"] = "{}.{}".format(suggested_table, suggested_column)
         # And the rest
         for rest_table, rest_column in info["options"]:
-            if "{}:{}".format(rest_table, rest_column) not in seen:
+            if (rest_table, rest_column) not in seen:
                 options.append(
                     {
                         "name": "{}.{}".format(rest_table, rest_column),
-                        "value": "{}.{}".format(rest_table, rest_column),
+                        "value": "{}.{}".format(
+                            tilde_encode(rest_table), tilde_encode(rest_column)
+                        ),
                         "selected": False,
                     }
                 )
@@ -619,6 +623,7 @@ async def edit_schema_table(request, datasette):
                 "can_rename_table": await can_rename_table(
                     datasette, request.actor, database_name, table
                 ),
+                "tilde_encode": tilde_encode,
             },
             request=request,
         )
@@ -782,8 +787,8 @@ async def update_foreign_keys(request, datasette, database, table, formdata):
         fks.append(
             (
                 column,
-                split[0],
-                split[1],
+                tilde_decode(split[0]),
+                tilde_decode(split[1]),
             )
         )
 

{datasette-edit-schema-0.8a1 → datasette_edit_schema-0.8a2}/datasette_edit_schema/templates/edit_schema_database.html

@@ -10,7 +10,7 @@
 <h1>Edit tables in {{ database.name }}.db</h1>
 
 {% for table in tables %}
-    <h2><a href="/-/edit-schema/{{ database.name|quote_plus }}/{{ table.name|quote_plus }}">{{ table.name }}</a></h2>
+    <h2><a href="/-/edit-schema/{{ database.name|quote_plus }}/{{ tilde_encode(table.name) }}">{{ table.name }}</a></h2>
     <p>{% for column in table.columns %}{{ column.name }}{% if not loop.last %}, {% endif %}{% endfor %}</p>
 {% endfor %}
 

{datasette-edit-schema-0.8a1 → datasette_edit_schema-0.8a2}/datasette_edit_schema/templates/edit_schema_table.html

@@ -86,12 +86,12 @@ html body label {
 {% endblock %}
 
 {% block content %}
-<h1>Edit table <a href="{{ base_url }}{{ database.name|quote_plus }}/{{ table|quote_plus }}">{{ database.name }}/{{ table }}</a></h1>
+<h1>Edit table <a href="{{ base_url }}{{ database.name|quote_plus }}/{{ tilde_encode(table) }}">{{ database.name }}/{{ table }}</a></h1>
 
 {% if can_rename_table %}
 <h2>Rename table</h2>
 
-<form action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ table|quote_plus }}" method="post">
+<form action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ tilde_encode(table) }}" method="post">
     <input type="hidden" name="csrftoken" value="{{ csrftoken() }}">
     <p><label>New name&nbsp; <input type="text" name="name"></label>
     <input type="hidden" name="rename_table" value="1">
@@ -99,7 +99,7 @@ html body label {
 </form>
 {% endif %}
 
-<form action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ table|quote_plus }}" method="post">
+<form action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ tilde_encode(table) }}" method="post">
 <h2>Change existing columns</h2>
 <ul class="sortable-columns">
 {% for column in columns %}
@@ -134,7 +134,7 @@ html body label {
 
 <h2>Add a column</h2>
 
-<form action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ table|quote_plus }}" method="post">
+<form action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ tilde_encode(table) }}" method="post">
     <input type="hidden" name="csrftoken" value="{{ csrftoken() }}">
     <input type="hidden" name="add_column" value="1">
     <p><label>Name &nbsp;<input type="text" name="name"></label>
@@ -156,7 +156,7 @@ table.foreign-key-options td {
 }
 </style>
 
-<form action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ table|quote_plus }}" method="post">
+<form action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ tilde_encode(table) }}" method="post">
     <input type="hidden" name="csrftoken" value="{{ csrftoken() }}">
     <input type="hidden" name="action" value="update_foreign_keys">
     <table class="foreign-key-options">
@@ -180,7 +180,7 @@ table.foreign-key-options td {
 
     <p>The primary key column uniquely identifies each row in the table.</p>
 
-    <form action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ table|quote_plus }}" method="post">
+    <form action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ tilde_encode(table) }}" method="post">
         <input type="hidden" name="csrftoken" value="{{ csrftoken() }}">
         <input type="hidden" name="action" value="update_primary_key">
         <label for="primary_key">Primary key column &nbsp;</label>
@@ -201,7 +201,7 @@ table.foreign-key-options td {
 
     <p>Indexes can speed up filter and sort operations against indexed columns.</p>
 
-    <form action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ table|quote_plus }}" method="post">
+    <form action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ tilde_encode(table) }}" method="post">
         <input type="hidden" name="csrftoken" value="{{ csrftoken() }}">
         {% if non_primary_key_columns %}
             <p><label for="id_add_index_column">
@@ -233,7 +233,7 @@ table.foreign-key-options td {
 {% if can_drop_table %}
     <h2>Drop table</h2>
 
-    <form id="drop-table-form" action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ table|quote_plus }}" method="post">
+    <form id="drop-table-form" action="{{ base_url }}-/edit-schema/{{ database.name|quote_plus }}/{{ tilde_encode(table) }}" method="post">
         <input type="hidden" name="csrftoken" value="{{ csrftoken() }}">
         <input type="hidden" name="drop_table" value="1">
         <input type="submit" class="button-red" value="Drop this table">

{datasette-edit-schema-0.8a1 → datasette_edit_schema-0.8a2}/datasette_edit_schema.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: datasette-edit-schema
-Version: 0.8a1
+Version: 0.8a2
 Summary: Datasette plugin for modifying table schemas
 Author: Simon Willison
 License: Apache-2.0

{datasette-edit-schema-0.8a1 → datasette_edit_schema-0.8a2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "datasette-edit-schema"
-version = "0.8a1"
+version = "0.8a2"
 description = "Datasette plugin for modifying table schemas"
 readme = "README.md"
 authors = [{name = "Simon Willison"}]

{datasette-edit-schema-0.8a1 → datasette_edit_schema-0.8a2}/tests/test_edit_schema.py

@@ -1,4 +1,5 @@
 from datasette.app import Datasette
+from datasette.utils import tilde_encode
 from datasette_edit_schema.utils import (
     potential_foreign_keys,
     get_primary_keys,
@@ -41,8 +42,9 @@ async def test_csrf_required(db_path):
         ("user_with_no_perms", False),
     ),
 )
+@pytest.mark.parametrize("table", ("creatures", "animal.name/with/slashes"))
 @pytest.mark.asyncio
-async def test_table_actions(permission_plugin, ds, actor_id, should_allow):
+async def test_table_actions(permission_plugin, ds, actor_id, should_allow, table):
     ds._rules_allow = [
         Rule(
             actor_id="user_with_edit_schema",
@@ -60,9 +62,13 @@ async def test_table_actions(permission_plugin, ds, actor_id, should_allow):
     cookies = None
     if actor_id:
         cookies = {"ds_actor": ds.sign({"a": {"id": actor_id}}, "actor")}
-    response = await ds.client.get("/data/creatures", cookies=cookies)
+    response = await ds.client.get(
+        ds.urls.table(database="data", table=table), cookies=cookies
+    )
     assert response.status_code == 200
-    fragment = '<a href="/-/edit-schema/data/creatures">Edit table schema'
+    fragment = '<a href="/-/edit-schema/data/{}">Edit table schema'.format(
+        tilde_encode(table)
+    )
     if should_allow:
         # Should have table action
         assert fragment in response.text
@@ -814,6 +820,24 @@ async def test_edit_form_for_empty_table(db_path):
             ["id"],
             "Foreign keys updated to distraction_id → cities.id",
         ),
+        # Same again for tables with weird characters in their names
+        (
+            "animal.name/with/slashes",
+            {
+                "action": "update_foreign_keys",
+                "fk.species": "table~2Ename~2Fwith~2Fslashes~2Ecategories.id",
+            },
+            [
+                (
+                    "animal.name/with/slashes",
+                    "species",
+                    "table.name/with/slashes.categories",
+                    "id",
+                )
+            ],
+            ["id"],
+            "Foreign keys updated to species → table.name/with/slashes.categories.id",
+        ),
         # Change primary key in a way that works
         (
             "museums",
@@ -839,13 +863,13 @@ async def test_edit_keys(
     # Grab a csrftoken
     cookies = {"ds_actor": ds.sign({"a": {"id": "root"}}, "actor")}
     csrftoken_r = await ds.client.get(
-        "/-/edit-schema/data/{}".format(table), cookies=cookies
+        "/-/edit-schema/data/{}".format(tilde_encode(table)), cookies=cookies
     )
     csrftoken = csrftoken_r.cookies["ds_csrftoken"]
     cookies["ds_csrftoken"] = csrftoken
     post_data["csrftoken"] = csrftoken
     response = await ds.client.post(
-        "/-/edit-schema/data/{}".format(table),
+        "/-/edit-schema/data/{}".format(tilde_encode(table)),
         data=post_data,
         cookies=cookies,
     )
@@ -1065,6 +1089,19 @@ def test_potential_primary_keys_primary_key_only_table():
             "Index dropped: name_unique_index",
             [{"columns": ["name"], "name": "name_index", "unique": 0}],
         ),
+        # Test for table with surprising characters in its name
+        (
+            "animal.name/with/slashes",
+            {"add_index": "1", "add_index_column": "species"},
+            "Index added on species",
+            [
+                {
+                    "name": "idx_animal.name/with/slashes_species",
+                    "columns": ["species"],
+                    "unique": 0,
+                }
+            ],
+        ),
     ),
 )
 async def test_add_remove_index(
@@ -1072,13 +1109,17 @@ async def test_add_remove_index(
 ):
     ds = Datasette([db_path])
     cookies = {"ds_actor": ds.sign({"a": {"id": "root"}}, "actor")}
-    csrftoken = (
-        await ds.client.get("/-/edit-schema/data/{}".format(table), cookies=cookies)
-    ).cookies["ds_csrftoken"]
+    get_response = await ds.client.get(
+        "/-/edit-schema/data/{}".format(tilde_encode(table)), cookies=cookies
+    )
+    assert get_response.status_code == 200
+    csrftoken = get_response.cookies["ds_csrftoken"]
     cookies["ds_csrftoken"] = csrftoken
     post_data["csrftoken"] = csrftoken
     response = await ds.client.post(
-        "/-/edit-schema/data/{}".format(table), cookies=cookies, data=post_data
+        "/-/edit-schema/data/{}".format(tilde_encode(table)),
+        cookies=cookies,
+        data=post_data,
     )
     assert response.status_code == 302
     messages = ds.unsign(response.cookies["ds_messages"], "messages")