Merge pull request open5e#560 from calumbell/feature/v2-rules

Feature: V2 `/rules` endpoint

Author: augustjohnson

api_v2/admin.py

@@ -97,3 +97,6 @@ class LanguageAdmin(admin.ModelAdmin):
 admin.site.register(CharacterClass)
 
 admin.site.register(Environment)
+
+admin.site.register(Rule)
+admin.site.register(RuleSet)

api_v2/management/commands/buildindex.py

@@ -55,7 +55,7 @@ def load_v1_content(self, model):
 
     def load_v2_content(self, model):
         results = []
-        standard_v2_models = ['Item','Spell','Creature','CharacterClass','Race','Feat','Condition','Background','Environment']
+        standard_v2_models = ['Item','Spell','Creature','CharacterClass','Race','Feat','Condition','Background','Environment', 'Rule']
 
         if model.__name__ in standard_v2_models:
             for o in model.objects.all():
@@ -147,6 +147,7 @@ def handle(self, *args, **options):
             self.load_content(v2.Condition,"v2")
             self.load_content(v2.Background,"v2")
             self.load_content(v2.Environment,"v2")
+            self.load_content(v2.Rule, "v2")
 
         # Take the content table's current data and load it into the index.
         self.load_index()

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/0004_alter_rule_index_alter_rule_initialheaderlevel_and_more.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.1.1 on 2024-10-08 21:49
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0003_rename_rulegroup_ruleset'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='rule',
+            name='index',
+            field=models.IntegerField(default=1, help_text="A rule's position in the list of rules of the parent RuleSet"),
+        ),
+        migrations.AlterField(
+            model_name='rule',
+            name='initialHeaderLevel',
+            field=models.IntegerField(choices=[(1, 1), (2, 2), (3, 3), (4, 4), (5, 5)], default=1, help_text='The header level to set rule title to'),
+        ),
+        migrations.AlterField(
+            model_name='rule',
+            name='ruleset',
+            field=models.ForeignKey(help_text='The RuleSet which this Rule belongs to', on_delete=django.db.models.deletion.CASCADE, related_name='rules', to='api_v2.ruleset'),
+        ),
+    ]

api_v2/models/__init__.py

@@ -56,4 +56,6 @@
 
 from .environment import Environment
 
-from .speed import HasSpeed
+from .speed import HasSpeed
+
+from .rule import Rule, RuleSet

api_v2/models/rule.py

@@ -0,0 +1,37 @@
+from django.db import models
+from .abstracts import HasName, HasDescription, key_field
+from .document import FromDocument
+
+class RuleSet(HasName, HasDescription, FromDocument):
+  """
+  The RuleSet model contains a set of Rules as part of a larger article, or 
+  as a chapter of a book.
+  """
+  key = key_field()
+
+
+class Rule(HasName, HasDescription, FromDocument):
+  """"
+  The Rule model contains information about a single rule from a larger RuleSet.
+  Each Rule is typically a paragraph or two long and might contain tables.
+  """
+
+  key = key_field()
+  
+  index = models.IntegerField(
+    default=1,
+    help_text="A rule's position in the list of rules of the parent RuleSet"
+  )
+  
+  ruleset = models.ForeignKey(
+    RuleSet,
+    on_delete=models.CASCADE,
+    related_name='rules',
+    help_text="The RuleSet which this Rule belongs to"
+  )
+  
+  initialHeaderLevel = models.IntegerField(
+    default=1,
+    choices=((i, i) for i in range(1,6)),
+    help_text="The header level to set rule title to"
+  )

api_v2/serializers/__init__.py

@@ -46,4 +46,6 @@
 from .environment import EnvironmentSerializer
 
 from .ability import AbilitySerializer
-from .ability import SkillSerializer
+from .ability import SkillSerializer
+
+from .rule import RuleSerializer, RuleSetSerializer

api_v2/serializers/rule.py

@@ -0,0 +1,17 @@
+""" Serializer for the Rule model """
+
+from rest_framework import serializers
+
+from api_v2 import models
+
+from .abstracts import GameContentSerializer
+
+class RuleSerializer(GameContentSerializer):
+  class Meta:
+    model = models.Rule
+    fields = '__all__'
+
+class RuleSetSerializer(GameContentSerializer):
+  class Meta:
+    model = models.RuleSet
+    fields = ['name', 'key', 'document', 'desc', 'rules']

api_v2/views/__init__.py

@@ -38,6 +38,8 @@
 
 from .size import SizeViewSet
 
+from .rule import RuleViewSet, RuleSetViewSet
+
 from .enum import get_enums
 
 from .environment import EnvironmentViewSet