Merge pull request #213 from kamilogorek/clear-with-values

Allow clear() on props with values array. FIX #212

ampersand-state.js

@@ -191,6 +191,7 @@ assign(Base.prototype, Events, {
             // If we are required but undefined, throw error.
             // If we are null and are not allowing null, throw error
             // If we have a defined type and the new type doesn't match, and we are not null, throw error.
+            // If we require specific value and new one is not one of them, throw error (unless it has default value or we're unsetting it with undefined).
 
             if (newVal === undefined && def.required) {
                 throw new TypeError('Required property \'' + attr + '\' must be of type ' + def.type + '. Tried to set ' + newVal);
@@ -202,7 +203,12 @@ assign(Base.prototype, Events, {
                 throw new TypeError('Property \'' + attr + '\' must be of type ' + def.type + '. Tried to set ' + newVal);
             }
             if (def.values && !includes(def.values, newVal)) {
-                throw new TypeError('Property \'' + attr + '\' must be one of values: ' + def.values.join(', ') + '. Tried to set ' + newVal);
+                var defaultValue = result(def, 'default');
+                if (unset && defaultValue !== undefined) {
+                    newVal = defaultValue;
+                } else if (!unset || (unset && newVal !== undefined)) {
+                    throw new TypeError('Property \'' + attr + '\' must be one of values: ' + def.values.join(', ') + '. Tried to set ' + newVal);
+                }
             }
 
             hasChanged = !isEqual(currentVal, newVal, attr);

test/basics.js

@@ -1137,3 +1137,58 @@ test('#74 - ensure default array/object types are mutable', function (t) {
     t.equal(s.anObject.foo, 'bar');
     t.end();
 });
+
+test('unset on prop with values array - issue #144', function (t) {
+    var Model = State.extend({
+        props: {
+            stuff: {
+                type: 'string',
+                required: false,
+                values: ['a', 'b', 'c']
+            }
+        }
+    });
+    var model = new Model({ stuff: 'a' });
+    t.doesNotThrow(function () {
+        model.unset('stuff');
+    });
+    t.equal(model.stuff, undefined);
+    t.end();
+});
+
+test('unset on prop with values array and default - issue #144', function (t) {
+    var Model = State.extend({
+        props: {
+            stuff: {
+                type: 'string',
+                required: false,
+                values: ['a', 'b', 'c'],
+                default: 'c'
+            }
+        }
+    });
+    var model = new Model({ stuff: 'a' });
+    t.doesNotThrow(function () {
+        model.unset('stuff');
+    });
+    t.equal(model.stuff, 'c');
+    t.end();
+});
+
+test('clear including prop with values array - issue #144', function (t) {
+    var Model = State.extend({
+        props: {
+            stuff: {
+                type: 'string',
+                required: false,
+                values: ['a', 'b', 'c']
+            }
+        }
+    });
+    var model = new Model({ stuff: 'a' });
+    t.doesNotThrow(function () {
+        model.clear();
+    });
+    t.equal(model.stuff, undefined);
+    t.end();
+});