Added tests

Author: Daniel Opitz

src/Validation/StatusCodeMessage.php

@@ -3,7 +3,7 @@
 namespace Odan\Validation;
 
 /**
- * StatusMessage.
+ * Status Code Message.
  *
  * Represents a status code ('5001', 'success', 'danger', etc...) and a status message.
  */
@@ -12,7 +12,7 @@ class StatusCodeMessage
     /**
      * @var string
      */
-    protected $status;
+    protected $code;
 
     /**
      * @var string
@@ -22,26 +22,27 @@ class StatusCodeMessage
     /**
      * Constructor.
      *
-     * @param string $status Alert status
+     * @param string $code Alert status
      * @param string $message The message
      */
-    public function __construct(string $status, string $message)
+    public function __construct(string $code, string $message)
     {
-        $this->status = $status;
+        $this->code = $code;
         $this->message = $message;
     }
 
     /**
-     * Clone object.
+     * Set values.
      *
-     * @param string $status Status code
+     * @param string $code Status code
      * @param string $message The message
      *
-     * @return self
+     * @return void
      */
-    public function with(string $status, string $message): self
+    public function set(string $code, string $message)
     {
-        return new self($status, $message);
+        $this->code = $code;
+        $this->message = $message;
     }
 
     /**
@@ -57,11 +58,11 @@ public function message(): string
     /**
      * Returns the status code.
      *
-     * @return string The status
+     * @return string The status code
      */
     public function status(): string
     {
-        return $this->status;
+        return $this->code;
     }
 
     /**

src/Validation/SuccessMessage.php

@@ -3,7 +3,7 @@
 namespace Odan\Validation;
 
 /**
- * SuccessMessage.
+ * Success Message.
  *
  * Represents a boolean success status and a success message.
  */
@@ -32,16 +32,17 @@ public function __construct(bool $success, string $message)
     }
 
     /**
-     * Get message.
+     * Set values.
      *
      * @param bool $success
      * @param string $message
      *
-     * @return self
+     * @return void
      */
-    public function with(bool $success, string $message): self
+    public function set(bool $success, string $message)
     {
-        return new self($success, $message);
+        $this->success = $success;
+        $this->message = $message;
     }
 
     /**

src/Validation/ValidationMessage.php

@@ -3,7 +3,7 @@
 namespace Odan\Validation;
 
 /**
- * ValidationMessage.
+ * Validation Message.
  *
  * Represents a container for the results of a validation request.
  */
@@ -24,7 +24,7 @@ class ValidationMessage
      *
      * @return array Errors
      */
-    public function getErrors()
+    public function getErrors(): array
     {
         return $this->errors;
     }
@@ -34,7 +34,7 @@ public function getErrors()
      *
      * @return mixed Error
      */
-    public function getError()
+    public function getFirstError()
     {
         return reset($this->errors);
     }
@@ -44,7 +44,7 @@ public function getError()
      *
      * @return string|null
      */
-    public function getMessage()
+    public function getMessage(): ?string
     {
         return $this->message;
     }
@@ -54,13 +54,11 @@ public function getMessage()
      *
      * @param string $message The default success message
      *
-     * @return self self
+     * @return void
      */
     public function setMessage(string $message)
     {
         $this->message = $message;
-
-        return $this;
     }
 
     /**
@@ -86,29 +84,31 @@ public function failed(): bool
     /**
      * Clear errors and message.
      *
-     * @return self
+     * @return void
      */
     public function clear()
     {
         $this->message = null;
         $this->errors = [];
-
-        return $this;
     }
 
     /**
      * Add error message.
      *
-     * @param string $field Field name
-     * @param string $message Message
+     * @param string $field the field name containing the error
+     * @param string $message A String providing a short description of the error.
+     * The message SHOULD be limited to a concise single sentence.
+     * @param string|null $code A numeric or alphanumeric value that indicates the error type that occurred. (optional)
      *
-     * @return self
+     * @return void
      */
-    public function addError(string $field, string $message)
+    public function addError(string $field, string $message, string $code = null)
     {
-        $this->errors[] = ['field' => $field, 'message' => $message];
-
-        return $this;
+        if ($code === null) {
+            $this->errors[] = ['field' => $field, 'message' => $message];
+        } else {
+            $this->errors[] = ['field' => $field, 'message' => $message, 'code' => $code];
+        }
     }
 
     /**

tests/StatusCodeMessageTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Odan\Validation\Test;
+
+use Odan\Validation\StatusCodeMessage;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Tests.
+ *
+ * @coversDefaultClass \Odan\Validation\StatusCodeMessage
+ */
+class StatusCodeMessageTest extends TestCase
+{
+    public function testConstruct()
+    {
+        $actual = new StatusCodeMessage(0, 'message');
+        $this->assertInstanceOf(StatusCodeMessage::class, $actual);
+    }
+    
+    public function testToArray()
+    {
+        $this->markTestSkipped();
+    }
+
+    public function testSet()
+    {
+        $this->markTestSkipped();
+    }
+
+    public function testMessage()
+    {
+        $this->markTestSkipped();
+    }
+
+    public function testStatus()
+    {
+        $this->markTestSkipped();
+    }
+
+
+}

tests/SuccessMessageTest.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Odan\Validation\Test;
+
+use Odan\Validation\SuccessMessage;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Tests.
+ *
+ * @coversDefaultClass \Odan\Validation\SuccessMessage
+ */
+class SuccessMessageTest extends TestCase
+{
+    public function testConstruct()
+    {
+        $actual = new SuccessMessage(true, 'Ok');
+        $this->assertInstanceOf(SuccessMessage::class, $actual);
+    }
+
+    public function testFailed()
+    {
+        $this->markTestSkipped();
+    }
+
+    public function testSet()
+    {
+        $this->markTestSkipped();
+    }
+
+    public function testMessage()
+    {
+        $this->markTestSkipped();
+    }
+
+
+    public function testSuccess()
+    {
+        $this->markTestSkipped();
+    }
+
+    public function testToArray()
+    {
+        $this->markTestSkipped();
+    }
+}

tests/ValidationResultTest.php tests/ValidationMessageTest.phptests/ValidationResultTest.php renamed to tests/ValidationMessageTest.php

@@ -8,9 +8,9 @@
 /**
  * ValidationResult tests.
  *
- * @coversDefaultClass \Odan\Validation\ValidationResult
+ * @coversDefaultClass \Odan\Validation\ValidationMessage
  */
-class ValidationResultTest extends TestCase
+class ValidationMessageTest extends TestCase
 {
     /**
      * Test instance.
@@ -102,7 +102,7 @@ public function testErrorsWithMessage()
         $val->addError('email', 'required');
         $result = $val->failed();
         $this->assertTrue($result);
-        $this->assertEquals(['field' => 'email', 'message' => 'required'], $val->getError());
+        $this->assertEquals(['field' => 'email', 'message' => 'required'], $val->getFirstError());
     }
 
     /**
@@ -174,12 +174,13 @@ public function testToArray()
         $val = new ValidationMessage();
         $val->setMessage('Errors');
         $val->addError('error1', 'error');
-        $val->addError('error2', 'error');
+        $val->addError('error2', 'error', '5000');
         $result = $val->toArray();
         $this->assertSame($result['message'], 'Errors');
         $this->assertSame($result['errors'][0]['field'], 'error1');
         $this->assertSame($result['errors'][0]['message'], 'error');
         $this->assertSame($result['errors'][1]['field'], 'error2');
         $this->assertSame($result['errors'][1]['message'], 'error');
+        $this->assertSame($result['errors'][1]['code'], '5000');
     }
 }