From bc5ba46851ee05833c9c01e4f4c200d5a8f510fb Mon Sep 17 00:00:00 2001
From: Griatch <griatch@gmail.com>
Date: Fri, 7 Jan 2022 22:27:06 +0100
Subject: [PATCH] Add additional script migration

---
 docs/pylib/contrib_readmes2docs.py            | 48 +++++++++++
 .../migrations/0015_convert_contrib_paths.py  | 81 +++++++++++++++++++
 2 files changed, 129 insertions(+)
 create mode 100644 docs/pylib/contrib_readmes2docs.py
 create mode 100644 evennia/scripts/migrations/0015_convert_contrib_paths.py

diff --git a/docs/pylib/contrib_readmes2docs.py b/docs/pylib/contrib_readmes2docs.py
new file mode 100644
index 0000000000..f6d67e8639
--- /dev/null
+++ b/docs/pylib/contrib_readmes2docs.py
@@ -0,0 +1,48 @@
+"""
+Convert contribs' README files to proper documentation pages along with
+an index.
+
+"""
+from os.path import abspath, dirname, join as pathjoin, sep
+from glob import glob
+
+_EVENNIA_PATH = pathjoin(dirname(dirname(dirname(abspath(__file__)))))
+_DOCS_PATH = pathjoin(_EVENNIA_PATH, "docs")
+
+_CONTRIB_PATH = pathjoin(_EVENNIA_PATH, "contrib")
+_SOURCE_DIR = pathjoin(_EVENNIA_PATH, "contrib")
+_OUT_DIR = pathjoin(_DOCS_PATH, "source", "Contribs")
+_OUT_INDEX_FILE = pathjoin(_OUT_DIR, "Contribs.md")
+
+
+TOCTREE = """
+```{{toctree}}
+:depth: 2
+
+{listing}
+
+"""
+
+
+def readme2doc(directory):
+    """
+    Parse directory for README files and convert them to doc pages.
+
+    """
+
+    indexfile = []
+    listing = []
+
+    for file_path in glob(f"directory{sep}*{sep}*{sep}README.md"):
+
+        # paths are e.g. evennia/contrib/utils/auditing/README.md
+        _, category, name, _ = file_path.rsplit(sep, 3)
+
+        filename = "-".join(part.capitalize() for part in name.split("_")) + ".md"
+        outfile = pathjoin(_OUT_DIR, filename)
+
+        with open(file_path) as fil:
+            data = fil.read()
+
+        with open(outfile, 'w') as fil:
+            fil.write(data)
diff --git a/evennia/scripts/migrations/0015_convert_contrib_paths.py b/evennia/scripts/migrations/0015_convert_contrib_paths.py
new file mode 100644
index 0000000000..26826563d5
--- /dev/null
+++ b/evennia/scripts/migrations/0015_convert_contrib_paths.py
@@ -0,0 +1,81 @@
+# Generated by Django 3.2.9 on 2022-01-07 21:17
+
+from django.db import migrations
+
+PATH_REMAP_PREFIX = {
+    "ingame_python": "evennia.contrib.base_systems",
+    "building_menu": "evennia.contrib.base_systems",
+    "color_markups": "evennia.contrib.base_systems",
+    "custom_gametime": "evennia.contrib.base_systems",
+    "email_login": "evennia.contrib.base_systems",
+    "ingame_python": "evennia.contrib.base_systems",
+    "menu_login": "evennia.contrib.base_systems",
+    "mux_cmms_cmds": "evennia.contrib.base_systems",
+    "unixommand": "evennia.contrib.base_systems",
+    "evscaperoom": "evennia.contrib.full_systems",
+    "barter": "evennia.contrib.game_systems",
+    "clothing": "evennia.contrib.game_systems",
+    "cooldowns": "evennia.contrib.game_systems",
+    "crafting": "evennia.contrib.game_systems",
+    "gendersub": "evennia.contrib.game_systems",
+    "mail": "evennia.contrib.game_systems",
+    "multidescer": "evennia.contrib.game_systems",
+    "puzzles": "evennia.contrib.game_systems",
+    "turnbattle": "evennia.contrib.game_systems",
+    "extended_room": "evennia.contrib.grid",
+    "mapbuilder": "evennia.contrib.grid",
+    "simpledoor": "evennia.contrib.grid",
+    "slow_exit": "evennia.contrib.grid",
+    "wilderness": "evennia.contrib.grid",
+    "xyzgrid": "evennia.contrib.grid",
+    "dice": "evennia.contrib.rpg",
+    "health_bar": "evennia.contrib.rpg",
+    "rpsystem": "evennia.contrib.rpg.rpsystem",
+    "rplanguage": "evennia.contrib.rpg.rpsystem",
+    "traits": "evennia.contrib.rpg",
+    "batchprocessor": "evennia.contrib.tutorials",
+    "bodyfunctions": "evennia.contrib.tutorials",
+    "mirror": "evennia.contrib.tutorials",
+    "red_button": "evennia.contrib.tutorials",
+    "tutorial_world": "evennia.contrib.tutorials",
+    "auditing": "evennia.contrib.utils",
+    "fieldfill": "evennia.contrib.utils",
+    "random_string_generator": "evennia.contrib.utils",
+    "tree_select": "evennia.contrib.utils"
+}
+
+
+def convert_contrib_typeclass_paths(apps, schema_editor):
+    ScriptDB = apps.get_model("scripts", "ScriptDB")
+
+    for obj in ScriptDB.objects.filter(db_typeclass_path__startswith="evennia.contrib."):
+        try:
+            package_path = obj.db_typeclass_path.split(".")[2:]
+            package_name = package_path[0]
+            if package_path[0] == 'security':
+                # renamed package and changed path
+                package_name = 'auditing'
+                package_path.pop(0)  # no longer security/auditing
+            if package_path[-1] == ".Clothing":
+                # renamed Clothing class to ContribClothing
+                package_path[-1] = "ContribClothing"
+            package_path = '.'.join(package_path)
+
+        except IndexError:
+            print(f"obj.db_typeclass_path={obj.db_typeclass_path} could not be parsed "
+                  "for converting to the new contrib location.")
+            continue
+        if package_name in PATH_REMAP_PREFIX:
+            obj.db_typeclass_path = f"{PATH_REMAP_PREFIX[package_name]}.{package_path}"
+            obj.save(update_fields=['db_typeclass_path'])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('scripts', '0014_auto_20210520_2137'),
+    ]
+
+    operations = [
+        migrations.RunPython(convert_contrib_typeclass_paths, migrations.RunPython.noop)
+    ]