diff --git a/lib/Constants.php b/lib/Constants.php index 3e465cd0c..4db4e54a3 100644 --- a/lib/Constants.php +++ b/lib/Constants.php @@ -111,6 +111,7 @@ class Constants { public const ANSWER_TYPE_MULTIPLE = 'multiple'; public const ANSWER_TYPE_MULTIPLEUNIQUE = 'multiple_unique'; public const ANSWER_TYPE_RANKING = 'ranking'; + public const ANSWER_TYPE_RATING = 'rating'; public const ANSWER_TYPE_SHORT = 'short'; public const ANSWER_TYPE_TIME = 'time'; @@ -131,9 +132,17 @@ class Constants { self::ANSWER_TYPE_MULTIPLE, self::ANSWER_TYPE_MULTIPLEUNIQUE, self::ANSWER_TYPE_RANKING, + self::ANSWER_TYPE_RATING, self::ANSWER_TYPE_SHORT, self::ANSWER_TYPE_TIME, ]; + + // AnswerTypes for date/time questions + public const ANSWER_TYPES_DATETIME = [ + self::ANSWER_TYPE_DATE, + self::ANSWER_TYPE_DATETIME, + self::ANSWER_TYPE_TIME, + ]; // AnswerTypes, that need/have predefined Options public const ANSWER_TYPES_PREDEFINED = [ @@ -145,18 +154,17 @@ class Constants { self::ANSWER_TYPE_RANKING, ]; - // AnswerTypes for date/time questions - public const ANSWER_TYPES_DATETIME = [ - self::ANSWER_TYPE_DATE, - self::ANSWER_TYPE_DATETIME, - self::ANSWER_TYPE_TIME + // AnswerTypes for scale questions + // TODO: add linearscale + public const ANSWER_TYPES_SCALE = [ + self::ANSWER_TYPE_RANKING, ]; // Formats for AnswerTypes date/datetime/time public const ANSWER_PHPDATETIME_FORMAT = [ self::ANSWER_TYPE_DATE => 'Y-m-d', self::ANSWER_TYPE_DATETIME => 'Y-m-d H:i', - self::ANSWER_TYPE_TIME => 'H:i' + self::ANSWER_TYPE_TIME => 'H:i', ]; /** @@ -168,7 +176,7 @@ class Constants { 'phone', 'email', 'regex', - 'number' + 'number', ]; // This are allowed extra settings @@ -229,6 +237,11 @@ class Constants { 'rows' => ['array'], ]; + public const EXTRA_SETTINGS_RATING = [ + 'optionsHighest' => ['integer', 'NULL'], + 'ratingIcon' => ['string', 'NULL'], + ]; + public const EXTRA_SETTINGS_RANKING = [ 'shuffleOptions' => ['boolean'], ]; diff --git a/lib/Service/FormsService.php b/lib/Service/FormsService.php index 197ababbc..456268778 100644 --- a/lib/Service/FormsService.php +++ b/lib/Service/FormsService.php @@ -909,6 +909,7 @@ public function areExtraSettingsValid(array $extraSettings, string $questionType Constants::ANSWER_TYPE_DATE => Constants::EXTRA_SETTINGS_DATE, Constants::ANSWER_TYPE_GRID => Constants::EXTRA_SETTINGS_GRID, Constants::ANSWER_TYPE_RANKING => Constants::EXTRA_SETTINGS_RANKING, + Constants::ANSWER_TYPE_RATING => Constants::EXTRA_SETTINGS_RATING, Constants::ANSWER_TYPE_TIME => Constants::EXTRA_SETTINGS_TIME, Constants::ANSWER_TYPE_LINEARSCALE => Constants::EXTRA_SETTINGS_LINEARSCALE, default => [], @@ -1045,8 +1046,10 @@ public function areExtraSettingsValid(array $extraSettings, string $questionType } // Special handling of linear scale validation - } elseif ($questionType === Constants::ANSWER_TYPE_LINEARSCALE) { - // Ensure limits are sane + } elseif ($questionType === Constants::ANSWER_TYPE_LINEARSCALE + || $questionType === Constants::ANSWER_TYPE_RATING) { + // Ensure limits are sane. A rating cannot set optionsLowest at all, so for it + // only the top end is checked. if (isset($extraSettings['optionsLowest']) && ($extraSettings['optionsLowest'] < 0 || $extraSettings['optionsLowest'] > 1) || isset($extraSettings['optionsHighest']) && ($extraSettings['optionsHighest'] < 2 || $extraSettings['optionsHighest'] > 10)) { return false; diff --git a/lib/Service/SubmissionService.php b/lib/Service/SubmissionService.php index c26f21ca6..bb427b5e4 100644 --- a/lib/Service/SubmissionService.php +++ b/lib/Service/SubmissionService.php @@ -691,7 +691,14 @@ public function validateSubmission(array $questions, array $answers, string $for * Otherwise, validate the single answer for the date/time question */ if (in_array($question['type'], Constants::ANSWER_TYPES_DATETIME)) { - $this->validateDateTime($answers[$questionId], Constants::ANSWER_PHPDATETIME_FORMAT[$question['type']], $question['text'] ?? null, $question['extraSettings'] ?? null); + $this->validateDateTimeQuestion($answers[$questionId], Constants::ANSWER_PHPDATETIME_FORMAT[$question['type']], $question['text'] ?? null, $question['extraSettings'] ?? null); + } + + // Check if answers to scale questions are within the limits + if (in_array($question['type'], Constants::ANSWER_TYPES_SCALE)) { + foreach ($answers[$questionId] as $answer) { + $this->validateScaleQuestion($question, $answer); + } } // Check if all answers are within the possible options @@ -701,12 +708,9 @@ public function validateSubmission(array $questions, array $answers, string $for foreach ($answers[$questionId] as $answer) { // Handle linear scale questions + // TODO: move to scale question check if ($question['type'] === Constants::ANSWER_TYPE_LINEARSCALE) { - $optionsLowest = $question['extraSettings']['optionsLowest'] ?? 1; - $optionsHighest = $question['extraSettings']['optionsHighest'] ?? 5; - if (!is_scalar($answer) || is_bool($answer) || !ctype_digit((string)$answer) || intval($answer) < $optionsLowest || intval($answer) > $optionsHighest) { - throw new \InvalidArgumentException(sprintf('The answer for question "%s" must be an integer between %d and %d.', $question['text'], $optionsLowest, $optionsHighest)); - } + $this->validateScaleQuestion($question, $answer); } // Check if all grid rows, columns and values match the configured grid subtype elseif ($question['type'] === Constants::ANSWER_TYPE_GRID) { @@ -794,6 +798,25 @@ public function validateSubmission(array $questions, array $answers, string $for } } + /** + * Check one answer to a question answered on a numbered scale. + * + * Shared by the linear scale and the rating, which differ only in how the scale is + * drawn. The bounds and their defaults are the linear scale's; a rating does not + * accept optionsLowest, so its lowest end always falls back to 1. + * + * @param array $question the question being answered + * @param mixed $answer one submitted value + * @throws \InvalidArgumentException if the answer is not a whole number within range + */ + private function validateScaleQuestion(array $question, mixed $answer): void { + $optionsLowest = $question['extraSettings']['optionsLowest'] ?? 1; + $optionsHighest = $question['extraSettings']['optionsHighest'] ?? 5; + if (!ctype_digit((string)$answer) || intval($answer) < $optionsLowest || intval($answer) > $optionsHighest) { + throw new \InvalidArgumentException(sprintf('The answer for question "%s" must be an integer between %d and %d.', $question['text'], $optionsLowest, $optionsHighest)); + } + } + /** * Validate correct date/time formats * @param array $answers Array with date from answer @@ -801,7 +824,7 @@ public function validateSubmission(array $questions, array $answers, string $for * @param string|null $text String with the title of the question * @param array|null $extraSettings Array with extra settings for validation */ - private function validateDateTime(array $answers, string $format, ?string $text = null, ?array $extraSettings = null): void { + private function validateDateTimeQuestion(array $answers, string $format, ?string $text = null, ?array $extraSettings = null): void { $previousDate = null; foreach ($answers as $dateStr) { diff --git a/src/components/Questions/QuestionRating.vue b/src/components/Questions/QuestionRating.vue new file mode 100644 index 000000000..17342ee1d --- /dev/null +++ b/src/components/Questions/QuestionRating.vue @@ -0,0 +1,284 @@ + + + + + + + diff --git a/src/components/Results/ResultsSummary.vue b/src/components/Results/ResultsSummary.vue index 4156ba3ef..8228d9902 100644 --- a/src/components/Results/ResultsSummary.vue +++ b/src/components/Results/ResultsSummary.vue @@ -247,7 +247,10 @@ export default defineComponent({ const questionOptions = computed(() => { // Build list of question options let questionOptionsStats: OptionStats[] - if (props.question.type !== 'linearscale') { + if ( + props.question.type !== 'linearscale' + && props.question.type !== 'rating' + ) { questionOptionsStats = (props.question.options ?? []).map( (option) => ({ ...option, @@ -342,7 +345,10 @@ export default defineComponent({ }) // Sort options by response count - if (props.question.type !== 'linearscale') { + if ( + props.question.type !== 'linearscale' + && props.question.type !== 'rating' + ) { questionOptionsStats.sort( (object1, object2) => object2.count - object1.count, ) diff --git a/src/models/AnswerTypes.ts b/src/models/AnswerTypes.ts index e2bc47b9e..d5103d5c3 100644 --- a/src/models/AnswerTypes.ts +++ b/src/models/AnswerTypes.ts @@ -17,6 +17,7 @@ import IconPalette from '@material-symbols/svg-400/outlined/palette.svg?raw' import IconRadioboxMarked from '@material-symbols/svg-400/outlined/radio_button_checked.svg?raw' import IconClockOutline from '@material-symbols/svg-400/outlined/schedule.svg?raw' import IconTextShort from '@material-symbols/svg-400/outlined/short_text.svg?raw' +import IconStar from '@material-symbols/svg-400/outlined/star.svg?raw' import IconTextLong from '@material-symbols/svg-400/outlined/subject.svg?raw' import IconSwapVertical from '@material-symbols/svg-400/outlined/swap_vert.svg?raw' import { t } from '@nextcloud/l10n' @@ -30,6 +31,7 @@ import QuestionLinearScale from '../components/Questions/QuestionLinearScale.vue import QuestionLong from '../components/Questions/QuestionLong.vue' import QuestionMultiple from '../components/Questions/QuestionMultiple.vue' import QuestionRanking from '../components/Questions/QuestionRanking.vue' +import QuestionRating from '../components/Questions/QuestionRating.vue' import QuestionShort from '../components/Questions/QuestionShort.vue' import { OptionType } from './Constants.ts' @@ -267,6 +269,16 @@ const answerTypes: Record = { warningInvalid: t('forms', 'This question needs a title!'), }, + rating: { + component: markRaw(QuestionRating), + icon: IconStar, + label: t('forms', 'Rating'), + predefined: true, + + titlePlaceholder: t('forms', 'Rating question title'), + warningInvalid: t('forms', 'This question needs a title!'), + }, + color: { component: markRaw(QuestionColor), icon: IconPalette, diff --git a/tests/Unit/Service/FormsServiceTest.php b/tests/Unit/Service/FormsServiceTest.php index 04185d43d..20d67844c 100644 --- a/tests/Unit/Service/FormsServiceTest.php +++ b/tests/Unit/Service/FormsServiceTest.php @@ -1662,6 +1662,36 @@ public function testAreExtraSettingsValidNormalizesLegacyDateLimitsAsUtcDates(): public static function dataAreExtraSettingsValid() { return [ + 'valid-rating-settings' => [ + 'extraSettings' => [ + 'optionsHighest' => 10, + 'ratingIcon' => 'heart', + ], + 'questionType' => Constants::ANSWER_TYPE_RATING, + 'expected' => true + ], + 'rating-top-above-scale-limit' => [ + 'extraSettings' => [ + 'optionsHighest' => 11, + ], + 'questionType' => Constants::ANSWER_TYPE_RATING, + 'expected' => false + ], + 'rating-top-below-scale-limit' => [ + 'extraSettings' => [ + 'optionsHighest' => 1, + ], + 'questionType' => Constants::ANSWER_TYPE_RATING, + 'expected' => false + ], + 'rating-has-no-lowest-end' => [ + // A rating always starts at 1, so the linear scale's lower bound is refused. + 'extraSettings' => [ + 'optionsLowest' => 0, + ], + 'questionType' => Constants::ANSWER_TYPE_RATING, + 'expected' => false + ], 'empty-extra-settings' => [ 'extraSettings' => [], 'questionType' => Constants::ANSWER_TYPE_LONG, diff --git a/tests/Unit/Service/SubmissionServiceTest.php b/tests/Unit/Service/SubmissionServiceTest.php index f8320aa3a..5a6d26bd8 100644 --- a/tests/Unit/Service/SubmissionServiceTest.php +++ b/tests/Unit/Service/SubmissionServiceTest.php @@ -965,6 +965,78 @@ public static function dataValidateSubmission() { [], 'Question "q1" is required.', ], + 'rating-within-configured-top' => [ + // Questions + [ + ['id' => 1, 'type' => 'rating', 'text' => 'r', 'isRequired' => false, 'extraSettings' => ['optionsHighest' => 10]], + ], + // Answers + [ + '1' => ['7'], + ], + // Expected Result + null, + ], + 'rating-at-default-top' => [ + // Questions + [ + ['id' => 1, 'type' => 'rating', 'text' => 'r', 'isRequired' => false], + ], + // Answers + [ + '1' => ['5'], + ], + // Expected Result + null, + ], + 'rating-above-default-top' => [ + // Questions + [ + ['id' => 1, 'type' => 'rating', 'text' => 'r', 'isRequired' => false], + ], + // Answers + [ + '1' => ['6'], + ], + // Expected Result + 'The answer for question "r" must be an integer between 1 and 5.', + ], + 'rating-above-configured-top' => [ + // Questions + [ + ['id' => 1, 'type' => 'rating', 'text' => 'r', 'isRequired' => false, 'extraSettings' => ['optionsHighest' => 3]], + ], + // Answers + [ + '1' => ['4'], + ], + // Expected Result + 'The answer for question "r" must be an integer between 1 and 3.', + ], + 'rating-zero' => [ + // Questions + [ + ['id' => 1, 'type' => 'rating', 'text' => 'r', 'isRequired' => false], + ], + // Answers + [ + '1' => ['0'], + ], + // Expected Result + 'The answer for question "r" must be an integer between 1 and 5.', + ], + 'rating-not-a-number' => [ + // Questions + [ + ['id' => 1, 'type' => 'rating', 'text' => 'r', 'isRequired' => false], + ], + // Answers + [ + '1' => ['three'], + ], + // Expected Result + 'The answer for question "r" must be an integer between 1 and 5.', + ], 'required-not-answered' => [ // Questions [