Merge pull request open5e#561 from open5e/ruleset_to_gamesystem_refactor

Ruleset to gamesystem refactor

Author: augustjohnson

CONTRIBUTING.md

@@ -79,7 +79,7 @@ it with the content you add.
   create a new one.
 - `Publisher`: The publisher of the source. Select one of the available publishers. If the publisher is not available, 
   create a new one.
-- `Ruleset`: The ruleset the source is associated with. Select one of the available rulesets. If the ruleset is not available, 
+- `GameSystem`: The gamesystem the source is associated with. Select one of the available gamesystems. If the gamesystem is not available, 
   create a new one.
 - `Author`: The author of the source. This can be a single author or a list of authors. List them in the format `Author 1, Author 2, Author 3`.
 - `Published at`: The Date and Time the source was published. Select the date it was published on. The time can be set to 00:00:00.

README.md

@@ -4,7 +4,7 @@
   <p align="center">
     <a href="https://open5e.com">https://open5e.com</a>
     <br/>
-    A JSON API for the D&D 5e ruleset
+    A JSON API for the D&D 5e gamesystem
   </p>
 </p>
 <br />

api_v2/admin.py

@@ -79,7 +79,7 @@ class LanguageAdmin(admin.ModelAdmin):
 admin.site.register(Document)
 admin.site.register(License)
 admin.site.register(Publisher)
-admin.site.register(Ruleset)
+admin.site.register(GameSystem)
 
 admin.site.register(DamageType)
 

api_v2/management/commands/export.py

@@ -83,13 +83,13 @@ def handle(self, *args, **options) -> None:
         self.stdout.write(self.style.SUCCESS('Data for v1 data complete.'))
 
         # Start V2 output.
-        rulesets = Ruleset.objects.all()
-        ruleset_path = get_filepath_by_model(
-            'Ruleset',
+        gamesystems = GameSystem.objects.all()
+        gamesystem_path = get_filepath_by_model(
+            'GameSystem',
             'api_v2',
             base_path=options['dir'],
             format=options['format'])
-        write_queryset_data(ruleset_path, rulesets, format=options['format'])
+        write_queryset_data(gamesystem_path, gamesystems, format=options['format'])
 
         license_path = get_filepath_by_model(
             'License',
@@ -123,7 +123,7 @@ def handle(self, *args, **options) -> None:
                 write_queryset_data(doc_path, docq, format=options['format'])
 
                 for model in app_models:
-                    SKIPPED_MODEL_NAMES = ['Document', 'Ruleset', 'License', 'Publisher','SearchResult']
+                    SKIPPED_MODEL_NAMES = ['Document', 'GameSystem', 'License', 'Publisher','SearchResult']
                     CHILD_MODEL_NAMES = ['RaceTrait', 'FeatBenefit', 'BackgroundBenefit', 'ClassFeatureItem', 'SpellCastingOption','CreatureAction', 'CreatureTrait']
                     CHILD_CHILD_MODEL_NAMES = ['CreatureActionAttack']
 
@@ -158,7 +158,7 @@ def get_filepath_by_model(model_name, app_label, pub_key=None, doc_key=None, bas
 
     if app_label == "api_v2":
         root_folder_name = 'v2'
-        root_models = ['License', 'Ruleset']
+        root_models = ['License', 'GameSystem']
         pub_models = ['Publisher']
 
         if model_name in root_models:

api_v2/migrations/0001_initial.py

@@ -95,11 +95,11 @@ class Migration(migrations.Migration):
             },
         ),
         migrations.CreateModel(
-            name='Ruleset',
+            name='GameSystem',
             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 ruleset the document was published for.', max_length=100, primary_key=True, serialize=False)),
+                ('key', models.CharField(help_text='Unique key for the gamesystem the document was published for.', max_length=100, primary_key=True, serialize=False)),
                 ('content_prefix', models.CharField(blank=True, help_text='Short code prepended to content keys.', max_length=10)),
             ],
             options={
@@ -533,8 +533,8 @@ class Migration(migrations.Migration):
         ),
         migrations.AddField(
             model_name='document',
-            name='ruleset',
-            field=models.ForeignKey(help_text="The document's game system that it was published for.", on_delete=django.db.models.deletion.CASCADE, to='api_v2.ruleset'),
+            name='gamesystem',
+            field=models.ForeignKey(help_text="The document's game system that it was published for.", on_delete=django.db.models.deletion.CASCADE, to='api_v2.gamesystem'),
         ),
         migrations.CreateModel(
             name='Size',

api_v2/models/__init__.py

@@ -31,7 +31,7 @@
 from .document import Document
 from .document import License
 from .document import Publisher
-from .document import Ruleset
+from .document import GameSystem
 from .document import FromDocument
 
 from .damagetype import DamageType

api_v2/models/creature.py

@@ -23,7 +23,7 @@ class CreatureType(HasName, HasDescription, FromDocument):
 
 class Creature(Object, HasAbilities, HasSenses, HasLanguage, HasSpeed, FromDocument):
     """
-    This is the model for a Creature, per the 5e ruleset.
+    This is the model for a Creature, per the 5e gamesystem.
 
     This extends the object and abilities models.
     """

api_v2/models/document.py

@@ -21,8 +21,8 @@ class Document(HasName, HasDescription):
         on_delete=models.CASCADE,
         help_text="Publisher which has written the game content document.")
 
-    ruleset = models.ForeignKey(
-        "Ruleset",
+    gamesystem = models.ForeignKey(
+        "GameSystem",
         on_delete=models.CASCADE,
         help_text="The document's game system that it was published for."
     )
@@ -55,7 +55,7 @@ def stats(self):
 
             SKIPPED_MODEL_NAMES = [
                 'Document',
-                'Ruleset',
+                'GameSystem',
                 'License',
                 'Publisher',
                 'SearchResult']
@@ -103,11 +103,11 @@ class Publisher(HasName):
     )
 
 
-class Ruleset(HasName, HasDescription):
+class GameSystem(HasName, HasDescription):
     key = models.CharField(
         primary_key=True,
         max_length=100,
-        help_text="Unique key for the ruleset the document was published for."
+        help_text="Unique key for the gamesystem the document was published for."
     )
 
     content_prefix = models.CharField(

api_v2/serializers/__init__.py

@@ -10,7 +10,7 @@
 from .background import BackgroundBenefitSerializer
 from .background import BackgroundSerializer
 
-from .document import RulesetSerializer
+from .document import GameSystemSerializer
 from .document import LicenseSerializer
 from .document import PublisherSerializer
 from .document import DocumentSerializer

api_v2/serializers/document.py

@@ -1,14 +1,14 @@
-"""Serializers for Ruleset, License, Publisher, and Document models."""
+"""Serializers for GameSystem, License, Publisher, and Document models."""
 from rest_framework import serializers
 from .abstracts import GameContentSerializer
 
 from api_v2 import models
 
-class RulesetSerializer(serializers.HyperlinkedModelSerializer):
+class GameSystemSerializer(serializers.HyperlinkedModelSerializer):
     key = serializers.ReadOnlyField()
 
     class Meta:
-        model = models.Ruleset
+        model = models.GameSystem
         fields = '__all__'