feat(n4s): added endsWith and doesNotEndWith rule

packages/n4s/src/rules/endsWith/index.js

@@ -0,0 +1,7 @@
+function endsWith(value, arg1) {
+    return typeof value === 'string' && typeof arg1 === 'string' && value.endsWith(arg1);
+}
+
+endsWith.negativeForm = 'doesNotEndWith';
+
+export default endsWith;

packages/n4s/src/rules/endsWith/spec.js

@@ -0,0 +1,33 @@
+import endsWith from '.';
+
+describe('Tests isArray rule', () => {
+    const word = 'meow';
+    const totallyDifferentWord = 'lorem';
+    it('Should return true for the same word', () => {
+        expect(endsWith(word, word)).toBe(true);
+    });
+
+    it('Should return true for a suffix', () => {
+        expect(endsWith(word, word.substring(word.length / 2, word.length))).toBe(true);
+    });
+
+    it('Should return true for empty suffix', () => {
+        expect(endsWith(word, '')).toBe(true);
+    });
+
+    it('Should return false for a wrong suffix', () => {
+        expect(endsWith(word, word.substring(0, word.length - 1))).toBe(false);
+    });
+
+    it('Should return false for a suffix which is a totally different word', () => {
+        expect(endsWith(word, totallyDifferentWord)).toBe(false);
+    });
+
+    it('Should return false for a suffix longer than the word', () => {
+        expect(endsWith(word, word + 'aaa')).toBe(false);
+    });
+
+    it('Should expose negativeForm property', () => {
+        expect(endsWith.negativeForm).toBe('doesNotEndWith');
+    });
+});

packages/n4s/src/rules/index.js

@@ -1,4 +1,5 @@
 import { extendRules } from '../lib';
+import endsWith from './endsWith';
 import equals from './equals';
 import greaterThan from './greaterThan';
 import greaterThanOrEquals from './greaterThanOrEquals';
@@ -25,6 +26,7 @@ import shorterThan from './shorterThan';
 import shorterThanOrEquals from './shorterThanOrEquals';
 
 const rules = {
+  endsWith,
   equals,
   greaterThan,
   greaterThanOrEquals,
@@ -48,7 +50,7 @@ const rules = {
   matches,
   numberEquals,
   shorterThan,
-  shorterThanOrEquals,
+  shorterThanOrEquals
 };
 
 export default extendRules(rules);

packages/n4s/src/rules/spec.js

@@ -26,6 +26,7 @@ const negativeRules = [
   'notMatches',
   'numberNotEquals',
   'isNotNull',
+  'doesNotEndWith',
 ];
 
 const positiveRules = [
@@ -58,6 +59,7 @@ const positiveRules = [
   'shorterThan',
   'shorterThanOrEquals',
   'isNull',
+  'endsWith'
 ];
 
 const allRules = [...new Set([...positiveRules, ...negativeRules])];

packages/vest/docs/enforce.md

@@ -64,6 +64,8 @@ Enforce rules are functions that allow you to test your data against different c
 - [isNotString](#isnotstring)
 - [isOdd](#isodd)
 - [isEven](#iseven)
+- [endsWith](#endswith)
+- [doesNotEndWith](#doesnotendwith)
 
 ### equals
 
@@ -995,6 +997,38 @@ enforce([0]).isEven();
 // throws
 ```
 
+## endsWith
+
+### Description
+
+Determines whether a string ends with the characters of a specified string.
+
+### Usage examples:
+
+```js
+enforce('aba').endsWith('ba');
+enforce('some_string').endsWith('_string');
+enforce('string with spaces').endsWith('ng with spaces');
+enforce('aaaa     ').endsWith(' ');
+// passes
+```
+
+```js
+enforce('for').endsWith('tor');
+enforce('aaaab').endsWith('aaaa');
+enforce('aa').endsWith('aaa');
+enforce(42).endsWith('b');
+enforce(42).endsWith(50);
+enforce(true).endsWith(100);
+// throws
+```
+
+## doesNotEndWith
+
+### Description
+
+Determines whether a string does not end with the characters of a specified string.
+Reverse implementation of `endsWith`.
 
 # Custom enforce rules
 

packages/vest/src/typings/vest.d.ts

@@ -135,6 +135,8 @@ export interface IEnforceRules<T = {}> {
   gte: (expected: number | string) => IEnforceRules<T> & EnforceExtendMap<T>;
   lt: (expected: number | string) => IEnforceRules<T> & EnforceExtendMap<T>;
   lte: (expected: number | string) => IEnforceRules<T> & EnforceExtendMap<T>;
+  endsWith: (suffix: string) => IEnforceRules<T> & EnforceExtendMap<T>;
+  doesNotEndWith: (suffix: string) => IEnforceRules<T> & EnforceExtendMap<T>;
   numberNotEquals: (
     expected: number | string
   ) => IEnforceRules<T> & EnforceExtendMap<T>;