Main parser method transformed. Improved Reasons with details for clarity of failure

EmailValidator/EmailParser.php

@@ -2,11 +2,15 @@
 
 namespace Egulias\EmailValidator;
 
-use Egulias\EmailValidator\Exception\ExpectingATEXT;
-use Egulias\EmailValidator\Exception\NoLocalPart;
-use Egulias\EmailValidator\Parser\DomainPart;
+use Egulias\EmailValidator\EmailLexer;
+use Egulias\EmailValidator\Result\Result;
 use Egulias\EmailValidator\Parser\LocalPart;
+use Egulias\EmailValidator\Parser\DomainPart;
+use Egulias\EmailValidator\Result\ValidEmail;
+use Egulias\EmailValidator\Result\InvalidEmail;
 use Egulias\EmailValidator\Warning\EmailTooLong;
+use Egulias\EmailValidator\Result\Reason\ExpectingATEXT;
+use Egulias\EmailValidator\Result\Reason\NoLocalPart;
 
 /**
  * EmailParser
@@ -57,25 +61,25 @@ class EmailParser
      * @param string $str
      * @return array
      */
-    public function parse($str)
+    public function parse($str) : Result
     {
         $this->lexer->setInput($str);
 
         if (!$this->hasAtToken()) {
-            throw new NoLocalPart();
+            return new InvalidEmail(new NoLocalPart(), $this->lexer->token["value"]);
         }
 
-
         $this->localPartParser->parse($str);
         $this->domainPartParser->parse($str);
 
         $this->setParts($str);
 
         if ($this->lexer->hasInvalidTokens()) {
-            throw new ExpectingATEXT();
+            return new InvalidEmail(new ExpectingATEXT("Invalid tokens found"), $this->lexer->token["value"]);
         }
 
-        return array('local' => $this->localPart, 'domain' => $this->domainPart);
+        return new ValidEmail();
+        //return array('local' => $this->localPart, 'domain' => $this->domainPart);
     }
 
     /**

EmailValidator/Result/Reason/DetailedReason.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Egulias\EmailValidator\Result\Reason;
+
+abstract class DetailedReason implements Reason
+{
+    protected $detailedDescription;
+
+    public function __construct(string $details)
+    {
+        $this->detailedDescription = $details;
+    }
+}

EmailValidator/Result/Reason/ExpectingATEXT.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Egulias\EmailValidator\Result\Reason;
+
+class ExpectingATEXT extends DetailedReason
+{
+    public function code() : int
+    {
+        return 137;
+    }
+
+    public function description() : string
+    {
+        return "Expecting ATEXT (Printable US-ASCII). Extended: " . $this->detailedDescription;
+    }
+}

EmailValidator/Result/Reason/NoLocalPart.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Egulias\EmailValidator\Result\Reason;
+
+class NoLocalPart implements Reason 
+{
+    public function code() : int
+    {
+        return 130;
+    }
+
+    public function description() : string
+    {
+        return "No local part";
+    }
+}

EmailValidator/Result/Reason/Reason.php

@@ -4,6 +4,13 @@ namespace Egulias\EmailValidator\Result\Reason;
 
 interface Reason
 {
+    /**
+     * Code for user land to act upon;
+     */
     public function code() : int;
+
+    /**
+     * Short description of the result, human readable.
+     */
     public function description() : string;
 }

EmailValidator/Result/Result.php

@@ -4,7 +4,18 @@ namespace Egulias\EmailValidator\Result;
 
 interface Result
 {
+    /**
+     * Is validation result valid?
+     */
     public function isValid() : bool;
+
+    /**
+     * Short description of the result, human readable.
+     */
     public function description() : string;
+
+    /**
+     * Code for user land to act upon.
+     */
     public function code() : int;
 }

EmailValidator/Validation/RFCValidation.php

