Update .gitignore (#224)

* Fixes

* Backport PHP 7.4 support from 2.x

Co-Authored-By: mlocati <michele@locati.it>

* Added php-coveralls

Co-authored-by: Michele Locati <michele@locati.it>

.gitignore

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

.scrutinizer.yml

@@ -0,0 +1,8 @@
+filter:
+  excluded_paths:
+    - 'documentation/*'
+    - 'tests/*'
+
+tools:
+    external_code_coverage:
+        runs: 1

.travis.yml

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

composer.json

@@ -2,27 +2,25 @@
   "name":         "egulias/email-validator",
   "description":  "A library for validating emails",
   "homepage":     "https://github.com/egulias/EmailValidator",
-  "type":         "Library",
   "keywords":     ["email", "validation", "validator", "emailvalidation", "emailvalidator"],
   "license":      "MIT",
   "authors": [
     {"name": "Eduardo Gulias Davis"}
   ],
-  "extra": {
+  "require": {
-    "branch-alias": {
+    "php": ">=5.3.3",
-      "dev-master": "2.0.x-dev"
-    }
-  },
-  "require":      {
-    "php": ">= 5.3.3",
     "doctrine/lexer": "^1.0.1"
   },
-  "require-dev" :   {
+  "require-dev": {
-    "phpunit/phpunit": "^4.8.24"
+    "satooshi/php-coveralls": "^1.0.1",
+    "phpunit/phpunit": "^4.8.36|^7.5.15"
   },
   "autoload": {
     "psr-0": {
       "Egulias\\": "src/"
     }
+  },
+  "scripts": {
+    "test": "phpunit"
   }
 }

phpunit.xml.dist

@@ -8,7 +8,6 @@
          convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
-         syntaxCheck="false"
          bootstrap="tests/bootstrap.php"
 >
 <testsuites>

src/Egulias/EmailValidator/EmailLexer.php

@@ -77,10 +77,22 @@ class EmailLexer extends AbstractLexer
 
     protected $previous;
 
+    private static $nullToken = array(
+        'value' => '',
+        'type' => null,
+        'position' => 0,
+    );
+
+    public function __construct()
+    {
+        $this->previous = $this->token = self::$nullToken;
+    }
+
     public function reset()
     {
         $this->hasInvalidTokens = false;
         parent::reset();
+        $this->previous = $this->token = self::$nullToken;
     }
 
     public function hasInvalidTokens()
@@ -122,8 +134,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;
     }
 
     /**

src/Egulias/EmailValidator/EmailValidator.php

@@ -7,7 +7,7 @@ namespace Egulias\EmailValidator;
  *
  * @author Eduardo Gulias Davis <me@egulias.com>
  */
-class EmailValidator
+class EmailValidator implements EmailValidatorInterface
 {
     /**
      * Critical validation errors used to indicate that
@@ -113,26 +113,7 @@ class EmailValidator
     }
 
     /**
-     * Validates an email address against the following standards:
+     * {@inheritdoc}
-     *
-     * RFC-5321: Simple Mail Transfer Protocol
-     * RFC-5322: Internet Message Format
-     * RFC-6530: Overview and Framework for Internationalized Email
-     * RFC-6531: SMTP Extension for Internationalized Email
-     * RFC-6532: Internationalized Email Headers
-     * RFC-1123 section 2.1: Requirements for Internet Hosts -- Application and Support
-     * RFC-4291 section 2.2: IP Version 6 Addressing Architecture
-     *
-     * @param string $email    The email address to validate.
-     * @param bool   $checkDNS Whether or not the email address's hostname should
-     *                         be confirmed with a DNS lookup. This only comes
-     *                         into play if strict mode is also enabled.
-     * @param bool   $strict   If this is true, and any informational warnings
-     *                         were raised during validation, the email address
-     *                         will be considered invalid. Additionally, if
-     *                         $checkDNS is true and the DNS lookup failed,
-     *                         the email address will be considered invalid.
-     * @return bool
      */
     public function isValid($email, $checkDNS = false, $strict = false)
     {
@@ -152,11 +133,11 @@ class EmailValidator
             return false;
         }
 
-        return ($strict ? (!$this->hasWarnings() && !$dnsProblemExists) : true);
+        return !($dnsProblemExists || $strict && $this->hasWarnings());
     }
 
     /**
-     * @return boolean
+     * {@inheritdoc}
      */
     public function hasWarnings()
     {
@@ -164,7 +145,7 @@ class EmailValidator
     }
 
     /**
-     * @return array
+     * {@inheritdoc}
      */
     public function getWarnings()
     {
@@ -172,7 +153,7 @@ class EmailValidator
     }
 
     /**
-     * @return string
+     * {@inheritdoc}
      */
     public function getError()
     {
@@ -180,9 +161,7 @@ class EmailValidator
     }
 
     /**
-     * @param int $threshold
+     * {@inheritdoc}
-     *
-     * @return EmailValidator
      */
     public function setThreshold($threshold)
     {
@@ -192,7 +171,7 @@ class EmailValidator
     }
 
     /**
-     * @return int
+     * {@inheritdoc}
      */
     public function getThreshold()
     {
@@ -205,7 +184,10 @@ class EmailValidator
      */
     protected function checkDNS()
     {
-        $mxRecordExists = checkdnsrr(trim($this->parser->getParsedDomainPart()), 'MX');
+        $host = $this->parser->getParsedDomainPart();
+        $host = rtrim($host, '.') . '.';
+
+        $mxRecordExists = checkdnsrr($host, 'MX');
 
         if (!$mxRecordExists) {
             $this->warnings[] = self::DNSWARN_NO_RECORD;

src/Egulias/EmailValidator/EmailValidatorInterface.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Egulias\EmailValidator;
+
+/**
+ * EmailValidatorInterface
+ *
+ * @author Chris McCafferty <cilefen@gmail.com>
+ */
+interface EmailValidatorInterface
+{
+    /**
+     * Validates an email address against the following standards:
+     *
+     * RFC-5321: Simple Mail Transfer Protocol
+     * RFC-5322: Internet Message Format
+     * RFC-6530: Overview and Framework for Internationalized Email
+     * RFC-6531: SMTP Extension for Internationalized Email
+     * RFC-6532: Internationalized Email Headers
+     * RFC-1123 section 2.1: Requirements for Internet Hosts -- Application and Support
+     * RFC-4291 section 2.2: IP Version 6 Addressing Architecture
+     *
+     * @param string $email    The email address to validate.
+     * @param bool   $checkDNS Whether or not the email address's hostname should
+     *                         be confirmed with a DNS lookup. This only comes
+     *                         into play if strict mode is also enabled.
+     * @param bool   $strict   If this is true, and any informational warnings
+     *                         were raised during validation, the email address
+     *                         will be considered invalid. Additionally, if
+     *                         $checkDNS is true and the DNS lookup failed,
+     *                         the email address will be considered invalid.
+     * @return bool
+     */
+    public function isValid($email, $checkDNS = false, $strict = false);
+
+    /**
+     * @return bool
+     */
+    public function hasWarnings();
+
+    /**
+     * @return array
+     */
+    public function getWarnings();
+
+    /**
+     * @return string
+     */
+    public function getError();
+
+    /**
+     * @param int $threshold The acceptable number of deprecation warnings.
+     *
+     * @return EmailValidator
+     */
+    public function setThreshold($threshold);
+
+    /**
+     * @return int
+     */
+    public function getThreshold();
+}

src/Egulias/EmailValidator/Parser/DomainPart.php

@@ -141,7 +141,7 @@ class DomainPart extends Parser
 
             $domain .= $this->lexer->token['value'];
             $this->lexer->moveNext();
-        } while ($this->lexer->token);
+        } while (null !== $this->lexer->token['type']);
 
         return $domain;
     }

src/Egulias/EmailValidator/Parser/LocalPart.php

@@ -13,9 +13,12 @@ class LocalPart extends Parser
         $closingQuote = false;
         $openedParenthesis = 0;
 
-        while ($this->lexer->token['type'] !== EmailLexer::S_AT && $this->lexer->token) {
+        while ($this->lexer->token['type'] !== EmailLexer::S_AT && null !== $this->lexer->token['type']) {
-            if ($this->lexer->token['type'] === EmailLexer::S_DOT && !$this->lexer->getPrevious()) {
+            if ($this->lexer->token['type'] === EmailLexer::S_DOT) {
-                throw new \InvalidArgumentException('ERR_DOT_START');
+                $previous = $this->lexer->getPrevious();
+                if (null === $previous['type']) {
+                    throw new \InvalidArgumentException('ERR_DOT_START');
+                }
             }
 
             $closingQuote = $this->checkDQUOTE($closingQuote);
@@ -78,7 +81,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[] = EmailValidator::CFWS_FWS;

tests/egulias/Tests/EmailValidator/EmailLexerTest.php

@@ -3,8 +3,9 @@
 namespace Egulias\EmailValidator\Tests;
 
 use Egulias\EmailValidator\EmailLexer;
+use PHPUnit\Framework\TestCase;
 
-class EmailLexerTests extends \PHPUnit_Framework_TestCase
+class EmailLexerTests extends TestCase
 {
 
     public function testLexerExtendsLib()

tests/egulias/Tests/EmailValidator/EmailValidatorTest.php

@@ -3,8 +3,9 @@
 namespace Egulias\Tests\EmailValidator;
 
 use Egulias\EmailValidator\EmailValidator;
+use PHPUnit\Framework\TestCase;
 
-class EmailValidatorTest extends \PHPUnit_Framework_TestCase
+class EmailValidatorTest extends TestCase
 {
     protected $validator;
 
@@ -180,7 +181,7 @@ class EmailValidatorTest extends \PHPUnit_Framework_TestCase
      */
     public function testValidEmailsWithWarningsCheck($warnings, $email)
     {
-        $this->assertTrue($this->validator->isValid($email, true));
+        $this->assertFalse($this->validator->isValid($email, true));
 
         $this->assertEquals($warnings, $this->validator->getWarnings());
     }