From 7aa2cfc8d4bb482642b97b1388190706fcac13e6 Mon Sep 17 00:00:00 2001
From: kolaente <k@knt.li>
Date: Sun, 9 Jan 2022 17:27:28 +0100
Subject: [PATCH] feat: add date range filter to task filters

---
 src/components/list/partials/filter-popup.vue |   2 +-
 src/components/list/partials/filters.vue      | 107 ++++++------------
 src/components/misc/popup.vue                 |   9 +-
 src/helpers/time/parseDateOrString.ts         |  12 ++
 src/styles/theme/theme.scss                   |   2 +-
 src/views/tasks/ShowTasks.vue                 |  17 +--
 6 files changed, 58 insertions(+), 91 deletions(-)
 create mode 100644 src/helpers/time/parseDateOrString.ts

diff --git a/src/components/list/partials/filter-popup.vue b/src/components/list/partials/filter-popup.vue
index d4caf9b4..8e156106 100644
--- a/src/components/list/partials/filter-popup.vue
+++ b/src/components/list/partials/filter-popup.vue
@@ -6,7 +6,7 @@
 	>
 		{{ $t('filters.clear') }}
 	</x-button>
-	<popup>
+	<popup :has-overflow="true">
 		<template #trigger="{toggle}">
 			<x-button
 				@click.prevent.stop="toggle()"
diff --git a/src/components/list/partials/filters.vue b/src/components/list/partials/filters.vue
index 42f84f95..c216e558 100644
--- a/src/components/list/partials/filters.vue
+++ b/src/components/list/partials/filters.vue
@@ -67,49 +67,25 @@
 		<div class="field">
 			<label class="label">{{ $t('task.attributes.dueDate') }}</label>
 			<div class="control">
-				<flat-pickr
-					:config="flatPickerConfig"
-					@on-close="setDueDateFilter"
-					class="input"
-					:placeholder="$t('filters.attributes.dueDateRange')"
-					v-model="filters.dueDate"
-				/>
+				<datepicker-with-range :show-selected-on-button="true" @dateChanged="setDueDateFilter"/>
 			</div>
 		</div>
 		<div class="field">
 			<label class="label">{{ $t('task.attributes.startDate') }}</label>
 			<div class="control">
-				<flat-pickr
-					:config="flatPickerConfig"
-					@on-close="setStartDateFilter"
-					class="input"
-					:placeholder="$t('filters.attributes.startDateRange')"
-					v-model="filters.startDate"
-				/>
+				<datepicker-with-range :show-selected-on-button="true" @dateChanged="setStartDateFilter"/>
 			</div>
 		</div>
 		<div class="field">
 			<label class="label">{{ $t('task.attributes.endDate') }}</label>
 			<div class="control">
-				<flat-pickr
-					:config="flatPickerConfig"
-					@on-close="setEndDateFilter"
-					class="input"
-					:placeholder="$t('filters.attributes.endDateRange')"
-					v-model="filters.endDate"
-				/>
+				<datepicker-with-range :show-selected-on-button="true" @dateChanged="setEndDateFilter"/>
 			</div>
 		</div>
 		<div class="field">
 			<label class="label">{{ $t('task.attributes.reminders') }}</label>
 			<div class="control">
-				<flat-pickr
-					:config="flatPickerConfig"
-					@on-close="setReminderFilter"
-					class="input"
-					:placeholder="$t('filters.attributes.reminderRange')"
-					v-model="filters.reminders"
-				/>
+				<datepicker-with-range :show-selected-on-button="true" @dateChanged="setReminderFilter"/>
 			</div>
 		</div>
 
@@ -175,15 +151,14 @@
 </template>
 
 <script>
+import DatepickerWithRange from '@/components/date/datepickerWithRange'
 import Fancycheckbox from '../../input/fancycheckbox'
-import flatPickr from 'vue-flatpickr-component'
-import 'flatpickr/dist/flatpickr.css'
 
 import {includesById} from '@/helpers/utils'
-import {formatISO} from 'date-fns'
 import PrioritySelect from '@/components/tasks/partials/prioritySelect.vue'
 import PercentDoneSelect from '@/components/tasks/partials/percentDoneSelect.vue'
 import Multiselect from '@/components/input/multiselect.vue'
