[V2] Weapon Properties refactor (open5e#730)

* created WeaponProperty model/serializer

* added srd-2014 weapon properties to dataset

* created WeaponPropertyAssignment intermediate model to link Weapons and WeaponProperties

* added Versatile weapon props to srd-2014 weapons

* added remaining WeaponPropertyAssignments to srd-2014 weapons

* moved Item/Weapon serializer/view to use new WeaponProperties

* updated tests

* fixed typo in WeaponPropertyAssignment data

---------

Co-authored-by: calumbell <[email protected]>

Author: calumbell

api_v2/migrations/0042_weaponproperty.py

@@ -0,0 +1,26 @@
+# Generated by Django 5.1.2 on 2025-05-14 12:02
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0041_merge_20250509_0736'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='WeaponProperty',
+            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 Item.', max_length=100, primary_key=True, serialize=False)),
+                ('document', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='api_v2.document')),
+            ],
+            options={
+                'verbose_name_plural': 'Weapon Properties',
+            },
+        ),
+    ]

api_v2/migrations/0043_alter_weaponproperty_options_and_more.py

@@ -0,0 +1,31 @@
+# Generated by Django 5.1.2 on 2025-05-15 10:33
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0042_weaponproperty'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='weaponproperty',
+            options={'ordering': ['pk'], 'verbose_name_plural': 'Weapon Properties'},
+        ),
+        migrations.CreateModel(
+            name='WeaponPropertyAssignment',
+            fields=[
+                ('key', models.CharField(help_text='Unique key for the Item.', max_length=100, primary_key=True, serialize=False)),
+                ('detail', models.CharField(blank=True, max_length=32, null=True)),
+                ('document', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='api_v2.document')),
+                ('property', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='weapons', to='api_v2.weaponproperty')),
+                ('weapon', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='properties', to='api_v2.weapon')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

api_v2/migrations/0044_remove_weapon_is_finesse_remove_weapon_is_heavy_and_more.py

@@ -0,0 +1,57 @@
+# Generated by Django 5.1.2 on 2025-05-16 12:01
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0043_alter_weaponproperty_options_and_more'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='weapon',
+            name='is_finesse',
+        ),
+        migrations.RemoveField(
+            model_name='weapon',
+            name='is_heavy',
+        ),
+        migrations.RemoveField(
+            model_name='weapon',
+            name='is_lance',
+        ),
+        migrations.RemoveField(
+            model_name='weapon',
+            name='is_light',
+        ),
+        migrations.RemoveField(
+            model_name='weapon',
+            name='is_net',
+        ),
+        migrations.RemoveField(
+            model_name='weapon',
+            name='is_thrown',
+        ),
+        migrations.RemoveField(
+            model_name='weapon',
+            name='is_two_handed',
+        ),
+        migrations.RemoveField(
+            model_name='weapon',
+            name='reach',
+        ),
+        migrations.RemoveField(
+            model_name='weapon',
+            name='requires_ammunition',
+        ),
+        migrations.RemoveField(
+            model_name='weapon',
+            name='requires_loading',
+        ),
+        migrations.RemoveField(
+            model_name='weapon',
+            name='versatile_dice',
+        ),
+    ]

api_v2/models/__init__.py

@@ -11,6 +11,8 @@
 from .armor import Armor
 
 from .weapon import Weapon
+from .weapon import WeaponProperty
+from .weapon import WeaponPropertyAssignment
 
 from .species import SpeciesTrait
 from .species import Species

api_v2/models/weapon.py

@@ -3,13 +3,39 @@
 from django.db import models
 from django.core.validators import MinValueValidator
 
-from .abstracts import HasName
+from .abstracts import HasName, HasDescription
 from .abstracts import distance_field, distance_unit_field
 from .document import FromDocument
 from drf_spectacular.utils import extend_schema_field
 from drf_spectacular.types import OpenApiTypes
 from rest_framework import serializers
 
