Skip to content

add max values for vehicles in config #1728

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.

Sign up for GitHub

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

Draft
kaligrafy wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

add max values for vehicles in config #1728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 29 additions & 0 deletions packages/evolution-common/src/config/project.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,31 @@ export type EvolutionProjectConfiguration = {
*/
surveyAreaGeojsonPath?: string;

/**
* Maximum valid household size. Used by `householdSizeValidation`. Defaults to 18.
*/
householdSizeMax: number;

/**
* Maximum valid number of cars per person in the household, above which the
* number of cars is considered suspicious. Used by `carNumberValidation`. Defaults to 3.
*/
carNumberMaxPerPerson: number;

/**
* Maximum valid number of two-wheeled motorized vehicles per person in the
* household, above which the number is considered suspicious. Used by
* `twoWheelNumberValidation`. Defaults to 3.
*/
twoWheelNumberMaxPerPerson: number;

/**
* Maximum valid number of bicycles per person in the household, above which
* the number of bicycles is considered suspicious. Used by
* `bicycleNumberValidation`. Defaults to 3.
*/
bicycleNumberMaxPerPerson: number;

// TODO Add more project configuration types
};

Expand Down Expand Up @@ -297,6 +322,10 @@ const defaultConfig = {
'#9F41B5',
'#B5417B'
],
householdSizeMax: 18,
carNumberMaxPerPerson: 3,
twoWheelNumberMaxPerPerson: 3,
bicycleNumberMaxPerPerson: 3,
requiredFieldsBySurveyObject: {
interview: [],
household: [],
Expand Down
87 changes: 65 additions & 22 deletions packages/evolution-common/src/services/widgets/validations/validations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,13 @@ export const inputRangeValidation: ValidationFunction = (value) => {
/**
* Verify if the value is a valid household size.
*
* The household size must be an integer between 1 and 18.
* The household size must be an integer between 1 and `projectConfig.householdSizeMax`.
*
* @see {@link ValidationFunction}
*/
export const householdSizeValidation: ValidationFunction = (value) => {
const householdSizeMax = projectConfig.householdSizeMax;

return [
{
validation: isNaN(Number(value)) || !Number.isInteger(Number(value)),
Expand All @@ -85,10 +87,10 @@ export const householdSizeValidation: ValidationFunction = (value) => {
}
},
{
validation: Number(value) > 18,
validation: Number(value) > householdSizeMax,
errorMessage: {
fr: 'La taille du ménage doit être au maximum 18.',
en: 'Household size must be at most 18.'
fr: `La taille du ménage doit être au maximum ${householdSizeMax}.`,
en: `Household size must be at most ${householdSizeMax}.`
}
},
{
Expand All @@ -104,16 +106,17 @@ export const householdSizeValidation: ValidationFunction = (value) => {
/**
* Verify if the value is a valid number of cars.
*
* The number of cars must be an integer between 0 and 13.
* The number of cars should not be more than 3 times the number of people in the household.
* The number of cars must be an integer between 0 and `projectConfig.carNumberMax`.
* The number of cars should not be more than `projectConfig.carNumberMaxPerPerson`
* times the number of people in the household.
*
* Required interview.response fields: 'household.size'
*
* @see {@link ValidationFunction}
*/
export const carNumberValidation: ValidationFunction = (value, _customValue, interview, _path, _customPath) => {
const householdSize = surveyHelperNew.getResponse(interview, 'household.size', null);
const maxCarsPerPerson = 3;
const maxCarsPerPerson = projectConfig.carNumberMaxPerPerson;

return [
{
Expand All @@ -137,7 +140,7 @@ export const carNumberValidation: ValidationFunction = (value, _customValue, int
en: 'The number of vehicles must be at least 0.'
}
},
// The number of vehicles should not be 3 times greater than the number of people in the household
// The number of vehicles should not be maxCarsPerPerson times greater than the number of people in the household
{
validation:
!_isBlank(householdSize) &&
Expand All @@ -148,12 +151,58 @@ export const carNumberValidation: ValidationFunction = (value, _customValue, int
fr: `Le nombre de véhicules doit être au maximum ${Number(householdSize) * maxCarsPerPerson} pour le nombre de personnes dans le ménage. Ne pas inclure les véhicules de collection ou les véhicules qui ne sont pas utilisés régulièrement.`,
en: `The number of vehicles must be at most ${Number(householdSize) * maxCarsPerPerson} for the number of people in the household. Do not include collection vehicles or vehicles that are not used on a regular basis.`
}
}
];
};

/**
* Verify if the value is a valid number of two-wheeled motorized vehicles (motorcycles, scooters, mopeds).
*
* The number of two-wheeled motorized vehicles must be an integer between 0 and
* `projectConfig.twoWheelNumberMax`. The number of two-wheeled motorized vehicles
* should not be more than `projectConfig.twoWheelNumberMaxPerPerson` times the
* number of people in the household.
*
* Required interview.response fields: 'household.size'
*
* @see {@link ValidationFunction}
*/
export const twoWheelNumberValidation: ValidationFunction = (value, _customValue, interview, _path, _customPath) => {
const householdSize = surveyHelperNew.getResponse(interview, 'household.size', null);
const maxTwoWheelPerPerson = projectConfig.twoWheelNumberMaxPerPerson;

return [
{
validation: isNaN(Number(value)) || !Number.isInteger(Number(value)),
errorMessage: {
fr: 'Le nombre de motocyclettes ou scooters est invalide.',
en: 'The number of motorcycles or scooters is invalid.'
}
},
{
validation: Number(value) > 13,
validation: _isBlank(value),
errorMessage: {
fr: 'Le nombre de motocyclettes ou scooters est requis.',
en: 'The number of motorcycles or scooters is required.'
}
},
{
validation: Number(value) < 0,
errorMessage: {
fr: 'Le nombre de motocyclettes ou scooters doit être au moins de 0.',
en: 'The number of motorcycles or scooters must be at least 0.'
}
},
// The number of two-wheeled motorized vehicles should not be maxTwoWheelPerPerson times greater than the number of people in the household
{
validation:
!_isBlank(householdSize) &&
!isNaN(Number(householdSize)) &&
typeof householdSize === 'number' &&
Number(value) / householdSize > maxTwoWheelPerPerson,
errorMessage: {
fr: 'Le nombre de véhicules doit être au maximum 13.',
en: 'The number of vehicles must be at most 13.'
fr: `Le nombre de motocyclettes ou scooters doit être au maximum ${Number(householdSize) * maxTwoWheelPerPerson} pour le nombre de personnes dans le ménage. Ne pas inclure les véhicules de collection ou les véhicules qui ne sont pas utilisés régulièrement.`,
en: `The number of motorcycles or scooters must be at most ${Number(householdSize) * maxTwoWheelPerPerson} for the number of people in the household. Do not include collection vehicles or vehicles that are not used on a regular basis.`
}
}
];
Expand All @@ -162,16 +211,17 @@ export const carNumberValidation: ValidationFunction = (value, _customValue, int
/**
* Verify if the value is a valid number of bicycles.
*
* The number of bicycles must be an integer between 0 and 20.
* The number of bicycles should not be more than 5 times the number of people in the household.
* The number of bicycles must be an integer between 0 and `projectConfig.bicycleNumberMax`.
* The number of bicycles should not be more than `projectConfig.bicycleNumberMaxPerPerson`
* times the number of people in the household.
*
* Required interview.response fields: 'household.size'
*
* @see {@link ValidationFunction}
*/
export const bicycleNumberValidation: ValidationFunction = (value, _customValue, interview, _path, _customPath) => {
const householdSize = surveyHelperNew.getResponse(interview, 'household.size', null);
const maxBicyclesPerPerson = 5;
const maxBicyclesPerPerson = projectConfig.bicycleNumberMaxPerPerson;

return [
{
Expand All @@ -195,7 +245,7 @@ export const bicycleNumberValidation: ValidationFunction = (value, _customValue,
en: 'The number of bicycles must be at least 0.'
}
},
// The number of bicycles should not be 5 times greater than the number of people in the household
// The number of bicycles should not be maxBicyclesPerPerson times greater than the number of people in the household
{
validation:
!_isBlank(householdSize) &&
Expand All @@ -206,13 +256,6 @@ export const bicycleNumberValidation: ValidationFunction = (value, _customValue,
fr: `Le nombre de vélos doit être au maximum ${Number(householdSize) * maxBicyclesPerPerson} pour le nombre de personnes dans le ménage. Ne pas inclure les vélos de collection ou les vélos qui ne sont pas utilisés régulièrement.`,
en: `The number of bicycles must be at most ${Number(householdSize) * maxBicyclesPerPerson} for the number of people in the household. Do not include collection bicycles or bicycles that are not used on a regular basis.`
}
},
{
validation: Number(value) > 20,
errorMessage: {
fr: 'Le nombre de vélos doit être au maximum 20.',
en: 'The number of bicycles must be at most to 20.'
}
}
];
};
Expand Down
Loading