+import {parseDateOrString} from '@/helpers/time/parseDateOrString'
 
 import UserService from '@/services/user'
 import ListService from '@/services/list'
@@ -222,15 +197,15 @@ const DEFAULT_FILTERS = {
 	namespace: '',
 }
 
-export const ALPHABETICAL_SORT	= 'title'
+export const ALPHABETICAL_SORT = 'title'
 
 export default {
 	name: 'filters',
 	components: {
+		DatepickerWithRange,
 		EditLabels,
 		PrioritySelect,
 		Fancycheckbox,
-		flatPickr,
 		PercentDoneSelect,
 		Multiselect,
 	},
@@ -281,7 +256,7 @@ export default {
 				return this.params?.sort_by?.find(sortBy => sortBy === ALPHABETICAL_SORT) !== undefined
 			},
 			set(sortAlphabetically) {
-				this.params.sort_by	= sortAlphabetically
+				this.params.sort_by = sortAlphabetically
 					? [ALPHABETICAL_SORT]
 					: getDefaultParams().sort_by
 
@@ -291,19 +266,6 @@ export default {
 		foundLabels() {
 			return this.$store.getters['labels/filterLabelsByQuery'](this.labels, this.query)
 		},
-		flatPickerConfig() {
-			return {
-				altFormat: this.$t('date.altFormatLong'),
-				altInput: true,
-				dateFormat: 'Y-m-d H:i',
-				enableTime: true,
-				time_24hr: true,
-				mode: 'range',
-				locale: {
-					firstDayOfWeek: this.$store.state.auth.settings.weekStart,
-				},
-			}
-		},
 	},
 	methods: {
 		change() {
@@ -343,19 +305,12 @@ export default {
 				}
 			}
 		},
-		setDateFilter(filterName, variableName = null) {
-			if (variableName === null) {
-				variableName = filterName
-			}
+		setDateFilter(filterName, {dateFrom, dateTo}) {
+			dateFrom = parseDateOrString(dateFrom, null)
+			dateTo = parseDateOrString(dateTo, null)
 			
-			// Only filter if we have a start and end due date
-			if (this.filters[variableName] !== '') {
-
-				const parts = this.filters[variableName].split(' to ')
-
-				if (parts.length < 2) {
-					return
-				}
+			// Only filter if we have a date
+			if (dateFrom !== null && dateTo !== null) {
 
 				// Check if we already have values in params and only update them if we do
 				let foundStart = false
@@ -363,23 +318,23 @@ export default {
 				this.params.filter_by.forEach((f, i) => {
 					if (f === filterName && this.params.filter_comparator[i] === 'greater_equals') {
 						foundStart = true
-						this.params.filter_value[i] = formatISO(new Date(parts[0]))
+						this.params.filter_value[i] = dateFrom
 					}
 					if (f === filterName && this.params.filter_comparator[i] === 'less_equals') {
 						foundEnd = true
-						this.params.filter_value[i] = formatISO(new Date(parts[1]))
+						this.params.filter_value[i] = dateTo
 					}
 				})
 
 				if (!foundStart) {
 					this.params.filter_by.push(filterName)
 					this.params.filter_comparator.push('greater_equals')
-					this.params.filter_value.push(formatISO(new Date(parts[0])))
+					this.params.filter_value.push(dateFrom)
 				}
 				if (!foundEnd) {
 					this.params.filter_by.push(filterName)
 					this.params.filter_comparator.push('less_equals')
-					this.params.filter_value.push(formatISO(new Date(parts[1])))
+					this.params.filter_value.push(dateTo)
 				}
 				this.change()
 				return
@@ -513,23 +468,23 @@ export default {
 				this.params.filter_concat = 'or'
 			}
 		},
-		setDueDateFilter() {
-			this.setDateFilter('due_date', 'dueDate')
-		},
 		setPriority() {
 			this.setSingleValueFilter('priority', 'priority', 'usePriority')
 		},
-		setStartDateFilter() {
-			this.setDateFilter('start_date', 'startDate')
-		},
-		setEndDateFilter() {
-			this.setDateFilter('end_date', 'endDate')
-		},
 		setPercentDoneFilter() {
 			this.setSingleValueFilter('percent_done', 'percentDone', 'usePercentDone')
 		},
-		setReminderFilter() {
-			this.setDateFilter('reminders')
+		setDueDateFilter(values) {
+			this.setDateFilter('due_date', values)
+		},
+		setStartDateFilter(values) {
+			this.setDateFilter('start_date', values)
+		},
+		setEndDateFilter(values) {
+			this.setDateFilter('end_date', values)
+		},
+		setReminderFilter(values) {
+			this.setDateFilter('reminders', values)
 		},
 		clear(kind) {
 			this[`found${kind}`] = []
@@ -618,4 +573,8 @@ export default {
 		margin-left: .5rem;
 	}
 }
+
+.datepicker-with-range-container .popup {
+	right: 0;
+}
 </style>
diff --git a/src/components/misc/popup.vue b/src/components/misc/popup.vue
index fcfa420e..f3815781 100644
--- a/src/components/misc/popup.vue
+++ b/src/components/misc/popup.vue
@@ -1,6 +1,6 @@
 <template>
 	<slot name="trigger" :isOpen="open" :toggle="toggle"></slot>
-	<div class="popup" :class="{'is-open': open}" ref="popup">
+	<div class="popup" :class="{'is-open': open, 'has-overflow': props.hasOverflow}" ref="popup">
 		<slot name="content" :isOpen="open"/>
 	</div>
 </template>
@@ -16,6 +16,13 @@ const toggle = () => {
 	open.value = !open.value
 }
 
+const props = defineProps({
+	hasOverflow: {
+		type: Boolean,
+		default: false,
+	}
+})
+
 function hidePopup(e) {
 	if (!open.value) {
 		return
diff --git a/src/helpers/time/parseDateOrString.ts b/src/helpers/time/parseDateOrString.ts
new file mode 100644
index 00000000..48dc97ae
--- /dev/null
+++ b/src/helpers/time/parseDateOrString.ts
@@ -0,0 +1,12 @@
+export function parseDateOrString(rawValue: string, fallback: any) {
+	if (typeof rawValue === 'undefined') {
+		return fallback
+	}
+
+	const d = new Date(rawValue)
+
+	// @ts-ignore if rawValue is an invalid date, isNan will return false.
+	return !isNaN(d)
+		? d
+		: rawValue
+}
diff --git a/src/styles/theme/theme.scss b/src/styles/theme/theme.scss
index 77a9ec06..9c10e769 100644
--- a/src/styles/theme/theme.scss
+++ b/src/styles/theme/theme.scss
@@ -65,7 +65,7 @@ h6 {
 }
 
 .has-overflow {
-  overflow: visible;
+  overflow: visible !important;
 }
 
 .has-horizontal-overflow {
diff --git a/src/views/tasks/ShowTasks.vue b/src/views/tasks/ShowTasks.vue
index 7015d8cc..ef0d6aeb 100644
--- a/src/views/tasks/ShowTasks.vue
+++ b/src/views/tasks/ShowTasks.vue
@@ -40,6 +40,7 @@
 <script>
 import {dateRanges} from '@/components/date/dateRanges'
 import SingleTaskInList from '@/components/tasks/partials/singleTaskInList'
+import {parseDateOrString} from '@/helpers/time/parseDateOrString'
 import {mapState} from 'vuex'
 
 import Fancycheckbox from '@/components/input/fancycheckbox'
@@ -48,18 +49,6 @@ import {LOADING, LOADING_MODULE} from '@/store/mutation-types'
 import LlamaCool from '@/assets/llama-cool.svg?component'
 import DatepickerWithRange from '@/components/date/datepickerWithRange'
 
-function parseDate(query, fallback) {
-	if (typeof query === 'undefined') {
-		return fallback
-	}
-
-	const d = new Date(query)
-
-	return !isNaN(d)
-		? d
-		: query
-}
-
 function getNextWeekDate() {
 	return new Date((new Date()).getTime() + 7 * 24 * 60 * 60 * 1000)
 }
@@ -95,10 +84,10 @@ export default {
 	},
 	computed: {
 		dateFrom() {
-			return parseDate(this.$route.query.from, new Date())
+			return parseDateOrString(this.$route.query.from, new Date())
 		},
 		dateTo() {
-			return parseDate(this.$route.query.to, getNextWeekDate())
+			return parseDateOrString(this.$route.query.to, getNextWeekDate())
 		},
 		showNulls() {
 			return this.$route.query.showNulls === 'true'