xamxam/tests/phpunit/EmailObfuscatorTest.php

<?php

use PHPUnit\Framework\TestCase;

/**
 * EmailObfuscatorTest — Pure logic tests for EmailObfuscator.
 */
class EmailObfuscatorTest extends TestCase
{
    // ── encode() ──────────────────────────────────────────────────────────────

    public function testEncodeContainsNoAtSign(): void
    {
        $result = EmailObfuscator::email('test@example.com');

        $this->assertStringNotContainsString('@', $result);
        $this->assertStringContainsString('&#64;', $result); // decimal entity for @
    }

    public function testEncodeOutputIsNumericEntities(): void
    {
        $result = EmailObfuscator::email('a@b.c');

        // Every original character should be a &#xxx; entity
        $this->assertMatchesRegularExpression('/^(?:&#\d+;)+$/', $result);
        $this->assertNotEmpty($result);
    }

    // ── email() ───────────────────────────────────────────────────────────────

    public function testEmailReturnsObfuscatedAddress(): void
    {
        $result = EmailObfuscator::email('hello@world.org');

        $this->assertStringNotContainsString('hello', $result);
        $this->assertStringNotContainsString('@', $result);
        $this->assertStringContainsString('&#104;', $result); // 'h'
        $this->assertStringContainsString('&#64;', $result);  // '@'
    }

    // ── mailto() ──────────────────────────────────────────────────────────────

    public function testMailtoBuildsCorrectHrefStructure(): void
    {
        $result = EmailObfuscator::mailto('x@y.com');

        $this->assertStringStartsWith('mailto:', $result);
        $this->assertStringNotContainsString('@', $result);
        $this->assertStringContainsString('&#64;', $result);
    }

    // ── emailText() ───────────────────────────────────────────────────────────

    public function testEmailTextReplacesBareEmail(): void
    {
        $input = 'Contact xamxam@erg.be for help';
        $result = EmailObfuscator::emailText($input);

        $this->assertStringNotContainsString('xamxam@erg.be', $result);
        $this->assertStringContainsString('&#64;', $result);   // @ entity
        $this->assertStringContainsString('Contact', $result); // surrounding text preserved
        // Entity-encoded chars: 120=x, 97=a, 109=m, so 'xamxam' becomes &#120;&#97;&#109;...
        $this->assertStringContainsString('&#120;', $result); // 'x'
        $this->assertStringContainsString('&#97;', $result);  // 'a'
        $this->assertStringContainsString('&#109;', $result); // 'm'
    }

    public function testEmailTextReplacesMultipleEmails(): void
    {
        $input = 'a@b.com and c@d.org';
        $result = EmailObfuscator::emailText($input);

        $this->assertStringNotContainsString('@', $result);
        $this->assertStringContainsString('&#64;', $result);
        // Should have two occurrences of the @ entity
        $this->assertEquals(2, substr_count($result, '&#64;'));
    }

    // ── mailtoInText() ────────────────────────────────────────────────────────

    public function testMailtoInTextReplacesMailtoLinks(): void
    {
        $input = '<a href="mailto:contact@example.com">contact</a>';
        $result = EmailObfuscator::mailtoInText($input);

        $this->assertStringNotContainsString('contact@example.com', $result);
        $this->assertStringContainsString('mailto:', $result);
        $this->assertStringContainsString('&#64;', $result);
    }

    // ── obfuscateHtml() ───────────────────────────────────────────────────────

    public function testObfuscateHtmlReplacesAnchorTag(): void
    {
        $input = '<a href="mailto:contact@example.com">contact@example.com</a>';
        $result = EmailObfuscator::obfuscateHtml($input);

        $this->assertStringNotContainsString('contact@example.com', $result);
        $this->assertStringContainsString('<a ', $result);
        $this->assertStringContainsString('href="mailto:', $result);
        // @ entity should appear twice (href + link text)
        $this->assertGreaterThanOrEqual(2, substr_count($result, '&#64;'));
    }

    public function testObfuscateHtmlKeepsNonMailtoLinksUnchanged(): void
    {
        $input = '<a href="https://erg.be">ERG</a> and <a href="mailto:x@y.z">x@y.z</a>';
        $result = EmailObfuscator::obfuscateHtml($input);

        $this->assertStringContainsString('https://erg.be', $result);
        $this->assertStringContainsString('ERG', $result);
        $this->assertStringNotContainsString('x@y.z', $result);
    }

    public function testObfuscateHtmlPreservesCustomLinkText(): void
    {
        // When the link text differs from the email, only the href is obfuscated
        $input = '<a href="mailto:foobar@test.com">custom text</a>';
        $result = EmailObfuscator::obfuscateHtml($input);

        $this->assertStringNotContainsString('foobar@test.com', $result);
        $this->assertStringContainsString('&#64;', $result); // in href
        $this->assertStringContainsString('custom text', $result);  // link text unchanged
    }

    // ── Edge cases ────────────────────────────────────────────────────────────

    public function testEmptyStringReturnsEmpty(): void
    {
        $this->assertSame('', EmailObfuscator::email(''));
    }

    public function testStringWithNoEmailsIsUnchanged(): void
    {
        $input = 'Hello, world! No emails here.';
        $this->assertSame($input, EmailObfuscator::emailText($input));
    }

    public function testAlreadyObfuscatedContentIsNotDoubleEncoded(): void
    {
        // Already entity-encoded email — no literal '@' to match
        $input = 'Contact &#120;&#97;&#109;&#120;&#97;&#109;&#64;&#101;&#114;&#103;&#46;&#98;&#101; here';
        $result = EmailObfuscator::emailText($input);

        // Should be unchanged (regex won't match entity-encoded @)
        $this->assertSame($input, $result);
    }

    public function testMultipleEmailsInOneString(): void
    {
        $input = 'Mail to a@b.com or c@d.org pls';
        $result = EmailObfuscator::emailText($input);

        $this->assertStringNotContainsString('a@b.com', $result);
        $this->assertStringNotContainsString('c@d.org', $result);
        // Two @ entities
        $this->assertEquals(2, substr_count($result, '&#64;'));
    }

    public function testEmailWithPlusSign(): void
    {
        $result = EmailObfuscator::email('user+tag@domain.com');
        $this->assertStringContainsString('&#43;', $result); // '+'
        $this->assertStringContainsString('&#64;', $result); // '@'
    }
}