Cleanup

* Fixes issue for email addresses with single quote in domain part
* specify version in cli for older php versions

Co-authored-by: Eduardo Gulias Davis <eduardomgulias@gmail.com>

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# Thanks!
+
+github: [egulias]

.gitignore

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

.travis.yml

@@ -31,7 +31,7 @@ matrix:
 
 install:
   - if [ "$deps" = "low" ]; then composer update --prefer-lowest; else composer install; fi
-  - if [ "$psalm" = "yes" ]; then composer require --dev vimeo/psalm; fi
+  - if [ "$psalm" = "yes" ]; then composer require --dev vimeo/psalm:3.18.2; fi
 
 before_script:
   - mkdir -p build/logs
@@ -42,3 +42,4 @@ script:
 
 after_script:
   - php vendor/bin/coveralls
+  

README.md

@@ -42,16 +42,14 @@ $validator->isValid("example@example.com", new RFCValidation()); //true
 
 ### Available validations ###
 
-1. [RFCValidation](/src/Validation/RFCValidation.php)
+1. [RFCValidation](/src/Validation/RFCValidation.php): Standard RFC-like email validation.
-2. [NoRFCWarningsValidation](/src/Validation/NoRFCWarningsValidation.php)
+2. [NoRFCWarningsValidation](/src/Validation/NoRFCWarningsValidation.php): RFC-like validation that will fail when warnings* are found.
-3. [DNSCheckValidation](/src/Validation/DNSCheckValidation.php)
+3. [DNSCheckValidation](/src/Validation/DNSCheckValidation.php): Will check if there are DNS records that signal that the server accepts emails. This does not entails that the email exists.
-4. [SpoofCheckValidation](/src/Validation/SpoofCheckValidation.php)
+4. [SpoofCheckValidation](/src/Validation/SpoofCheckValidation.php): Will check for multi-utf-8 chars that can signal an erroneous email name.
-5. [MultipleValidationWithAnd](/src/Validation/MultipleValidationWithAnd.php)
+5. [MultipleValidationWithAnd](/src/Validation/MultipleValidationWithAnd.php): It is a validation that operates over other validations performing a logical and (&&) over the result of each validation.
-6. [Your own validation](#how-to-extend)
+6. [Your own validation](#how-to-extend): You can extend the library behaviour by implementing your own validations.
 
-`MultipleValidationWithAnd`
+*warnings: Warnings are deviations from the RFC that in a broader interpretation are acceptded.
-
-It is a validation that operates over other validations performing a logical and (&&) over the result of each validation.
 
 ```php
 <?php
@@ -66,7 +64,8 @@ $multipleValidations = new MultipleValidationWithAnd([
     new RFCValidation(),
     new DNSCheckValidation()
 ]);
-$validator->isValid("example@example.com", $multipleValidations); //true
+//ietf.org has MX records signaling a server with email capabilites
+$validator->isValid("example@ietf.org", $multipleValidations); //true
 ```
 
 ### How to extend ###

src/EmailLexer.php

@@ -13,6 +13,8 @@ class EmailLexer extends AbstractLexer
     const S_BACKSLASH        = 92;
     const S_DOT              = 46;
     const S_DQUOTE           = 34;
+    const S_SQUOTE           = 39;
+    const S_BACKTICK         = 96;
     const S_OPENPARENTHESIS  = 49;
     const S_CLOSEPARENTHESIS = 261;
     const S_OPENBRACKET      = 262;
@@ -58,6 +60,8 @@ class EmailLexer extends AbstractLexer
         '/'    => self::S_SLASH,
         ','    => self::S_COMMA,
         '.'    => self::S_DOT,
+        "'"    => self::S_SQUOTE,
+        "`"    => self::S_BACKTICK,
         '"'    => self::S_DQUOTE,
         '-'    => self::S_HYPHEN,
         '::'   => self::S_DOUBLECOLON,

src/Parser/DomainPart.php

@@ -335,6 +335,8 @@ class DomainPart extends Parser
     {
         $invalidDomainTokens = array(
             EmailLexer::S_DQUOTE => true,
+            EmailLexer::S_SQUOTE => true,
+            EmailLexer::S_BACKTICK => true,
             EmailLexer::S_SEMICOLON => true,
             EmailLexer::S_GREATERTHAN => true,
             EmailLexer::S_LOWERTHAN => true,

src/Validation/DNSCheckValidation.php

@@ -120,7 +120,7 @@ class DNSCheckValidation implements EmailValidation
 
 
         // No MX, A or AAAA DNS records
-        if (empty($dnsRecords) || !$dnsRecords) {
+        if (empty($dnsRecords)) {
             $this->error = new NoDNSRecord();
             return false;
         }

tests/EmailValidator/EmailLexerTest.php

@@ -138,6 +138,8 @@ class EmailLexerTests extends TestCase
             array(":", EmailLexer::S_COLON),
             array(".", EmailLexer::S_DOT),
             array("\"", EmailLexer::S_DQUOTE),
+            array("'", EmailLexer::S_SQUOTE),
+            array("`", EmailLexer::S_BACKTICK),
             array("-", EmailLexer::S_HYPHEN),
             array("\\", EmailLexer::S_BACKSLASH),
             array("/", EmailLexer::S_SLASH),

tests/EmailValidator/Validation/RFCValidationTest.php

@@ -168,6 +168,8 @@ class RFCValidationTest extends TestCase
             ['test@email{'],
             ['test@ '],
             ['test@example.com []'],
+            ["test@example.com'"],
+            ["test@exam`ple.com"],
         ];
     }
 
@@ -212,6 +214,7 @@ class RFCValidationTest extends TestCase
             [new CRNoLF(), "example@exa\rmple.co.uk"],
             [new CRNoLF(), "example@[\r]"],
             [new CRNoLF(), "exam\rple@example.co.uk"],
+            [new ExpectingATEXT(), "test@example.com'"],
         ];
     }