Merge pull request #5 from rachelnicole/lintandtests

Update plugin for linting and coveralls and new validation

Author: Snugug

.eslintrc-ava.yml

@@ -0,0 +1,2 @@
+extends:
+  - punchcard/configurations/ava

.eslintrc.yml

@@ -1,13 +1,2 @@
 extends:
-  - punchcard
-
-env:
-  es6: true
-
-rules:
-  no-empty-label: 0 # hides deprecated rule
-  space-after-keywords: 0 # hides deprecated rule
-  space-before-keywords: 0 # hides deprecated rule
-  space-return-throw-case: 0 # hides deprecated rule
-  keyword-spacing: 2 # replaces `space-after-keywords`, `space-before-keywords`, and `space-return-throw-case`
-  strict: 1 # fixes a circular bug
+  - punchcard

.travis.yml

@@ -4,6 +4,7 @@ node_js:
 cache:
   directories:
   - node_modules
+after_success: npm run coverage
 notifications:
   slack:
     secure: Wwh0JLcQnGtHoAaUSc/6oQrTBhdz4zS26tflVUa2aFraVFt7sUcHMjWBWYDO2KpVRXjeky2JslwGCpwuoNUIBwl6Ah89MoeR3pQBXEfMPTHfkMPfl/XtPvl/q7JjzOcsOya0zdRPVgGHWc/ikd5Yd3Gn8yTmwWjW0UyrKkIeTmBb0L2DK4ZaeV3qFuL3CVW+ziW6c6fscicej2jOKb0OgwPw4Qdtczn9ueTN+GY4Jr+4L9hSaL3UR6H+JBaFikfc0pMboFU86ZIB0J8ig4+jZWI07dHJUNo8vOxdRwPiItjf75RqkGMkub2tS5wH1Wn3VF3O1STw4JsBtvsieScHQ3jetWzWAbM+LLptNYoGGVN18GxzJx+i1afPqxoadOKTle3ldI+ePJJrX7pSMjSYzPmnKRjl9fecnmMcLS8UOG+tIIxkhq8jkQ4DY0Jm9V/ID5+4+0YgTei4rQ8gkCpfYMi1AcFOO0flBFxFsQGuTFWVHOFpijde82QXPdvJAmAlciFwAfH8gMOvh3ptzesdtzxKrD/Ftw7/mQLHhajC2x9GUAq/zmelNMner8JMapQ5wreA4E3oEumBfk4AaAe2WsKVMtA1V6A9btAXClklyNMy+wf4Zz0dZaKo8a6dG3jDFQ02r2aGrpLsDesbqalmpvI8D701OwCd5ROAWRTG5e8=

index.js

@@ -1,3 +1,5 @@
+'use strict';
+
 /**
  * email Input Plugin
  *
@@ -26,8 +28,7 @@ module.exports = {
       label: 'email',
       placeholder: 'add your email',
       settings: {
-        'domains': ['foo.com', 'bar.com', 'baz.com'],
-        'regex': /^\s*[\w\-\+_]+(\.[\w\-\+_]+)*\@[\w\-\+_]+\.[\w\-\+_]+(\.[\w\-\+_]+)*\s*$/,
+        empty: true,
       },
     },
   },

lib/validation.js

@@ -1,37 +1,26 @@
+'use strict';
+
 /**
  * Validation for email Input Plugin
  *
- * @param {Object} input - inputs in this plugin's instance and their values as {String}
- * @param {Object} input.target - the triggering input's name and value as {String}
- * @param {String} input.target.name - the triggering input's name
- * @param {String|Bool} input.target.value - the triggering input's value
- * @param {Object} input.all - all inputs in this plugin's instance
- * @param {String|Bool} input.all.email - value of input email
- * @param {Object} [settings] - settings for this input plugin instance
- * @param {Object} [settings.target] - the triggering input's settings as an {Object}
- * @param {Object} [settings.all] - all settings in this plugin instance as an {Object}
- * @param {Object} [settings.all.email] - settings of input email {Object}
+ * @param {object} input - inputs in this plugin's instance and their values as {string}
+ * @param {object} input.target - the triggering input's name and value as {string}
+ * @param {string} input.target.name - the triggering input's name
+ * @param {string|bool} input.target.value - the triggering input's value
+ * @param {object} input.all - all inputs in this plugin's instance
+ * @param {string|bool} input.all.email - value of input email
  *
- * @returns {Bool|String} true or a string with the text describing the error
+ * @returns {bool|string} true or a string with the text describing the error
  *
  * @module emailValidation
  */
