first implementation on validateSometimes

Author: David Tang

README.md

@@ -1,6 +1,63 @@
 # ember-changeset-conditional-validations
 
-This README outlines the details of collaborating on this Ember addon.
+An extra validator for conditional validations with [`ember-changeset-validations`](https://github.com/DockYard/ember-changeset-validations).
+
+## Installation
+
+```
+ember install ember-changeset-conditional-validations
+```
+
+## Usage
+
+Let's say you want to validate a user's settings. Only if the payment method is a credit card should the credit card number validations be applied.
+
+```js
+import Ember from 'ember';
+import { validatePresence, validateNumber } from 'ember-changeset-validations/validators';
+import validateSometimes from 'ember-changeset-conditional-validations/validators/sometimes';
+
+const { get } = Ember;
+
+const Validations = {
+  creditCardNumber: validateSometimes([
+    validatePresence(true),
+    validateNumber({ is: 16 })
+  ], function(changes) {
+    return get(changes, 'paymentMethod.isCreditCard')
+  })
+};
+```
+
+`validateSometimes` takes 2 arguments. The first is a list of validators and the second is a callback function which represents the condition. If the condition callback returns `true`, the rules will be added.
+
+```js
+import Changeset from 'ember-changeset';
+import lookupValidator from 'ember-changeset-validations';
+
+let settings = {};
+let changeset = new Changeset(settings, lookupValidator(Validations), Validations);
+
+console.log(changeset.get('isValid')); // true
+changeset.set('paymentMethod', {
+  isCreditCard: true
+});
+changeset.validate();
+console.log(changeset.get('isValid')); // false
+console.log(changeset.get('errors')); // [{key: 'creditCardNumber', validation: ['Credit card number can't be blank', 'Credit card number must be a number']}]
+changeset.set('creditCardNumber', '1234567890123456');
+changeset.validate();
+console.log(changeset.get('isValid')); // true
+changeset.set('creditCardNumber', '1234');
+changeset.validate();
+console.log(changeset.get('isValid')); // false
+console.log(changeset.get('errors')); // [{key: 'creditCardNumber', value: '1234', validation: ['Credit card number must be equal to 16']}]
+changeset.set('paymentMethod', {
+  isCreditCard: false
+});
+changeset.validate();
+console.log(changeset.get('isValid')); // true
+```
 
 ## Installation
 

addon/validators/sometimes.js

@@ -0,0 +1,10 @@
+export default function validateSometimes(validators, condition) {
+  return validators.map(function(validator) {
+    return function(key, newValue, oldValue, changes, content) {
+      if (condition(changes)) {
+        return validator(key, newValue, oldValue, changes, content);
+      }
+      return true;
+    };
+  });
+}

package.json

@@ -1,9 +1,14 @@
 {
   "name": "ember-changeset-conditional-validations",
   "version": "0.0.0",
-  "description": "The default blueprint for ember-cli addons.",
+  "description": "Conditional validations for ember-changeset-validations",
   "keywords": [
-    "ember-addon"
+    "ember-addon",
+    "ember-changeset",
+    "ember-changeset-validations",
+    "changeset",
+    "validations",
+    "conditional validations"
   ],
   "license": "MIT",
   "author": "",
@@ -23,6 +28,8 @@
   "devDependencies": {
     "broccoli-asset-rev": "^2.4.5",
     "ember-ajax": "^3.0.0",
+    "ember-changeset": "^1.3.0",
+    "ember-changeset-validations": "^1.2.8",
     "ember-cli": "~2.14.1",
     "ember-cli-dependency-checker": "^1.3.0",
     "ember-cli-eslint": "^3.0.0",
@@ -37,6 +44,7 @@
     "ember-export-application-global": "^2.0.0",
     "ember-load-initializers": "^1.0.0",
     "ember-resolver": "^4.0.0",
+    "ember-sinon": "^0.7.0",
     "ember-source": "~2.14.1",
     "loader.js": "^4.2.3"
   },

tests/dummy/app/routes/application.js

@@ -0,0 +1,44 @@
+/* eslint no-console: "off" */
+import Ember from 'ember';
+import Changeset from 'ember-changeset';
+import lookupValidator from 'ember-changeset-validations';
+import { validatePresence, validateNumber } from 'ember-changeset-validations/validators';
+import validateSometimes from 'ember-changeset-conditional-validations/validators/sometimes';
+
+const { get } = Ember;
+
+const Validations = {
+  creditCardNumber: validateSometimes([
+    validatePresence(true),
+    validateNumber({ is: 16 })
+  ], function(changes) {
+    return get(changes, 'paymentMethod.isCreditCard')
+  })
+};
+
+export default Ember.Route.extend({
+  model() {
+    let settings = {};
+    let changeset = new Changeset(settings, lookupValidator(Validations), Validations);
+
+    console.log(changeset.get('isValid')); // true
+    changeset.set('paymentMethod', {
+      isCreditCard: true
+    });
+    changeset.validate();
+    console.log(changeset.get('isValid')); // false
+    console.log(changeset.get('errors')); // [{key: 'creditCardNumber', validation: ['Credit card number can't be blank', 'Credit card number must be a number']}]
+    changeset.set('creditCardNumber', '1234567890123456');
+    changeset.validate();
+    console.log(changeset.get('isValid')); // true
+    changeset.set('creditCardNumber', '1234');
+    changeset.validate();
+    console.log(changeset.get('isValid')); // false
+    console.log(changeset.get('errors')); // [{key: 'creditCardNumber', value: '1234', validation: ['Credit card number must be equal to 16']}]
+    changeset.set('paymentMethod', {
+      isCreditCard: false
+    });
+    changeset.validate();
+    console.log(changeset.get('isValid')); // true
+  }
+});

tests/helpers/is-function.js

@@ -0,0 +1,7 @@
+import Ember from 'ember';
+
+const { typeOf } = Ember;
+
+export default function isFunction(fn) {
+  return typeOf(fn) === 'function';
+}

tests/unit/validators/sometimes-test.js

@@ -0,0 +1,84 @@
+import { module, test } from 'qunit';
+import validateSometimes from 'ember-changeset-conditional-validations/validators/sometimes';
+import sinon from 'sinon';
+import isFunction from './../../helpers/is-function';
+
+module('Unit | Validator | sometimes');
+
+test('an array of validators is returned', function(assert) {
+  let validatorA = sinon.stub();
+  let validatorB = sinon.stub();
+  let condition = sinon.stub();
+  let validators = validateSometimes([validatorA, validatorB], condition);
+  assert.equal(validators.length, 2);
+  assert.ok(validators.every(isFunction));
+});
+
+test('if the condition returns false, the validators return true', function(assert) {
+  let validatorA = sinon.stub();
+  let validatorB = sinon.stub();
+  let condition = sinon.stub().returns(false);
+  let validators = validateSometimes([validatorA, validatorB], condition);
+  let validations = validators.map((validator) => {
+    return validator();
+  });
+  assert.deepEqual(validations, [true, true]);
+});
+
+test('if the condition returns true, the validators are invoked and their result is returned', function(assert) {
+  let validatorA = sinon.stub().returns('Error message A');
+  let validatorB = sinon.stub().returns(true);
+  let condition = sinon.stub().returns(true);
+  let validators = validateSometimes([validatorA, validatorB], condition);
+  let validations = validators.map((validator) => {
+    return validator();
+  });
+  assert.deepEqual(validations, ['Error message A', true]);
+});
+
+test('the condition is invoked with the changes for each validator', function(assert) {
+  let key = 'name';
+  let newValue = 'Yehuda';
+  let oldValue = 'YK';
+  let changes = {};
+
+  let validatorA = sinon.stub().returns('Error message A');
+  let validatorB = sinon.stub().returns(true);
+  let condition = sinon.spy();
+
+  let validators = validateSometimes([validatorA, validatorB], condition);
+  validators.map((validator) => {
+    return validator(key, newValue, oldValue, changes);
+  });
+  assert.equal(condition.callCount, 2);
+  assert.strictEqual(condition.getCall(0).args[0], changes);
+  assert.strictEqual(condition.getCall(1).args[0], changes);
+});
+
+test('each validator is invoked with key, newValue, oldValue, changes, and content', function(assert) {
+  let key = 'name';
+  let newValue = 'Yehuda';
+  let oldValue = 'YK';
+  let changes = {};
+  let content = {};
+
+  let validatorA = sinon.spy();
+  let validatorB = sinon.spy();
+  let condition = sinon.stub().returns(true);  
+  let validators = validateSometimes([validatorA, validatorB], condition);
+
+  validators.map((validator) => {
+    return validator(key, newValue, oldValue, changes, content);
+  });
+
+  assert.strictEqual(validatorA.firstCall.args[0], key);
+  assert.strictEqual(validatorA.firstCall.args[1], newValue);
+  assert.strictEqual(validatorA.firstCall.args[2], oldValue);
+  assert.strictEqual(validatorA.firstCall.args[3], changes);
+  assert.strictEqual(validatorA.firstCall.args[4], content);
+  assert.strictEqual(validatorB.firstCall.args[0], key);
+  assert.strictEqual(validatorB.firstCall.args[1], newValue);
+  assert.strictEqual(validatorB.firstCall.args[2], oldValue);
+  assert.strictEqual(validatorB.firstCall.args[3], changes);
+  assert.strictEqual(validatorB.firstCall.args[4], content);
+});