Merge pull request #4 from ARCANESCRIPTS/develop

Adding the ability to add messages to the collection

Author: arcanedev-maroc

README.md

@@ -59,6 +59,18 @@ getFormat(): string;
 setFormat(format:string): void;
 ```
 
+```js
+/**
+ * Add a message to the collection.
+ *
+ * @param  {string}  key
+ * @param  {string}  message
+ *
+ * @return void
+ */
+add(key: string, message: string): void;
+```
+
 ```js
 /**
  * Merge a new array of messages into the collection.

src/FormErrors.ts

@@ -59,6 +59,23 @@ class FormErrors implements FormErrorsInterface {
 
     // Main Method //
 
+    /**
+     * Add a message to the collection.
+     *
+     * @param  {string}  key
+     * @param  {string}  message
+     *
+     * @return void
+     */
+    add(key: string, message: string): void {
+        if (this.isUnique(key, message)) {
+            if (this.messages[key])
+                this.messages[key].push(message);
+            else
+                this.messages[key] = [message];
+        }
+    }
+
     /**
      * Merge a new array of messages into the collection.
      *
@@ -233,7 +250,7 @@ class FormErrors implements FormErrorsInterface {
      *
      * @return {string[]}
      */
-    private transform(messages, format: string, key) {
+    private transform(messages: string[], format: string, key: string) {
         format = this.checkFormat(format);
 
         return _.transform(messages, function(result, message) {
@@ -266,6 +283,22 @@ class FormErrors implements FormErrorsInterface {
 
         return transformed;
     }
+
+    /**
+     * Determine if a key and message combination already exists.
+     *
+     * @param  {string}  key
+     * @param  {string}  message
+     *
+     * @return boolean
+     */
+    private isUnique(key: string, message: string): boolean {
+        if (this.messages[key]) {
+            return ! this.messages[key].includes(message);
+        }
+
+        return true;
+    }
 }
 
 export default FormErrors;

src/FormErrorsInterface.ts

@@ -32,6 +32,16 @@ interface FormErrorsInterface {
 
     // Main Methods //
 
+    /**
+     * Add a message to the collection.
+     *
+     * @param  {string}  key
+     * @param  {string}  message
+     *
+     * @return void
+     */
+    add(key: string, message: string): void;
+
     /**
      * Merge a new array of messages into the collection.
      *

test/FormErrors.test.js

@@ -482,3 +482,60 @@ describe('#reset()', () => {
         expect(errors.isEmpty()).toBe(true);
     });
 });
+
+describe('#add()', () => {
+    it('Can add message to the collection', () => {
+        let errors = new FormErrors;
+
+        expect(errors.count()).toEqual(0);
+
+        errors.add('name', 'The name is required.');
+
+        expect(errors.count()).toEqual(1);
+
+        errors.add('name', 'The name must be an alpha-numeric.');
+
+        expect(errors.count()).toEqual(1);
+
+        errors.add('email', 'The email is required.');
+
+        expect(errors.count()).toEqual(2);
+
+        expect(errors.getMessages()).toEqual({
+            'email': [
+                'The email is required.'
+            ],
+            'name': [
+                'The name is required.',
+                'The name must be an alpha-numeric.'
+            ]
+        });
+    });
+
+    it('Can only add unique messages to the collection', () => {
+        let errors = new FormErrors;
+
+        expect(errors.count()).toEqual(0);
+
+        errors.add('name', 'The name is required.');
+
+        expect(errors.count()).toEqual(1);
+
+        errors.add('name', 'The name must be an alpha-numeric.');
+
+        expect(errors.count()).toEqual(1);
+
+        errors.add('name', 'The name is required.');
+
+        expect(errors.count()).toEqual(1);
+
+        errors.add('name', 'The name must be an alpha-numeric.');
+
+        expect(errors.getMessages()).toEqual({
+            'name': [
+                'The name is required.',
+                'The name must be an alpha-numeric.'
+            ]
+        });
+    });
+});