evilchili/tabletop-frog
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

adding support for managing class attributes

Browse Source
This commit is contained in:
evilchili 2024-02-26 01:12:45 -08:00
parent 75b9aec28e
commit 304a4d9c79
7 changed files with 175 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
ttfrog/assets/templates/character_sheet.html
View File

@ -143,11 +143,9 @@
</div>
<div class='card'>
<div class='label'>Attributes</div>
<ul>
{% for rec in c.record.attributes %}
<li>{{ rec.attribute.name }}: {{ rec.attribute.value }}</li>
{% endfor %}
</ul>
{% if c.record.class_attributes %}
{{ field('class_attributes') }}
{% endif %}
</div>
<div class='card'>
<div class='label'>Defenses</div>
@ -171,18 +169,17 @@
<div style='clear:both;display:block;'>
<h2>Debug</h2>
<code>
{{ DISABLED }}
<code>
{{ c.record }}
{% for field, msg in c.form.errors.items() %}
{{ field }}: {{ msg }}
{% endfor %}
</code>
{{ c.record.class_attributes }}
</code>
{% endblock %}
{% block script %}
<script type='text/javascript'>
{% for field, msg in c.form.errors.items() %}
console.log("{{ field }}: {{ msg }}");
{% endfor %}
const TRAITS = {
{% for trait_desc, traits in [] %}
'{{ trait_desc }}': [

31
ttfrog/db/bootstrap.py
View File

@ -53,16 +53,16 @@ data = {
],
'AncestryTrait': [
{ 'id': 1, 'name': '+1 to All Ability Scores', },
{ 'id': 2, 'name': 'Breath Weapon', },
{ 'id': 3, 'name': 'Darkvision', },
{'id': 1, 'name': '+1 to All Ability Scores', },
{'id': 2, 'name': 'Breath Weapon', },
{'id': 3, 'name': 'Darkvision', },
],
'AncestryTraitMap': [
{ 'ancestry_id': 1, 'ancestry_trait_id': 1, 'level': 1}, # human +1 to scores
{ 'ancestry_id': 2, 'ancestry_trait_id': 2, 'level': 1}, # dragonborn breath weapon
{ 'ancestry_id': 3, 'ancestry_trait_id': 3, 'level': 1}, # tiefling darkvision
{ 'ancestry_id': 2, 'ancestry_trait_id': 2, 'level': 1}, # elf darkvision
{'ancestry_id': 1, 'ancestry_trait_id': 1, 'level': 1}, # human +1 to scores
{'ancestry_id': 2, 'ancestry_trait_id': 2, 'level': 1}, # dragonborn breath weapon
{'ancestry_id': 3, 'ancestry_trait_id': 3, 'level': 1}, # tiefling darkvision
{'ancestry_id': 2, 'ancestry_trait_id': 2, 'level': 1}, # elf darkvision
],
'CharacterClassMap': [
@ -101,15 +101,26 @@ data = {
],
'ClassAttribute': [
{'id': 1, 'name': 'Fighting Style', 'value': 'Archery'},
{'id': 1, 'name': 'Fighting Style'},
{'id': 2, 'name': 'Another Attribute'},
],
'ClassAttributeOption': [
{'id': 1, 'attribute_id': 1, 'name': 'Archery'},
{'id': 2, 'attribute_id': 1, 'name': 'Battlemaster'},
{'id': 3, 'attribute_id': 2, 'name': 'Another Option 1'},
{'id': 4, 'attribute_id': 2, 'name': 'Another Option 2'},
],
'ClassAttributeMap': [
{'class_attribute_id': 1, 'character_class_id': 1, 'level': 2}, # Fighter: Archery fighting style
{'class_attribute_id': 1, 'character_class_id': 1, 'level': 2}, # Fighter: Fighting Style
{'class_attribute_id': 2, 'character_class_id': 1, 'level': 1}, # Fighter: Another Attr
],
'CharacterClassAttributeMap': [
{'class_attribute_id': 1, 'character_id': 1}, # Sabetha: Archery fighting style
{'character_id': 1, 'class_attribute_id': 2, 'option_id': 4}, # Sabetha, another option, option 2
{'character_id': 1, 'class_attribute_id': 1, 'option_id': 1}, # Sabetha, fighting style, archery
],

27
ttfrog/db/schema/character.py
View File

@ -1,6 +1,3 @@
import logging
from ttfrog.db.base import Bases, BaseObject, IterableMixin, SavingThrowsMixin, SkillsMixin
from ttfrog.db.base import CreatureTypesEnum
@ -24,11 +21,17 @@ __all__ = [
'Character',
]
def class_map_creator(fields):
if isinstance(fields, CharacterClassMap):
return fields
return CharacterClassMap(**fields)
def attr_map_creator(fields):
if isinstance(fields, CharacterClassAttributeMap):
return fields
return CharacterClassAttributeMap(**fields)
class AncestryTraitMap(BaseObject):
__tablename__ = "trait_map"
@ -62,7 +65,7 @@ class AncestryTrait(BaseObject, IterableMixin):
description = Column(Text)
class CharacterClassMap(BaseObject):
class CharacterClassMap(BaseObject, IterableMixin):
__tablename__ = "class_map"
id = Column(Integer, primary_key=True, autoincrement=True)
character_id = Column(Integer, ForeignKey("character.id"))
@ -73,11 +76,16 @@ class CharacterClassMap(BaseObject):
level = Column(Integer, nullable=False, info={'min': 1, 'max': 20}, default=1)
class CharacterClassAttributeMap(BaseObject):
class CharacterClassAttributeMap(BaseObject, IterableMixin):
__tablename__ = "character_class_attribute_map"
class_attribute_id = Column(Integer, ForeignKey("class_attribute.id"), primary_key=True)
character_id = Column(Integer, ForeignKey("character.id"), primary_key=True)
attribute = relationship("ClassAttribute", lazy='immediate')
id = Column(Integer, primary_key=True, autoincrement=True)
character_id = Column(Integer, ForeignKey("character.id"), nullable=False)
class_attribute_id = Column(Integer, ForeignKey("class_attribute.id"), nullable=False)
option_id = Column(Integer, ForeignKey("class_attribute_option.id"), nullable=False)
mapping = UniqueConstraint(character_id, class_attribute_id)
class_attribute = relationship("ClassAttribute", lazy='immediate')
option = relationship("ClassAttributeOption", lazy='immediate')
class Character(*Bases, SavingThrowsMixin, SkillsMixin):
@ -100,7 +108,8 @@ class Character(*Bases, SavingThrowsMixin, SkillsMixin):
class_map = relationship("CharacterClassMap", cascade='all,delete,delete-orphan')
classes = association_proxy('class_map', 'id', creator=class_map_creator)
attributes = relationship("CharacterClassAttributeMap")
character_class_attribute_map = relationship("CharacterClassAttributeMap", cascade='all,delete,delete-orphan')
class_attributes = association_proxy('character_class_attribute_map', 'id', creator=attr_map_creator)
ancestry_id = Column(Integer, ForeignKey("ancestry.id"), nullable=False, default='1')
ancestry = relationship("Ancestry", uselist=False)

17
ttfrog/db/schema/classes.py
View File

@ -13,15 +13,15 @@ from sqlalchemy.orm import relationship
__all__ = [
'ClassAttributeMap',
'ClassAttribute',
'ClassAttributeOption',
'CharacterClass',
]
class ClassAttributeMap(BaseObject):
class ClassAttributeMap(BaseObject, IterableMixin):
__tablename__ = "class_attribute_map"
class_attribute_id = Column(Integer, ForeignKey("class_attribute.id"), primary_key=True)
character_class_id = Column(Integer, ForeignKey("character_class.id"), primary_key=True)
attribute = relationship("ClassAttribute", lazy='immediate')
level = Column(Integer, nullable=False, info={'min': 1, 'max': 20}, default=1)
@ -29,8 +29,17 @@ class ClassAttribute(BaseObject, IterableMixin):
__tablename__ = "class_attribute"
id = Column(Integer, primary_key=True, autoincrement=True)
name = Column(String, nullable=False)
value = Column(String, nullable=False)
description = Column(Text)
def __repr__(self):
return f"{self.id}: {self.name}"
class ClassAttributeOption(BaseObject, IterableMixin):
__tablename__ = "class_attribute_option"
id = Column(Integer, primary_key=True, autoincrement=True)
name = Column(String, nullable=False)
attribute_id = Column(Integer, ForeignKey("class_attribute.id"), nullable=False)
# attribute = relationship("ClassAttribute", uselist=False)
class CharacterClass(*Bases, SavingThrowsMixin, SkillsMixin):

22
ttfrog/webserver/controllers/base.py
View File

@ -100,10 +100,27 @@ class BaseController:
def populate(self):
self.form.populate_obj(self.record)
def populate_association(self, key, formdata):
populated = []
for field in formdata:
map_id = field.pop('id')
map_id = int(map_id) if map_id else 0
if not field[key]:
continue
elif not map_id:
populated.append(field)
else:
field['id'] = map_id
populated.append(field)
return populated
def validate(self):
return self.form.validate()
def save(self):
if not self.form.save.data:
return
if not self.form.validate():
if not self.validate():
return
logging.debug(f"{self.form.data = }")
# previous = dict(self.record)
@ -112,7 +129,8 @@ class BaseController:
# transaction_log.record(previous, self.record)
with db.transaction():
db.add(self.record)
logging.debug(f"Added {self.record = }")
self.save_callback()
logging.debug(f"Saved {self.record = }")
location = self.request.current_route_path()
if self.record.slug not in location:
location = f"{location}/{self.record.uri}"

133
ttfrog/webserver/controllers/character_sheet.py
View File

@ -3,7 +3,15 @@ import logging
from ttfrog.webserver.controllers.base import BaseController
from ttfrog.webserver.forms import DeferredSelectField
from ttfrog.webserver.forms import NullableDeferredSelectField
from ttfrog.db.schema import Character, Ancestry, CharacterClass, CharacterClassMap
from ttfrog.db.schema import (
Character,
Ancestry,
CharacterClass,
CharacterClassMap,
ClassAttributeOption,
CharacterClassAttributeMap
)
from ttfrog.db.base import STATS
from ttfrog.db.manager import db
@ -11,14 +19,37 @@ from wtforms_alchemy import ModelForm
from wtforms.fields import SubmitField, SelectField, SelectMultipleField, FieldList, FormField, HiddenField
from wtforms.widgets import Select, ListWidget
from wtforms import ValidationError
from wtforms.validators import Optional
VALID_LEVELS = range(1, 21)
class ClassAttributesForm(ModelForm):
id = HiddenField()
class_attribute_id = HiddenField()
option_id = SelectField(
widget=Select(),
choices=[],
validators=[Optional()],
coerce=int
)
def __init__(self, formdata=None, obj=None, prefix=None):
if obj:
obj = db.query(CharacterClassAttributeMap).get(obj)
super().__init__(formdata=formdata, obj=obj, prefix=prefix)
if obj:
options = db.query(ClassAttributeOption).filter_by(attribute_id=obj.class_attribute.id)
self.option_id.label = obj.class_attribute.name
self.option_id.choices = [(rec.id, rec.name) for rec in options.all()]
class MulticlassForm(ModelForm):
id = HiddenField()
character_class_id = NullableDeferredSelectField(
'CharacterClass',
model=CharacterClass,
validate_choice=True,
widget=Select(),
@ -32,7 +63,8 @@ class MulticlassForm(ModelForm):
to an instance. This will ensure that the rendered field is populated with the current
value of the class_map.
"""
obj = db.query(CharacterClassMap).get(obj)
if obj:
obj = db.query(CharacterClassMap).get(obj)
super().__init__(formdata=formdata, obj=obj, prefix=prefix)
@ -46,6 +78,9 @@ class CharacterForm(ModelForm):
ancestry_id = DeferredSelectField('Ancestry', model=Ancestry, default=1, validate_choice=True, widget=Select())
classes = FieldList(FormField(MulticlassForm, widget=ListWidget()), min_entries=0)
newclass = FormField(MulticlassForm, widget=ListWidget())
class_attributes = FieldList(FormField(ClassAttributesForm, widget=ListWidget()), min_entries=1)
saving_throws = SelectMultipleField('Saving Throws', validate_choice=True, choices=STATS)
@ -59,62 +94,82 @@ class CharacterSheet(BaseController):
{'type': 'script', 'uri': 'js/character_sheet.js'},
]
def populate_class_map(self, formdata):
"""
Populate the record's class_map association_proxy with dictionaries of
CharacterClassMap field data. The creator factory on the proxy will
convert dictionary data to CharacterClassMap instances..
"""
populated = []
for field in formdata:
class_map_id = field.pop('id')
class_map_id = int(class_map_id) if class_map_id else 0
logging.debug(f"{class_map_id = }, {field = }, {self.record.classes = }")
if not field['character_class_id']:
continue
elif not class_map_id:
populated.append(field)
else:
field['id'] = class_map_id
populated.append(field)
self.record.classes = populated
def validate_multiclass_form(self):
def validate_callback(self):
"""
Validate multiclass fields in form data.
"""
ret = super().validate()
if not self.form.data['classes']:
return ret
err = ""
total_level = 0
for field in self.form.data['classes']:
level = field.get('level', 0)
level = field.get('level')
total_level += level
if level not in VALID_LEVELS:
err = f"Multiclass form field {field = } level is outside possible range."
break
if self.record.id and field.get('character_id', None) != self.record.id:
err = f"Multiclass form field {field = } does not match character ID {self.record.id}"
break
if total_level not in VALID_LEVELS:
err = f"Total level for all multiclasses ({total_level}) is outside possible range."
if err:
logging.error(err)
raise ValidationError(err)
return ret and True
def validate(self):
"""
Add custom validation of the multiclass form data to standard form validation.
"""
super().validate()
self.validate_multiclass_form()
def add_class_attributes(self):
# prefetch the records for each of the character's classes
classes_by_id = {
c.id: c for c in db.query(CharacterClass).filter(CharacterClass.id.in_(
c.character_class_id for c in self.record.class_map
)).all()
}
assigned = [int(m.class_attribute_id) for m in self.record.character_class_attribute_map]
logging.debug(f"{assigned = }")
# step through the list of class mappings for this character
for class_map in self.record.class_map:
thisclass = classes_by_id[class_map.character_class_id]
# assign each class attribute available at the character's current
# level to the list of the character's class attributes
for attr_map in [a for a in thisclass.attributes if a.level <= class_map.level]:
# when creating a record, assign the first of the available
# options to the character's class attribute.
default_option = db.query(ClassAttributeOption).filter_by(
attribute_id=attr_map.class_attribute_id
).first()
if attr_map.class_attribute_id not in assigned:
self.record.character_class_attribute_map.append(
CharacterClassAttributeMap(
class_attribute_id=attr_map.class_attribute_id,
option=default_option
)
)
def save_callback(self):
self.add_class_attributes()
def populate(self):
"""
Delete the multiclass form data before calling form.populate_obj() and use
our own method for populating the fieldlist.
Delete the association proxies' form data before calling form.populate_obj(),
and instead use our own methods for populating the fieldlist.
"""
formdata = self.form.data['classes']
formdata.append(self.form.data['newclass'])
# multiclass form
classes_formdata = self.form.data['classes']
classes_formdata.append(self.form.data['newclass'])
del self.form.classes
del self.form.newclass
# class attributes
attrs_formdata = self.form.data['class_attributes']
del self.form.class_attributes
super().populate()
self.populate_class_map(formdata)
self.record.classes = self.populate_association('character_class_id', classes_formdata)
self.record.class_attributes = self.populate_association('class_attribute_id', attrs_formdata)

2
ttfrog/webserver/forms.py
View File

@ -11,7 +11,7 @@ class DeferredSelectMultipleField(SelectMultipleField):
class DeferredSelectField(SelectField):
def __init__(self, *args, model=None, **kwargs):
super().__init__(*args, **kwargs)
self.choices = [(rec.id, rec.name) for rec in db.query(model).all()]
self.choices = [(rec.id, getattr(rec, 'name', str(rec))) for rec in db.query(model).all()]
class NullableDeferredSelectField(DeferredSelectField):