moved Item/Weapon serializer/view to use new WeaponProperties

Author: calumbell

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/weapon.py

@@ -20,6 +20,10 @@ def __str__(self):
 
 
 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',
@@ -53,15 +57,6 @@ 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()
@@ -76,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,
@@ -131,37 +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 
+        return not self.is_simple

api_v2/serializers/item.py

@@ -63,13 +63,10 @@ class Meta:
 class WeaponSerializer(GameContentSerializer):
     key = serializers.ReadOnlyField()
     document = DocumentSummarySerializer()
+    properties = WeaponPropertyAssignmentSerializer(many=True)
     damage_type = DamageTypeSummarySerializer()
-    is_versatile = serializers.ReadOnlyField()
-    is_martial = serializers.ReadOnlyField()
-    is_melee = serializers.ReadOnlyField()
     ranged_attack_possible = serializers.ReadOnlyField()
     range_melee = serializers.ReadOnlyField()
-    is_reach = serializers.ReadOnlyField()
     distance_unit = serializers.SerializerMethodField()
 
     class Meta:
@@ -88,13 +85,8 @@ class WeaponSummarySerializer(GameContentSerializer):
     `"weapon"` field on the ItemSerializer
     '''
     damage_type = DamageTypeSummarySerializer()
-    is_versatile = serializers.ReadOnlyField()
     is_martial = serializers.ReadOnlyField()
     is_melee = serializers.ReadOnlyField()
-    is_finesse = serializers.ReadOnlyField()
-    ranged_attack_possible = serializers.ReadOnlyField()
-    range_melee = serializers.ReadOnlyField()
-    is_reach = serializers.ReadOnlyField()
     distance_unit = serializers.SerializerMethodField()
     properties = WeaponPropertyAssignmentSerializer(many=True, read_only=True)
 
@@ -106,28 +98,11 @@ class Meta:
             'url',
             'damage_type',
             'damage_dice',
-            'versatile_dice',
-            'is_versatile',
-            'reach',
-            'is_reach',
-            'is_finesse',
-            'range',
-            'range_melee',
-            'long_range',
-            'ranged_attack_possible',
-            'is_thrown',
-            'is_two_handed',
-            'requires_ammunition',
-            'requires_loading',
-            'is_heavy',
-            'is_light',
-            'is_lance',
-            'is_net',
+            'properties',
             'is_melee',
             'is_simple',
             'is_martial',
             'is_improvised',
-            'properties',
             'distance_unit',
         ]
 

api_v2/views/item.py

@@ -1,28 +1,59 @@
 from rest_framework import viewsets
+from django_filters import FilterSet, BooleanFilter
 
-from django_filters import FilterSet
-from django_filters import BooleanFilter
-
-from api_v2 import models
-from api_v2 import serializers
+from api_v2 import models, serializers
 from .mixins import EagerLoadingMixin
 
 class ItemFilterSet(FilterSet):
-    is_magic_item = BooleanFilter(field_name='rarity', lookup_expr='isnull', exclude=True)
+    ''' Filter set for the Item model. Used in the ItemViewSet below '''
+
+    is_magic_item = BooleanFilter(
+        label='Magic Items',
+        field_name='rarity',
+        lookup_expr='isnull',
+        exclude=True
+    )
+
+    is_weapon = BooleanFilter(
+        label='Weapons',
+        field_name='weapon',
+        lookup_expr='isnull',
+        exclude=True
+    )
+
+    is_armor = BooleanFilter(
+        label='Armor',
+        field_name='armor',
+        lookup_expr='isnull',
+        exclude=True
+    )
+    
+    # Weapon property filter factory method
+    def weapon_property_filter(property_name):
+        return lambda queryset, name, value: (
+            queryset.filter(weapon__properties__property__name__iexact=property_name)
+        )
+
+    # Filters for weapon properties (using the factory method defined above)
+    is_light = BooleanFilter(label='Light Weapons', method=weapon_property_filter('light'))
+    is_versatile = BooleanFilter(label='Versatile Weapons', method=weapon_property_filter('versatile'))
+    is_thrown = BooleanFilter(label='Thrown Weapons', method=weapon_property_filter('thrown'))
+    is_finesse = BooleanFilter(label='Finesse Weapons', method = weapon_property_filter('finesse'))
+    is_two_handed = BooleanFilter(label='Two-handed Weapons', method=weapon_property_filter('two-handed'))
 
     class Meta:
         model = models.Item
         fields = {
-            'key': ['in', 'iexact', 'exact'],
-            'name': ['iexact', 'exact', 'icontains'],
+            'key': ['in', 'iexact'],
+            'name': ['iexact', 'icontains'],
             'desc': ['icontains'],
             'cost': ['exact', 'range', 'gt', 'gte', 'lt', 'lte'],
             'weight': ['exact', 'range', 'gt', 'gte', 'lt', 'lte'],
             'rarity': ['exact', 'in'],
-            'requires_attunement': ['exact'],
+            'requires_attunement': ['iexact'],
             'category': ['in', 'exact'],
-            'document__key': ['in','iexact','exact'],
-            'document__gamesystem__key': ['in','iexact','exact'],
+            'document__key': ['in','iexact'],
+            'document__gamesystem__key': ['in','iexact'],
         }
 
 
@@ -45,8 +76,9 @@ class ItemViewSet(EagerLoadingMixin, viewsets.ReadOnlyModelViewSet):
         'damage_vulnerabilities',
         'document',
         'weapon__properties',
+        'weapon__damage_type',
+        'weapon__document',
         'weapon__properties__property',
-        # 'document__gamesystem',
         'rarity',
         'size',
     ]
@@ -108,30 +140,27 @@ class ItemCategoryViewSet(viewsets.ReadOnlyModelViewSet):
 
 class WeaponFilterSet(FilterSet):
 
+    # returns a filter method to a given WeaponProperty
+    def weapon_property_filter(property_name):
+        return lambda queryset, name, value: (
+            queryset.filter(properties__property__name__iexact=property_name)
+        )
+
+    is_light = BooleanFilter(label='Is Light', method=weapon_property_filter('light'))
+    is_versatile = BooleanFilter(label='Is Versatile', method=weapon_property_filter('versatile'))
+    is_thrown = BooleanFilter(label='Is Thrown', method=weapon_property_filter('thrown'))
+    is_finesse = BooleanFilter(label='Is Finesse', method = weapon_property_filter('finesse'))
+    is_two_handed = BooleanFilter(label='Is Two-handed', method=weapon_property_filter('two-handed'))
+
     class Meta:
         model = models.Weapon
         fields = {
-            'key': ['in', 'iexact', 'exact' ],
-            'name': ['iexact', 'exact'],
-            'document__key': ['in','iexact','exact'],
-            'document__gamesystem__key': ['in','iexact','exact'],
-            'damage_dice': ['in','iexact','exact'],
-            'versatile_dice': ['in','iexact','exact'],
-            'reach': ['exact','lt','lte','gt','gte'],
-            'range': ['exact','lt','lte','gt','gte'],
-            'long_range': ['exact','lt','lte','gt','gte'],
-            'is_finesse': ['exact'],
-            'is_thrown': ['exact'],
-            'is_two_handed': ['exact'],
-            'requires_ammunition': ['exact'],
-            'requires_loading': ['exact'],
-            'is_heavy': ['exact'],
-            'is_light': ['exact'],
-            'is_lance': ['exact'],
-            'is_net': ['exact'],
-            'is_simple': ['exact'],
-            'is_improvised': ['exact']
-            }
+            'key': ['in', 'iexact'],
+            'name': ['iexact'],
+            'document__key': ['in','iexact'],
+            'document__gamesystem__key': ['in','iexact'],
+            'damage_dice': ['in','iexact'],
+        }
 
 
 class WeaponViewSet(EagerLoadingMixin, viewsets.ReadOnlyModelViewSet):
@@ -143,7 +172,7 @@ class WeaponViewSet(EagerLoadingMixin, viewsets.ReadOnlyModelViewSet):
     serializer_class = serializers.WeaponSerializer
     filterset_class = WeaponFilterSet
 
-    prefetch_related_fields = ['document']
+    prefetch_related_fields = ['document', 'damage_type', 'properties__property']
 
 class ArmorFilterSet(FilterSet):