Added comments to event store

This commit is contained in:
Alexis
2024-04-01 00:29:13 +02:00
parent 196c06ece4
commit 39c03c9706

View File

@@ -1,5 +1,5 @@
import { defineStore, storeToRefs } from 'pinia' import { defineStore } from 'pinia'
import { computed, watch, type ComputedRef, toRefs, type Ref, ref } from 'vue' import { computed, watch, type ComputedRef, type Ref, ref } from 'vue'
import { useCharacters, type Character } from './characters' import { useCharacters, type Character } from './characters'
import type { LeimDate } from '@/models/Date' import type { LeimDate } from '@/models/Date'
@@ -12,8 +12,9 @@ type CalendarEvent = {
export const useCalendarEvents = defineStore('calendar-events', () => { export const useCalendarEvents = defineStore('calendar-events', () => {
const { characters } = useCharacters() const { characters } = useCharacters()
const calendarStore = useCalendar() const { currentDate, currentConfig } = useCalendar()
// Get all birth events
const charactersWithBirthData: ComputedRef<Character[]> = computed(() => const charactersWithBirthData: ComputedRef<Character[]> = computed(() =>
characters.filter((character) => character.birth) characters.filter((character) => character.birth)
) )
@@ -22,6 +23,8 @@ export const useCalendarEvents = defineStore('calendar-events', () => {
return { title: `Naissance de ${character.name}`, date: character.birth } as CalendarEvent return { title: `Naissance de ${character.name}`, date: character.birth } as CalendarEvent
}) })
}) })
// Get all death events
const charactersWithDeathData: ComputedRef<Character[]> = computed(() => const charactersWithDeathData: ComputedRef<Character[]> = computed(() =>
characters.filter((character) => character.death) characters.filter((character) => character.death)
) )
@@ -31,30 +34,40 @@ export const useCalendarEvents = defineStore('calendar-events', () => {
}) })
}) })
// Gets all current event in its default state
const currentEvents: Ref<CalendarEvent[]> = ref(computeCurrentEvents()) const currentEvents: Ref<CalendarEvent[]> = ref(computeCurrentEvents())
watch(calendarStore.currentDate, () => { // Watch for currentDate changes
watch(currentDate, () => {
currentEvents.value = computeCurrentEvents() currentEvents.value = computeCurrentEvents()
}) })
/**
* Determines if the event can appear in the front end
*
* This function takes into consideration the viewType of the calendar config
*
* @param event The event to analyze
* @returns Whether the event should appear in the current view
*/
function shouldEventBeDisplayed(event: CalendarEvent): boolean { function shouldEventBeDisplayed(event: CalendarEvent): boolean {
switch (calendarStore.currentConfig.viewType) { switch (currentConfig.viewType) {
case 'month': case 'month':
return event.date.month === Number(calendarStore.currentDate.currentMonth) return event.date.month === Number(currentDate.currentMonth)
case 'year': case 'year':
return event.date.year === Number(calendarStore.currentDate.currentYear) return event.date.year === Number(currentDate.currentYear)
case 'decade': case 'decade':
return ( return (
event.date.year >= Number(calendarStore.currentDate.currentYear) - 10 && event.date.year >= Number(currentDate.currentYear) - 10 &&
event.date.year <= Number(calendarStore.currentDate.currentYear) + 10 event.date.year <= Number(currentDate.currentYear) + 10
) )
case 'century': case 'century':
return ( return (
event.date.year >= Number(calendarStore.currentDate.currentYear) - 100 && event.date.year >= Number(currentDate.currentYear) - 100 &&
event.date.year <= Number(calendarStore.currentDate.currentYear) + 100 event.date.year <= Number(currentDate.currentYear) + 100
) )
default: default:
@@ -62,6 +75,11 @@ export const useCalendarEvents = defineStore('calendar-events', () => {
} }
} }
/**
* Fetches all the current events for the current view
*
* @returns A list of events that can appear in the current view
*/
function computeCurrentEvents(): CalendarEvent[] { function computeCurrentEvents(): CalendarEvent[] {
const allEvents = [...characterBirthEvents.value, ...characterDeathEvents.value] const allEvents = [...characterBirthEvents.value, ...characterDeathEvents.value]