MultipleValidatorWithAnd now can break out of loop when error occurs (#122)

* MultipleValidatorWithAnd now can break out of loop when error occurs

* improved logic

* updated doc

* bugfix

.gitattributes

@@ -0,0 +1,4 @@
+/Tests export-ignore
+/documentation export-ignore
+/.* export-ignore
+/phpunit.xml.dist

EmailValidator/EmailValidator.php

@@ -58,7 +58,7 @@ class EmailValidator
     }
 
     /**
-     * @return string
+     * @return InvalidEmail
      */
     public function getError()
     {

EmailValidator/Validation/DNSCheckValidation.php

@@ -3,16 +3,12 @@
 namespace Egulias\EmailValidator\Validation;
 
 use Egulias\EmailValidator\EmailLexer;
+use Egulias\EmailValidator\Exception\InvalidEmail;
 use Egulias\EmailValidator\Warning\NoDNSMXRecord;
 use Egulias\EmailValidator\Exception\NoDNSRecord;
 
 class DNSCheckValidation implements EmailValidation
 {
-    /**
-     * @var EmailParser
-     */
-    private $parser;
-
     /**
      * @var array
      */
@@ -27,10 +23,10 @@ class DNSCheckValidation implements EmailValidation
     {
         // use the input to check DNS if we cannot extract something similar to a domain
         $host = $email;
+
         // Arguable pattern to extract the domain. Not aiming to validate the domain nor the email
-        $pattern = "/^[a-z'0-9]+([._-][a-z'0-9]+)*@([a-z0-9]+([._-][a-z0-9]+)+)+$/";
-        if (preg_match($pattern, $email, $result)) {
-            $host = $this->extractHost($result);
+        if (false !== $lastAtPos = strrpos($email, '@')) {
+            $host = substr($email, $lastAtPos + 1);
         }
 
         return $this->checkDNS($host);
@@ -46,16 +42,6 @@ class DNSCheckValidation implements EmailValidation
         return $this->warnings;
     }
 
-    private function extractHost(array $result)
-    {
-        foreach ($result as $match) {
-            $onlyDomainPattern = "/^([a-z0-9]+([._-][a-z0-9]+))+$/";
-            if (preg_match($onlyDomainPattern, $match, $domainResult)) {
-                return $domainResult[0];
-            }
-        }
-    }
-
     protected function checkDNS($host)
     {
         $Aresult = true;
@@ -63,7 +49,7 @@ class DNSCheckValidation implements EmailValidation
         
         if (!$MXresult) {
             $this->warnings[NoDNSMXRecord::CODE] = new NoDNSMXRecord();
-            $Aresult = checkdnsrr($host, 'A');
+            $Aresult = checkdnsrr($host, 'A') || checkdnsrr($host, 'AAAA');
             if (!$Aresult) {
                 $this->error = new NoDNSRecord();
             }

EmailValidator/Validation/EmailValidation.php

@@ -3,6 +3,7 @@
 namespace Egulias\EmailValidator\Validation;
 
 use Egulias\EmailValidator\EmailLexer;
+use Egulias\EmailValidator\Exception\InvalidEmail;
 
 interface EmailValidation
 {

EmailValidator/Validation/MultipleValidationWithAnd.php

@@ -3,23 +3,60 @@
 namespace Egulias\EmailValidator\Validation;
 
 use Egulias\EmailValidator\EmailLexer;
+use Egulias\EmailValidator\Exception\InvalidEmail;
 use Egulias\EmailValidator\Validation\Exception\EmptyValidationList;
 
 class MultipleValidationWithAnd implements EmailValidation
 {
+    /**
+     * If one of validations gets failure skips all succeeding validation.
+     * This means MultipleErrors will only contain a single error which first found.
+     */
+    const STOP_ON_ERROR = 0;
+
+    /**
+     * All of validations will be invoked even if one of them got failure.
+     * So MultipleErrors will contain all causes.
+     */
+    const ALLOW_ALL_ERRORS = 1;
+
+    /**
+     * @var EmailValidation[]
+     */
     private $validations = [];
+
+    /**
+     * @var array
+     */
     private $warnings = [];
+
+    /**
+     * @var MultipleErrors
+     */
     private $error;
-    
-    public function __construct(array $validations)
+
+    /**
+     * @var bool
+     */
+    private $mode;
+
+    /**
+     * @param EmailValidation[] $validations The validations.
+     * @param int               $mode        The validation mode (one of the constants).
+     */
+    public function __construct(array $validations, $mode = self::ALLOW_ALL_ERRORS)
     {
         if (count($validations) == 0) {
             throw new EmptyValidationList();
         }
         
         $this->validations = $validations;
+        $this->mode = $mode;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function isValid($email, EmailLexer $emailLexer)
     {
         $result = true;
@@ -29,17 +66,32 @@ class MultipleValidationWithAnd implements EmailValidation
             $result = $result && $validation->isValid($email, $emailLexer);
             $this->warnings = array_merge($this->warnings, $validation->getWarnings());
             $errors[] = $validation->getError();
+
+            if ($this->shouldStop($result)) {
+                break;
+            }
         }
         $this->error = new MultipleErrors($errors);
         
         return $result;
     }
 
+    private function shouldStop($result)
+    {
+        return !$result && $this->mode === self::STOP_ON_ERROR;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
     public function getError()
     {
         return $this->error;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getWarnings()
     {
         return $this->warnings;

EmailValidator/Validation/SpoofCheckValidation.php

@@ -3,6 +3,7 @@
 namespace Egulias\EmailValidator\Validation;
 
 use Egulias\EmailValidator\EmailLexer;
+use Egulias\EmailValidator\Exception\InvalidEmail;
 use Egulias\EmailValidator\Validation\Error\SpoofEmail;
 use \Spoofchecker;
 

README.md

@@ -32,10 +32,10 @@ $validator->isValid("example@example.com", new RFCValidation()) //true
 2. [NoWarningsRFCValidation](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/NoRFCWarningsValidation.php)
 3. [DNSCheckValidation](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/DNSCheckValidation.php)
 4. [SpoofCheckValidation](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/SpoofCheckValidation.php)
-5. [MultipleValidationsWithAnd](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/MultipleValidationWithAnd.php)
+5. [MultipleValidationWithAnd](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/MultipleValidationWithAnd.php)
 6. [Your own validation](#how-to-extend)
 
-`MultipleValidationsWithAnd`
+`MultipleValidationWithAnd`
 
 It is a validation that operates over other validations performing a logical and (&&) over the result of each validation.
 
@@ -43,9 +43,12 @@ It is a validation that operates over other validations performing a logical and
 <?php
 
 use Egulias\EmailValidator\EmailValidator;
+use Egulias\EmailValidator\Validation\DNSCheckValidation;
+use Egulias\EmailValidator\Validation\MultipleValidationWithAnd;
+use Egulias\EmailValidator\Validation\RFCValidation;
 
 $validator = new EmailValidator();
-$multipleValidations = new MultipleValidationsWithAnd([
+$multipleValidations = new MultipleValidationWithAnd([
     new RFCValidation(),
     new DNSCheckValidation()
 ])

Tests/EmailValidator/Validation/DNSCheckValidationTest.php

@@ -9,10 +9,30 @@ use Egulias\EmailValidator\Warning\NoDNSMXRecord;
 
 class DNSCheckValidationTest extends \PHPUnit_Framework_TestCase
 {
-    public function testValidDNS()
+    public function validEmailsProvider()
+    {
+        return [
+            // dot-atom
+            ['Abc@example.com'],
+            ['ABC@EXAMPLE.COM'],
+            ['Abc.123@example.com'],
+            ['user+mailbox/department=shipping@example.com'],
+            ['!#$%&\'*+-/=?^_`.{|}~@example.com'],
+
+            // quoted string
+            ['"Abc@def"@example.com'],
+            ['"Fred\ Bloggs"@example.com'],
+            ['"Joe.\\Blow"@example.com'],
+        ];
+    }
+
+    /**
+     * @dataProvider validEmailsProvider
+     */
+    public function testValidDNS($validEmail)
     {
         $validation = new DNSCheckValidation();
-        $this->assertTrue($validation->isValid("example@example.com", new EmailLexer()));
+        $this->assertTrue($validation->isValid($validEmail, new EmailLexer()));
     }
     
     public function testInvalidDNS()

Tests/EmailValidator/Validation/MultipleValidationWitAndTest.php

@@ -25,7 +25,7 @@ class MultipleValidationWitAndTest extends \PHPUnit_Framework_TestCase
     }
 
     /**
-     * @expectedException Egulias\EmailValidator\Validation\Exception\EmptyValidationList
+     * @expectedException \Egulias\EmailValidator\Validation\Exception\EmptyValidationList
      */
     public function testEmptyListIsNotAllowed()
     {
@@ -79,4 +79,27 @@ class MultipleValidationWitAndTest extends \PHPUnit_Framework_TestCase
         $multipleValidation->isValid("example@example.com", $lexer);
         $this->assertEquals($expectedResult, $multipleValidation->getError());
     }
+
+    public function testBreakOutOfLoopWhenError()
+    {
+        $error = new CommaInDomain();
+
+        $expectedResult = new MultipleErrors([$error]);
+
+        $lexer = $this->getMock("Egulias\\EmailValidator\\EmailLexer");
+
+        $validation1 = $this->getMock("Egulias\\EmailValidator\\Validation\\EmailValidation");
+        $validation1->expects($this->any())->method("isValid")->willReturn(false);
+        $validation1->expects($this->once())->method("getWarnings")->willReturn([]);
+        $validation1->expects($this->once())->method("getError")->willReturn($error);
+
+        $validation2 = $this->getMock("Egulias\\EmailValidator\\Validation\\EmailValidation");
+        $validation2->expects($this->never())->method("isValid");
+        $validation2->expects($this->never())->method("getWarnings");
+        $validation2->expects($this->never())->method("getError");
+
+        $multipleValidation = new MultipleValidationWithAnd([$validation1, $validation2], MultipleValidationWithAnd::STOP_ON_ERROR);
+        $multipleValidation->isValid("example@example.com", $lexer);
+        $this->assertEquals($expectedResult, $multipleValidation->getError());
+    }
 }