renamed RuleGroup model to RuleSet

Author: calumbell

api_v2/admin.py

@@ -98,4 +98,5 @@ class LanguageAdmin(admin.ModelAdmin):
 
 admin.site.register(Environment)
 
-admin.site.register(Rule)
+admin.site.register(Rule)
+admin.site.register(RuleSet)

api_v2/migrations/0002_rulegroup_rule.py

@@ -0,0 +1,41 @@
+# Generated by Django 5.1.1 on 2024-10-08 21:31
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='RuleGroup',
+            fields=[
+                ('name', models.CharField(help_text='Name of the item.', max_length=100)),
+                ('desc', models.TextField(help_text='Description of the game content item. Markdown.')),
+                ('key', models.CharField(help_text='Unique key for the Document.', max_length=100, primary_key=True, serialize=False)),
+                ('document', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='api_v2.document')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+        migrations.CreateModel(
+            name='Rule',
+            fields=[
+                ('name', models.CharField(help_text='Name of the item.', max_length=100)),
+                ('desc', models.TextField(help_text='Description of the game content item. Markdown.')),
+                ('key', models.CharField(help_text='Unique key for the Document.', max_length=100, primary_key=True, serialize=False)),
+                ('index', models.IntegerField(default=1)),
+                ('initialHeaderLevel', models.IntegerField(choices=[(1, 1), (2, 2), (3, 3), (4, 4), (5, 5)], default=1)),
+                ('document', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='api_v2.document')),
+                ('ruleset', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='rules', to='api_v2.rulegroup')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

api_v2/migrations/0003_rename_rulegroup_ruleset.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.1.1 on 2024-10-08 21:38
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0002_rulegroup_rule'),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name='RuleGroup',
+            new_name='RuleSet',
+        ),
+    ]

api_v2/migrations/0114_rule.py

@@ -58,4 +58,4 @@
 
 from .speed import HasSpeed
 
-from .rules import Rule, RuleGroup
+from .rules import Rule, RuleSet

api_v2/migrations/0115_auto_20240925_0917.py

@@ -2,15 +2,7 @@
 from .abstracts import HasName, HasDescription, key_field
 from .document import FromDocument
 
-
-# TODO it has been agreed that this model should be called 'RuleSet' and that 
-# existant the 'RuleSet' should be renamed to 'GameSystem'.
-#
-# This change be handled in its own PR, as it represents a significant 
-# expansion of the initial issue and will likely touch many files, causing 
-# headaches for whichever poor soul ends up reviewing it
-
-class RuleGroup(HasName, HasDescription, FromDocument):
+class RuleSet(HasName, HasDescription, FromDocument):
   """
   The RuleGroup model contains a set of Rules as part of a larger article, or 
   as a chapter of a book.
@@ -26,7 +18,7 @@ class Rule(HasName, HasDescription, FromDocument):
   key = key_field()
   index = models.IntegerField(default=1)
   ruleset = models.ForeignKey(
-    RuleGroup,
+    RuleSet,
     on_delete=models.CASCADE,
     related_name='rules'
   )