+class WeaponProperty(HasName, HasDescription, FromDocument):  
+  class Meta:
+    verbose_name_plural = "Weapon Properties"
+    ordering = ["pk"]
+  
+  def __str__(self):
+    return self.name
+
+
+class WeaponPropertyAssignment(FromDocument):
+  """
+  This is an intermediate model that is used to assign WeaponProperties to
+  Weapons while bundling in any extra contextual data in the `detail` field
+  """
+  weapon = models.ForeignKey(
+    'Weapon',
+    related_name='properties',
+    on_delete=models.CASCADE
+  )
+  property = models.ForeignKey(
+    'WeaponProperty',
+    related_name='weapons',
+    on_delete=models.CASCADE,
+  )
+  detail = models.CharField(null=True, blank=True, max_length=32)
+  
 class Weapon(HasName, FromDocument):
     """
     This model represents types of weapons.
@@ -31,21 +57,12 @@ class Weapon(HasName, FromDocument):
         max_length=100,
         help_text='The damage dice when used making an attack.')
 
-    versatile_dice = models.CharField(
-        null=False,
-        default=0,
-        max_length=100,
-        help_text="""The damage dice when attacking using versatile.
-A value of 0 means that the weapon does not have the versatile property.""")
-
-    reach = distance_field()
-
     range = distance_field()
 
     long_range = distance_field()
 
     distance_unit = distance_unit_field()
-    
+
     @property
     # or none
     @extend_schema_field(OpenApiTypes.STR)
@@ -54,52 +71,6 @@ def get_distance_unit(self):
             return self.document.distance_unit
         return self.distance_unit
 
-
-    is_finesse = models.BooleanField(
-        null=False,
-        default=False,
-        help_text='If the weapon is finesse.')
-
-    is_thrown = models.BooleanField(
-        null=False,
-        default=False,
-        help_text='If the weapon is thrown.')
-
-    is_two_handed = models.BooleanField(
-        null=False,
-        default=False,
-        help_text='If the weapon is two-handed.')
-
-    requires_ammunition = models.BooleanField(
-        null=False,
-        default=False,
-        help_text='If the weapon requires ammunition.')
-
-    requires_loading = models.BooleanField(
-        null=False,
-        default=False,
-        help_text='If the weapon requires loading.')
-
-    is_heavy = models.BooleanField(
-        null=False,
-        default=False,
-        help_text='If the weapon is heavy.')
-
-    is_light = models.BooleanField(
-        null=False,
-        default=False,
-        help_text='If the weapon is light.')
-
-    is_lance = models.BooleanField(
-        null=False,
-        default=False,
-        help_text='If the weapon is a lance.')
-
-    is_net = models.BooleanField(
-        null=False,
-        default=False,
-        help_text='If the weapon is a net.')
-
     is_simple = models.BooleanField(
         null=False,
         default=False,
@@ -109,71 +80,8 @@ def get_distance_unit(self):
         null=False,
         default=False,
         help_text='If the weapon is improvised.')
-    
-    @property
-    @extend_schema_field(OpenApiTypes.BOOL)
-    def is_versatile(self):
-        return self.versatile_dice != str(0)
 
     @property
     @extend_schema_field(OpenApiTypes.BOOL)
     def is_martial(self):
-        return not self.is_simple
-
-    @property
-    @extend_schema_field(OpenApiTypes.BOOL)
-    def is_melee(self):
-        # Ammunition weapons can only be used as improvised melee weapons.
-        return not self.requires_ammunition
-
-    @property
-    @extend_schema_field(OpenApiTypes.BOOL)
-    def ranged_attack_possible(self):
-        # Only ammunition or throw weapons can make ranged attacks.
-        return self.requires_ammunition or self.is_thrown
-
-    @property
-    # type is any
-    @extend_schema_field(OpenApiTypes.BOOL)
-    def range_melee(self):
-        return self.reach
-    
-    @property
-    @extend_schema_field(OpenApiTypes.BOOL)
-    def is_reach(self):
-        # A weapon with a longer reach than the default has the reach property.
-        return self.reach > 5 
-
-    @property
-    @extend_schema_field(serializers.ChoiceField(choices=['special', 'finesse', 'ammunition', 'light', 'heavy', 'thrown', 'loading', 'two-handed', 'versatile', 'reach'])) 
-    def properties(self):
-        properties = []
-        
-        range_desc = "(range {}/{})".format(
-            str(self.range),
-            str(self.long_range))
-
-        versatile_desc = "({})".format(self.versatile_dice)
-
-        if self.is_net or self.is_lance:
-            properties.append("special")
-        if self.is_finesse:
-            properties.append("finesse")
-        if self.requires_ammunition:
-            properties.append("ammuntion {}".format(range_desc))
-        if self.is_light:
-            properties.append("light")
-        if self.is_heavy:
-            properties.append("heavy")
-        if self.is_thrown:
-            properties.append("thrown {}".format(range_desc))
-        if self.requires_loading:
-            properties.append("loading")
-        if self.is_two_handed:
-            properties.append("two-handed")
-        if self.is_versatile:
-            properties.append("versatile {}".format(versatile_desc))
-        if self.is_reach:
-            properties.append("reach")
-       
-        return properties
+        return not self.is_simple

api_v2/serializers/__init__.py

@@ -6,6 +6,7 @@
 from .item import ItemRaritySerializer
 from .item import ItemSetSerializer
 from .item import ItemCategorySerializer
+from .item import WeaponPropertySerializer
 
 from .background import BackgroundBenefitSerializer
 from .background import BackgroundSerializer