ParserTest.php

<?php

namespace TheIconic\NameParser;

use PHPUnit\Framework\TestCase;
use TheIconic\NameParser\Language\English;
use TheIconic\NameParser\Language\German;

class ParserTest extends TestCase
{
    /**
     * @return array
     */
    public function provider()
    {
        return [
            [
                'James Norrington',
                [
                    'firstname' => 'James',
                    'lastname' => 'Norrington',
                ]

            ],
            [
                'Hans Christian Anderssen',
                [
                    'firstname' => 'Hans',
                    'lastname' => 'Anderssen',
                    'middlename' => 'Christian',
                ]
            ],
            [
                'Mr Anthony R Von Fange III',
                [
                    'salutation' => 'Mr.',
                    'firstname' => 'Anthony',
                    'initials' => 'R',
                    'lastname' => 'von Fange',
                    'suffix' => 'III',
                ]
            ],
            [
                'J. B. Hunt',
                [
                    'firstname' => 'J.',
                    'initials' => 'B.',
                    'lastname' => 'Hunt',
                ]
            ],
            [
                'J.B. Hunt',
                [
                    'firstname' => 'J',
                    'initials' => 'B',
                    'lastname' => 'Hunt',
                ]
            ],
            [
                'Edward Senior III',
                [
                    'firstname' => 'Edward',
                    'lastname' => 'Senior',
                    'suffix' => 'III'
                ]
            ],
            [
                'Edward Dale Senior II',
                [
                    'firstname' => 'Edward',
                    'lastname' => 'Dale',
                    'suffix' => 'Senior II'
                ]
            ],
            [
                'Dale Edward Jones Senior',
                [
                    'firstname' => 'Dale',
                    'middlename' => 'Edward',
                    'lastname' => 'Jones',
                    'suffix' => 'Senior'
                ]
            ],
            [
                'Jason Rodriguez Sr.',
                [
                    'firstname' => 'Jason',
                    'lastname' => 'Rodriguez',
                    'suffix' => 'Sr'
                ]
            ],
            [
                'Jason Senior',
                [
                    'firstname' => 'Jason',
                    'lastname' => 'Senior',
                ]
            ],
            [
                'Bill Junior',
                [
                    'firstname' => 'Bill',
                    'lastname' => 'Junior',
                ]
            ],
            [
                'Sara Ann Fraser',
                [
                    'firstname' => 'Sara',
                    'middlename' => 'Ann',
                    'lastname' => 'Fraser',
                ]
            ],
            [
                'Adam',
                [
                    'firstname' => 'Adam',
                ]
            ],
            [
                'OLD MACDONALD',
                [
                    'firstname' => 'Old',
                    'lastname' => 'Macdonald',
                ]
            ],
            [
                'Old MacDonald',
                [
                    'firstname' => 'Old',
                    'lastname' => 'MacDonald',
                ]
            ],
            [
                'Old McDonald',
                [
                    'firstname' => 'Old',
                    'lastname' => 'McDonald',
                ]
            ],
            [
                'Old Mc Donald',
                [
                    'firstname' => 'Old',
                    'middlename' => 'Mc',
                    'lastname' => 'Donald',
                ]
            ],
            [
                'Old Mac Donald',
                [
                    'firstname' => 'Old',
                    'middlename' => 'Mac',
                    'lastname' => 'Donald',
                ]
            ],
            [
                'James van Allen',
                [
                    'firstname' => 'James',
                    'lastname' => 'van Allen',
                ]
            ],
            [
                'Jimmy (Bubba) Smith',
                [
                    'firstname' => 'Jimmy',
                    'lastname' => 'Smith',
                    'nickname' => 'Bubba',
                ]
            ],
            [
                'Miss Jennifer Shrader Lawrence',
                [
                    'salutation' => 'Miss',
                    'firstname' => 'Jennifer',
                    'middlename' => 'Shrader',
                    'lastname' => 'Lawrence',
                ]
            ],
            [
                'Dr. Jonathan Smith',
                [
                    'salutation' => 'Dr.',
                    'firstname' => 'Jonathan',
                    'lastname' => 'Smith',
                ]
            ],
            [
                'Ms. Jamie P. Harrowitz',
                [
                    'salutation' => 'Ms.',
                    'firstname' => 'Jamie',
                    'initials' => 'P.',
                    'lastname' => 'Harrowitz',
                ]
            ],
            [
                'Mr John Doe',
                [
                    'salutation' => 'Mr.',
                    'firstname' => 'John',
                    'lastname' => 'Doe',
                ]
            ],
            [
                'Rev. Dr John Doe',
                [
                    'salutation' => 'Rev. Dr.',
                    'firstname' => 'John',
                    'lastname' => 'Doe',
                ]
            ],
            [
                'Prof. Tyson J. Hirthe',
                [
                    'salutation' => 'Prof.',
                    'lastname' => 'Hirthe',
                    'firstname' => 'Tyson',
                    'initials' => 'J.',
                ]
            ],
            [
                'prof Eveline Aufderhar',
                [
                    'salutation' => 'Prof.',
                    'lastname' => 'Aufderhar',
                    'firstname' => 'Eveline',
                ]
            ],
            [
                'Anthony Von Fange III',
                [
                    'firstname' => 'Anthony',
                    'lastname' => 'von Fange',
                    'suffix' => 'III'
                ]
            ],
            [
                'Smarty Pants Phd',
                [
                    'firstname' => 'Smarty',
                    'lastname' => 'Pants',
                    'suffix' => 'PhD'
                ]
            ],
            [
                'Mark Peter Williams',
                [
                    'firstname' => 'Mark',
                    'middlename' => 'Peter',
                    'lastname' => 'Williams',
                ]
            ],
            [
                'Mark P Williams',
                [
                    'firstname' => 'Mark',
                    'lastname' => 'Williams',
                    'initials' => 'P',
                ]
            ],
            [
                'Mark P. Williams',
                [
                    'firstname' => 'Mark',
                    'initials' => 'P.',
                    'lastname' => 'Williams',
                ]
            ],
            [
                'M Peter Williams',
                [
                    'firstname' => 'Peter',
                    'initials' => 'M',
                    'lastname' => 'Williams',
                ]
            ],
            [
                'M. Peter Williams',
                [
                    'firstname' => 'Peter',
                    'initials' => 'M.',
                    'lastname' => 'Williams',
                ]
            ],
            [
                'M. P. Williams',
                [
                    'firstname' => 'M.',
                    'initials' => 'P.',
                    'lastname' => 'Williams',
                ]
            ],
            [
                'The Rev. Mark Williams',
                [
                    'salutation' => 'Rev.',
                    'firstname' => 'Mark',
                    'lastname' => 'Williams',
                ]
            ],
            [
                'Mister Mark Williams',
                [
                    'salutation' => 'Mr.',
                    'firstname' => 'Mark',
                    'lastname' => 'Williams',
                ]
            ],
            [
                'Fraser, Joshua',
                [
                    'firstname' => 'Joshua',
                    'lastname' => 'Fraser',
                ]
            ],
            [
                'Mrs. Brown, Amanda',
                [
                    'salutation' => 'Mrs.',
                    'firstname' => 'Amanda',
                    'lastname' => 'Brown',
                ]
            ],
            [
                "Mr.\r\nPaul\rJoseph\nMaria\tWinters",
                [
                    'salutation' => 'Mr.',
                    'firstname' => 'Paul',
                    'middlename' => 'Joseph Maria',
                    'lastname' => 'Winters',
                ]
            ],
            [
                'Van Truong',
                [
                    'firstname' => 'Van',
                    'lastname' => 'Truong',
                ],
            ],
            [
                'John Van',
                [
                    'firstname' => 'John',
                    'lastname' => 'Van',
                ],
            ],
            [
                'Mr. Van Truong',
                [
                    'salutation' => 'Mr.',
                    'firstname' => 'Van',
                    'lastname' => 'Truong',
                ],
            ],
            [
                'Anthony Von Fange III, PHD',
                [
                    'firstname' => 'Anthony',
                    'lastname' => 'von Fange',
                    'suffix' => 'III PhD'
                ]
            ],
            [
                'Jimmy (Bubba Junior) Smith',
                [
                    'nickname' => 'Bubba Junior',
                    'firstname' => 'Jimmy',
                    'lastname' => 'Smith',
                ]
            ],
            [
                'Jonathan Smith, MD',
                [
                    'firstname' => 'Jonathan',
                    'lastname' => 'Smith',
                    'suffix' => 'MD'
                ]
            ],
            [
                'Kirk, James T.',
                [
                    'firstname' => 'James',
                    'initials' => 'T.',
                    'lastname' => 'Kirk',
                ],
            ],
            [
                'James B',
                [
                    'firstname' => 'James',
                    'lastname' => 'B',
                ]
            ],
            [
                'Williams, Hank, Jr.',
                [
                    'firstname' => 'Hank',
                    'lastname' => 'Williams',
                    'suffix' => 'Jr',
                ]
            ],
            [
                'Sir James Reynolds, Junior',
                [
                    'salutation' => 'Sir',
                    'firstname' => 'James',
                    'lastname' => 'Reynolds',
                    'suffix' => 'Junior'
                ]
            ],
            [
                'Sir John Paul Getty Sr.',
                [
                    'salutation' => 'Sir',
                    'firstname' => 'John',
                    'middlename' => 'Paul',
                    'lastname' => 'Getty',
                    'suffix' => 'Sr',
                ]
            ],
            [
                'etna übel',
                [
                    'firstname' => 'Etna',
                    'lastname' => 'Übel',
                ]
            ],
            [
                'Markus Müller',
                [
                    'firstname' => 'Markus',
                    'lastname' => 'Müller',
                ]
            ],
            [
                'Charles Dixon (20th century)',
                [
                    'firstname' => 'Charles',
                    'lastname' => 'Dixon',
                    'nickname' => '20Th Century'
                ]
            ],
            [
                'Smith, John Eric',
                [
                    'lastname' => 'Smith',
                    'firstname' => 'John',
                    'middlename' => 'Eric',
                ]
            ],
            [
                'PAUL M LEWIS MR',
                [
                    'firstname' => 'Paul',
                    'initials' => 'M',
                    'lastname' => 'Lewis Mr',
                ]
            ],
            [
                'SUJAN MASTER',
                [
                    'firstname' => 'Sujan',
                    'lastname' => 'Master',
                ],
            ],
            [
                'JAMES J MA',
                [
                    'firstname' => 'James',
                    'initials' => 'J',
                    'lastname' => 'Ma',
                ]
            ],
            [
                'Tiptree, James, Jr.',
                [
                    'lastname' => 'Tiptree',
                    'firstname' => 'James',
                    'suffix' => 'Jr',
                ]
            ],
            [
                'Miller, Walter M., Jr.',
                [
                    'lastname' => 'Miller',
                    'firstname' => 'Walter',
                    'initials' => 'M.',
                    'suffix' => 'Jr',
                ]
            ],
            [
                'Tiptree, James Jr.',
                [
                    'lastname' => 'Tiptree',
                    'firstname' => 'James',
                    'suffix' => 'Jr',
                ]
            ],
            [
                'Miller, Walter M. Jr.',
                [
                    'lastname' => 'Miller',
                    'firstname' => 'Walter',
                    'initials' => 'M.',
                    'suffix' => 'Jr',
                ]
            ],
            [
                'Thái Quốc Nguyễn',
                [
                    'lastname' => 'Nguyễn',
                    'middlename' => 'Quốc',
                    'firstname' => 'Thái',
                ]
            ],
            [
                'Yumeng Du',
                [
                    'lastname' => 'Du',
                    'firstname' => 'Yumeng',
                ]
            ],
            [
                'Her Honour Mrs Judy',
                [
                    'lastname' => 'Judy',
                    'salutation' => 'Her Honour Mrs.'
                ]
            ],
            [
                'Etje Heijdanus-De Boer',
                [
                    'firstname' => 'Etje',
                    'lastname' => 'Heijdanus-De Boer',
                ]
            ],
            [
                'JB Hunt',
                [
                    'firstname' => 'J',
                    'initials' => 'B',
                    'lastname' => 'Hunt',
                ]
            ],
            [
                'Charles Philip Arthur George Mountbatten-Windsor',
                [
                    'firstname' => 'Charles',
                    'middlename' => 'Philip Arthur George',
                    'lastname' => 'Mountbatten-Windsor',
                ]
            ],
            [
                'Ella Marija Lani Yelich-O\'Connor',
                [
                    'firstname' => 'Ella',
                    'middlename' => 'Marija Lani',
                    'lastname' => 'Yelich-O\'Connor',
                ]
            ]
        ];
    }

