update propValidation, add tests

Author: jscottsmith

__tests__/propValidation.test.js

@@ -0,0 +1,57 @@
+import { offsetMin, offsetMax } from 'utils/propValidation';
+
+describe('offsetMin prop validation', () => {
+
+    it('returns null when provided a valid value', () => {
+        expect(offsetMin({ offsetXMin: -100 }, 'offsetXMin', 'foo')).toBe(null);
+        expect(offsetMin({ offsetXMin: '-10321px' }, 'offsetXMin', 'foo')).toBe(null);
+        expect(offsetMin({ offsetXMin: '-10%' }, 'offsetXMin', 'foo')).toBe(null);
+    });
+
+    it('throws when provided a invalid value type', () => {
+        const error = new Error('[offsetXMin] in foo must be a string with with "%"" or "px" units or number.');
+        expect(offsetMin({ offsetXMin: false }, 'offsetXMin', 'foo')).toEqual(error);
+        expect(offsetMin({ offsetXMin: {} }, 'offsetXMin', 'foo')).toEqual(error);
+        expect(offsetMin({ offsetXMin: null }, 'offsetXMin', 'foo')).toEqual(error);
+        expect(offsetMin({ offsetXMin: undefined }, 'offsetXMin', 'foo')).toEqual(error);
+        expect(offsetMin({ offsetXMin: [] }, 'offsetXMin', 'foo')).toEqual(error);
+    });
+
+    it('throws when provided a invalid value', () => {
+        const error = new Error('[offsetXMin] in foo is greater than zero. [offsetXMin] must be less than or equal to zero.')
+        expect(offsetMin({ offsetXMin: 100 }, 'offsetXMin', 'foo')).toEqual(error);
+        expect(offsetMin({ offsetXMin: 1 }, 'offsetXMin', 'foo')).toEqual(error);
+        expect(offsetMin({ offsetXMin: 0.0009 }, 'offsetXMin', 'foo')).toEqual(error);
+        expect(offsetMin({ offsetXMin: '100px' }, 'offsetXMin', 'foo')).toEqual(error);
+        expect(offsetMin({ offsetXMin: '99%' }, 'offsetXMin', 'foo')).toEqual(error);
+    });
+    
+});
+
+describe('offsetMax prop validation', () => {
+    
+    it('returns null when provided a valid value', () => {
+        expect(offsetMax({ offsetXMax: 100 }, 'offsetXMax', 'foo')).toBe(null);
+        expect(offsetMax({ offsetXMax: '10321px' }, 'offsetXMax', 'foo')).toBe(null);
+        expect(offsetMax({ offsetXMax: '10%' }, 'offsetXMax', 'foo')).toBe(null);
+    });
+
+    it('throws when provided a invalid value type', () => {
+        const error = new Error('[offsetXMax] in foo must be a string with with "%"" or "px" units or number.');
+        expect(offsetMax({ offsetXMax: false }, 'offsetXMax', 'foo')).toEqual(error);
+        expect(offsetMax({ offsetXMax: {} }, 'offsetXMax', 'foo')).toEqual(error);
+        expect(offsetMax({ offsetXMax: null }, 'offsetXMax', 'foo')).toEqual(error);
+        expect(offsetMax({ offsetXMax: undefined }, 'offsetXMax', 'foo')).toEqual(error);
+        expect(offsetMax({ offsetXMax: [] }, 'offsetXMax', 'foo')).toEqual(error);
+    });
+
+    it('throws when provided a invalid value', () => {
+        const error = new Error('[offsetXMax] in foo is less than zero. [offsetXMax] must be greater than or equal to zero.')
+        expect(offsetMax({ offsetXMax: -100 }, 'offsetXMax', 'foo')).toEqual(error);
+        expect(offsetMax({ offsetXMax: -1 }, 'offsetXMax', 'foo')).toEqual(error);
+        expect(offsetMax({ offsetXMax: -0.0009 }, 'offsetXMax', 'foo')).toEqual(error);
+        expect(offsetMax({ offsetXMax: '-100px' }, 'offsetXMax', 'foo')).toEqual(error);
+        expect(offsetMax({ offsetXMax: '-99%' }, 'offsetXMax', 'foo')).toEqual(error);
+    });
+    
+});

src/utils/propValidation.js

@@ -1,14 +1,14 @@
-export function offsetMin(props, propName, componentName) {
-    componentName = componentName || 'ANONYMOUS';
+export function offsetMin(props, propName, componentName = 'ANONYMOUS') {
+    let value = props[propName];
+    const isValid = typeof value === 'string' || typeof value === 'number';
 
-    if (!typeof value === 'string' || !typeof value === 'number') {
+    if (!isValid) {
         return new Error(
-            `[${propName}] in ${componentName} must be a string with with "%"" or "px" units or number`
+            `[${propName}] in ${componentName} must be a string with with "%"" or "px" units or number.`
         );
     }
 
     if (props[propName]) {
-        let value = props[propName];
         if (typeof value === 'string') {
             value = parseInt(value, 10);
         }
@@ -21,17 +21,17 @@ export function offsetMin(props, propName, componentName) {
     return null;
 }
 
-export function offsetMax(props, propName, componentName) {
-    componentName = componentName || 'ANONYMOUS';
+export function offsetMax(props, propName, componentName = 'ANONYMOUS') {
+    let value = props[propName];
+    const isValid = typeof value === 'string' || typeof value === 'number';
 
-    if (!typeof value === 'string' || !typeof value === 'number') {
+    if (!isValid) {
         return new Error(
-            `[${propName}] in ${componentName} must be a string with with "%"" or "px" units or number`
+            `[${propName}] in ${componentName} must be a string with with "%"" or "px" units or number.`
         );
     }
 
     if (props[propName]) {
-        let value = props[propName];
         if (typeof value === 'string') {
             value = parseInt(value, 10);
         }