Fix "Trying to access array offset on value of type null" (#228)

Added a check that `$previous` is not null (i.e. previous token exists)

.gitignore

@@ -1,3 +1,4 @@
+.idea
+composer.lock
 report/
 vendor/
-.idea

.travis.yml

@@ -1,33 +1,44 @@
-sudo: false
-
 language: php
 
-php:
-  - 5.5
-  - 5.6
-  - 7.0
-  - hhvm
-
-env:
-  global:
-    - deps=no
-
 matrix:
-  fast_finish: true
   include:
-    - php: 5.5
+    - php: 5.5.9
+      dist: trusty
       env: deps=low
+    - php: 5.5
+      dist: trusty
     - php: 5.6
-      env: deps=high
+      env:
+      dist: xenial
+    - php: 7.0
+      dist: xenial
+    - php: 7.1
+      env:
+        - psalm=yes
+      dist: bionic
+    - php: 7.2
+      env:
+        - psalm=yes
+      dist: bionic
+    - php: 7.3
+      dist: bionic
+      env:
+        - psalm=yes
+    - php: 7.4
+      env:
+        - psalm=yes
+      dist: bionic
 
 install:
-  - if [ "$deps" = "no" ]; then composer install; fi
-  - if [ "$deps" = "low" ]; then composer update --prefer-lowest; fi
-  - if [ "$deps" = "high" ]; then composer update; fi
+  - if [ "$deps" = "low" ]; then composer update --prefer-lowest; else composer install; fi
+  - if [ "$psalm" = "yes" ]; then composer require --dev vimeo/psalm; fi
+
+before_script:
+  - mkdir -p build/logs
 
 script:
- - mkdir -p build/logs
- - vendor/bin/phpunit --coverage-clover build/logs/clover.xml
+  - vendor/bin/phpunit --coverage-clover build/logs/clover.xml
+  - if [ "$psalm" = "yes" ]; then vendor/bin/psalm; fi
 
 after_script:
- - php vendor/bin/coveralls
+  - php vendor/bin/coveralls

EmailValidator/EmailLexer.php

@@ -73,25 +73,73 @@ class EmailLexer extends AbstractLexer
         '\0'   => self::C_NUL,
     );
 
+    /**
+     * @var bool
+     */
     protected $hasInvalidTokens = false;
 
-    protected $previous;
+    /**
+     * @var array
+     *
+     * @psalm-var array{value:string, type:null|int, position:int}|array<empty, empty>
+     */
+    protected $previous = [];
 
+    /**
+     * The last matched/seen token.
+     *
+     * @var array
+     *
+     * @psalm-var array{value:string, type:null|int, position:int}
+     */
+    public $token;
+
+    /**
+     * The next token in the input.
+     *
+     * @var array|null
+     */
+    public $lookahead;
+
+    /**
+     * @psalm-var array{value:'', type:null, position:0}
+     */
+    private static $nullToken = [
+        'value' => '',
+        'type' => null,
+        'position' => 0,
+    ];
+
+    public function __construct()
+    {
+        $this->previous = $this->token = self::$nullToken;
+        $this->lookahead = null;
+    }
+
+    /**
+     * @return void
+     */
     public function reset()
     {
         $this->hasInvalidTokens = false;
         parent::reset();
+        $this->previous = $this->token = self::$nullToken;
     }
 