-module.exports = function emailValidation(input, settings) {
-  'use strict';
-  let domains;
 
-  domains = settings.target.domains || ['foo.com', 'bar.com', 'baz.com'];
-  if (!Array.isArray(domains)) {
-    domains = [String(domains)];
-  }
+const isEmail = require('validator/lib/isEmail');
 
-  if (!settings.target.regex.test(input.target.value)) {
+module.exports = function emailValidation(input) {
+  if (!isEmail(input.target.value)) {
     return 'Not a valid e-mail address.';
   }
 
-  if (!domains.some(domain => (input.target.value.indexOf(domain, input.target.value.length - domain.length) !== -1))) {
-    return `Email must be within the following domains: ${domains.toString()}`;
-  }
-
   return true;
 };

package.json

@@ -9,23 +9,29 @@
     "ava": "ava | tap-diff",
     "ava:watch": "ava --watch | tap-diff",
     "nyc": "nyc --all npm run ava",
-    "lint": "eslint ./"
-  },  "repository": {
+    "lint": "eslint index.js lib && eslint -c ./.eslintrc-ava.yml tests",
+    "coverage": "nyc report --reporter=text-lcov | coveralls"
+  },
+  "repository": {
     "type": "git",
     "url": "git@github.com:punchcard-cms/input-plugin-email.git"
   },
   "contributors": [
     "Scott Nath <snath@us.ibm.com>"
   ],
   "license": "Apache-2.0",
-  "dependencies": {},
+  "dependencies": {
+    "validator": "^5.2.0"
+  },
   "devDependencies": {
-    "ava": "^0.12.0",
-    "eslint": "2.2.0",
-    "eslint-config-punchcard": "^0.1.2",
+    "ava": "^0.14.0",
+    "coveralls": "^2.11.9",
+    "eslint": "^2.10.0",
+    "eslint-config-punchcard": "^1.0.1",
     "nyc": "^6.0.0",
     "punchcard-content-types": "^0.1.0",
-    "tap-diff": "^0.1.1"
+    "tap-diff": "^0.1.1",
+    "validator": "^5.2.0"
   },
   "engines": {
     "node": "5.7",

tests/validation.js

@@ -9,43 +9,14 @@ const input = {
   },
 };
 
-const settings = {
-  target: {
-    domains: ['foo.com', 'bar.com', 'baz.com'],
-    regex: /^\s*[\w\-\+_]+(\.[\w\-\+_]+)*\@[\w\-\+_]+\.[\w\-\+_]+(\.[\w\-\+_]+)*\s*$/,
-  },
-};
-
-
 // Valid input
 test('valid input', t => {
-  t.true(validation(input, settings), 'Valid input returns true');
+  t.true(validation(input), 'Valid input returns true');
 });
 
 test('validate text is email', t => {
   const ip = input;
   ip.target.value = 'scott@scott';
-  t.is(validation(ip, settings), 'Not a valid e-mail address.', 'Must be an actual email address');
+  t.is(validation(ip), 'Not a valid e-mail address.', 'Must be an actual email address');
 });
 
-test('Validate email is not among default domains', t => {
-  const ip = input;
-  ip.target.value = 'scott@scott.com';
-  t.is(validation(ip, settings), 'Email must be within the following domains: foo.com,bar.com,baz.com', 'Validate if entered email matches any default domains.');
-});
-
-test('Validate email is within a single implementation-defined domain', t => {
-  const ip = input;
-  ip.target.value = 'scott@test.com';
-  const set = settings;
-  set.target.domains = 'test.com';
-  t.is(validation(ip, set), true, 'Validate if entered email is within a single, implementation-defined domain.');
-});
-
-test('Validate email is within an array of implementation-defined domains', t => {
-  const ip = input;
-  ip.target.value = 'scott@test.com';
-  const set = settings;
-  set.target.domains = ['test2.com', 'test.com'];
-  t.is(validation(ip, set), true, 'Validate if entered email is within an array of implementation-defined domains');
-});