Merge pull request #130 from dafortin/master

Added date type

addon/utils/prop-types.js

@@ -36,6 +36,7 @@ export function generateType (key) {
   'any',
   'array',
   'bool',
+  'date',
   'element',
   'EmberComponent',
   'EmberObject',

addon/utils/validators/date.js

@@ -0,0 +1,18 @@
+/**
+ * The PropTypes.date validator
+ */
+
+import Ember from 'ember'
+const {typeOf} = Ember
+
+import logger from '../logger'
+
+export default function (ctx, name, value, def, logErrors, throwErrors) {
+  const valid = typeOf(value) === 'date'
+
+  if (!valid && logErrors) {
+    logger.warn(ctx, `Expected property ${name} to be a date but instead got: ${typeOf(value)}`, throwErrors)
+  }
+
+  return valid
+}

addon/utils/validators/index.js

@@ -4,6 +4,7 @@ import any from './any'
 import array from './array'
 import arrayOf from './array-of'
 import bool from './bool'
+import date from './date'
 import element from './element'
 import emberComponent from './ember-component'
 import emberObject from './ember-object'
@@ -24,6 +25,7 @@ const validators = {
   any,
   array,
   bool,
+  date,
   element,
   EmberComponent: emberComponent,
   EmberObject: emberObject,

tests/dummy/app/fixtures/validators.js

@@ -71,6 +71,24 @@ export default Component.extend(PropTypeMixin, {
     `,
     name: 'bool'
   },
+  {
+    description: 'Property must be a date.',
+    example: `
+import Ember from 'ember'
+const {Component} = Ember
+import PropTypeMixin, {PropTypes} from 'ember-prop-types'
+
+export default Component.extend(PropTypeMixin, {
+  propTypes: {
+    bar: PropTypes.date,
+    baz: PropTypes.date.isRequired,
+    foo: PropTypes.date({required: true}),
+    spam: PropTypes.date({updatable: false})
+  }
+})
+    `,
+    name: 'date'
+  },
   {
     description: 'Property must be an instance of Element.',
     example: `

tests/unit/prop-types/hash-api/date-test.js

@@ -0,0 +1,195 @@
+/**
+ * Unit test for the PropTypes.date validator
+ */
+import Ember from 'ember'
+import SpreadMixin from 'ember-spread'
+import {afterEach, beforeEach, describe} from 'mocha'
+import sinon from 'sinon'
+
+import {
+  itSupportsUpdatableOption,
+  itValidatesOnUpdate,
+  itValidatesTheProperty,
+  spyOnValidateMethods
+} from 'dummy/tests/helpers/validator'
+
+import PropTypesMixin, {PropTypes} from 'ember-prop-types/mixins/prop-types'
+
+const requiredDef = {
+  required: true,
+  type: 'date'
+}
+
+const notRequiredDef = {
+  required: false,
+  type: 'date'
+}
+
+describe('Unit / validator / PropTypes.date', function () {
+  const ctx = {propertyName: 'bar'}
+  let sandbox, Foo
+
+  beforeEach(function () {
+    sandbox = sinon.sandbox.create()
+    spyOnValidateMethods(sandbox)
+  })
+
+  afterEach(function () {
+    sandbox.restore()
+  })
+
+  describe('when required option not present', function () {
+    beforeEach(function () {
+      ctx.def = notRequiredDef
+      Foo = Ember.Object.extend(SpreadMixin, PropTypesMixin, {
+        propTypes: {
+          bar: PropTypes.date()
+        }
+      })
+    })
+
+    describe('when initialized with date value', function () {
+      beforeEach(function () {
+        ctx.instance = Foo.create({bar: new Date()})
+      })
+
+      itValidatesTheProperty(ctx, false)
+      itValidatesOnUpdate(ctx, 'date', 'Expected property bar to be a date')
+    })
+
+    describe('when initialized without value', function () {
+      beforeEach(function () {
+        ctx.instance = Foo.create()
+      })
+
+      itValidatesTheProperty(ctx, false)
+      itValidatesOnUpdate(ctx, 'date', 'Expected property bar to be a date')
+    })
+
+    describe('when initialized with date value via spread property', function () {
+      beforeEach(function () {
+        ctx.instance = Foo.create({
+          options: {
+            bar: new Date()
+          }
+        })
+      })
+
+      itValidatesTheProperty(ctx, false)
+    })
+
+    describe('when initialized without value via spread property', function () {
+      beforeEach(function () {
+        ctx.instance = Foo.create({
+          options: {}
+        })
+      })
+
+      itValidatesTheProperty(ctx, false)
+    })
+  })
+
+  describe('when required', function () {
+    beforeEach(function () {
+      ctx.def = requiredDef
+      Foo = Ember.Object.extend(SpreadMixin, PropTypesMixin, {
+        propTypes: {
+          bar: PropTypes.date({required: true})
+        }
+      })
+    })
+
+    describe('when initialized with date value', function () {
+      beforeEach(function () {
+        ctx.instance = Foo.create({bar: new Date()})
+      })
+
+      itValidatesTheProperty(ctx, false)
+      itValidatesOnUpdate(ctx, 'date', 'Expected property bar to be a date')
+    })
+
+    describe('when initialized without value', function () {
+      beforeEach(function () {
+        ctx.instance = Foo.create()
+      })
+
+      itValidatesTheProperty(ctx, false, 'Missing required property bar')
+      itValidatesOnUpdate(ctx, 'date', 'Expected property bar to be a date')
+    })
+
+    describe('when initialized with date value via spread property', function () {
+      beforeEach(function () {
+        ctx.instance = Foo.create({
+          options: {
+            bar: new Date()
+          }
+        })
+      })
+
+      itValidatesTheProperty(ctx, false)
+    })
+
+    describe('when initialized without value via spread property', function () {
+      beforeEach(function () {
+        ctx.instance = Foo.create({
+          options: {}
+        })
+      })
+
+      itValidatesTheProperty(ctx, false, 'Missing required property bar')
+    })
+  })
+
+  describe('when not required', function () {
+    beforeEach(function () {
+      ctx.def = notRequiredDef
+      Foo = Ember.Object.extend(SpreadMixin, PropTypesMixin, {
+        propTypes: {
+          bar: PropTypes.date({required: false})
+        }
+      })
+    })
+
+    describe('when initialized with date value', function () {
+      beforeEach(function () {
+        ctx.instance = Foo.create({bar: new Date()})
+      })
+
+      itValidatesTheProperty(ctx, false)
+      itValidatesOnUpdate(ctx, 'date', 'Expected property bar to be a date')
+    })
+
+    describe('when initialized without value', function () {
+      beforeEach(function () {
+        ctx.instance = Foo.create()
+      })
+
+      itValidatesTheProperty(ctx, false)
+      itValidatesOnUpdate(ctx, 'date', 'Expected property bar to be a date')
+    })
+
+    describe('when initialized with date value via spread property', function () {
+      beforeEach(function () {
+        ctx.instance = Foo.create({
+          options: {
+            bar: new Date()
+          }
+        })
+      })
+
+      itValidatesTheProperty(ctx, false)
+    })
+
+    describe('when initialized without value via spread property', function () {
+      beforeEach(function () {
+        ctx.instance = Foo.create({
+          options: {}
+        })
+      })
+
+      itValidatesTheProperty(ctx, false)
+    })
+  })
+
+  itSupportsUpdatableOption('date', new Date(), new Date(86400000))
+})