From c81828e04f46a992ce0a149c28012defa38aa8c6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julien=20Fastr=C3=A9?= <julien.fastre@champs-libres.coop>
Date: Fri, 17 May 2024 12:16:28 +0200
Subject: [PATCH] Add phone number parsing functionality

Added a new method 'parse' in the PhonenumberHelper class in ChillMainBundle to sanitize and parse phone numbers. This method specifically handles phone numbers that start with '00', '+' or '0'. Associated unit tests for this new method were also added in PhonenumberHelperTest.php.
---
 .../Phonenumber/PhonenumberHelper.php         | 18 ++++++++
 .../Phonenumber/PhonenumberHelperTest.php     | 45 +++++++++++++++++++
 2 files changed, 63 insertions(+)

diff --git a/src/Bundle/ChillMainBundle/Phonenumber/PhonenumberHelper.php b/src/Bundle/ChillMainBundle/Phonenumber/PhonenumberHelper.php
index d08d393a3..dfdf0ca49 100644
--- a/src/Bundle/ChillMainBundle/Phonenumber/PhonenumberHelper.php
+++ b/src/Bundle/ChillMainBundle/Phonenumber/PhonenumberHelper.php
@@ -76,6 +76,24 @@ final class PhonenumberHelper implements PhoneNumberHelperInterface
             ->formatOutOfCountryCallingNumber($phoneNumber, $this->config['default_carrier_code']);
     }
 
+    /**
+     * @throws NumberParseException
+     */
+    public function parse(string $phoneNumber): PhoneNumber
+    {
+        $sanitizedPhoneNumber = $phoneNumber;
+
+        if (str_starts_with($sanitizedPhoneNumber, '00')) {
+            $sanitizedPhoneNumber = '+'.substr($sanitizedPhoneNumber, 2, null);
+        }
+
+        if (!str_starts_with($sanitizedPhoneNumber, '+') && !str_starts_with($sanitizedPhoneNumber, '0')) {
+            $sanitizedPhoneNumber = '+'.$sanitizedPhoneNumber;
+        }
+
+        return $this->phoneNumberUtil->parse($sanitizedPhoneNumber, $this->config['default_carrier_code']);
+    }
+
     /**
      * Get type (mobile, landline, ...) for phone number.
      */
diff --git a/src/Bundle/ChillMainBundle/Tests/Phonenumber/PhonenumberHelperTest.php b/src/Bundle/ChillMainBundle/Tests/Phonenumber/PhonenumberHelperTest.php
index 6f65c612f..556fa9fde 100644
--- a/src/Bundle/ChillMainBundle/Tests/Phonenumber/PhonenumberHelperTest.php
+++ b/src/Bundle/ChillMainBundle/Tests/Phonenumber/PhonenumberHelperTest.php
@@ -12,6 +12,7 @@ declare(strict_types=1);
 namespace Chill\MainBundle\Tests\Phonenumber;
 
 use Chill\MainBundle\Phonenumber\PhonenumberHelper;
+use libphonenumber\PhoneNumber;
 use libphonenumber\PhoneNumberUtil;
 use Psr\Log\NullLogger;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
@@ -52,12 +53,36 @@ final class PhonenumberHelperTest extends KernelTestCase
         ];
     }
 
+    public static function providePhoneNumbersToParse(): iterable
+    {
+        $util = PhoneNumberUtil::getInstance();
+
+        yield [
+            'FR',
+            '+32486544999',
+            $util->parse('+32486544999', 'FR'),
+        ];
+
+        yield [
+            'FR',
+            '32486544999',
+            $util->parse('+32486544999', 'FR'),
+        ];
+
+        yield [
+            'FR',
+            '0228858040',
+            $util->parse('+33228858040', 'FR'),
+        ];
+    }
+
     /**
      * @dataProvider formatPhonenumbers
      */
     public function testFormatPhonenumbers(string $defaultCarrierCode, string $phoneNumber, string $expected)
     {
         $util = PhoneNumberUtil::getInstance();
+
         $subject = new PhonenumberHelper(
             new ArrayAdapter(),
             new ParameterBag([
@@ -70,4 +95,24 @@ final class PhonenumberHelperTest extends KernelTestCase
 
         $this->assertEquals($expected, $subject->format($util->parse($phoneNumber)));
     }
+
+    /**
+     * @dataProvider providePhoneNumbersToParse
+     */
+    public function testParsePhonenumbers(string $defaultCarrierCode, string $phoneNumber, PhoneNumber $expected): void
+    {
+        $subject = new PhonenumberHelper(
+            new ArrayAdapter(),
+            new ParameterBag([
+                'chill_main.phone_helper' => [
+                    'default_carrier_code' => $defaultCarrierCode,
+                ],
+            ]),
+            new NullLogger()
+        );
+
+        $actual = $subject->parse($phoneNumber);
+
+        self::assertTrue($expected->equals($actual));
+    }
 }