Rename to TransparentEmail

README.md

@@ -2,9 +2,9 @@
 [![Coverage Status](https://coveralls.io/repos/github/bkrukowski/gordianus/badge.svg?branch=master)](https://coveralls.io/github/bkrukowski/gordianus?branch=master)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b057fa037a3b4f318f75af27b0b01d47)](https://www.codacy.com/app/bartlomiej-krukowski/gordianus?utm_source=github.com&utm_medium=referral&utm_content=bkrukowski/gordianus&utm_campaign=Badge_Grade)
 
-# Gordianus
+# Transparent Email
 
-Gordianus clears aliases from email address. Email `John.Doe+alias@gmail.com` will be transformed to `johndoe@gmail.com`.
+Transparent Email clears aliases from email address. Email `John.Doe+alias@gmail.com` will be transformed to `johndoe@gmail.com`.
 
 ## Why?
 
@@ -21,8 +21,8 @@ To detect multi-accounts on your website.
 ## Usage
 
 ```php
-$gordianus = new \bkrukowski\Gordianus\Gordianus();
+$cleaner = new \bkrukowski\TransparentEmail\TransparentEmail();
-$transformedEmail = $gordianus->getPrimaryEmail('John.Doe+alias@gmail.com');
+$transformedEmail = $cleaner->getPrimaryEmail('John.Doe+alias@gmail.com');
 ```
 
 ## Yahoo.com

composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "bkrukowski/gordianus",
+    "name": "bkrukowski/transparent-email",
     "description": "Remove aliases from email and get primary email account",
     "type": "library",
     "require": {
@@ -19,12 +19,12 @@
     ],
     "autoload": {
         "psr-4": {
-            "bkrukowski\\Gordianus\\": "src/"
+            "bkrukowski\\TransparentEmail\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "bkrukowski\\Gordianus\\Tests\\": "tests/"
+            "bkrukowski\\TransparentEmail\\Tests\\": "tests/"
         }
     }
 }

phpunit.xml.dist

@@ -8,7 +8,7 @@
 >
 
     <testsuites>
-        <testsuite name="Gordianus Test Suite">
+        <testsuite name="TransparentEmail Test Suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>

src/InvalidEmailException.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace bkrukowski\Gordianus;
+namespace bkrukowski\TransparentEmail;
 
 class InvalidEmailException extends \Exception
 {

src/Services/GmailCom.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace bkrukowski\Gordianus\Services;
+namespace bkrukowski\TransparentEmail\Services;
 
 /**
  * @internal

src/Services/MultiDomain.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace bkrukowski\Gordianus\Services;
+namespace bkrukowski\TransparentEmail\Services;
 
 /**
  * @internal

src/Services/OutlookCom.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace bkrukowski\Gordianus\Services;
+namespace bkrukowski\TransparentEmail\Services;
 
 /**
  * @internal

src/Services/ServiceInterface.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace bkrukowski\Gordianus\Services;
+namespace bkrukowski\TransparentEmail\Services;
 
 /**
  * @internal

src/Services/TlenPl.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace bkrukowski\Gordianus\Services;
+namespace bkrukowski\TransparentEmail\Services;
 
 /**
  * @codeCoverageIgnore

src/Services/Www33MailCom.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace bkrukowski\Gordianus\Services;
+namespace bkrukowski\TransparentEmail\Services;
 
 /**
  * @internal

src/Services/YahooCom.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace bkrukowski\Gordianus\Services;
+namespace bkrukowski\TransparentEmail\Services;
 
 /**
  * @internal

src/TransparentEmail.php

@@ -1,15 +1,15 @@
 <?php
 
-namespace bkrukowski\Gordianus;
+namespace bkrukowski\TransparentEmail;
 
-use bkrukowski\Gordianus\Services\GmailCom;
+use bkrukowski\TransparentEmail\Services\GmailCom;
-use bkrukowski\Gordianus\Services\OutlookCom;
+use bkrukowski\TransparentEmail\Services\OutlookCom;
-use bkrukowski\Gordianus\Services\ServiceInterface;
+use bkrukowski\TransparentEmail\Services\ServiceInterface;
-use bkrukowski\Gordianus\Services\TlenPl;
+use bkrukowski\TransparentEmail\Services\TlenPl;
-use bkrukowski\Gordianus\Services\Www33MailCom;
+use bkrukowski\TransparentEmail\Services\Www33MailCom;
-use bkrukowski\Gordianus\Services\YahooCom;
+use bkrukowski\TransparentEmail\Services\YahooCom;
 
-class Gordianus
+class TransparentEmail
 {
     const SERVICE_GMAIL_COM = GmailCom::class;
     const SERVICE_TLEN_PL = TlenPl::class;

tests/GordianusTest.php

@@ -1,56 +0,0 @@
-<?php
-
-namespace bkrukowski\Gordianus\Tests;
-
-use bkrukowski\Gordianus\Gordianus;
-use bkrukowski\Gordianus\InvalidEmailException;
-
-class GordianusTest extends \PHPUnit_Framework_TestCase
-{
-    /**
-     * @dataProvider providerValidator
-     *
-     * @param string $email
-     * @param bool $validEmail
-     */
-    public function testValidator(string $email, bool $validEmail)
-    {
-        if (!$validEmail) {
-            $this->expectException(InvalidEmailException::class);
-        }
-        (new Gordianus())->getPrimaryEmail($email);
-    }
-
-    public function providerValidator()
-    {
-        return [
-            ['john.doe@gmail.comm', true],
-            ['john doe@gmail.com', false],
-        ];
-    }
-
-    /**
-     * @dataProvider providerGetPrimaryEmail
-     *
-     * @param Gordianus $gordianus
-     * @param string $email
-     * @param string $expectedEmail
-     */
-    public function testGetPrimaryEmail(Gordianus $gordianus, string $email, string $expectedEmail)
-    {
-        $this->assertSame($expectedEmail, $gordianus->getPrimaryEmail($email));
-    }
-
-    public function providerGetPrimaryEmail()
-    {
-        return [
-            [new Gordianus([Gordianus::SERVICE_TLEN_PL]), 'john.doe+alias@gmail.com', 'john.doe+alias@gmail.com'],
-            [new Gordianus(), 'john.doe+alias@gmail.com', 'johndoe@gmail.com'],
-            [new Gordianus([]), 'John.Doe@example.com', 'john.doe@example.com'],
-            [new Gordianus([], true), 'John.Doe@example.com', 'John.Doe@example.com'],
-            [new Gordianus(Gordianus::ALL_SERVICES, true), 'John.Doe@gmail.com', 'johndoe@gmail.com'],
-            [new Gordianus(), 'Jane.Doe+receipts@hotmail.com', 'jane.doe@hotmail.com'],
-            [new Gordianus(), 'Jane.Doe-receipts@yahoo.com', 'jane.doe@yahoo.com'],
-        ];
-    }
-}

tests/Services/GmailComTest.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace bkrukowski\Gordianus\Tests\Services;
+namespace bkrukowski\TransparentEmail\Tests\Services;
 
-use bkrukowski\Gordianus\Services\GmailCom;
+use bkrukowski\TransparentEmail\Services\GmailCom;
 
 class GmailComTest extends \PHPUnit_Framework_TestCase
 {

tests/Services/MultiDomainTest.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace bkrukowski\Gordianus\Tests\Services;
+namespace bkrukowski\TransparentEmail\Tests\Services;
 
-use bkrukowski\Gordianus\Services\MultiDomain;
+use bkrukowski\TransparentEmail\Services\MultiDomain;
 
 class MultiDomainTest extends \PHPUnit_Framework_TestCase
 {

tests/Services/OutlookComTest.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace bkrukowski\Gordianus\Tests\Services;
+namespace bkrukowski\TransparentEmail\Tests\Services;
 
-use bkrukowski\Gordianus\Services\OutlookCom;
+use bkrukowski\TransparentEmail\Services\OutlookCom;
 
 class OutlookComTest extends \PHPUnit_Framework_TestCase
 {

tests/Services/Www33MailComTest.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace bkrukowski\Gordianus\Tests\Services;
+namespace bkrukowski\TransparentEmail\Tests\Services;
 
-use bkrukowski\Gordianus\Services\Www33MailCom;
+use bkrukowski\TransparentEmail\Services\Www33MailCom;
 
 class Www33MailComTest extends \PHPUnit_Framework_TestCase
 {

tests/Services/YahooComTest.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace bkrukowski\Gordianus\Tests\Services;
+namespace bkrukowski\TransparentEmail\Tests\Services;
 
-use bkrukowski\Gordianus\Services\YahooCom;
+use bkrukowski\TransparentEmail\Services\YahooCom;
 
 class YahooComTest extends \PHPUnit_Framework_TestCase
 {

tests/TransparentEmailTest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace bkrukowski\TransparentEmail\Tests;
+
+use bkrukowski\TransparentEmail\TransparentEmail;
+use bkrukowski\TransparentEmail\InvalidEmailException;
+
+class TransparentEmailTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @dataProvider providerValidator
+     *
+     * @param string $email
+     * @param bool $validEmail
+     */
+    public function testValidator(string $email, bool $validEmail)
+    {
+        if (!$validEmail) {
+            $this->expectException(InvalidEmailException::class);
+        }
+        (new TransparentEmail())->getPrimaryEmail($email);
+    }
+
+    public function providerValidator()
+    {
+        return [
+            ['john.doe@gmail.comm', true],
+            ['john doe@gmail.com', false],
+        ];
+    }
+
+    /**
+     * @dataProvider providerGetPrimaryEmail
+     *
+     * @param TransparentEmail $TransparentEmail
+     * @param string $email
+     * @param string $expectedEmail
+     */
+    public function testGetPrimaryEmail(TransparentEmail $TransparentEmail, string $email, string $expectedEmail)
+    {
+        $this->assertSame($expectedEmail, $TransparentEmail->getPrimaryEmail($email));
+    }
+
+    public function providerGetPrimaryEmail()
+    {
+        return [
+            [new TransparentEmail([TransparentEmail::SERVICE_TLEN_PL]), 'john.doe+alias@gmail.com', 'john.doe+alias@gmail.com'],
+            [new TransparentEmail(), 'john.doe+alias@gmail.com', 'johndoe@gmail.com'],
+            [new TransparentEmail([]), 'John.Doe@example.com', 'john.doe@example.com'],
+            [new TransparentEmail([], true), 'John.Doe@example.com', 'John.Doe@example.com'],
+            [new TransparentEmail(TransparentEmail::ALL_SERVICES, true), 'John.Doe@gmail.com', 'johndoe@gmail.com'],
+            [new TransparentEmail(), 'Jane.Doe+receipts@hotmail.com', 'jane.doe@hotmail.com'],
+            [new TransparentEmail(), 'Jane.Doe-receipts@yahoo.com', 'jane.doe@yahoo.com'],
+        ];
+    }
+}