Merge pull request #12 from fashion-js/11-individual-property-clean

Fixes #11 - Allow individual properties to implement a clean function.

Model.js

@@ -370,11 +370,15 @@ Model_proto.clean = function (options) {
           }
         } else {
           const propertyType = property.type;
+          const propertyClean = property.clean;
           const clean = propertyType.clean;
           const oldProperty = options.property;
           options.property = property;
 
-          if (clean) {
+          if (propertyClean) {
+            // call the clean method on the property
+            value = propertyClean(value, options);
+          } else if (clean) {
             // call the clean function provided by model
             value = propertyType.clean(value, options);
           } else if (value.Model || propertyType.isWrapped()) {

README.md

@@ -512,6 +512,32 @@ assert(typeof cleanedImage.data.constructor === 'string');
 console.log(cleanedImage.data);
 ```
 
+Implementing a `clean` function on individual properties is also supported:
+
+```js
+const Person = Model.extend({
+  properties: {
+    name: String,
+    ssn: {
+      type: String,
+      clean: function (value, options) {
+        // Only return the value of the ssn property if the `showSensitive`
+        // option is passed to `clean`.
+        return (options.showSensitive) ? value : undefined;
+      }
+    }
+  }
+});
+
+const person = new Person({ name: 'John', ssn: 'abc123' });
+
+assert.deepEqual(person.clean(), { name: 'John' });
+assert.deepEqual(person.clean({ showSensitive: true }), {
+  name: 'John',
+  ssn: 'abc123'
+});
+```
+
 ### Stringify
 
 Model instances have a `stringify` function that can be used to

package.json

@@ -34,5 +34,5 @@
     "dependencies": {
         "events": "^1.1.1"
     },
-    "version": "6.0.2"
-}
+    "version": "6.1.0"
+}

test/clean.test.js

@@ -756,3 +756,55 @@ test('should allow enum values to override clean in static method', function (t)
   t.is(Model.clean(Gender.MALE), 'M');
   t.is(Model.clean(Gender.FEMALE), 'F');
 });
+
+test('should allow clean function on individual properties', function (t) {
+  const Person = Model.extend({
+    properties: {
+      name: String,
+      ssn: {
+        type: String,
+        clean: function (val, options) {
+          t.is(val, 'abc123');
+          if (options.showSensitive) return val;
+        }
+      }
+    }
+  });
+
+  const person = Person.wrap({
+    name: 'John',
+    ssn: 'abc123'
+  });
+
+  t.deepEqual(person.clean(), { name: 'John' });
+  t.deepEqual(person.clean({ showSensitive: true }), {
+    name: 'John',
+    ssn: 'abc123'
+  });
+});
+
+test('should allow clean function on individual properties when using Model.clean', function (t) {
+  const Person = Model.extend({
+    properties: {
+      name: String,
+      ssn: {
+        type: String,
+        clean: function (val, options) {
+          t.is(val, 'abc123');
+          if (options.showSensitive) return val;
+        }
+      }
+    }
+  });
+
+  const person = Person.wrap({
+    name: 'John',
+    ssn: 'abc123'
+  });
+
+  t.deepEqual(Model.clean(person), { name: 'John' });
+  t.deepEqual(Model.clean(person, { showSensitive: true }), {
+    name: 'John',
+    ssn: 'abc123'
+  });
+});