+    /**
+     * @return bool
+     */
     public function hasInvalidTokens()
     {
         return $this->hasInvalidTokens;
     }
 
     /**
-     * @param $type
+     * @param int $type
      * @throws \UnexpectedValueException
      * @return boolean
+     *
+     * @psalm-suppress InvalidScalarArgument
      */
     public function find($type)
     {
@@ -107,7 +155,7 @@ class EmailLexer extends AbstractLexer
     /**
      * getPrevious
      *
-     * @return array token
+     * @return array
      */
     public function getPrevious()
     {
@@ -122,8 +170,10 @@ class EmailLexer extends AbstractLexer
     public function moveNext()
     {
         $this->previous = $this->token;
+        $hasNext = parent::moveNext();
+        $this->token = $this->token ?: self::$nullToken;
 
-        return parent::moveNext();
+        return $hasNext;
     }
 
     /**
@@ -179,6 +229,11 @@ class EmailLexer extends AbstractLexer
         return  self::GENERIC;
     }
 
+    /**
+     * @param string $value
+     *
+     * @return bool
+     */
     protected function isValid($value)
     {
         if (isset($this->charValue[$value])) {
@@ -189,7 +244,7 @@ class EmailLexer extends AbstractLexer
     }
 
     /**
-     * @param $value
+     * @param string $value
      * @return bool
      */
     protected function isNullType($value)
@@ -202,7 +257,7 @@ class EmailLexer extends AbstractLexer
     }
 
     /**
-     * @param $value
+     * @param string $value
      * @return bool
      */
     protected function isUTF8Invalid($value)
@@ -214,6 +269,9 @@ class EmailLexer extends AbstractLexer
         return false;
     }
 
+    /**
+     * @return string
+     */
     protected function getModifiers()
     {
         return 'iu';

EmailValidator/EmailParser.php

@@ -17,11 +17,33 @@ class EmailParser
 {
     const EMAIL_MAX_LENGTH = 254;
 
-    protected $warnings;
+    /**
+     * @var array
+     */
+    protected $warnings = [];
+
+    /**
+     * @var string
+     */
     protected $domainPart = '';
+
+    /**
+     * @var string
+     */
     protected $localPart = '';
+    /**
+     * @var EmailLexer
+     */
     protected $lexer;
+
+    /**
+     * @var LocalPart
+     */
     protected $localPartParser;
+
+    /**
+     * @var DomainPart
+     */
     protected $domainPartParser;
 
     public function __construct(EmailLexer $lexer)
@@ -29,11 +51,10 @@ class EmailParser
         $this->lexer = $lexer;
         $this->localPartParser = new LocalPart($this->lexer);
         $this->domainPartParser = new DomainPart($this->lexer);
-        $this->warnings = new \SplObjectStorage();
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return array
      */
     public function parse($str)
@@ -57,6 +78,9 @@ class EmailParser
         return array('local' => $this->localPart, 'domain' => $this->domainPart);
     }
 
+    /**
+     * @return Warning\Warning[]
+     */
     public function getWarnings()
     {
         $localPartWarnings = $this->localPartParser->getWarnings();
@@ -68,11 +92,17 @@ class EmailParser
         return $this->warnings;
     }
 
+    /**
+     * @return string
+     */
     public function getParsedDomainPart()
     {
         return $this->domainPart;
     }
 
+    /**
+     * @param string $email
+     */
     protected function setParts($email)
     {
         $parts = explode('@', $email);
@@ -80,6 +110,9 @@ class EmailParser
         $this->localPart = $parts[0];
     }
 
+    /**
+     * @return bool
+     */
     protected function hasAtToken()
     {
         $this->lexer->moveNext();

EmailValidator/EmailValidator.php

@@ -13,12 +13,12 @@ class EmailValidator
     private $lexer;
 
     /**
-     * @var array
+     * @var Warning\Warning[]
      */
-    protected $warnings;
+    protected $warnings = [];
 
     /**
-     * @var InvalidEmail
+     * @var InvalidEmail|null
      */
     protected $error;
 
@@ -28,7 +28,7 @@ class EmailValidator
     }
 
     /**
-     * @param                 $email
+     * @param string          $email
      * @param EmailValidation $emailValidation
      * @return bool
      */
@@ -58,7 +58,7 @@ class EmailValidator
     }
 
     /**
-     * @return InvalidEmail
+     * @return InvalidEmail|null
      */
     public function getError()
     {

EmailValidator/Exception/ExpectingQPair.php

@@ -2,7 +2,7 @@
 
 namespace Egulias\EmailValidator\Exception;
 
-class ExpectedQPair extends InvalidEmail
+class ExpectingQPair extends InvalidEmail
 {
     const CODE = 136;
     const REASON = "Expecting QPAIR";

EmailValidator/Exception/NoDNSRecord.php

@@ -2,8 +2,6 @@
 
 namespace Egulias\EmailValidator\Exception;
 
-use Egulias\EmailValidator\Exception\InvalidEmail;
-
 class NoDNSRecord extends InvalidEmail
 {
     const CODE = 5;

EmailValidator/Parser/DomainPart.php

@@ -35,27 +35,17 @@ use Egulias\EmailValidator\Warning\TLD;
 class DomainPart extends Parser
 {
     const DOMAIN_MAX_LENGTH = 254;
+
+    /**
+     * @var string
+     */
     protected $domainPart = '';
 
     public function parse($domainPart)
     {
         $this->lexer->moveNext();
 
-        if ($this->lexer->token['type'] === EmailLexer::S_DOT) {
-            throw new DotAtStart();
-        }
-
-        if ($this->lexer->token['type'] === EmailLexer::S_EMPTY) {
-            throw new NoDomainPart();
-        }
-        if ($this->lexer->token['type'] === EmailLexer::S_HYPHEN) {
-            throw new DomainHyphened();
-        }
-
-        if ($this->lexer->token['type'] === EmailLexer::S_OPENPARENTHESIS) {
-            $this->warnings[DeprecatedComment::CODE] = new DeprecatedComment();
-            $this->parseDomainComments();
-        }
+        $this->performDomainStartChecks();
 
         $domain = $this->doParseDomainPart();
 
@@ -77,11 +67,50 @@ class DomainPart extends Parser
         $this->domainPart = $domain;
     }
 
+    private function performDomainStartChecks()
+    {
+        $this->checkInvalidTokensAfterAT();
+        $this->checkEmptyDomain();
+
+        if ($this->lexer->token['type'] === EmailLexer::S_OPENPARENTHESIS) {
+            $this->warnings[DeprecatedComment::CODE] = new DeprecatedComment();
+            $this->parseDomainComments();
+        }
+    }
+
+    private function checkEmptyDomain()
+    {
+        $thereIsNoDomain = $this->lexer->token['type'] === EmailLexer::S_EMPTY ||
+            ($this->lexer->token['type'] === EmailLexer::S_SP &&
+            !$this->lexer->isNextToken(EmailLexer::GENERIC));
+
+        if ($thereIsNoDomain) {
+            throw new NoDomainPart();
+        }
+    }
+
+    private function checkInvalidTokensAfterAT()
+    {
+        if ($this->lexer->token['type'] === EmailLexer::S_DOT) {
+            throw new DotAtStart();
+        }
+        if ($this->lexer->token['type'] === EmailLexer::S_HYPHEN) {
+            throw new DomainHyphened();
+        }
+    }
+
+    /**
+     * @return string
+     */
     public function getDomainPart()
     {
         return $this->domainPart;
     }
 
+    /**
+     * @param string $addressLiteral
+     * @param int $maxGroups
+     */
     public function checkIPV6Tag($addressLiteral, $maxGroups = 8)
     {
         $prev = $this->lexer->getPrevious();
@@ -125,6 +154,9 @@ class DomainPart extends Parser
         }
     }
 
+    /**
+     * @return string
+     */
     protected function doParseDomainPart()
     {
         $domain = '';
@@ -166,12 +198,12 @@ class DomainPart extends Parser
 
             $domain .= $this->lexer->token['value'];
             $this->lexer->moveNext();
-        } while ($this->lexer->token);
+        } while (null !== $this->lexer->token['type']);
 
         return $domain;
     }
 
-    private function checkNotAllowedChars($token)
+    private function checkNotAllowedChars(array $token)
     {
         $notAllowed = [EmailLexer::S_BACKSLASH => true, EmailLexer::S_SLASH=> true];
         if (isset($notAllowed[$token['type']])) {
@@ -179,6 +211,9 @@ class DomainPart extends Parser
         }
     }
 
+    /**
+     * @return string|false
+     */
     protected function parseDomainLiteral()
     {
         if ($this->lexer->isNextToken(EmailLexer::S_COLON)) {
@@ -195,6 +230,9 @@ class DomainPart extends Parser
         return $this->doParseDomainLiteral();
     }
 
+    /**
+     * @return string|false
+     */
     protected function doParseDomainLiteral()
     {
         $IPv6TAG = false;
@@ -262,6 +300,11 @@ class DomainPart extends Parser
         return $addressLiteral;
     }
 
+    /**
+     * @param string $addressLiteral
+     *
+     * @return string|false
+     */
     protected function checkIPV4Tag($addressLiteral)
     {
         $matchesIP  = array();
@@ -279,13 +322,13 @@ class DomainPart extends Parser
                 return false;
             }
             // Convert IPv4 part to IPv6 format for further testing
-            $addressLiteral = substr($addressLiteral, 0, $index) . '0:0';
+            $addressLiteral = substr($addressLiteral, 0, (int) $index) . '0:0';
         }
 
         return $addressLiteral;
     }
 
-    protected function checkDomainPartExceptions($prev)
+    protected function checkDomainPartExceptions(array $prev)
     {
         $invalidDomainTokens = array(
             EmailLexer::S_DQUOTE => true,
@@ -320,6 +363,9 @@ class DomainPart extends Parser
         }
     }
 
+    /**
+     * @return bool
+     */
     protected function hasBrackets()
     {
         if ($this->lexer->token['type'] !== EmailLexer::S_OPENBRACKET) {
@@ -335,7 +381,7 @@ class DomainPart extends Parser
         return true;
     }
 
-    protected function checkLabelLength($prev)
+    protected function checkLabelLength(array $prev)
     {
         if ($this->lexer->token['type'] === EmailLexer::S_DOT &&
             $prev['type'] === EmailLexer::GENERIC &&

EmailValidator/Parser/LocalPart.php

@@ -5,7 +5,6 @@ namespace Egulias\EmailValidator\Parser;
 use Egulias\EmailValidator\Exception\DotAtEnd;
 use Egulias\EmailValidator\Exception\DotAtStart;
 use Egulias\EmailValidator\EmailLexer;
-use Egulias\EmailValidator\EmailValidator;
 use Egulias\EmailValidator\Exception\ExpectingAT;
 use Egulias\EmailValidator\Exception\ExpectingATEXT;
 use Egulias\EmailValidator\Exception\UnclosedQuotedString;
@@ -21,8 +20,8 @@ class LocalPart extends Parser
         $closingQuote = false;
         $openedParenthesis = 0;
 
-        while ($this->lexer->token['type'] !== EmailLexer::S_AT && $this->lexer->token) {
-            if ($this->lexer->token['type'] === EmailLexer::S_DOT && !$this->lexer->getPrevious()) {
+        while ($this->lexer->token['type'] !== EmailLexer::S_AT && null !== $this->lexer->token['type']) {
+            if ($this->lexer->token['type'] === EmailLexer::S_DOT && null === $this->lexer->getPrevious()['type']) {
                 throw new DotAtStart();
             }
 
@@ -67,6 +66,9 @@ class LocalPart extends Parser
         }
     }
 
+    /**
+     * @return bool
+     */
     protected function parseDoubleQuote()
     {
         $parseAgain = true;
@@ -86,7 +88,7 @@ class LocalPart extends Parser
 
         $this->lexer->moveNext();
 
-        while ($this->lexer->token['type'] !== EmailLexer::S_DQUOTE && $this->lexer->token) {
+        while ($this->lexer->token['type'] !== EmailLexer::S_DQUOTE && null !== $this->lexer->token['type']) {
             $parseAgain = false;
             if (isset($special[$this->lexer->token['type']]) && $setSpecialsWarning) {
                 $this->warnings[CFWSWithFWS::CODE] = new CFWSWithFWS();
@@ -118,7 +120,10 @@ class LocalPart extends Parser
         return $parseAgain;
     }
 
-    protected function isInvalidToken($token, $closingQuote)
+    /**
+     * @param bool $closingQuote
+     */
+    protected function isInvalidToken(array $token, $closingQuote)
     {
         $forbidden = array(
             EmailLexer::S_COMMA,

EmailValidator/Parser/Parser.php

@@ -8,7 +8,7 @@ use Egulias\EmailValidator\Exception\ConsecutiveDot;
 use Egulias\EmailValidator\Exception\CRLFAtTheEnd;
 use Egulias\EmailValidator\Exception\CRLFX2;
 use Egulias\EmailValidator\Exception\CRNoLF;
-use Egulias\EmailValidator\Exception\ExpectedQPair;
+use Egulias\EmailValidator\Exception\ExpectingQPair;
 use Egulias\EmailValidator\Exception\ExpectingATEXT;
 use Egulias\EmailValidator\Exception\ExpectingCTEXT;
 use Egulias\EmailValidator\Exception\UnclosedComment;
@@ -21,8 +21,19 @@ use Egulias\EmailValidator\Warning\QuotedString;
 
 abstract class Parser
 {
+    /**
+     * @var \Egulias\EmailValidator\Warning\Warning[]
+     */
     protected $warnings = [];
+
+    /**
+     * @var EmailLexer
+     */
     protected $lexer;
+
+    /**
+     * @var int
+     */
     protected $openedParenthesis = 0;
 
     public function __construct(EmailLexer $lexer)
@@ -30,11 +41,17 @@ abstract class Parser
         $this->lexer = $lexer;
     }
 
+    /**
+     * @return \Egulias\EmailValidator\Warning\Warning[]
+     */
     public function getWarnings()
     {
         return $this->warnings;
     }
 
+    /**
+     * @param string $str
+     */
     abstract public function parse($str);
 
     /** @return int */
@@ -50,7 +67,7 @@ abstract class Parser
     {
         if (!($this->lexer->token['type'] === EmailLexer::INVALID
             || $this->lexer->token['type'] === EmailLexer::C_DEL)) {
-            throw new ExpectedQPair();
+            throw new ExpectingQPair();
         }
 
         $this->warnings[QuotedPart::CODE] =
@@ -80,6 +97,9 @@ abstract class Parser
         }
     }
 
+    /**
+     * @return bool
+     */
     protected function isUnclosedComment()
     {
         try {
@@ -122,6 +142,9 @@ abstract class Parser
         }
     }
 
+    /**
+     * @return bool
+     */
     protected function isFWS()
     {
         if ($this->escaped()) {
@@ -140,11 +163,14 @@ abstract class Parser
         return false;
     }
 
+    /**
+     * @return bool
+     */
     protected function escaped()
     {
         $previous = $this->lexer->getPrevious();
 
-        if ($previous['type'] === EmailLexer::S_BACKSLASH
+        if ($previous && $previous['type'] === EmailLexer::S_BACKSLASH
             &&
             $this->lexer->token['type'] !== EmailLexer::GENERIC
         ) {
@@ -154,6 +180,9 @@ abstract class Parser
         return false;
     }
 
+    /**
+     * @return bool
+     */
     protected function warnEscaping()
     {
         if ($this->lexer->token['type'] !== EmailLexer::S_BACKSLASH) {
@@ -174,6 +203,11 @@ abstract class Parser
 
     }
 
+    /**
+     * @param bool $hasClosingQuote
+     *
+     * @return bool
+     */
     protected function checkDQUOTE($hasClosingQuote)
     {
         if ($this->lexer->token['type'] !== EmailLexer::S_DQUOTE) {

EmailValidator/Validation/DNSCheckValidation.php

@@ -15,10 +15,17 @@ class DNSCheckValidation implements EmailValidation
     private $warnings = [];
 
     /**
-     * @var InvalidEmail
+     * @var InvalidEmail|null
      */
     private $error;
 
+    public function __construct()
+    {
+        if (!function_exists('idn_to_ascii')) {
+            throw new \LogicException(sprintf('The %s class requires the Intl extension.', __CLASS__));
+        }
+    }
+
     public function isValid($email, EmailLexer $emailLexer)
     {
         // use the input to check DNS if we cannot extract something similar to a domain
@@ -42,9 +49,18 @@ class DNSCheckValidation implements EmailValidation
         return $this->warnings;
     }
 
+    /**
+     * @param string $host
+     *
+     * @return bool
+     */
     protected function checkDNS($host)
     {
-        $host = rtrim($host, '.') . '.';
+        $variant = INTL_IDNA_VARIANT_2003;
+        if ( defined('INTL_IDNA_VARIANT_UTS46') ) {
+            $variant = INTL_IDNA_VARIANT_UTS46;
+        }
+        $host = rtrim(idn_to_ascii($host, IDNA_DEFAULT, $variant), '.') . '.';
 
         $Aresult = true;
         $MXresult = checkdnsrr($host, 'MX');

EmailValidator/Validation/Exception/EmptyValidationList.php

@@ -6,6 +6,9 @@ use Exception;
 
 class EmptyValidationList extends \InvalidArgumentException
 {
+    /**
+    * @param int $code
+    */
     public function __construct($code = 0, Exception $previous = null)
     {
         parent::__construct("Empty validation list is not allowed", $code, $previous);

EmailValidator/Validation/MultipleErrors.php

@@ -9,16 +9,22 @@ class MultipleErrors extends InvalidEmail
     const CODE = 999;
     const REASON = "Accumulated errors for multiple validations";
     /**
-     * @var array
+     * @var InvalidEmail[]
      */
     private $errors = [];
 
+    /**
+     * @param InvalidEmail[] $errors
+     */
     public function __construct(array $errors)
     {
         $this->errors = $errors;
         parent::__construct();
     }
 
+    /**
+     * @return InvalidEmail[]
+     */
     public function getErrors()
     {
         return $this->errors;

EmailValidator/Validation/MultipleValidationWithAnd.php

@@ -30,12 +30,12 @@ class MultipleValidationWithAnd implements EmailValidation
     private $warnings = [];
 
     /**
-     * @var MultipleErrors
+     * @var MultipleErrors|null
      */
     private $error;
 
     /**
-     * @var bool
+     * @var int
      */
     private $mode;
 
@@ -62,7 +62,8 @@ class MultipleValidationWithAnd implements EmailValidation
         $errors = [];
         foreach ($this->validations as $validation) {
             $emailLexer->reset();
-            $result = $result && $validation->isValid($email, $emailLexer);
+            $validationResult = $validation->isValid($email, $emailLexer);
+            $result = $result && $validationResult;
             $this->warnings = array_merge($this->warnings, $validation->getWarnings());
             $errors = $this->addNewError($validation->getError(), $errors);
 
@@ -78,6 +79,12 @@ class MultipleValidationWithAnd implements EmailValidation
         return $result;
     }
 
+    /**
+     * @param \Egulias\EmailValidator\Exception\InvalidEmail|null $possibleError
+     * @param \Egulias\EmailValidator\Exception\InvalidEmail[] $errors
+     *
+     * @return \Egulias\EmailValidator\Exception\InvalidEmail[]
+     */
     private function addNewError($possibleError, array $errors)
     {
         if (null !== $possibleError) {
@@ -87,13 +94,20 @@ class MultipleValidationWithAnd implements EmailValidation
         return $errors;
     }
 
+    /**
+     * @param bool $result
+     *
+     * @return bool
+     */
     private function shouldStop($result)
     {
         return !$result && $this->mode === self::STOP_ON_ERROR;
     }
 
     /**
-     * {@inheritdoc}
+     * Returns the validation errors.
+     *
+     * @return MultipleErrors|null
      */
     public function getError()
     {

EmailValidator/Validation/NoRFCWarningsValidation.php

@@ -9,7 +9,7 @@ use Egulias\EmailValidator\Validation\Error\RFCWarnings;
 class NoRFCWarningsValidation extends RFCValidation
 {
     /**
-     * @var InvalidEmail
+     * @var InvalidEmail|null
      */
     private $error;
 

EmailValidator/Validation/RFCValidation.php

@@ -9,7 +9,7 @@ use Egulias\EmailValidator\Exception\InvalidEmail;
 class RFCValidation implements EmailValidation
 {
     /**
-     * @var EmailParser
+     * @var EmailParser|null
      */
     private $parser;
 
@@ -19,7 +19,7 @@ class RFCValidation implements EmailValidation
     private $warnings = [];
 
     /**
-     * @var InvalidEmail
+     * @var InvalidEmail|null
      */
     private $error;
 

EmailValidator/Validation/SpoofCheckValidation.php

@@ -10,17 +10,20 @@ use \Spoofchecker;
 class SpoofCheckValidation implements EmailValidation
 {
     /**
-     * @var InvalidEmail
+     * @var InvalidEmail|null
      */
     private $error;
-    
+
     public function __construct()
     {
-        if (!class_exists(Spoofchecker::class)) {
+        if (!extension_loaded('intl')) {
             throw new \LogicException(sprintf('The %s class requires the Intl extension.', __CLASS__));
         }
     }
 
+    /**
+     * @psalm-suppress InvalidArgument
+     */
     public function isValid($email, EmailLexer $emailLexer)
     {
         $checker = new Spoofchecker();
@@ -33,6 +36,9 @@ class SpoofCheckValidation implements EmailValidation
         return $this->error === null;
     }
 
+    /**
+     * @return InvalidEmail|null
+     */
     public function getError()
     {
         return $this->error;

EmailValidator/Warning/QuotedPart.php

@@ -6,6 +6,10 @@ class QuotedPart extends Warning
 {
     const CODE = 36;
 
+    /**
+     * @param scalar $prevToken
+     * @param scalar $postToken
+     */
     public function __construct($prevToken, $postToken)
     {
         $this->message = "Deprecated Quoted String found between $prevToken and $postToken";

EmailValidator/Warning/QuotedString.php

@@ -6,6 +6,10 @@ class QuotedString extends Warning
 {
     const CODE = 11;
 
+    /**
+     * @param scalar $prevToken
+     * @param scalar $postToken
+     */
     public function __construct($prevToken, $postToken)
     {
         $this->message = "Quoted String found between $prevToken and $postToken";

EmailValidator/Warning/Warning.php

@@ -5,19 +5,36 @@ namespace Egulias\EmailValidator\Warning;
 abstract class Warning
 {
     const CODE = 0;
-    protected $message;
-    protected $rfcNumber;
 
+    /**
+     * @var string
+     */
+    protected $message = '';
+
+    /**
+     * @var int
+     */
+    protected $rfcNumber = 0;
+
+    /**
+     * @return string
+     */
     public function message()
     {
         return $this->message;
     }
 
+    /**
+     * @return int
+     */
     public function code()
     {
         return self::CODE;
     }
 
+    /**
+     * @return int
+     */
     public function RFCNumber()
     {
         return $this->rfcNumber;

README.md

@@ -1,19 +1,22 @@
 # EmailValidator
-[![Build Status](https://travis-ci.org/egulias/EmailValidator.png?branch=master)](https://travis-ci.org/egulias/EmailValidator) [![Coverage Status](https://coveralls.io/repos/egulias/EmailValidator/badge.png?branch=master)](https://coveralls.io/r/egulias/EmailValidator?branch=master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/egulias/EmailValidator/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/egulias/EmailValidator/?branch=master) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/22ba6692-9c02-42e5-a65d-1c5696bfffc6/small.png)](https://insight.sensiolabs.com/projects/22ba6692-9c02-42e5-a65d-1c5696bfffc6)
+[![Build Status](https://travis-ci.org/egulias/EmailValidator.svg?branch=master)](https://travis-ci.org/egulias/EmailValidator) [![Coverage Status](https://coveralls.io/repos/egulias/EmailValidator/badge.svg?branch=master)](https://coveralls.io/r/egulias/EmailValidator?branch=master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/egulias/EmailValidator/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/egulias/EmailValidator/?branch=master) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/22ba6692-9c02-42e5-a65d-1c5696bfffc6/small.png)](https://insight.sensiolabs.com/projects/22ba6692-9c02-42e5-a65d-1c5696bfffc6)
 =============================
-With the help of [PHPStorm](https://www.jetbrains.com/phpstorm/)
+## Suported RFCs ##
+This library aims to support:
+
+RFC 5321, 5322, 6530, 6531, 6532.
 
 ## Requirements ##
 
  * [Composer](https://getcomposer.org) is required for installation
- * [Spoofchecking](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/SpoofCheckValidation.php) validation requires that your PHP system have the [PHP Internationalization Libraries](http://php.net/manual/en/book.intl.php) (also known as PHP Intl)
+ * [Spoofchecking](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/SpoofCheckValidation.php) and [DNSCheckValidation](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/DNSCheckValidation.php) validation requires that your PHP system has the [PHP Internationalization Libraries](https://php.net/manual/en/book.intl.php) (also known as PHP Intl)
 
 ## Installation ##
 
 Run the command below to install via Composer
 
 ```shell
-composer require egulias/email-validator "~2.1"
+composer require egulias/email-validator
 ```
 
 ## Getting Started ##
@@ -62,7 +65,7 @@ $validator->isValid("example@example.com", $multipleValidations); //true
 
 ### How to extend ###
 
-It's easy! You just need to extend [EmailValidation](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/EmailValidation.php) and you can use your own validation.
+It's easy! You just need to implement [EmailValidation](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/EmailValidation.php) and you can use your own validation.
 
 
 ## Other Contributors ##
@@ -70,9 +73,9 @@ It's easy! You just need to extend [EmailValidation](https://github.com/egulias/
 
 As this is a port from another library and work, here are other people related to the previous one:
 
-* Ricard Clau [@ricardclau](http://github.com/ricardclau):      	Performance against PHP built-in filter_var
-* Josepf Bielawski [@stloyd](http://github.com/stloyd):      		For its first re-work of Dominic's lib
-* Dominic Sayers [@dominicsayers](http://github.com/dominicsayers):  	The original isemail function
+* Ricard Clau [@ricardclau](https://github.com/ricardclau):      	Performance against PHP built-in filter_var
+* Josepf Bielawski [@stloyd](https://github.com/stloyd):      		For its first re-work of Dominic's lib
+* Dominic Sayers [@dominicsayers](https://github.com/dominicsayers):  	The original isemail function
 
 ## License ##
 Released under the MIT License attached with this code.

Tests/EmailValidator/EmailValidatorTest.php

@@ -3,6 +3,7 @@
 namespace Egulias\Tests\EmailValidator;
 
 use Egulias\EmailValidator\EmailValidator;
+use Egulias\EmailValidator\Validation\EmailValidation;
 use Egulias\EmailValidator\Validation\MultipleValidationWithAnd;
 use PHPUnit\Framework\TestCase;
 
@@ -11,7 +12,7 @@ class EmailValidatorTest extends TestCase
     public function testValidationIsUsed()
     {
         $validator = new EmailValidator();
-        $validation = $this->getMockBuilder("Egulias\\EmailValidator\\Validation\\EmailValidation")->getMock();
+        $validation = $this->getMockBuilder(EmailValidation::class)->getMock();
         $validation->expects($this->once())->method("isValid")->willReturn(true);
         $validation->expects($this->once())->method("getWarnings")->willReturn([]);
         $validation->expects($this->once())->method("getError")->willReturn(null);
@@ -22,7 +23,7 @@ class EmailValidatorTest extends TestCase
     public function testMultipleValidation()
     {
         $validator = new EmailValidator();
-        $validation = $this->getMockBuilder("Egulias\\EmailValidator\\Validation\\EmailValidation")->getMock();
+        $validation = $this->getMockBuilder(EmailValidation::class)->getMock();
         $validation->expects($this->once())->method("isValid")->willReturn(true);
         $validation->expects($this->once())->method("getWarnings")->willReturn([]);
         $validation->expects($this->once())->method("getError")->willReturn(null);

Tests/EmailValidator/Validation/DNSCheckValidationTest.php

@@ -24,6 +24,9 @@ class DNSCheckValidationTest extends TestCase
             ['"Abc@def"@example.com'],
             ['"Fred\ Bloggs"@example.com'],
             ['"Joe.\\Blow"@example.com'],
+            
+            // unicide
+            ['ñandu.cl'],
         ];
     }
 

Tests/EmailValidator/Validation/IsEmailFunctionTests.php

@@ -6,7 +6,6 @@ use Egulias\EmailValidator\EmailValidator;
 use Egulias\EmailValidator\Validation\DNSCheckValidation;
 use Egulias\EmailValidator\Validation\MultipleValidationWithAnd;
 use Egulias\EmailValidator\Validation\NoRFCWarningsValidation;
-use Egulias\EmailValidator\Validation\RFCValidation;
 use PHPUnit\Framework\TestCase;
 
 class IsEmailFunctionTests extends TestCase

Tests/EmailValidator/Validation/MultipleValidationWithAndTest.php

@@ -2,23 +2,26 @@
 
 namespace Egulias\Tests\EmailValidator\Validation;
 
+use Egulias\EmailValidator\EmailLexer;
 use Egulias\EmailValidator\Exception\CommaInDomain;
 use Egulias\EmailValidator\Exception\NoDomainPart;
+use Egulias\EmailValidator\Validation\EmailValidation;
 use Egulias\EmailValidator\Validation\MultipleErrors;
 use Egulias\EmailValidator\Validation\MultipleValidationWithAnd;
+use Egulias\EmailValidator\Validation\RFCValidation;
 use Egulias\EmailValidator\Warning\AddressLiteral;
 use Egulias\EmailValidator\Warning\DomainLiteral;
 use PHPUnit\Framework\TestCase;
 
-class MultipleValidationWitAndTest extends TestCase
+class MultipleValidationWithAndTest extends TestCase
 {
     public function testUsesAndLogicalOperation()
     {
-        $lexer = $this->getMockBuilder("Egulias\\EmailValidator\\EmailLexer")->getMock();
+        $lexer = new EmailLexer();
         $validationTrue = $this->getMockBuilder("Egulias\\EmailValidator\\Validation\\EmailValidation")->getMock();
         $validationTrue->expects($this->any())->method("isValid")->willReturn(true);
         $validationTrue->expects($this->any())->method("getWarnings")->willReturn([]);
-        $validationFalse = $this->getMockBuilder("Egulias\\EmailValidator\\Validation\\EmailValidation")->getMock();
+        $validationFalse = $this->getMockBuilder(EmailValidation::class)->getMock();
         $validationFalse->expects($this->any())->method("isValid")->willReturn(false);
         $validationFalse->expects($this->any())->method("getWarnings")->willReturn([]);
         $multipleValidation = new MultipleValidationWithAnd([$validationTrue, $validationFalse]);
@@ -35,9 +38,9 @@ class MultipleValidationWitAndTest extends TestCase
 
     public function testValidationIsValid()
     {
-        $lexer = $this->getMockBuilder("Egulias\\EmailValidator\\EmailLexer")->getMock();
+        $lexer = new EmailLexer();
 
-        $validation = $this->getMockBuilder("Egulias\\EmailValidator\\Validation\\EmailValidation")->getMock();
+        $validation = $this->getMockBuilder(EmailValidation::class)->getMock();
         $validation->expects($this->any())->method("isValid")->willReturn(true);
         $validation->expects($this->once())->method("getWarnings")->willReturn([]);
 
@@ -56,12 +59,12 @@ class MultipleValidationWitAndTest extends TestCase
         ];
         $expectedResult = array_merge($warnings1, $warnings2);
 
-        $lexer = $this->getMockBuilder("Egulias\\EmailValidator\\EmailLexer")->getMock();
+        $lexer = new EmailLexer();
         $validation1 = $this->getMockBuilder("Egulias\\EmailValidator\\Validation\\EmailValidation")->getMock();
         $validation1->expects($this->any())->method("isValid")->willReturn(true);
         $validation1->expects($this->once())->method("getWarnings")->willReturn($warnings1);
 
-        $validation2 = $this->getMockBuilder("Egulias\\EmailValidator\\Validation\\EmailValidation")->getMock();
+        $validation2 = $this->getMockBuilder(EmailValidation::class)->getMock();
 
         $validation2->expects($this->any())->method("isValid")->willReturn(false);
         $validation2->expects($this->once())->method("getWarnings")->willReturn($warnings2);
@@ -78,15 +81,15 @@ class MultipleValidationWitAndTest extends TestCase
 
         $expectedResult = new MultipleErrors([$error1, $error2]);
 
-        $lexer = $this->getMockBuilder("Egulias\\EmailValidator\\EmailLexer")->getMock();
+        $lexer = new EmailLexer();
 
-        $validation1 = $this->getMockBuilder("Egulias\\EmailValidator\\Validation\\EmailValidation")->getMock();
-        $validation1->expects($this->any())->method("isValid")->willReturn(true);
+        $validation1 = $this->getMockBuilder(EmailValidation::class)->getMock();
+        $validation1->expects($this->once())->method("isValid")->willReturn(false);
         $validation1->expects($this->once())->method("getWarnings")->willReturn([]);
         $validation1->expects($this->once())->method("getError")->willReturn($error1);
 
-        $validation2 = $this->getMockBuilder("Egulias\\EmailValidator\\Validation\\EmailValidation")->getMock();
-        $validation2->expects($this->any())->method("isValid")->willReturn(false);
+        $validation2 = $this->getMockBuilder(EmailValidation::class)->getMock();
+        $validation2->expects($this->once())->method("isValid")->willReturn(false);
         $validation2->expects($this->once())->method("getWarnings")->willReturn([]);
         $validation2->expects($this->once())->method("getError")->willReturn($error2);
 
@@ -95,20 +98,44 @@ class MultipleValidationWitAndTest extends TestCase
         $this->assertEquals($expectedResult, $multipleValidation->getError());
     }
 
+    public function testStopsAfterFirstError()
+    {
+        $error1 = new CommaInDomain();
+        $error2 = new NoDomainPart();
+
+        $expectedResult = new MultipleErrors([$error1]);
+
+        $lexer = new EmailLexer();
+
+        $validation1 = $this->getMockBuilder(EmailValidation::class)->getMock();
+        $validation1->expects($this->any())->method("isValid")->willReturn(false);
+        $validation1->expects($this->once())->method("getWarnings")->willReturn([]);
+        $validation1->expects($this->once())->method("getError")->willReturn($error1);
+
+        $validation2 = $this->getMockBuilder(EmailValidation::class)->getMock();
+        $validation2->expects($this->any())->method("isValid")->willReturn(false);
+        $validation2->expects($this->never())->method("getWarnings")->willReturn([]);
+        $validation2->expects($this->never())->method("getError")->willReturn($error2);
+
+        $multipleValidation = new MultipleValidationWithAnd([$validation1, $validation2], MultipleValidationWithAnd::STOP_ON_ERROR);
+        $multipleValidation->isValid("example@example.com", $lexer);
+        $this->assertEquals($expectedResult, $multipleValidation->getError());
+    }
+
     public function testBreakOutOfLoopWhenError()
     {
         $error = new CommaInDomain();
 
         $expectedResult = new MultipleErrors([$error]);
 
-        $lexer = $this->getMockBuilder("Egulias\\EmailValidator\\EmailLexer")->getMock();
+        $lexer = new EmailLexer();
 
-        $validation1 = $this->getMockBuilder("Egulias\\EmailValidator\\Validation\\EmailValidation")->getMock();
+        $validation1 = $this->getMockBuilder(EmailValidation::class)->getMock();
         $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->getMockBuilder("Egulias\\EmailValidator\\Validation\\EmailValidation")->getMock();
+        $validation2 = $this->getMockBuilder(EmailValidation::class)->getMock();
         $validation2->expects($this->never())->method("isValid");
         $validation2->expects($this->never())->method("getWarnings");
         $validation2->expects($this->never())->method("getError");
@@ -117,4 +144,16 @@ class MultipleValidationWitAndTest extends TestCase
         $multipleValidation->isValid("example@example.com", $lexer);
         $this->assertEquals($expectedResult, $multipleValidation->getError());
     }
+
+    public function testBreakoutOnInvalidEmail()
+    {
+        $lexer = new EmailLexer();
+
+        $validationNotCalled = $this->getMockBuilder(EmailValidation::class)->getMock();
+        $validationNotCalled->expects($this->never())->method("isValid");
+        $validationNotCalled->expects($this->never())->method("getWarnings");
+        $validationNotCalled->expects($this->never())->method("getError");
+        $multipleValidation = new MultipleValidationWithAnd([new RFCValidation(), $validationNotCalled], MultipleValidationWithAnd::STOP_ON_ERROR);
+        $this->assertFalse($multipleValidation->isValid("invalid-email", $lexer));
+    }
 }

Tests/EmailValidator/Validation/RFCValidationTest.php

@@ -166,6 +166,7 @@ class RFCValidationTest extends TestCase
             ['test@email>'],
             ['test@email<'],
             ['test@email{'],
+            ['test@ '],
         ];
     }
 
@@ -220,13 +221,13 @@ class RFCValidationTest extends TestCase
     {
         $this->assertTrue($this->validator->isValid($email, $this->lexer));
         $warnings = $this->validator->getWarnings();
-        $this->assertTrue(
-            count($warnings) === count($expectedWarnings),
+        $this->assertCount(
+            count($warnings), $expectedWarnings,
             "Expected: " . implode(",", $expectedWarnings) . " and got " . implode(",", $warnings)
         );
 
         foreach ($warnings as $warning) {
-            $this->assertTrue(isset($expectedWarnings[$warning->code()]));
+            $this->assertArrayHasKey($warning->code(), $expectedWarnings);
         }
     }
 

composer.json

@@ -2,7 +2,6 @@
   "name":         "egulias/email-validator",
   "description":  "A library for validating emails against several RFCs",
   "homepage":     "https://github.com/egulias/EmailValidator",
-  "type":         "Library",
   "keywords":     ["email", "validation", "validator", "emailvalidation", "emailvalidator"],
   "license":      "MIT",
   "authors": [
@@ -10,23 +9,18 @@
   ],
   "extra": {
     "branch-alias": {
-      "dev-master": "2.0.x-dev"
+      "dev-master": "2.1.x-dev"
     }
   },
-  "repositories": [
-    {
-      "type": "git",
-      "url": "https://github.com/dominicsayers/isemail"
-    }
-  ],
-  "require":      {
-    "php": ">= 5.5",
-    "doctrine/lexer": "^1.0.1"
+  "require": {
+    "php": ">=5.5",
+    "doctrine/lexer": "^1.0.1",
+    "symfony/polyfill-intl-idn": "^1.10"
   },
-  "require-dev" :   {
+  "require-dev": {
     "satooshi/php-coveralls": "^1.0.1",
-    "phpunit/phpunit": "^4.8.35",
-    "dominicsayers/isemail": "dev-master"
+    "phpunit/phpunit": "^4.8.36|^7.5.15",
+    "dominicsayers/isemail": "^3.0.7"
   },
   "suggest": {
     "ext-intl": "PHP Internationalization Libraries are required to use the SpoofChecking validation"
@@ -35,5 +29,10 @@
     "psr-4": {
       "Egulias\\EmailValidator\\": "EmailValidator"
     }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Egulias\\Tests\\": "Tests"
+    }
   }
 }

documentation/Other.md

@@ -1,23 +1,23 @@
 Email length
 ------------
-http://tools.ietf.org/html/rfc5321#section-4.1.2
+https://tools.ietf.org/html/rfc5321#section-4.1.2
   Forward-path   = Path
 
   Path           = "<" [ A-d-l ":" ] Mailbox ">"
 
-http://tools.ietf.org/html/rfc5321#section-4.5.3.1.3
-http://tools.ietf.org/html/rfc1035#section-2.3.4
+https://tools.ietf.org/html/rfc5321#section-4.5.3.1.3
+https://tools.ietf.org/html/rfc1035#section-2.3.4
 
 DNS
 ---
 
-http://tools.ietf.org/html/rfc5321#section-2.3.5
+https://tools.ietf.org/html/rfc5321#section-2.3.5
   Names that can
   be resolved to MX RRs or address (i.e., A or AAAA) RRs (as discussed
   in Section 5) are permitted, as are CNAME RRs whose targets can be
   resolved, in turn, to MX or address RRs.
 
-http://tools.ietf.org/html/rfc5321#section-5.1
+https://tools.ietf.org/html/rfc5321#section-5.1
   The lookup first attempts to locate an MX record associated with the
   name.  If a CNAME record is found, the resulting name is processed as
   if it were the initial name. ... If an empty list of MXs is returned,
@@ -37,7 +37,7 @@ status to these addresses on the basis that they are more likely
 to be typos than genuine addresses (unless we've already
 established that the domain does have an MX record)
 
-http://tools.ietf.org/html/rfc5321#section-2.3.5
+https://tools.ietf.org/html/rfc5321#section-2.3.5
   In the case
   of a top-level domain used by itself in an email address, a single
   string is used without any dots.  This makes the requirement,
@@ -57,7 +57,7 @@ an ambiguity. The most authoritative statement on TLD formats that
 the author can find is in a (rejected!) erratum to RFC 1123
 submitted by John Klensin, the author of RFC 5321:
 
-http://www.rfc-editor.org/errata_search.php?rfc=1123&eid=1353
+https://www.rfc-editor.org/errata_search.php?rfc=1123&eid=1353
   However, a valid host name can never have the dotted-decimal
   form #.#.#.#, since this change does not permit the highest-level
   component label to start with a digit even if it is not all-numeric.
@@ -66,4 +66,4 @@ Comments
 --------
 Comments at the start of the domain are deprecated in the text
 Comments at the start of a subdomain are obs-domain
-(http://tools.ietf.org/html/rfc5322#section-3.4.1)
+(https://tools.ietf.org/html/rfc5322#section-3.4.1)

phpunit.xml.dist

@@ -8,7 +8,6 @@
          convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
-         syntaxCheck="false"
          bootstrap="vendor/autoload.php"
 >
 <testsuites>
@@ -19,8 +18,8 @@
 </testsuites>
 
 <filter>
-  <blacklist>
-    <directory>./vendor</directory>
-  </blacklist>
+  <whitelist>
+    <directory>./EmailValidator/</directory>
+  </whitelist>
 </filter>
 </phpunit>

psalm.baseline.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<files psalm-version="3.8.3@389af1bfc739bfdff3f9e3dc7bd6499aee51a831">
+  <file src="EmailValidator/EmailLexer.php">
+    <DocblockTypeContradiction occurrences="1">
+      <code>self::$nullToken</code>
+    </DocblockTypeContradiction>
+  </file>
+  <file src="EmailValidator/Parser/Parser.php">
+    <MissingReturnType occurrences="1">
+      <code>parse</code>
+    </MissingReturnType>
+  </file>
+  <file src="EmailValidator/Validation/SpoofCheckValidation.php">
+    <UndefinedClass occurrences="2">
+      <code>Spoofchecker</code>
+      <code>Spoofchecker</code>
+    </UndefinedClass>
+  </file>
+</files>

psalm.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<psalm
+    requireVoidReturnType="false"
+    totallyTyped="false"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config ./vendor/vimeo/psalm/config.xsd"
+    errorBaseline="./psalm.baseline.xml"
+>
+    <projectFiles>
+        <directory name="EmailValidator" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+
+    <issueHandlers>
+    </issueHandlers>
+</psalm>