Add date type validator, closes #5

Author: lindyhopchris

src/Validator/Type/DateValidator.php

@@ -0,0 +1,136 @@
+<?php
+
+/**
+ * Copyright 2015 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace CloudCreativity\JsonApi\Validator\Type;
+
+use CloudCreativity\JsonApi\Error\ErrorObject;
+
+/**
+ * Class DateValidator
+ * @package CloudCreativity\JsonApi
+ */
+class DateValidator extends TypeValidator
+{
+
+    const FORMATS = 'formats';
+
+    const FORMAT_ISO_8601 = \DateTime::ISO8601;
+    const FORMAT_ISO_8601_MILLISECONDS = 'Y-m-d\TH:i:s.uO';
+
+    /**
+     * @var array
+     */
+    protected $_formats = [];
+
+    /**
+     * @param array $formats
+     * @param bool|false $nullable
+     */
+    public function __construct(array $formats = [], $nullable = false)
+    {
+        parent::__construct($nullable);
+
+        if (empty($formats)) {
+            $formats = [
+                static::FORMAT_ISO_8601,
+                static::FORMAT_ISO_8601_MILLISECONDS,
+            ];
+        }
+
+        $this->setFormats($formats);
+
+        $this->updateTemplate(static::ERROR_INVALID_VALUE, [
+            ErrorObject::DETAIL => 'Expecting a valid date value.',
+        ]);
+    }
+
+    /**
+     * @param array $formats
+     * @return $this
+     */
+    public function setFormats(array $formats)
+    {
+        foreach ($formats as $format) {
+            $this->addFormat($format);
+        }
+
+        return $this;
+    }
+
+    /**
+     * @param $format
+     * @return $this
+     */
+    public function addFormat($format)
+    {
+        if (!is_string($format) || empty($format)) {
+            throw new \InvalidArgumentException('Expecting a non-empty string format.');
+        }
+
+        $this->_formats[] = $format;
+
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    public function getFormats()
+    {
+        return $this->_formats;
+    }
+
+    /**
+     * @param array $config
+     * @return $this
+     */
+    public function configure(array $config)
+    {
+        parent::configure($config);
+
+        if (isset($config[static::FORMATS]) && is_array($config[static::FORMATS])) {
+            $this->setFormats($config[static::FORMATS]);
+        } elseif (isset($config[static::FORMATS]) && is_string($config[static::FORMATS])) {
+            $this->addFormat($config[static::FORMATS]);
+        }
+
+        return $this;
+    }
+
+    /**
+     * @param $value
+     * @return bool
+     */
+    protected function isType($value)
+    {
+        if (!is_string($value) || empty($value)) {
+            return false;
+        }
+
+        foreach ($this->getFormats() as $format) {
+
+            $date = \DateTime::createFromFormat($format, $value);
+
+            if ($date instanceof \DateTime) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

test/Validator/Type/DateValidatorTest.php

@@ -0,0 +1,63 @@
+<?php
+
+/**
+ * Copyright 2015 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace CloudCreativity\JsonApi\Validator\Type;
+
+use CloudCreativity\JsonApi\Validator\ValidatorTestCase;
+
+/**
+ * Class DateValidatorTest
+ * @package CloudCreativity\JsonApi
+ */
+class DateValidatorTest extends ValidatorTestCase
+{
+
+    public function testValid()
+    {
+        $validator = new DateValidator();
+        $date = new \DateTime();
+
+        $this->assertTrue($validator->isValid($date->format(DateValidator::FORMAT_ISO_8601)));
+        $this->assertTrue($validator->isValid($date->format(DateValidator::FORMAT_ISO_8601_MILLISECONDS)));
+
+        return $validator;
+    }
+
+    /**
+     * @depends testValid
+     */
+    public function testInvalid(DateValidator $validator)
+    {
+        $date = new \DateTime();
+
+        $this->assertFalse($validator->isValid($date->format('Y-m-d')));
+        $error = $this->getError($validator);
+        $this->assertEquals(DateValidator::ERROR_INVALID_VALUE, $error->getCode());
+        $this->assertEquals(400, $error->getStatus());
+    }
+
+    public function testCustomFormat()
+    {
+        $format = 'H:i:s';
+        $validator = new DateValidator([$format]);
+        $date = new \DateTime();
+
+        $this->assertTrue($validator->isValid($date->format($format)));
+        $this->assertFalse($validator->isValid($date->format(DateValidator::FORMAT_ISO_8601)));
+    }
+}

test/Validator/ValidatorTestCase.php

@@ -10,7 +10,7 @@ class ValidatorTestCase extends \PHPUnit_Framework_TestCase
 
     /**
      * @param ValidatorInterface $validator
-     * @return mixed
+     * @return ErrorObject
      */
     protected function getError(ValidatorInterface $validator)
     {
@@ -28,4 +28,4 @@ protected function getError(ValidatorInterface $validator)
 
         return $error;
     }
-}
+}