Skip to content
Open
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
16 changes: 11 additions & 5 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ function validateForm({ formData, includeMessages=true }) {

if (result.errors) {
fields.push(key);
errors.push(result.errors);
errors.push(result.errors.map(rule => rule.key));

if (includeMessages) {
const fieldMessages = result.errors.map(rule => generateMessage(rule, fieldData));
const fieldMessages = result.errors.map(rule => generateMessage(rule.key, rule.params, fieldData));
messages.push(fieldMessages);
}

Expand Down Expand Up @@ -92,7 +92,12 @@ function parseRule(rule) {
};
}

// {key, value, validation}
/**
* Returns array of failed rules or false if all rules passed.
*
* @param fieldData In the format { key, value, validation, ... }
* @param formData See `validateForm`
*/
function validateField(fieldData, formData) {

const values = formData && Object.keys(formData).reduce((values, key) => {
Expand Down Expand Up @@ -132,6 +137,7 @@ function validateField(fieldData, formData) {
...rule,
key: fieldData.key,
value: fieldData.value,
rules: validation,
values,
}

Expand All @@ -148,7 +154,7 @@ function validateField(fieldData, formData) {
if (!overrideNullable && nullable && fieldData.value === null) {
continue;
}
errors.push(rule.key);
errors.push(rule);
}
}

Expand All @@ -161,4 +167,4 @@ toExport.validateForm = validateForm;
toExport.validateField = validateField;
toExport.parseRule = parseRule;

export const validate = toExport;
export const validate = toExport;
6 changes: 3 additions & 3 deletions src/messages.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export const messages = {
before: () => "The :attribute must be a date before :date.",
before_or_equal: () => "The :attribute must be a date before or equal to :date.",

between: () => "", // TODO this one is more complicated
between: () => "The :attribute must be between :min and :max.",

boolean: () => "The :attribute field must be true or false.",

Expand Down Expand Up @@ -66,12 +66,12 @@ export const messages = {
lt: () => "", // TODO this is more complicated, and is it done with size?
lte: () => "", // TODO this is more complicated, and is it done with size?

max: () => "", // TODO this is more complicated, and is it done with size?
max: () => "The :attribute must be maximal :max.", // TODO this is more complicated, and is it done with size?

// mimes?
// mimetypes?

min: () => "", // TODO this is more complicated, and is it done with size?
min: () => "The :attribute must be at least :min.", // TODO this is more complicated, and is it done with size?

not_in: () => "The selected :attribute is invalid.",

Expand Down
13 changes: 9 additions & 4 deletions src/placeholders.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ export const DEFAULT_PLACEHOLDERS = {
"date_equals": {
date: ({ params }) => params[0],
},
"digits": {
digits: ({ params }) => params[0],
},
"digits_between": {
min: ({params}) => params[0],
max: ({params}) => params[1]
},
"dimensions": {
// TODO
},
Expand Down Expand Up @@ -86,10 +93,10 @@ export const DEFAULT_PLACEHOLDERS = {
},
};

export function generateMessage(rule, fieldData) {
export function generateMessage(rule, ruleParams, fieldData) {
const message = getMessage(rule, fieldData);

return replacePlaceholders(message, { rule, ...fieldData });
return replacePlaceholders(message, { rule, params: ruleParams, ...fieldData });
}

function replacePlaceholders(message, fieldData) {
Expand All @@ -104,8 +111,6 @@ function replacePlaceholders(message, fieldData) {
const replacementValue = fieldData[placeholder];

if (replacementValue === null || replacementValue === undefined) {


replacementValue = getDefaultPlaceholderValue(placeholder, fieldData) || "";
}

Expand Down
19 changes: 14 additions & 5 deletions src/rules.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ export default {
before: ({ value, params }) => b(new Date(value) < new Date(params[0])),
before_or_equal: ({ value, params }) => b(new Date(value) <= new Date(params[0])),

between: ({ value, params }) => {
between: ({ value, rules, params }) => {
if (typeof value !== 'number' && !value) return false;
const [min, max] = params;
value = sizeOf(value);
value = sizeOf(value, rules);
return value > min && value < max;
},

Expand Down Expand Up @@ -123,6 +123,7 @@ export default {
if (!Array.isArray(array)) return false;
return array.findIndex(arrayVal => deepEquals(arrayVal, value)) !== -1;
},

integer: ({ value }) => {
return Number.isInteger(typeof value === 'string' ? parseInt(value) : value);
},
Expand All @@ -140,7 +141,7 @@ export default {
lt: ({ value, values, params }) => value < values[params[0]],
lte: ({ value, values, params }) => value <= values[params[0]],

max: ({ value, params }) => (b(value) || typeof value === 'number') && sizeOf(value) <= params[0],
max: ({ value, params, rules }) => (b(value) || typeof value === 'number') && sizeOf(value, rules) <= params[0],

mimetypes: ({ value, params }) => {
if (!value || !value.type) {
Expand All @@ -166,7 +167,7 @@ export default {
return false;
},

min: ({ value, params }) => (b(value) || typeof value === 'number') && sizeOf(value) >= params[0],
min: ({ value, params, rules }) => (b(value) || typeof value === 'number') && sizeOf(value, rules) >= params[0],

not_in: ({ value, params }) => params.findIndex(param => deepEquals(param, value)) === -1,

Expand Down Expand Up @@ -253,14 +254,22 @@ function isNotEmpty(value) {
return typeof value === 'number' || typeof value === 'boolean' || !! value;
}

function sizeOf(value) {
function sizeOf(value, rules) {
// If value is a string, but there is a numeric rule we parse the string as number.
if(rules !== undefined && typeof value === 'string' && hasNumericRule(rules)) {
return Number.parseFloat(value);
}
//TODO files, images other things
if (value.hasOwnProperty('length')) {
value = value.length;
}
return value;
}

function hasNumericRule(rules) {
return rules.includes("number") || rules.includes("integer");
}

function b(value) {
return !! value;
}
Expand Down
18 changes: 9 additions & 9 deletions tests/index.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ describe('Form Validator', () => {
}

const validateField = mockValidateField({
errors: ['required']
errors: [ { key: 'required' } ]
});

expect(validateForm({ formData, includeMessages: false } )).toEqual({
Expand All @@ -88,7 +88,7 @@ describe('Form Validator', () => {
}

const validateField = mockValidateField({
errors: ['testRule']
errors: [ { key: 'testRule' } ]
});

const messageMock = mockMessage('testRule', 'hello');
Expand Down Expand Up @@ -124,10 +124,10 @@ describe('Form Validator', () => {

const validateField = mockValidateField();
validateField.mockReturnValueOnce({
errors: ['required'],
errors: [ { key: 'required' } ],
});
validateField.mockReturnValueOnce({
errors: ['required'],
errors: [ { key: 'required' } ],
});

expect(validateForm({ formData, includeMessages: false } )).toEqual({
Expand All @@ -149,7 +149,7 @@ describe('Form Validator', () => {

const validateField = mockValidateField();
validateField.mockReturnValueOnce({
errors: ['required', 'string'],
errors: [ { key: 'required' }, { key: 'string' } ],
});

expect(validateForm({ formData, includeMessages: false } )).toEqual({
Expand Down Expand Up @@ -239,14 +239,14 @@ describe('Form Validator', () => {
it('can detect an invalid field', () => {
const result = validateField(createFieldData({ validation: ['required'] }))

expect(result.errors).toEqual(['required']);
expect(result.errors).toEqual([ { key: 'required', params: [] } ]);
expect(console.warn).not.toHaveBeenCalled();
});

it('can detect multiple rules on one field', () => {
const result = validateField(createFieldData({ validation: ['required', 'string'] }))

expect(result.errors).toEqual(['required', 'string']);
expect(result.errors).toEqual([ { key: 'required', params: [] }, { key: 'string', params: [] }]);
expect(console.warn).not.toHaveBeenCalled();
})

Expand Down Expand Up @@ -277,7 +277,7 @@ describe('Form Validator', () => {
throw new Error();
});

expect(validateField(fieldData)).toEqual({ errors: ['testRule'] });
expect(validateField(fieldData)).toEqual({ errors: [ { key: 'testRule', params: [] } ] });
expect(console.warn).toHaveBeenCalled();
expect(ruleMock).toHaveBeenCalled();

Expand All @@ -293,7 +293,7 @@ describe('Form Validator', () => {
throw new Error();
});

expect(validateField(fieldData)).toEqual({ errors: ['test'] });
expect(validateField(fieldData)).toEqual({ errors: [ { key: 'test', params: [] } ] });
expect(console.warn).toHaveBeenCalled();
expect(ruleMock).toHaveBeenCalled();

Expand Down
9 changes: 5 additions & 4 deletions tests/placeholders.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ const oldGetMessage = Messages.getMessage;

describe('Placeholders', () => {
const testRule = "foo";
const testRuleParams = [];
const testMessage = "hello :dog what's up with :cat";
const getMessage = jest.fn().mockReturnValue(testMessage);

Expand All @@ -21,7 +22,7 @@ describe('Placeholders', () => {
const cat = "Reginald";
const fieldData = { dog, cat };

const message = generateMessage(testRule, fieldData);
const message = generateMessage(testRule, testRuleParams, fieldData);

expect(message).toEqual("hello Suzy what's up with Reginald");
expect(getMessage).toHaveBeenCalledWith(testRule, fieldData);
Expand All @@ -31,7 +32,7 @@ describe('Placeholders', () => {
const dog = "Suzy";
const fieldData = { dog };

const message = generateMessage(testRule, fieldData);
const message = generateMessage(testRule, testRuleParams, fieldData);

expect(message).toEqual("hello Suzy what's up with ");
expect(getMessage).toHaveBeenCalledWith(testRule, fieldData);
Expand All @@ -41,7 +42,7 @@ describe('Placeholders', () => {
const dog = "Suzy";
const fieldData = { dog };

const message = generateMessage(testRule, fieldData);
const message = generateMessage(testRule, testRuleParams, fieldData);

expect(message).toEqual("hello Suzy what's up with ");
expect(getMessage).toHaveBeenCalledWith(testRule, fieldData);
Expand All @@ -58,7 +59,7 @@ describe('Placeholders', () => {
messageRules.forEach((rule) => {
it(`will replace placeholders in message for ${rule} rule`, () => {
const fieldData = { name: "some field", params };
const message = generateMessage(rule, fieldData);
const message = generateMessage(rule, testRuleParams, fieldData);

const placeholders = [];
let placeholderMatch = message.match(PLACEHOLDER_REGEX);
Expand Down
92 changes: 92 additions & 0 deletions tests/rules.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -1281,6 +1281,52 @@ describe('Rules', () => {
value: null,
result: false,
},
{
desc: 'string with numeric rule and small value',
value: "0",
params: [1],
ruleParams: { rules: ["integer", "max:1"] },
result: true,
},
{
desc: 'string with numeric rule and large value',
value: "80",
params: [10],
ruleParams: { rules: ["integer", "max:10"] },
result: false,
},
{
desc: 'string without numieric rule, but number value, long string',
value: "80000000000",
params: [10],
ruleParams: { rules: ["string", "max:10"] },
result: false,
},
{
desc: 'string without numieric rule, but number value, short string',
value: "80",
params: [10],
ruleParams: { rules: ["string", "max:10"] },
result: true,
},
{
desc: 'short string',
value: "abc",
params: [10],
result: true,
},
{
desc: 'equal string',
value: "abcdefghij",
params: [10],
result: true,
},
{
desc: 'too long string',
value: "abcdefghijk",
params: [10],
result: false,
}
]);

createRuleTests('mimetypes', [ // File.type should be correct mime type
Expand Down Expand Up @@ -1365,6 +1411,52 @@ describe('Rules', () => {
value: null,
result: false,
},
{
desc: 'string with numeric rule and small value',
value: "0",
params: [1],
ruleParams: { rules: ["integer", "min:1"] },
result: false,
},
{
desc: 'string with numeric rule and large value',
value: "80",
params: [10],
ruleParams: { rules: ["integer", "min:10"] },
result: true,
},
{
desc: 'string without numieric rule, but number value, long string',
value: "80000000000",
params: [10],
ruleParams: { rules: ["string", "min:10"] },
result: true,
},
{
desc: 'string without numieric rule, but number value, short string',
value: "80",
params: [10],
ruleParams: { rules: ["string", "min:10"] },
result: false,
},
{
desc: 'short string',
value: "abc",
params: [10],
result: false,
},
{
desc: 'equal string',
value: "abcdefghij",
params: [10],
result: true,
},
{
desc: 'too long string',
value: "abcdefghijk",
params: [10],
result: true,
}
]);

createRuleTests('not_in', [
Expand Down