Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor event models #50

Merged
merged 8 commits into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions backend/case_study/admin.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
from django.contrib import admin
from . import models
from event.admin import EpistolaryEventInline


@admin.register(models.CaseStudy)
class CaseStudyAdmin(admin.ModelAdmin):
fields = ["name"]
inlines = [EpistolaryEventInline]
extra = 0
list_display = ["name", "description"]
fields = ["name", "description", "episodes", "key_persons", "key_sites"]
filter_horizontal = ["episodes", "key_persons", "key_sites"]
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Generated by Django 4.2.7 on 2024-04-11 13:14

from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
("event", "0015_alter_eventcategory_options_episode"),
("case_study", "0001_initial"),
]

operations = [
migrations.AddField(
model_name="casestudy",
name="description",
field=models.TextField(
blank=True, help_text="Longer description to help identify this object"
),
),
migrations.AlterField(
model_name="casestudy",
name="name",
field=models.CharField(
help_text="A name to help identify this object", max_length=200
),
),
migrations.AddField(
model_name="casestudy",
name="episodes",
field=models.ManyToManyField(
blank=True,
help_text="Episodes involved in this case study",
to="event.episode",
),
),
]
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Generated by Django 4.2.7 on 2024-04-15 12:31

from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
('person', '0014_alter_persondateofbirth_person_and_more'),
('space', '0008_alter_spacedescription_source'),
('case_study', '0002_casestudy_description_alter_casestudy_name_episode_and_more'),
]

operations = [
migrations.AddField(
model_name='casestudy',
name='key_persons',
field=models.ManyToManyField(blank=True, help_text='Key historical figures involved in this case study', to='person.historicalperson'),
),
migrations.AddField(
model_name='casestudy',
name='key_sites',
field=models.ManyToManyField(blank=True, help_text='Key historical sites involved in this case study', to='space.structure'),
),
]
27 changes: 21 additions & 6 deletions backend/case_study/models.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
from django.db import models
from core.models import Named
from event.models import Episode
from person.models import HistoricalPerson
from space.models import Structure


class CaseStudy(models.Model):
class CaseStudy(Named, models.Model):
"""
A case study is an overarching collection of epistolary events, bound together by a common theme, e.g. `The Saga of St. Boniface` or `The Nun Rebellion of Poitiers`.
"""
Expand All @@ -10,10 +13,22 @@ class Meta:
verbose_name = "case study"
verbose_name_plural = "case studies"

name = models.CharField(
max_length=256,
null=False,
blank=False,
episodes = models.ManyToManyField(
to=Episode,
blank=True,
help_text="Episodes involved in this case study",
)

key_persons = models.ManyToManyField(
to=HistoricalPerson,
blank=True,
help_text="Key historical figures involved in this case study",
)

key_sites = models.ManyToManyField(
to=Structure,
blank=True,
help_text="Key historical sites involved in this case study",
)

def __str__(self):
Expand Down
77 changes: 20 additions & 57 deletions backend/conftest.py
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
import pytest
from case_study.models import CaseStudy
from letter.models import LetterDescription
from event.models import (
EpistolaryEvent,
LetterAction,
LetterActionCategory,
WorldEvent,
LetterEventDate,
)

from person.models import HistoricalPerson, AgentDescription
from source.models import Source
from event.models import EventDescription


@pytest.fixture()
Expand Down Expand Up @@ -51,73 +46,41 @@ def agent_description(db, historical_person, source):


@pytest.fixture()
def agent_group_description(db, source, historical_person, historical_person_2):
def agent_description_2(db, historical_person, source):
agent = AgentDescription.objects.create(
name="The Muppets",
name="Ernie",
source=source,
is_group=True,
)
agent.describes.add(historical_person)
agent.describes.add(historical_person_2)
agent.save()
return agent


@pytest.fixture()
def letter_action_writing(db, letter_description):
letter_action = LetterAction.objects.create()
# letter_action.letters.add(letter_description)
# letter_action.actors.add(agent)

LetterActionCategory.objects.create(
letter_action=letter_action,
value="write",
)

LetterEventDate.objects.create(
year_lower=500, year_upper=500, year_exact=500, letter_action=letter_action
def agent_group_description(db, source, historical_person, historical_person_2):
agent = AgentDescription.objects.create(
name="The Muppets",
source=source,
is_group=True,
)

return letter_action
agent.describes.add(historical_person)
agent.describes.add(historical_person_2)
agent.save()
return agent


@pytest.fixture()
def letter_action_reading(db, letter_description):
letter_action = LetterAction.objects.create()
# letter_action.letters.add(letter_description)
# letter_action.actors.add(agent_2)

LetterActionCategory.objects.create(
letter_action=letter_action,
value="read",
)

LetterEventDate.objects.create(
year_lower=505, year_upper=510, letter_action=letter_action
def event_description(db, source, agent_description, agent_description_2):
event = EventDescription.objects.create(
name="Bert writes a letter",
source=source,
)

return letter_action
event.agents.add(agent_description)
event.agents.add(agent_description_2)
return event


@pytest.fixture()
def case_study(db):
case_study = CaseStudy.objects.create(name="Test Case Study")
return case_study


@pytest.fixture()
def epistolary_event(db, letter_description, case_study):
epistolary_event = EpistolaryEvent.objects.create(
name="Test Epistolary event", note="Test note"
)
epistolary_event.case_studies.add(case_study)

return epistolary_event


@pytest.fixture()
def world_event(db):
world_event = WorldEvent.objects.create(
name="Test World Event", note="Test World Event note", year_exact=612
)
return world_event
Loading
Loading