libphonenumber\Tests\core\PhoneNumberMatcherTest

Complexity

Total Complexity

85

Size/Duplication

Total Lines	1108
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	7

Importance

Changes

0

70 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	8	1
B	testContainsMoreThanOneSlashInNationalNumber()	0	44	1
A	testFindNationalNumber()	0	23	1
A	testFindWithInternationalPrefixes()	0	20	1
A	testFindWithLeadingZero()	0	6	1
A	testFindNationalNumberArgentina()	0	19	1
A	testFindWithXInNumber()	0	12	1
A	testFindNumbersMexico()	0	12	1
A	testFindNumbersWithPlusWithNoRegion()	0	8	1
B	testFindExtensions()	0	28	1
A	testFindInterspersedWithSpace()	0	4	1
A	testIntermediateParsePositions()	0	18	3
B	testFourMatchesInARow()	0	26	1
A	testMatchesFoundWithMultipleSpaces()	0	16	1
A	testMatchWithSurroundingZipcodes()	0	22	1
A	dataLatinLetters()	0	17	1
A	testIsLatinLetter()	0	5	1
A	testMatchesWithSurroundingLatinChars()	0	15	1
A	testMoneyNotSeenAsPhoneNumber()	0	10	1
A	testPercentageNotSeenAsPhoneNumber()	0	7	1
A	testPhoneNumberWithLeadingOrTrailingMoneyMatches()	0	10	1
B	testMatchesWithSurroundingLatinCharsAndLeadingPunctuation()	0	26	1
A	testMatchesWithSurroundingChineseChars()	0	10	1
A	testMatchesWithSurroundingPunctuation()	0	11	1
A	testMatchesMultiplePhoneNumbersSeparatedByPhoneNumberPunctuation()	0	23	1
A	testDoesNotMatchMultiplePhoneNumbersSeparatedWithNoWhiteSpace()	0	8	1
A	dataImpossibleCases()	0	22	1
A	dataPossibleOnlyCases()	0	13	1
B	dataValidCases()	0	24	1
A	dataStrictGroupingCases()	0	18	1
B	dataExactGroupingCases()	0	31	1
A	data_testMatchesWithPossibleLeniency()	0	7	1
A	testMatchesWithPossibleLeniency()	0	4	1
A	testNonMatchesWithPossibleLeniency()	0	4	1
A	data_testMatchesWithValidLeniency()	0	6	1
A	testMatchesWithValidLeniency()	0	4	1
A	data_testNonMatchesWithValidLeniency()	0	5	1
A	testNonMatchesWithValidLeniency()	0	4	1
A	data_testMatchesWithStrictGroupingLeniency()	0	5	1
A	testMatchesWithStrictGroupingLeniency()	0	4	1
A	data_testNonMatchesWithStrictGroupLeniency()	0	6	1
A	testNonMatchesWithStrictGroupLeniency()	0	4	1
A	testMatchesWithExactGroupingLeniency()	0	4	1
A	data_testNonMatchesExactGroupLeniency()	0	7	1
A	testNonMatchesExactGroupLeniency()	0	4	1
A	doTestNumberMatchesForLeniency()	0	10	1
A	doTestNumberNonMatchesForLeniency()	0	9	1
B	findMatchesInContexts()	0	22	5
A	testNonMatchingBracketsAreInvalid()	0	19	1
A	testNoMatchIfRegionIsNull()	0	6	1
A	testNoMatchInEmptyString()	0	5	1
A	testNoMatchIfNoNumber()	0	5	1
B	testSequences()	0	24	1
A	testNullInput()	0	5	1
A	testMaxMatches()	0	17	2
A	testMaxMatchesInvalid()	0	15	3
A	testMaxMatchesMixed()	0	21	3
A	testNonPlusPrefixedNumbersNotFoundForInvalidRegion()	0	8	1
A	testEmptyIteration()	0	7	1
A	testSingleIteration()	0	12	1
A	testDoubleIteration()	0	16	1
A	assertMatchProperties()	0	7	1
A	assertEqualRange()	0	14	1
A	doTestFindInContext()	0	9	2
B	findPossibleInContext()	0	33	1
A	findValidInContext()	0	16	1
B	doTestInContext()	0	24	2
A	ensureTermination()	0	14	3
A	findNumbersForLeniency()	0	4	1
A	hasNoMatches()	0	4	1

<?php

namespace libphonenumber\Tests\core;

use libphonenumber\CountryCodeSource;
use libphonenumber\CountryCodeToRegionCodeMapForTesting;
use libphonenumber\Leniency;
use libphonenumber\PhoneNumber;
use libphonenumber\PhoneNumberMatch;
use libphonenumber\PhoneNumberMatcher;
use libphonenumber\PhoneNumberUtil;
use libphonenumber\RegionCode;

class PhoneNumberMatcherTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var PhoneNumberUtil
     */
    protected $phoneUtil;

    public function setUp()
    {
        PhoneNumberUtil::resetInstance();
        $this->phoneUtil = PhoneNumberUtil::getInstance(
            PhoneNumberUtilTest::TEST_META_DATA_FILE_PREFIX,
            CountryCodeToRegionCodeMapForTesting::$countryCodeToRegionCodeMapForTesting
        );
    }

    public function testContainsMoreThanOneSlashInNationalNumber()
    {
        // A date should return true.
        $number = new PhoneNumber();
        $number->setCountryCode(1);
        $number->setCountryCodeSource(CountryCodeSource::FROM_DEFAULT_COUNTRY);
        $candidate = "1/05/2013";
        $this->assertTrue(PhoneNumberMatcher::containsMoreThanOneSlashInNationalNumber($number, $candidate));

        // Here, the country code source thinks it started with a country calling code, but this is not
        // the same as the part before the slash, so it's still true.
        $number = new PhoneNumber();
        $number->setCountryCodeSource(274);
        $number->setCountryCodeSource(CountryCodeSource::FROM_NUMBER_WITHOUT_PLUS_SIGN);
        $candidate = "27/4/2013";
        $this->assertTrue(PhoneNumberMatcher::containsMoreThanOneSlashInNationalNumber($number, $candidate));

        // Now it should be false, because the first slash is after the country calling code.
        $number = new PhoneNumber();
        $number->setCountryCode(49);
        $number->setCountryCodeSource(CountryCodeSource::FROM_NUMBER_WITH_PLUS_SIGN);
        $candidate = "49/69/2013";
        $this->assertFalse(PhoneNumberMatcher::containsMoreThanOneSlashInNationalNumber($number, $candidate));

        $number = new PhoneNumber();
        $number->setCountryCode(49);
        $number->setCountryCodeSource(CountryCodeSource::FROM_NUMBER_WITHOUT_PLUS_SIGN);
        $candidate = "+49/69/2013";
        $this->assertFalse(PhoneNumberMatcher::containsMoreThanOneSlashInNationalNumber($number, $candidate));

        $candidate = "+ 49/69/2013";
        $this->assertFalse(PhoneNumberMatcher::containsMoreThanOneSlashInNationalNumber($number, $candidate));

        $candidate = "+ 49/69/20/13";
        $this->assertTrue(PhoneNumberMatcher::containsMoreThanOneSlashInNationalNumber($number, $candidate));

        // Here, the first group is not assumed to be the country calling code, even though it is the
        // same as it, so this should return true.
        $number = new PhoneNumber();
        $number->setCountryCode(49);
        $number->setCountryCodeSource(CountryCodeSource::FROM_DEFAULT_COUNTRY);
        $candidate = "49/69/2013";
        $this->assertTrue(PhoneNumberMatcher::containsMoreThanOneSlashInNationalNumber($number, $candidate));
    }

    public function testFindNationalNumber()
    {
        // same cases as in testParseNationalNumber
        $this->doTestFindInContext("033316005", RegionCode::NZ);
        // ("33316005", RegionCode.NZ) is omitted since the national prefix is obligatory for these
        // types of numbers in New Zealand.
        // National prefix attached and some formatting present.
        $this->doTestFindInContext("03-331 6005", RegionCode::NZ);
        $this->doTestFindInContext("03 331 6005", RegionCode::NZ);
        // Testing international prefixes.
        // Should strip country code.
        $this->doTestFindInContext("0064 3 331 6005", RegionCode::NZ);
        // Try again, but this time we have an international number with Region Code US. It should
        // recognize the country code and parse accordingly.
        $this->doTestFindInContext("01164 3 331 6005", RegionCode::US);
        $this->doTestFindInContext("+64 3 331 6005", RegionCode::US);

        $this->doTestFindInContext("64(0)64123456", RegionCode::NZ);
        // Check that using a "/" is fine in a phone number.
        // Note that real Polish numbers do *not* start with a 0.
        $this->doTestFindInContext("0123/456789", RegionCode::PL);
        $this->doTestFindInContext("123-456-7890", RegionCode::US);
    }

    public function testFindWithInternationalPrefixes()
    {
        $this->doTestFindInContext("+1 (650) 333-6000", RegionCode::NZ);
        $this->doTestFindInContext("1-650-333-6000", RegionCode::US);
        // Calling the US number from Singapore by using different service providers
        // 1st test: calling using SingTel IDD service (IDD is 001)
        $this->doTestFindInContext("0011-650-333-6000", RegionCode::SG);
        // 2nd test: calling using StarHub IDD service (IDD is 008)
        $this->doTestFindInContext("0081-650-333-6000", RegionCode::SG);
        // 3rd test: calling using SingTel V019 service (IDD is 019)
        $this->doTestFindInContext("0191-650-333-6000", RegionCode::SG);
        // Calling the US number from Poland
        $this->doTestFindInContext("0~01-650-333-6000", RegionCode::PL);
        // Using "++" at the start.
        $this->doTestFindInContext("++1 (650) 333-6000", RegionCode::PL);
        // Using a full-width plus sign.
        $this->doTestFindInContext("\xEF\xBC\x8B1 (650) 333-6000", RegionCode::SG);
        // The whole number, including punctuation, is here represented in full-width form.
        $this->doTestFindInContext("＋１ （６５０） ３３３－６０００", RegionCode::SG);
    }

    public function testFindWithLeadingZero()
    {
        $this->doTestFindInContext("+39 02-36618 300", RegionCode::NZ);
        $this->doTestFindInContext("02-36618 300", RegionCode::IT);
        $this->doTestFindInContext("312 345 678", RegionCode::IT);
    }

    public function testFindNationalNumberArgentina()
    {
        // Test parsing mobile numbers of Argentina.
        $this->doTestFindInContext("+54 9 343 555 1212", RegionCode::AR);
        $this->doTestFindInContext("0343 15 555 1212", RegionCode::AR);

        $this->doTestFindInContext("+54 9 3715 65 4320", RegionCode::AR);
        $this->doTestFindInContext("03715 15 65 4320", RegionCode::AR);

        // Test parsing fixed-line numbers of Argentina.
        $this->doTestFindInContext("+54 11 3797 0000", RegionCode::AR);
        $this->doTestFindInContext("011 3797 0000", RegionCode::AR);

        $this->doTestFindInContext("+54 3715 65 4321", RegionCode::AR);
        $this->doTestFindInContext("03715 65 4321", RegionCode::AR);

        $this->doTestFindInContext("+54 23 1234 0000", RegionCode::AR);
        $this->doTestFindInContext("023 1234 0000", RegionCode::AR);
    }

    public function testFindWithXInNumber()
    {
        $this->doTestFindInContext("(0xx) 123456789", RegionCode::AR);
        // A case where x denotes both carrier codes and extension symbol.
        $this->doTestFindInContext("(0xx) 123456789 x 1234", RegionCode::AR);

        // This test is intentionally constructed such that the number of digit after xx is larger than
        // 7, so that the number won't be mistakenly treated as an extension, as we allow extensions up
        // to 7 digits. This assumption is okay for now as all the countries where a carrier selection
        // code is written in the form of xx have a national significant number of length larger than 7.
        $this->doTestFindInContext("011xx5481429712", RegionCode::US);
    }

    public function testFindNumbersMexico()
    {
        // Test parsing fixed-line numbers of Mexico.
        $this->doTestFindInContext("+52 (449)978-0001", RegionCode::MX);
        $this->doTestFindInContext("01 (449)978-0001", RegionCode::MX);
        $this->doTestFindInContext("(449)978-0001", RegionCode::MX);

        // Test parsing mobile numbers of Mexico.
        $this->doTestFindInContext("+52 1 33 1234-5678", RegionCode::MX);
        $this->doTestFindInContext("044 (33) 1234-5678", RegionCode::MX);
        $this->doTestFindInContext("045 33 1234-5678", RegionCode::MX);
    }

    public function testFindNumbersWithPlusWithNoRegion()
    {
        // RegionCode.ZZ is allowed only if the number starts with a '+' - then the country code can be
        // calculated.
        $this->doTestFindInContext("+64 3 331 6005", RegionCode::ZZ);
        // Null is also allowed for the region code in these cases.
        $this->doTestFindInContext("+64 3 331 6005", null);
    }

    public function testFindExtensions()
    {
        $this->doTestFindInContext("03 331 6005 ext 3456", RegionCode::NZ);
        $this->doTestFindInContext("03-3316005x3456", RegionCode::NZ);
        $this->doTestFindInContext("03-3316005 int.3456", RegionCode::NZ);
        $this->doTestFindInContext("03 3316005 #3456", RegionCode::NZ);
        $this->doTestFindInContext("0~0 1800 7493 524", RegionCode::PL);
        $this->doTestFindInContext("(1800) 7493.524", RegionCode::US);
        // Check that the last instance of an extension token is matched.
        $this->doTestFindInContext("0~0 1800 7493 524 ~1234", RegionCode::PL);
        // Verifying bug-fix where the last digit of a number was previously omitted if it was a 0 when
        // extracting the extension. Also verifying a few different cases of extensions.
        $this->doTestFindInContext("+44 2034567890x456", RegionCode::NZ);
        $this->doTestFindInContext("+44 2034567890x456", RegionCode::GB);
        $this->doTestFindInContext("+44 2034567890 x456", RegionCode::GB);
        $this->doTestFindInContext("+44 2034567890 X456", RegionCode::GB);
        $this->doTestFindInContext("+44 2034567890 X 456", RegionCode::GB);
        $this->doTestFindInContext("+44 2034567890 X  456", RegionCode::GB);
        $this->doTestFindInContext("+44 2034567890  X 456", RegionCode::GB);

        $this->doTestFindInContext("(800) 901-3355 x 7246433", RegionCode::US);
        $this->doTestFindInContext("(800) 901-3355 , ext 7246433", RegionCode::US);
        $this->doTestFindInContext("(800) 901-3355 ,extension 7246433", RegionCode::US);
        // The next test differs from PhoneNumberUtil -> when matching we don't consider a lone comma to
        // indicate an extension, although we accept it when parsing.
        $this->doTestFindInContext("(800) 901-3355 ,x 7246433", RegionCode::US);
        $this->doTestFindInContext("(800) 901-3355 ext: 7246433", RegionCode::US);
    }

    public function testFindInterspersedWithSpace()
    {
        $this->doTestFindInContext("0 3   3 3 1   6 0 0 5", RegionCode::NZ);
    }

    /**
     * Test matching behaviour when starting in the middle of a phone number.
     */
    public function testIntermediateParsePositions()
    {
        $text = "Call 033316005  or 032316005!";
        //       |    |    |    |    |    |

50% of this comment could be valid code. Did you maybe forget this after debugging?

        //       0    5   10   15   20   25

50% of this comment could be valid code. Did you maybe forget this after debugging?

        // Iterate over all possible indices.
        for ($i = 0; $i <= 5; $i++) {
            $this->assertEqualRange($text, $i, 5, 14);
        }
        // 7 and 8 digits in a row are still parsed as number.
        $this->assertEqualRange($text, 6, 6, 14);
        $this->assertEqualRange($text, 7, 7, 14);
        // Anything smaller is skipped to the second instance.
        for ($i = 8; $i <= 19; $i++) {
            $this->assertEqualRange($text, $i, 19, 28);
        }
    }

    public function testFourMatchesInARow()
    {
        $number1 = "415-666-7777";
        $number2 = "800-443-1223";
        $number3 = "212-443-1223";
        $number4 = "650-443-1223";
        $text = $number1 . " - " . $number2 . " - " . $number3 . " - " . $number4;

        $iterator = $this->phoneUtil->findNumbers($text, RegionCode::US);

        $iterator->next();
        $match = $iterator->current();
        $this->assertMatchProperties($match, $text, $number1, RegionCode::US);

        $iterator->next();
        $match = $iterator->current();
        $this->assertMatchProperties($match, $text, $number2, RegionCode::US);

        $iterator->next();
        $match = $iterator->current();
        $this->assertMatchProperties($match, $text, $number3, RegionCode::US);

        $iterator->next();
        $match = $iterator->current();
        $this->assertMatchProperties($match, $text, $number4, RegionCode::US);
    }

    public function testMatchesFoundWithMultipleSpaces()
    {
        $number1 = "(415) 666-7777";
        $number2 = "(800) 443-1223";
        $text = $number1 . " " . $number2;

        $iterator = $this->phoneUtil->findNumbers($text, RegionCode::US);

        $iterator->next();
        $match = $iterator->current();
        $this->assertMatchProperties($match, $text, $number1, RegionCode::US);

        $iterator->next();
        $match = $iterator->current();
        $this->assertMatchProperties($match, $text, $number2, RegionCode::US);
    }

    public function testMatchWithSurroundingZipcodes()
    {
        $number = "415-666-7777";
        $zipPreceding = "My address is CA 34215 - " . $number . " is my number.";

        $iterator = $this->phoneUtil->findNumbers($zipPreceding, RegionCode::US);

        $iterator->next();
        $match = $iterator->current();
        $this->assertMatchProperties($match, $zipPreceding, $number, RegionCode::US);

        // Now repeat, but this time the phone number has spaces in it. It should still be found.
        $number = "(415) 666 7777";

        $zipFollowing = "My number is " . $number . ". 34215 is my zip-code.";

        $iterator = $this->phoneUtil->findNumbers($zipFollowing, RegionCode::US);

        $iterator->next();
        $match = $iterator->current();
        $this->assertMatchProperties($match, $zipFollowing, $number, RegionCode::US);
    }

    public function dataLatinLetters()
    {
        return array(
            array('c', true),
            array('C', true),
            array("\xC3\x89", true),
            array("\xCC\x81", true), // Combining acute accent
            // Punctuation, digits and white-space are not considered "latin letters".
            array(':', false),
            array('5', false),
            array('-', false),
            array('.', false),
            array(' ', false),
            array("\xE6\x88\x91", false),  // Chinese character
            array("\xE3\x81\xAE", false),  // Hiragana letter no
        );
    }

    /**
     * @dataProvider dataLatinLetters
     * @param string $letter
     * @param string $expectedResult
     */
    public function testIsLatinLetter($letter, $expectedResult)
    {
        $this->assertEquals($expectedResult, PhoneNumberMatcher::isLatinLetter($letter),
            "{$letter} should return {$expectedResult}");
    }

    public function testMatchesWithSurroundingLatinChars()
    {
        $possibleOnlyContexts = array();
        $possibleOnlyContexts[] = array("abc", "def");
        $possibleOnlyContexts[] = array("abc", "");
        $possibleOnlyContexts[] = array("", "def");
        // Latin capital letter e with an acute accent.
        $possibleOnlyContexts[] = array("\xC3\x89", "");
        // e with an acute accent decomposed (with combining mark).
        $possibleOnlyContexts[] = array("e\xCC\x81", "");

        // Numbers should not be considered valid, if they are surrounded by Latin characters, but
        // should be considered possible.
        $this->findMatchesInContexts($possibleOnlyContexts, false, true);
    }

    public function testMoneyNotSeenAsPhoneNumber()
    {
        $possibleOnlyContexts = array();
        $possibleOnlyContexts[] = array("$", "");
        $possibleOnlyContexts[] = array("", "$");
        $possibleOnlyContexts[] = array("\xC2\xA3", "");  // Pound sign
        $possibleOnlyContexts[] = array("\xC2\xA5", "");  // Yen sign

        $this->findMatchesInContexts($possibleOnlyContexts, false, true);
    }

    public function testPercentageNotSeenAsPhoneNumber()
    {
        $possibleOnlyContexts = array();
        $possibleOnlyContexts[] = array("", "%");
        // Numbers followed by % should be dropped
        $this->findMatchesInContexts($possibleOnlyContexts, false, true);
    }

    public function testPhoneNumberWithLeadingOrTrailingMoneyMatches()
    {
        // Because of the space after the 20 (or before the 100) these dollar amounts should not stop
        // the actual number from being found.
        $contexts = array();
        $contexts[] = array('$20 ', '');
        $contexts[] = array('', ' 100$');

        $this->findMatchesInContexts($contexts, true, true);
    }

    public function testMatchesWithSurroundingLatinCharsAndLeadingPunctuation()
    {
        // Contexts with trailing characters. Leading characters are okay here since the numbers we will
        // insert start with punctuation, but trailing characters are still not allowed.
        $possibleOnlyContexts = array();
        $possibleOnlyContexts[] = array("abc", "def");
        $possibleOnlyContexts[] = array("", "def");
        $possibleOnlyContexts[] = array("", "\xC3\x89");

        // Numbers should not be considered valid, if they have trailing Latin characters, but should be
        // considered possible.
        $numberWithPlus = "+14156667777";
        $numberWithBrackets = "(415)6667777";
        $this->findMatchesInContexts($possibleOnlyContexts, false, true, RegionCode::US, $numberWithPlus);
        $this->findMatchesInContexts($possibleOnlyContexts, false, true, RegionCode::US, $numberWithBrackets);

        $validContexts = array();
        $validContexts[] = array("abc", "");
        $validContexts[] = array("\xC3\x89", "");
        $validContexts[] = array("\xC3\x89", "."); // Trailing punctuation.
        $validContexts[] = array("\xC3\x89", " def"); // Trailing white space.

        // Numbers should be considered valid, since they start with punctuation.
        $this->findMatchesInContexts($validContexts, true, true, RegionCode::US, $numberWithPlus);
        $this->findMatchesInContexts($validContexts, true, true, RegionCode::US, $numberWithBrackets);
    }

    public function testMatchesWithSurroundingChineseChars()
    {
        $validContexts = array();
        $validContexts[] = array("我的电话号码是", "");
        $validContexts[] = array("", "是我的电话号码");
        $validContexts[] = array("请拨打", "我在明天");

        // Numbers should be considered valid, since they are surrounded by Chinese.
        $this->findMatchesInContexts($validContexts, true, true);
    }

    public function testMatchesWithSurroundingPunctuation()
    {
        $validContexts = array();
        $validContexts[] = array("My number-", ""); // At end of text
        $validContexts[] = array("", ".Nice day."); // At start of text
        $validContexts[] = array("Tel:", "."); // Punctuation surrounds number.
        $validContexts[] = array("Tel: ", " on Saturdays."); // White-space is also fine.

        // Numbers should be considered valid, since they are surrounded by punctuation.
        $this->findMatchesInContexts($validContexts, true, true);
    }

    public function testMatchesMultiplePhoneNumbersSeparatedByPhoneNumberPunctuation()
    {
        $text = "Call 650-253-4561 -- 455-234-3451";
        $region = RegionCode::US;

        $number1 = new PhoneNumber();
        $number1->setCountryCode($this->phoneUtil->getCountryCodeForRegion($region));
        $number1->setNationalNumber(6502534561);
        $match1 = new PhoneNumberMatch(5, "650-253-4561", $number1);

        $number2 = new PhoneNumber();
        $number2->setCountryCode($this->phoneUtil->getCountryCodeForRegion($region));
        $number2->setNationalNumber(4552343451);
        $match2 = new PhoneNumberMatch(21, "455-234-3451", $number2);

        $matches = $this->phoneUtil->findNumbers($text, $region);

        $matches->next();
        $this->assertEquals($match1, $matches->current());

        $matches->next();
        $this->assertEquals($match2, $matches->current());
    }

    public function testDoesNotMatchMultiplePhoneNumbersSeparatedWithNoWhiteSpace()
    {
        // No white-space found between numbers - neither is found.
        $text = "Call 650-253-4561--455-234-3451";
        $region = RegionCode::US;

        $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers($text, $region)));
    }

    /**
     * Strings with number-like things that shouldn't be found under any level.
     * @return array
     */
    public function dataImpossibleCases()
    {
        return array(
            array("12345", RegionCode::US),
            array("23456789", RegionCode::US),
            array("234567890112", RegionCode::US),
            array("650+253+1234", RegionCode::US),
            array("3/10/1984", RegionCode::CA),
            array("03/27/2011", RegionCode::US),
            array("31/8/2011", RegionCode::US),
            array("1/12/2011", RegionCode::US),
            array("10/12/82", RegionCode::DE),
            array("650x2531234", RegionCode::US),
            array("2012-01-02 08:00", RegionCode::US),
            array("2012/01/02 08:00", RegionCode::US),
            array("20120102 08:00", RegionCode::US),
            array("2014-04-12 04:04 PM", RegionCode::US),
            array("2014-04-12 &nbsp;04:04 PM", RegionCode::US),
            array("2014-04-12 &nbsp;04:04 PM", RegionCode::US),
            array("2014-04-12  04:04 PM", RegionCode::US),
        );
    }

    /**
     * Strings with number-like things that should only be found under "possible".
     * @return array
     */
    public function dataPossibleOnlyCases()
    {
        return array(
            // US numbers cannot start with 7 in the test metadata to be valid.
            array("7121115678", RegionCode::US),
            // 'X' should not be found in numbers at leniencies stricter than POSSIBLE, unless it represents
            // a carrier code or extension.
            array("1650 x 253 - 1234", RegionCode::US),
            array("650 x 253 - 1234", RegionCode::US),
            array("6502531x234", RegionCode::US),
            array("(20) 3346 1234", RegionCode::GB),  // Non-optional NP omitted
        );
    }

    /**
     * Strings with number-like things that should only be found up to and including the "valid"
     * leniency level.
     * @return array
     */
    public function dataValidCases()
    {
        return array(
            array("65 02 53 00 00", RegionCode::US),
            array("6502 538365", RegionCode::US),
            array("650//253-1234", RegionCode::US),  // 2 slashes are illegal at higher levels
            array("650/253/1234", RegionCode::US),
            array("9002309. 158", RegionCode::US),
            array("12 7/8 - 14 12/34 - 5", RegionCode::US),
            array("12.1 - 23.71 - 23.45", RegionCode::US),
            array("800 234 1 111x1111", RegionCode::US),
            array("1979-2011 100", RegionCode::US),
            array("+494949-4-94", RegionCode::DE),  // National number in wrong format
            array("４１５６６６６-７７７", RegionCode::US),
            array("2012-0102 08", RegionCode::US),  // Very strange formatting.
            array("2012-01-02 08", RegionCode::US),
            // Breakdown assistance number with unexpected formatting.
            array("1800-1-0-10 22", RegionCode::AU),
            array("030-3-2 23 12 34", RegionCode::DE),
            array("03 0 -3 2 23 12 34", RegionCode::DE),
            array("(0)3 0 -3 2 23 12 34", RegionCode::DE),
            array("0 3 0 -3 2 23 12 34", RegionCode::DE),
        );
    }

    /**
     * Strings with number-like things that should only be found up to and including the
     * "strict_grouping" leniency level.
     * @return array
     */
    public function dataStrictGroupingCases()
    {
        return array(
            array("(415) 6667777", RegionCode::US),
            array("415-6667777", RegionCode::US),
            // Should be found by strict grouping but not exact grouping, as the last two groups are
            // formatted together as a block.
            array("0800-2491234", RegionCode::DE),
            // Doesn't match any formatting in the test file, but almost matches an alternate format (the
            // last two groups have been squashed together here).
            array("0900-1 123123", RegionCode::DE),
            array("(0)900-1 123123", RegionCode::DE),
            array("0 900-1 123123", RegionCode::DE),
            // NDC also found as part of the country calling code; this shouldn't ruin the grouping
            // expectations.
            array("+33 3 34 2312", RegionCode::FR),
        );
    }

    /**
     * Strings with number-like things that should be found at all levels.
     * @return array
     */
    public function dataExactGroupingCases()
    {
        return array(
            array("４１５６６６７７７７", RegionCode::US),
            array("４１５-６６６-７７７７", RegionCode::US),
            array("4156667777", RegionCode::US),
            array("4156667777 x 123", RegionCode::US),
            array("415-666-7777", RegionCode::US),
            array("415/666-7777", RegionCode::US),
            array("415-666-7777 ext. 503", RegionCode::US),
            array("1 415 666 7777 x 123", RegionCode::US),
            array("+1 415-666-7777", RegionCode::US),
            array("+494949 49", RegionCode::DE),
            array("+49-49-34", RegionCode::DE),
            array("+49-4931-49", RegionCode::DE),
            array("04931-49", RegionCode::DE),  // With National Prefix
            array("+49-494949", RegionCode::DE),  // One group with country code
            array("+49-494949 ext. 49", RegionCode::DE),
            array("+49494949 ext. 49", RegionCode::DE),
            array("0494949", RegionCode::DE),
            array("0494949 ext. 49", RegionCode::DE),
            array("01 (33) 3461 2234", RegionCode::MX),  // Optional NP present
            array("(33) 3461 2234", RegionCode::MX),  // Optional NP omitted
            array("1800-10-10 22", RegionCode::AU),  // Breakdown assistance number.
            // Doesn't match any formatting in the test file, but matches an alternate format exactly.
            array("0900-1 123 123", RegionCode::DE),
            array("(0)900-1 123 123", RegionCode::DE),
            array("0 900-1 123 123", RegionCode::DE),
            array("+33 3 34 23 12", RegionCode::FR),
        );
    }

    public function data_testMatchesWithPossibleLeniency()
    {
        return $this->dataStrictGroupingCases()
        + $this->dataExactGroupingCases()
        + $this->dataValidCases()
        + $this->dataPossibleOnlyCases();
    }

    /**
     * @param string $rawString
     * @param string $region
     * @dataProvider data_testMatchesWithPossibleLeniency
     */
    public function testMatchesWithPossibleLeniency($rawString, $region)
    {
        $this->doTestNumberMatchesForLeniency($rawString, $region, Leniency::POSSIBLE());
    }

    /**
     * @param string $rawString
     * @param string $region
     * @dataProvider dataImpossibleCases
     */
    public function testNonMatchesWithPossibleLeniency($rawString, $region)
    {
        $this->doTestNumberNonMatchesForLeniency($rawString, $region, Leniency::POSSIBLE());
    }

    public function data_testMatchesWithValidLeniency()
    {
        return $this->dataStrictGroupingCases()
        + $this->dataExactGroupingCases()
        + $this->dataValidCases();
    }

    /**
     * @param string $rawString
     * @param string $region
     * @dataProvider data_testMatchesWithValidLeniency
     */
    public function testMatchesWithValidLeniency($rawString, $region)
    {
        $this->doTestNumberMatchesForLeniency($rawString, $region, Leniency::VALID());
    }

    public function data_testNonMatchesWithValidLeniency()
    {
        return $this->dataImpossibleCases()
            + $this->dataPossibleOnlyCases();
    }

    /**
     * @param $rawString
     * @param $region
     * @dataProvider data_testNonMatchesWithValidLeniency
     */
    public function testNonMatchesWithValidLeniency($rawString, $region)
    {
        $this->doTestNumberNonMatchesForLeniency($rawString, $region, Leniency::VALID());
    }

    public function data_testMatchesWithStrictGroupingLeniency()
    {
        return $this->dataStrictGroupingCases()
            + $this->dataExactGroupingCases();
    }

    /**
     * @param string $rawString
     * @param string $region
     * @dataProvider data_testMatchesWithStrictGroupingLeniency
     */
    public function testMatchesWithStrictGroupingLeniency($rawString, $region)
    {
        $this->doTestNumberMatchesForLeniency($rawString, $region, Leniency::STRICT_GROUPING());
    }

    public function data_testNonMatchesWithStrictGroupLeniency()
    {
        return $this->dataImpossibleCases()
            + $this->dataPossibleOnlyCases()
            + $this->dataValidCases();
    }

    /**
     * @param string $rawString
     * @param string $region
     * @dataProvider data_testNonMatchesWithStrictGroupLeniency
     */
    public function testNonMatchesWithStrictGroupLeniency($rawString, $region)
    {
        $this->doTestNumberNonMatchesForLeniency($rawString, $region, Leniency::STRICT_GROUPING());
    }

    /**
     * @param string $rawString
     * @param string $region
     * @dataProvider dataExactGroupingCases
     */
    public function testMatchesWithExactGroupingLeniency($rawString, $region)
    {
        $this->doTestNumberMatchesForLeniency($rawString, $region, Leniency::EXACT_GROUPING());
    }

    public function data_testNonMatchesExactGroupLeniency()
    {
        return $this->dataImpossibleCases()
            + $this->dataPossibleOnlyCases()
            + $this->dataValidCases()
            + $this->dataStrictGroupingCases();
    }

    /**
     * @param string $rawString
     * @param string $region
     * @dataProvider data_testNonMatchesExactGroupLeniency
     */
    public function testNonMatchesExactGroupLeniency($rawString, $region)
    {
        $this->doTestNumberNonMatchesForLeniency($rawString, $region, Leniency::EXACT_GROUPING());
    }

    private function doTestNumberMatchesForLeniency($string, $region, Leniency\AbstractLeniency $leniency)
    {
        $iterator = $this->findNumbersForLeniency($string, $region, $leniency);

        $iterator->next();
        $match = $iterator->current();

        $this->assertNotNull($match, "No match found in {$string} ({$region}) for leniency {$leniency}");
        $this->assertEquals($string, $match->rawString(), "Found wrong match in test {$string} ({$region}). Found {$match->rawString()}");
    }

    private function doTestNumberNonMatchesForLeniency($string, $region, Leniency\AbstractLeniency $leniency)
    {
        $iterator = $this->findNumbersForLeniency($string, $region, $leniency);

        $iterator->next();
        $match = $iterator->current();

        $this->assertNull($match, "Match found in {$string} ({$region}) for leniency {$leniency}");
    }

    /**
     * Helper method which tests the contexts provided and ensures that:
     * -- if isValid is true, they all find a test number inserted in the middle when leniency of
     *  matching is set to VALID; else no test number should be extracted at that leniency level
     * -- if isPossible is true, they all find a test number inserted in the middle when leniency of
     *  matching is set to POSSIBLE; else no test number should be extracted at that leniency level
     *
     *
     * @param array $contexts
     * @param bool $isValid
     * @param bool $isPossible
     * @param string $region
     * @param string $number
     */
    private function findMatchesInContexts($contexts, $isValid, $isPossible, $region = RegionCode::US, $number = "415-666-7777")
    {
        if ($isValid) {
            $this->doTestInContext($number, $region, $contexts, Leniency::VALID());
        } else {
            foreach ($contexts as $context) {
                $text = $context[0] . $number . $context[1];
                $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers($text, $region)),
                    "Should not have found a number in {$text}");
            }
        }

        if ($isPossible) {
            $this->doTestInContext($number, $region, $contexts, Leniency::POSSIBLE());
        } else {
            foreach ($contexts as $context) {
                $text = $context[0] . $number . $context[1];
                $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers($text, $region)),
                    "Should not have found a number in {$text}");
            }
        }
    }

    public function testNonMatchingBracketsAreInvalid()
    {
        // The digits up to the ", " form a valid US number, but it shouldn't be matched as one since
        // there was a non-matching bracket present.
        $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers(
            "80.585 [79.964, 81.191]", RegionCode::US)));

        // The trailing "]" is thrown away before parsing, so the resultant number, while a valid US
        // number, does not have matching brackets.
        $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers(
            "80.585 [79.964]", RegionCode::US)));

        $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers(
            "80.585 ((79.964)", RegionCode::US)));

        // This case has too many sets of brackets to be valid.
        $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers(
            "(80).(585) (79).(9)64", RegionCode::US)));
    }

    public function testNoMatchIfRegionIsNull()
    {
        // Fail on non-international prefix if region code is null.
        $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers(
            "Random text body - number is 0331 6005, see you there", null)));
    }

    public function testNoMatchInEmptyString()
    {
        $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers("", RegionCode::US)));
        $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers("  ", RegionCode::US)));
    }

    public function testNoMatchIfNoNumber()
    {
        $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers(
            "Random text body - number is foobar, see you there", RegionCode::US)));
    }

    public function testSequences()
    {
        // Test multiple occurrences.
        $text = "Call 033316005  or 032316005!";
        $region = RegionCode::NZ;

        $number1 = new PhoneNumber();
        $number1->setCountryCode($this->phoneUtil->getCountryCodeForRegion($region));
        $number1->setNationalNumber(33316005);
        $match1 = new PhoneNumberMatch(5, "033316005", $number1);

        $number2 = new PhoneNumber();
        $number2->setCountryCode($this->phoneUtil->getCountryCodeForRegion($region));
        $number2->setNationalNumber(32316005);
        $match2 = new PhoneNumberMatch(19, "032316005", $number2);

        $matches = $this->phoneUtil->findNumbers($text, $region, Leniency::POSSIBLE());

        $matches->next();
        $this->assertEquals($match1, $matches->current());

        $matches->next();
        $this->assertEquals($match2, $matches->current());
    }

    public function testNullInput()
    {
        $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers(null, RegionCode::US)));
        $this->assertTrue($this->hasNoMatches($this->phoneUtil->findNumbers(null, null)));
    }

    public function testMaxMatches()
    {
        // Set up text with 100 valid phone numbers.
        $numbers = str_repeat("My info: 415-666-7777,", 100);

        // Matches all 100. Max only applies to failed cases.
        $number = $this->phoneUtil->parse("+14156667777", null);
        $expected = array_fill(0, 100, $number);

        $iterable = $this->phoneUtil->findNumbers($numbers, RegionCode::US, Leniency::VALID(), 10);
        $actual = array();
        foreach ($iterable as $match) {
            $actual[] = $match->number();
        }

        $this->assertEquals($expected, $actual);
    }

    public function testMaxMatchesInvalid()
    {
        // Set up text with 10 invalid phone numbers followed by 100 valid.
        $numbers = "";
        for ($i = 0; $i < 10; $i++) {
            $numbers .= "My address is 949-8945-0";
        }
        for ($i = 0; $i < 100; $i++) {
            $numbers .= "My info: 415-666-7777,";
        }

        $iterable = $this->phoneUtil->findNumbers($numbers, RegionCode::US, Leniency::VALID(), 10);
        $iterable->next();
        $this->assertNull($iterable->current());
    }

    public function testMaxMatchesMixed()
    {
        // Set up text with 100 valid numbers inside an invalid number.
        $numbers = "";
        for ($i = 0; $i < 100; $i++) {
            $numbers .= "My info: 415-666-7777 123 fake street";
        }

        // Only matches the first 10 despite there being 100 numbers due to max matches
        $number = $this->phoneUtil->parse("+14156667777", null);
        $expected = array_fill(0, 10, $number);

        $iterable = $this->phoneUtil->findNumbers($numbers, RegionCode::US, Leniency::VALID(), 10);

        $actual = array();
        foreach ($iterable as $match) {
            $actual[] = $match->number();
        }

        $this->assertEquals($expected, $actual);
    }

    public function testNonPlusPrefixedNumbersNotFoundForInvalidRegion()
    {
        // Does not start with a "+", we won't match it.
        $iterable = $this->phoneUtil->findNumbers("1 456 764 156", RegionCode::ZZ);

        $iterable->next();
        $this->assertFalse($iterable->valid());
    }

    public function testEmptyIteration()
    {
        $iterable = $this->phoneUtil->findNumbers("", RegionCode::ZZ);

        $iterable->next();
        $this->assertFalse($iterable->valid());
    }

    public function testSingleIteration()
    {
        $iterable = $this->phoneUtil->findNumbers("+14156667777", RegionCode::ZZ);

        $iterable->next();
        $this->assertTrue($iterable->valid());
        $this->assertNotNull($iterable->current());

        $iterable->next();
        $this->assertFalse($iterable->valid());
        $this->assertNull($iterable->current());
    }

    public function testDoubleIteration()
    {
        $iterable = $this->phoneUtil->findNumbers("+14156667777 foobar +14156667777 ", RegionCode::ZZ);

        $iterable->next();
        $this->assertTrue($iterable->valid());
        $this->assertNotNull($iterable->current());

        $iterable->next();
        $this->assertTrue($iterable->valid());
        $this->assertNotNull($iterable->current());

        $iterable->next();
        $this->assertFalse($iterable->valid());
        $this->assertNull($iterable->current());
    }

    /**
     * Asserts that the expected match is non-null, and that the raw string and expected
     * proto buffer are set appropriately
     *
     * @param PhoneNumberMatch $match
     * @param string $text
     * @param string $number
     * @param string $region
     */
    private function assertMatchProperties(PhoneNumberMatch $match, $text, $number, $region)
    {
        $expectedResult = $this->phoneUtil->parse($number, $region);
        $this->assertNotNull($match, "Did not find a number in {$text}; expected {$number}");
        $this->assertEquals($expectedResult, $match->number());
        $this->assertEquals($number, $match->rawString());
    }

    /**
     * Asserts that another number can be found in $text starting at $index, and that its
     * corresponding range in $start to $end
     *
     * @param string $text
     * @param int $index
     * @param int $start
     * @param int $end
     */
    private function assertEqualRange($text, $index, $start, $end)
    {
        $sub = mb_substr($text, $index, mb_strlen($text) - $index);
        $matches = $this->phoneUtil->findNumbers($sub, RegionCode::NZ, Leniency::POSSIBLE(), PHP_INT_MAX);

        $matches->next();
        $this->assertTrue($matches->valid());

        $match = $matches->current();

        $this->assertEquals($start - $index, $match->start());
        $this->assertEquals($end - $index, $match->end());
        $this->assertEquals(mb_substr($sub, $match->start(), $match->end() - $match->start()), $match->rawString());
    }

    /**
     * Tests numbers found by PhoneNumberUtil->findNumbers in various
     * textual contexts
     *
     * @param string $number The number to test
     * @param string $defaultCountry The corresponding region code
     */
    private function doTestFindInContext($number, $defaultCountry)
    {
        $this->findPossibleInContext($number, $defaultCountry);

        $parsed = $this->phoneUtil->parse($number, $defaultCountry);
        if ($this->phoneUtil->isValidNumber($parsed)) {
            $this->findValidInContext($number, $defaultCountry);
        }
    }

    /**
     * Tests valid numbers in contexts that should pass for Leniency::POSSIBLE()
     * @param $number
     * @param $defaultCountry
     */
    private function findPossibleInContext($number, $defaultCountry)
    {
        $contextPairs = array();
        $contextPairs[] = array("", ""); // no content
        $contextPairs[] = array("   ", "\t");  // whitespace only
        $contextPairs[] = array("Hello ", ""); // no context at end
        $contextPairs[] = array("", " to call me!"); // no context at start
        $contextPairs[] = array("Hi there, call ", " to reach me!"); // no context at start
        $contextPairs[] = array("Hi here, call ", " , or don't"); // with commas
        // Three examples without whitespace around the number
        $contextPairs[] = array("Hi call", "");
        $contextPairs[] = array("", "forme");
        $contextPairs[] = array("Hi call", "forme");
        // With other small numbers.
        $contextPairs[] = array("It's cheap! Call ", " before 6:30");
        // With a second number later.
        $contextPairs[] = array("Call ", " or +1800-123-4567!");
        $contextPairs[] = array("Call me on June 2 at", ""); // with a Month-Day date
        // With publication pages
        $contextPairs[] = array("As quoted by Alfonso 12-15 (2009), you may call me at ", "");
        $contextPairs[] = array("As quoted by Alfonso et al. 12-15 (2009), you may call me at ", "");
        // With dates, written in the American style.
        $contextPairs[] = array("As I said on 03/10/2011, you may call be at ", "");
        // With trailing numbers after a comma. The 45 should not be considered an extension
        $contextPairs[] = array("", ", 45 days a year");
        // When matching we don't consider semicolon along with legitimate extension symbol to indicate
        // an extension. The 7246433 should not be considered an extension.
        $contextPairs[] = array("", ";x 7246433");
        // With a postfix stripped off as it looks like the start of another number.
        $contextPairs[] = array("Call ", "/x12 more");

        $this->doTestInContext($number, $defaultCountry, $contextPairs, Leniency::POSSIBLE());
    }

    /**
     * Tests valid numbers in contexts that fail for Leniency::POSSIBLE() but are valid for
     * Leniency::VALID()
     *
     * @param string $number
     * @param string $defaultCountry
     */
    private function findValidInContext($number, $defaultCountry)
    {
        $contextPairs = array();
        // With other small numbers
        $contextPairs[] = array("It's only 9.99! Call ", " to buy");
        // with a number Day.Month.Year date.
        $contextPairs[] = array("Call me on 21.6.1984 at ", "");
        // With a number Month/Day date.
        $contextPairs[] = array("Call me on 06/21 at ", "");
        // With a number Day.Month date.
        $contextPairs[] = array("Call me on 21.6. at ", "");
        // With a number Month/Day/Year date.
        $contextPairs[] = array("Call me on 06/21/84 at ", "");

        $this->doTestInContext($number, $defaultCountry, $contextPairs, Leniency::VALID());
    }

    private function doTestInContext($number, $defaultCountry, $contextPairs, Leniency\AbstractLeniency $leniency)
    {
        foreach ($contextPairs as $context) {
            $prefix = $context[0];
            $text = $prefix . $number . $context[1];

            $start = mb_strlen($prefix);
            $end = $start + mb_strlen($number);

            $iterator = $this->phoneUtil->findNumbers($text, $defaultCountry, $leniency, PHP_INT_MAX);

            $iterator->next();
            $match = $iterator->current();
            $this->assertNotNull($match, "Did not find number in '{$text}'; expected '{$number}'");

            $extracted = mb_substr($text, $match->start(), $match->end() - $match->start());
            $this->assertEquals($start, $match->start(), "Unexpected phone region in '{$text}'; extracted '{$extracted}'");
            $this->assertEquals($end, $match->end(), "Unexpected phone region in '{$text}'; extracted '{$extracted}'");
            $this->assertEquals($number, $extracted);
            $this->assertEquals($extracted, $match->rawString());

            $this->ensureTermination($text, $defaultCountry, $leniency);
        }
    }

    private function ensureTermination($text, $defaultCountry, Leniency\AbstractLeniency $leniency)
    {

        $textLength = mb_strlen($text);
        for ($index = 0; $index <= $textLength; $index++) {
            $sub = mb_substr($text, $index);
            $matches = "";
            // Iterates over all matches.
            foreach ($this->phoneUtil->findNumbers($sub, $defaultCountry, $leniency, PHP_INT_MAX) as $match)
            {
                $matches .= ", " . $match;
            }
        }
    }

    private function findNumbersForLeniency($text, $defaultCountry, Leniency\AbstractLeniency $leniency)
    {
        return $this->phoneUtil->findNumbers($text, $defaultCountry, $leniency, PHP_INT_MAX);
    }

    private function hasNoMatches(PhoneNumberMatcher $match)
    {
        return !$match->valid();
    }
}