@@ -27,7 +27,11 @@ class RFCValidation implements EmailValidation
     {
         $this->parser = new EmailParser($emailLexer);
         try {
-            $this->parser->parse((string)$email);
+            $result = $this->parser->parse((string)$email);
+            if (!$result->isValid()) {
+                $this->error = $result;
+                return false;
+            }
         } catch (InvalidEmail $invalid) {
             $this->error = $invalid;
             return false;

Tests/EmailValidator/Result/ResultTest.php

@@ -1,5 +1,7 @@
 <?php
 
+namespace Egulias\Tests\EmailValidator\Validation;
+
 use PHPUnit\Framework\TestCase;
 use Egulias\EmailValidator\Result\ValidEmail;
 use Egulias\EmailValidator\Result\InvalidEmail;

Tests/EmailValidator/Validation/RFCValidationTest.php

@@ -2,40 +2,42 @@
 
 namespace Egulias\Tests\EmailValidator\Validation;
 
+use PHPUnit\Framework\TestCase;
 use Egulias\EmailValidator\EmailLexer;
-use Egulias\EmailValidator\Validation\RFCValidation;
-use Egulias\EmailValidator\Exception\AtextAfterCFWS;
-use Egulias\EmailValidator\Exception\ConsecutiveAt;
-use Egulias\EmailValidator\Exception\ConsecutiveDot;
-use Egulias\EmailValidator\Exception\CRNoLF;
-use Egulias\EmailValidator\Exception\DomainHyphened;
-use Egulias\EmailValidator\Exception\DotAtEnd;
-use Egulias\EmailValidator\Exception\DotAtStart;
-use Egulias\EmailValidator\Exception\ExpectingATEXT;
-use Egulias\EmailValidator\Exception\ExpectingDTEXT;
-use Egulias\EmailValidator\Exception\NoDomainPart;
-use Egulias\EmailValidator\Exception\NoLocalPart;
-use Egulias\EmailValidator\Exception\UnclosedComment;
-use Egulias\EmailValidator\Exception\UnclosedQuotedString;
-use Egulias\EmailValidator\Exception\UnopenedComment;
-use Egulias\EmailValidator\Warning\AddressLiteral;
-use Egulias\EmailValidator\Warning\CFWSNearAt;
-use Egulias\EmailValidator\Warning\CFWSWithFWS;
+use Egulias\EmailValidator\EmailValidator;
 use Egulias\EmailValidator\Warning\Comment;
-use Egulias\EmailValidator\Warning\DomainLiteral;
-use Egulias\EmailValidator\Warning\DomainTooLong;
+use Egulias\EmailValidator\Exception\CRNoLF;
+use Egulias\EmailValidator\Exception\DotAtEnd;
+use Egulias\EmailValidator\Warning\CFWSNearAt;
+use Egulias\EmailValidator\Result\InvalidEmail;
+use Egulias\EmailValidator\Warning\CFWSWithFWS;
 use Egulias\EmailValidator\Warning\IPV6BadChar;
+use Egulias\EmailValidator\Exception\DotAtStart;
 use Egulias\EmailValidator\Warning\IPV6ColonEnd;
-use Egulias\EmailValidator\Warning\IPV6ColonStart;
-use Egulias\EmailValidator\Warning\IPV6Deprecated;
-use Egulias\EmailValidator\Warning\IPV6DoubleColon;
-use Egulias\EmailValidator\Warning\IPV6GroupCount;
-use Egulias\EmailValidator\Warning\IPV6MaxGroups;
 use Egulias\EmailValidator\Warning\LabelTooLong;
 use Egulias\EmailValidator\Warning\LocalTooLong;
-use Egulias\EmailValidator\Warning\ObsoleteDTEXT;
 use Egulias\EmailValidator\Warning\QuotedString;
-use PHPUnit\Framework\TestCase;
+use Egulias\EmailValidator\Warning\DomainLiteral;
+use Egulias\EmailValidator\Warning\DomainTooLong;
+use Egulias\EmailValidator\Warning\IPV6MaxGroups;
+use Egulias\EmailValidator\Warning\ObsoleteDTEXT;
+use Egulias\EmailValidator\Exception\NoDomainPart;
+use Egulias\EmailValidator\Warning\AddressLiteral;
+use Egulias\EmailValidator\Warning\IPV6ColonStart;
+use Egulias\EmailValidator\Warning\IPV6Deprecated;
+use Egulias\EmailValidator\Warning\IPV6GroupCount;
+use Egulias\EmailValidator\Exception\ConsecutiveAt;
+use Egulias\EmailValidator\Warning\IPV6DoubleColon;
+use Egulias\EmailValidator\Exception\AtextAfterCFWS;
+use Egulias\EmailValidator\Exception\ConsecutiveDot;
+use Egulias\EmailValidator\Exception\DomainHyphened;
+use Egulias\EmailValidator\Exception\ExpectingATEXT;
+use Egulias\EmailValidator\Exception\ExpectingDTEXT;
+use Egulias\EmailValidator\Validation\RFCValidation;
+use Egulias\EmailValidator\Exception\UnclosedComment;
+use Egulias\EmailValidator\Exception\UnopenedComment;
+use Egulias\EmailValidator\Result\Reason\NoLocalPart;
+use Egulias\EmailValidator\Exception\UnclosedQuotedString;
 
 class RFCValidationTest extends TestCase
 {
@@ -182,7 +184,7 @@ class RFCValidationTest extends TestCase
     public function getInvalidEmailsWithErrors()
     {
         return [
-            [new NoLocalPart(), '@example.co.uk'],
+            [new InvalidEmail(new NoLocalPart(), "@"), '@example.co.uk'],
             [new NoDomainPart(), 'example@'],
             [new DomainHyphened(), 'example@example-.co.uk'],
             [new DomainHyphened(), 'example@example-'],

Tests/EmailValidator/Validation/ValitadionTest.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Egulias\Tests\EmailValidator\Validation;
+
+use PHPUnit\Framework\TestCase;
+
+class ValidationTest extends TestCase
+{
+    public function testValidationReturnsResult()
+    {
+        $this->fail("implement return type Validation");
+    }
+}