[BUGFIX] Languages field on Creatures endpoint now work as intended (open5e#698)

* rmv'd extra languages when language_desc contained substring 'all' or 'any'

* added CreatureLanguageSerializer/LanguageSummarySerializer for handling Creature languages

* updated tests

Author: calumbell

api_v2/serializers/creature.py

@@ -10,7 +10,7 @@
 from .damagetype import DamageTypeSerializer
 from .condition import ConditionSerializer
 from .document import DocumentSummarySerializer
-from .language import LanguageSerializer
+from .language import LanguageSummarySerializer
 from .environment import EnvironmentSerializer
 from .size import SizeSerializer
 from drf_spectacular.utils import extend_schema_field, inline_serializer
@@ -56,6 +56,14 @@ class Meta:
         model = models.CreatureTrait
         fields = '__all__'
 
+class CreatureLanguageSerializer(GameContentSerializer):
+    as_string = serializers.CharField(source="languages_desc")
+    data = LanguageSummarySerializer(source="languages", many=True)
+
+    class Meta:
+        model = models.Creature
+        fields = ['as_string', 'data']
+
 class CreatureSerializer(GameContentSerializer):
     '''The serializer for the Creature object.'''
 
@@ -79,7 +87,7 @@ class CreatureSerializer(GameContentSerializer):
     document = DocumentSummarySerializer()
     type = CreatureTypeSerializer()
     size = SizeSerializer()
-    languages = LanguageSerializer(many=True)
+    languages = CreatureLanguageSerializer(source='*')
     environments = EnvironmentSerializer(many=True)
     initiative_bonus = serializers.SerializerMethodField()
 

api_v2/serializers/language.py

@@ -13,3 +13,14 @@ class LanguageSerializer(GameContentSerializer):
     class Meta:
         model = models.Language
         fields = '__all__'
+
+class LanguageSummarySerializer(GameContentSerializer):
+    """
+    This serializer is used for FKs to the Language model from other 
+    serializers. ie. for the languages spoken by creatures on the 
+    CreatureSerializer.
+    """
+    key = serializers.ReadOnlyField()
+    class Meta:
+        model = models.Language
+        fields = ['name', 'key', 'url', 'desc']

api_v2/tests/responses/TestObjects.test_creature_ancient_example.approved.json

@@ -252,56 +252,23 @@
     "hit_points": 546,
     "initiative_bonus": 0,
     "key": "srd_ancient-red-dragon",
-    "languages": [
-        {
-            "desc": "Typical speakers are Humans.",
-            "document": {
-                "gamesystem": {
-                    "key": "o5e",
-                    "name": "5th Edition",
-                    "url": "http://localhost:8000/v2/gamesystems/o5e/"
-                },
-                "key": "srd",
-                "name": "Systems Reference Document",
-                "permalink": "https://dnd.wizards.com/resources/systems-reference-document",
-                "publisher": {
-                    "key": "wizards-of-the-coast",
-                    "name": "Wizards of the Coast",
-                    "url": "http://localhost:8000/v2/publishers/wizards-of-the-coast/"
-                }
+    "languages": {
+        "as_string": "Common, Draconic",
+        "data": [
+            {
+                "desc": "Typical speakers are Humans.",
+                "key": "common",
+                "name": "Common",
+                "url": "http://localhost:8000/v2/languages/common/"
             },
-            "is_exotic": false,
-            "is_secret": false,
-            "key": "common",
-            "name": "Common",
-            "script_language": "http://localhost:8000/v2/languages/common/",
-            "url": "http://localhost:8000/v2/languages/common/"
-        },
-        {
-            "desc": "Typical speakers include dragons and dragonborn.",
-            "document": {
-                "gamesystem": {
-                    "key": "o5e",
-                    "name": "5th Edition",
-                    "url": "http://localhost:8000/v2/gamesystems/o5e/"
-                },
-                "key": "srd",
-                "name": "Systems Reference Document",
-                "permalink": "https://dnd.wizards.com/resources/systems-reference-document",
-                "publisher": {
-                    "key": "wizards-of-the-coast",
-                    "name": "Wizards of the Coast",
-                    "url": "http://localhost:8000/v2/publishers/wizards-of-the-coast/"
-                }
-            },
-            "is_exotic": true,
-            "is_secret": false,
-            "key": "draconic",
-            "name": "Draconic",
-            "script_language": "http://localhost:8000/v2/languages/draconic/",
-            "url": "http://localhost:8000/v2/languages/draconic/"
-        }
-    ],
+            {
+                "desc": "Typical speakers include dragons and dragonborn.",
+                "key": "draconic",
+                "name": "Draconic",
+                "url": "http://localhost:8000/v2/languages/draconic/"
+            }
+        ]
+    },
     "modifiers": {
         "charisma": 6,
         "constitution": 9,

api_v2/tests/responses/TestObjects.test_creature_goblin_example.approved.json

@@ -242,56 +242,23 @@
     "hit_points": 7,
     "initiative_bonus": 2,
     "key": "srd_goblin",
-    "languages": [
-        {
-            "desc": "Typical speakers are Humans.",
-            "document": {
-                "gamesystem": {
-                    "key": "o5e",
-                    "name": "5th Edition",
-                    "url": "http://localhost:8000/v2/gamesystems/o5e/"
-                },
-                "key": "srd",
-                "name": "Systems Reference Document",
-                "permalink": "https://dnd.wizards.com/resources/systems-reference-document",
-                "publisher": {
-                    "key": "wizards-of-the-coast",
-                    "name": "Wizards of the Coast",
-                    "url": "http://localhost:8000/v2/publishers/wizards-of-the-coast/"
-                }
+    "languages": {
+        "as_string": "Common, Goblin",
+        "data": [
+            {
+                "desc": "Typical speakers are Humans.",
+                "key": "common",
+                "name": "Common",
+                "url": "http://localhost:8000/v2/languages/common/"
             },
-            "is_exotic": false,
-            "is_secret": false,
-            "key": "common",
-            "name": "Common",
-            "script_language": "http://localhost:8000/v2/languages/common/",
-            "url": "http://localhost:8000/v2/languages/common/"
-        },
-        {
-            "desc": "Typical speakers are goblinoids.",
-            "document": {
-                "gamesystem": {
-                    "key": "o5e",
-                    "name": "5th Edition",
-                    "url": "http://localhost:8000/v2/gamesystems/o5e/"
-                },
-                "key": "srd",
-                "name": "Systems Reference Document",
-                "permalink": "https://dnd.wizards.com/resources/systems-reference-document",
-                "publisher": {
-                    "key": "wizards-of-the-coast",
-                    "name": "Wizards of the Coast",
-                    "url": "http://localhost:8000/v2/publishers/wizards-of-the-coast/"
-                }
-            },
-            "is_exotic": false,
-            "is_secret": false,
-            "key": "goblin",
-            "name": "Goblin",
-            "script_language": "http://localhost:8000/v2/languages/dwarvish/",
-            "url": "http://localhost:8000/v2/languages/goblin/"
-        }
-    ],
+            {
+                "desc": "Typical speakers are goblinoids.",
+                "key": "goblin",
+                "name": "Goblin",
+                "url": "http://localhost:8000/v2/languages/goblin/"
+            }
+        ]
+    },
     "modifiers": {
         "charisma": -1,
         "constitution": 0,