    /**
     * @dataProvider provider
     *
     * @param $input
     * @param $expectation
     */
    public function testParse($input, $expectation)
    {
        $parser = new Parser();
        $name = $parser->parse($input);

        $this->assertInstanceOf(Name::class, $name);
        $this->assertEquals($expectation, $name->getAll());
    }

    public function testSetGetWhitespace()
    {
        $parser = new Parser();
        $parser->setWhitespace('abc');
        $this->assertSame('abc', $parser->getWhitespace());
        $parser->setWhitespace(' ');
        $this->assertSame(' ', $parser->getWhitespace());
        $parser->setWhitespace('   _');
        $this->assertSame('   _', $parser->getWhitespace());
    }

    public function testSetGetNicknameDelimiters()
    {
        $parser = new Parser();
        $parser->setNicknameDelimiters(['[' => ']']);
        $this->assertSame(['[' => ']'], $parser->getNicknameDelimiters());
        $this->assertSame('Jim', $parser->parse('[Jim]')->getNickname());
        $this->assertNotSame('Jim', $parser->parse('(Jim)')->getNickname());
    }

    public function testSetMaxSalutationIndex()
    {
        $parser = new Parser();
        $this->assertSame(0, $parser->getMaxSalutationIndex());
        $parser->setMaxSalutationIndex(1);
        $this->assertSame(1, $parser->getMaxSalutationIndex());
        $this->assertSame('', $parser->parse('Francis Mr')->getSalutation());

        $parser = new Parser();
        $this->assertSame(0, $parser->getMaxSalutationIndex());
        $parser->setMaxSalutationIndex(2);
        $this->assertSame(2, $parser->getMaxSalutationIndex());
        $this->assertSame('Mr.', $parser->parse('Francis Mr')->getSalutation());
    }

    public function testSetMaxCombinedInitials()
    {
        $parser = new Parser();
        $this->assertSame(2, $parser->getMaxCombinedInitials());
        $parser->setMaxCombinedInitials(1);
        $this->assertSame(1, $parser->getMaxCombinedInitials());
        $this->assertSame('', $parser->parse('DJ Westbam')->getInitials());

        $parser = new Parser();
        $this->assertSame(2, $parser->getMaxCombinedInitials());
        $parser->setMaxCombinedInitials(3);
        $this->assertSame(3, $parser->getMaxCombinedInitials());
        $this->assertSame('P A G', $parser->parse('Charles PAG Mountbatten-Windsor')->getInitials());
    }

    public function testParserAndSubparsersProperlyHandleLanguages()
    {
        $parser = new Parser([
            new German(),
        ]);

        $this->assertSame('Herr', $parser->parse('Herr Schmidt')->getSalutation());
        $this->assertSame('Herr', $parser->parse('Herr Schmidt, Bernd')->getSalutation());
    }
}