[4.x] [SWP-2788] Introduce memoization for efficiency during use on mass (#44)

**Changes**
- Introduced a history for finds in the CountryHelper so that we don't perform the same lookup many times
- Introduced a caching layer for NumberFormatters used in the CurrencyHelper to avoid creating many unnecessary instances when used on mass

Author: clemblanco

.styleci.yml

@@ -1 +1,5 @@
 preset: laravel
+enabled:
+  - concat_with_spaces
+disabled:
+  - concat_without_spaces

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to `pod-point/countries` will be documented in this file.
 
+## 5.0.1 - 2021-05-19
+
+* [SWP-2788](https://podpoint.atlassian.net/browse/SWP-2788) Introduce memoization for efficiency during use on mass
+  * Introduced a history for finds in the `CountryHelper` so that we don't perform the same lookup many times
+  * Introduced a caching layer for `NumberFormatters` used in the `CurrencyHelper` to avoid creating many unnecessary instances when used on mass
+
 ## 5.0.0 - 2021-05-18
 
 * Major release to support PHP 7.3+ and Laravel 7.x+
@@ -18,6 +24,12 @@ All notable changes to `pod-point/countries` will be documented in this file.
 
 * This package can no longer support PHP7.2 - if using PHP7.2 please use version 4.*.
 
+## 4.0.2 - 2021-05-19
+
+* [SWP-2788](https://podpoint.atlassian.net/browse/SWP-2788) Introduce memoization for efficiency during use on mass
+  * Introduced a history for finds in the `CountryHelper` so that we don't perform the same lookup many times
+  * Introduced a caching layer for `NumberFormatters` used in the `CurrencyHelper` to avoid creating many unnecessary instances when used on mass
+
 ## 4.0.1 - 2021-05-18
 
 * Implement Laravel Auto-Discovery
@@ -38,6 +50,17 @@ All notable changes to `pod-point/countries` will be documented in this file.
 
 * This package can no longer support PHP7.1 - if using PHP7.1 please use version 3.*.
 
+## 3.1.3 - 2021-05-19
+
+* [SWP-2788](https://podpoint.atlassian.net/browse/SWP-2788) Introduce memoization for efficiency during use on mass
+  * Introduced a history for finds in the `CountryHelper` so that we don't perform the same lookup many times
+  * Introduced a caching layer for `NumberFormatters` used in the `CurrencyHelper` to avoid creating many unnecessary instances when used on mass
+
+## 3.1.2 - 2021-05-18
+
+* Minor modernisations
+* Moved from Travis CI to Github Actions
+
 ## 3.1.1 - 2020-11-05
 
 * `getSystemLocale` in `LocalizedHelper` now returns the fallback locale if the given one is not found. This created issues with some tests because NumberFormatter becomes system dependent if null is given.

README.md

@@ -31,7 +31,7 @@ For Laravel 7.x or 8.x and PHP >= 7.3
 composer require pod-point/countries:^5.0
 ```
 
-Then finally, if you're using a Laravel version which doesn't support Auto Discovery, add the service provider to your `config/app.php` providers array:
+Then, finally, if you're using a Laravel version which doesn't support Auto Discovery, add the service provider to your `config/app.php` providers array:
 
 ```php
 'providers' => [
@@ -49,9 +49,9 @@ $app->register(PodPoint\I18n\CountriesServiceProvider::class);
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
-## License
+## Licence
 
-The MIT License (MIT). Please see [License File](LICENCE.md) for more information.
+The MIT Licence (MIT). Please see [Licence File](LICENCE.md) for more information.
 
 ---
 

src/CountriesServiceProvider.php

@@ -36,7 +36,7 @@ protected function mergeConfig()
             'countries-partial',
         ])->each(function ($key) {
             $this->app->config->set($key, array_merge(
-                require __DIR__."/../config/$key.php",
+                require __DIR__ . "/../config/$key.php",
                 $this->app->config->get($key, [])
             ));
         });

src/CountryHelper.php

@@ -4,6 +4,13 @@
 
 class CountryHelper extends Helper
 {
+    /**
+     * Recent lookup results by `property-value`.
+     *
+     * @var array
+     */
+    protected $results = [];
+
     /**
      * Returns the first country matching the given property/value pair.
      *
@@ -14,7 +21,13 @@ class CountryHelper extends Helper
      */
     public function findBy(string $property, $value): ?array
     {
-        return collect($this->config->get('countries'))
+        $key = $this->generateResultsKey($property, $value);
+
+        if ($this->results[$key] ?? false) {
+            return $this->results[$key];
+        }
+
+        return $this->results[$key] = collect($this->config->get('countries'))
             ->where($property, $value)
             ->first();
     }
@@ -45,4 +58,16 @@ public function getCountryCodeFromLocale(string $locale): ?string
 
         return $code ? $code : null;
     }
+
+    /**
+     * Generate a string formed of the property and value for the results cache.
+     *
+     * @param string $property
+     * @param string $value
+     * @return string
+     */
+    protected function generateResultsKey(string $property, string $value): string
+    {
+        return "${property}-{$value}";
+    }
 }

src/CurrencyHelper.php

@@ -6,25 +6,29 @@
 
 class CurrencyHelper extends LocalizedHelper
 {
+    /**
+     * Number Formatters created per locale.
+     *
+     * @var array
+     */
+    protected $localizedFormatters = [];
+
     /**
      * Return a value in the given currency formatted for the given locale.
      *
      * @param float|int $value
      * @param string $currencyCode
      * @param string $locale
+     * @return string
      *
      * @deprecated toStandardFormat should be used.
-     * @return string
      */
     public function toFormat(
         $value,
         string $currencyCode = CurrencyCode::POUND_STERLING,
         string $locale = 'en'
     ): string {
-        $formatter = new NumberFormatter(
-            $this->getSystemLocale($locale),
-            NumberFormatter::CURRENCY
-        );
+        $formatter = $this->getFormatter($locale);
 
         /*
          * NumberFormatter will round up with 2 decimals only by default.
@@ -71,10 +75,7 @@ public function formatToMinorUnitWhenApplicable(
         $pattern = $this->getMinorUnitPattern($locale);
 
         if ($value <= $this->getMinorUnitEnd($locale) && $pattern) {
-            $formatter = new NumberFormatter(
-                $this->getSystemLocale($locale),
-                NumberFormatter::CURRENCY
-            );
+            $formatter = $this->getFormatter($locale);
 
             $formatter->setPattern($pattern);
 
@@ -94,10 +95,7 @@ public function formatToMinorUnitWhenApplicable(
      */
     public function getSymbol(string $currencyCode = CurrencyCode::POUND_STERLING, string $locale = 'en'): string
     {
-        $formatter = new NumberFormatter(
-            "{$this->getSystemLocale($locale)}@currency={$currencyCode}",
-            NumberFormatter::CURRENCY
-        );
+        $formatter = $this->getFormatter($locale);
 
         return $formatter->getSymbol(NumberFormatter::CURRENCY_SYMBOL);
     }
@@ -119,7 +117,7 @@ public function toStandardFormat(
         string $locale = 'en',
         $precision = null
     ): string {
-        $formatter = new NumberFormatter($this->getSystemLocale($locale), NumberFormatter::CURRENCY);
+        $formatter = $this->getFormatter($locale);
 
         if (is_int($precision)) {
             $formatter->setAttribute(NumberFormatter::MAX_FRACTION_DIGITS, $precision);
@@ -128,4 +126,31 @@ public function toStandardFormat(
 
         return $formatter->formatCurrency($value, $currencyCode);
     }
+
+    /**
+     * Get an instance of a localized Formatter.
+     *
+     * @param string $locale
+     * @return NumberFormatter
+     */
+    protected function getFormatter(string $locale): NumberFormatter
+    {
+        return $this->localizedFormatters[$locale]
+            ?? $this->setFormatter(
+                $locale,
+                new NumberFormatter($this->getSystemLocale($locale), NumberFormatter::CURRENCY)
+            );
+    }
+
+    /**
+     * Set an instance of a localized Formatter.
+     *
+     * @param string $locale
+     * @param NumberFormatter $formatter
+     * @return NumberFormatter
+     */
+    public function setFormatter(string $locale, NumberFormatter $formatter): NumberFormatter
+    {
+        return $this->localizedFormatters[$locale] = $formatter;
+    }
 }

src/ViewComposers/CountryCodeViewComposer.php

@@ -124,7 +124,7 @@ private function countryLabel(string $countryCode, string $countryName, $diallin
      */
     private function countryNameMarkup(string $name, bool $defaultChoice = false): string
     {
-        return '&nbsp;<span class="country-name'.($defaultChoice ? ' country-name--heading' : '').'">'.$name.'</span>';
+        return '&nbsp;<span class="country-name' . ($defaultChoice ? ' country-name--heading' : '') . '">' . $name . '</span>';
     }
 
     /**
@@ -141,7 +141,7 @@ private function dialingCodeMarkup(?int $diallingCode = null, bool $defaultChoic
             return '';
         }
 
-        return '&nbsp;<span class="country-dialling-code'.($defaultChoice ? ' country-dialling-code--heading' : '').'">(+'.$diallingCode.')</span>';
+        return '&nbsp;<span class="country-dialling-code' . ($defaultChoice ? ' country-dialling-code--heading' : '') . '">(+' . $diallingCode . ')</span>';
     }
 
     /**
@@ -203,7 +203,7 @@ private function unicodeCharacter(string $letter): string
         $letter = strtolower($letter);
 
         if (array_key_exists($letter, $codes)) {
-            return mb_convert_encoding('&#x'.$codes[$letter].';', 'UTF-8', 'HTML-ENTITIES');
+            return mb_convert_encoding('&#x' . $codes[$letter] . ';', 'UTF-8', 'HTML-ENTITIES');
         }
 
         return '';

tests/TestCase.php

@@ -38,8 +38,8 @@ public function loadConfiguration()
 
         try {
             $this->app->config = new Repository([
-                'countries' => $filesystem->getRequire(__DIR__.'/../src/config/countries.php'),
-                'countries-partial' => $filesystem->getRequire(__DIR__.'/../src/config/countries-partial.php'),
+                'countries' => $filesystem->getRequire(__DIR__ . '/../src/config/countries.php'),
+                'countries-partial' => $filesystem->getRequire(__DIR__ . '/../src/config/countries-partial.php'),
             ]);
         } catch (FileNotFoundException $e) {
             exit("Package configuration files not found: {$e->getMessage()}");

tests/Unit/CountriesServiceProviderTest.php

@@ -29,7 +29,7 @@ public function testCountriesConfigIsEnhancedWithAdditionalInfo()
     {
         $this->loadConfiguration();
 
-        $countryWithBasicInfo = $this->app->config->get('countries.'.CountryCode::UNITED_KINGDOM);
+        $countryWithBasicInfo = $this->app->config->get('countries.' . CountryCode::UNITED_KINGDOM);
 
         $this->assertArrayHasKey('name', $countryWithBasicInfo);
         $this->assertArrayHasKey('diallingCode', $countryWithBasicInfo);
@@ -46,8 +46,8 @@ public function testCountriesConfigIsEnhancedWithAdditionalInfo()
         $this->loadServiceProvider();
 
         collect([
-            $this->app->config->get('countries.'.CountryCode::UNITED_KINGDOM),
-            $this->app->config->get('countries-partial.'.CountryCode::UNITED_KINGDOM),
+            $this->app->config->get('countries.' . CountryCode::UNITED_KINGDOM),
+            $this->app->config->get('countries-partial.' . CountryCode::UNITED_KINGDOM),
         ])->each(function ($enhancedCountry) {
             $this->assertArrayHasKey('name', $enhancedCountry);
             $this->assertArrayHasKey('diallingCode', $enhancedCountry);