4.x release

juanparati · May 25, 2023 · 95e21e9 · 95e21e9
1 parent 2e602ab
commit 95e21e9
Show file tree

Hide file tree

Showing 11 changed files with 259 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@ Publish configuration file (Required only when custom dataset or locales are req
 
 The list of results are returned as [Collections](https://laravel.com/docs/9.x/collections).
 
-### Country model
+### Country model examples
 
 Get the list of all country codes as an array:
 
@@ -191,11 +191,10 @@ Retrieve a list of countries that has Portuguese as one of their official langua
     ->whereLanguage('PT');
 ```
 
-* Note that most spoken language should be always the first in the list.
+* Note that most spoken language of each country should be always the first in the list.
 
 
-### Language model
-
+### Language model examples
 Get the list grouped by language:
 
 ```php
@@ -233,7 +232,7 @@ It returns something like:
     ];
 
 
-### Continent model
+### Continent model examples
 
 Get the list grouped by continent.
 
@@ -244,7 +243,7 @@ Example:
 ```
 
 
-### Currency model
+### Currency model examples
 
 Get the list grouped by currency.
 
@@ -254,7 +253,7 @@ Example:
 (new ISOCodes)->currencies()->toArray();
 ```
 
-### CurrencyNumber model
+### CurrencyNumber model examples
 
 Get the list grouped by currency number.
 
@@ -319,9 +318,9 @@ Examples:
 ```php
 (new ISOCodes)
     ->countries()
-    ->setResolution('currencies', CountryModel::NODE_AS_ALL)
-    ->setResolution('languages', CountryModel::NODE_AS_NAME)
-    ->setResolution('continents', CountryModel::NODE_AS_NONE)
+    ->setResolution('currencies', \Juanparati\ISOCodes\Enums\NodeResolution::NODE_AS_ALL)
+    ->setResolution('languages', \Juanparati\ISOCodes\Enums\NodeResolution::NODE_AS_ALL)
+    ->setResolution('continents', \Juanparati\ISOCodes\Enums\NodeResolution::NODE_AS_ALL)
     ->findByAlpha2('PT')
     ->toArray();
 ```
@@ -371,6 +370,31 @@ instead of:
 
 The node resolutions works with the others models like "currencies", "languages", etc.
 
+#### Node resolutions and immutability
+
+When the resolution is changed it will be back to the previous state in the next model call.
+
+Example:
+
+```php
+$iso = new ISOCodes();
+
+echo $iso->countries()
+    ->setResolution('currencies', \Juanparati\ISOCodes\Enums\NodeResolution::NODE_AS_ALL)
+    ->findByAlpha2('PT')
+    ->currencies[0];  // Returns "Euro"
+
+echo $iso->countries()
+    ->findByAlpha2('PT')
+    ->currencies[0];  // Returns "EUR"
+```
+In order to keep persistent the resolutions it's possible to pass the resolution values to the constructor. Example:
+
+```php
+$iso = new ISOCodes(new ISOCodes(defaultResolutions: [
+            'currencies' =>  \Juanparati\ISOCodes\Enums\NodeResolution::NODE_AS_NAME
+        ]);
+```
 
 ## Custom dataset and locales
 

diff --git a/composer.json b/composer.json
@@ -3,7 +3,7 @@
     "description": "A PHP library that provides ISO codes for countries, currencies and languages.",
     "type": "library",
     "require": {
-        "php": "^8.0",
+        "php": "^8.1",
         "ext-ctype": "*",
         "illuminate/support": "^8.34.0|~v9.0|~v10.0"
     },

diff --git a/config/isocodes.php b/config/isocodes.php
@@ -20,4 +20,28 @@
         'continents'     => \Juanparati\ISOCodes\Data\Continents\ContinentsEN::class,
     ],
 
+
+    /*
+    |--------------------------------------------------------------------------
+    | Default resolutions
+    |--------------------------------------------------------------------------
+    |
+    */
+    'resolutions' => [
+        'currencies'  => \Juanparati\ISOCodes\Enums\NodeResolution::NODE_AS_CODE,
+        'continents'  => \Juanparati\ISOCodes\Enums\NodeResolution::NODE_AS_CODE,
+        'languages'   => \Juanparati\ISOCodes\Enums\NodeResolution::NODE_AS_CODE,
+    ],
+
+
+    /*
+    |--------------------------------------------------------------------------
+    | Additional options
+    |--------------------------------------------------------------------------
+    |
+    */
+    'options' => [
+        'currencyAsNumber' => false   // Specify if the currency code is returned as a number.
+    ],
+
 ];
diff --git a/src/Contracts/ISOModelContract.php b/src/Contracts/ISOModelContract.php
@@ -3,6 +3,7 @@
 namespace Juanparati\ISOCodes\Contracts;
 
 use Illuminate\Support\Collection;
+use Juanparati\ISOCodes\Enums\NodeResolution;
 use Juanparati\ISOCodes\ISOCodes;
 
 interface ISOModelContract
@@ -30,4 +31,31 @@ public function all(bool $asArray = false): Collection;
      * @return array
      */
     public function list(): Collection;
+
+
+    /**
+     * Clone model.
+     *
+     * @return static
+     */
+    public function clone(): static;
+
+
+    /**
+     * Set resolution.
+     *
+     * @param string $node
+     * @param NodeResolution $format
+     * @return $this
+     */
+    public function setResolution(string $node, NodeResolution $format): static;
+
+
+    /**
+     * Set currency as number.
+     *
+     * @param bool $state
+     * @return $this
+     */
+    public function setCurrencyAsNumber(bool $state): static;
 }
diff --git a/src/Enums/NodeResolution.php b/src/Enums/NodeResolution.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Juanparati\ISOCodes\Enums;
+
+enum NodeResolution
+{
+    case NODE_AS_CODE;
+    case NODE_AS_NAME;
+    case NODE_AS_ALL;
+    case NODE_AS_NONE;
+}
diff --git a/src/ISOCodes.php b/src/ISOCodes.php
@@ -5,6 +5,7 @@
 use Illuminate\Support\Pluralizer;
 use Juanparati\ISOCodes\Contracts\ISODataContract;
 use Juanparati\ISOCodes\Contracts\ISOModelContract;
+use Juanparati\ISOCodes\Enums\NodeResolution;
 use Juanparati\ISOCodes\Exceptions\ISOModelNotFound;
 
 /**
@@ -33,6 +34,28 @@ class ISOCodes
     ];
 
 
+    /**
+     * Default resolutions.
+     *
+     * @var array
+     */
+    protected array $defaultResolutions = [
+        'currencies'  => NodeResolution::NODE_AS_CODE,
+        'continents'  => NodeResolution::NODE_AS_CODE,
+        'languages'   => NodeResolution::NODE_AS_CODE,
+    ];
+
+
+    /**
+     * Default options.
+     *
+     * @var array|false[]
+     */
+    protected array $defaultOptions = [
+        'currencyAsNumber' => false
+    ];
+
+
     /**
      * Loaded models.
      *
@@ -53,10 +76,18 @@ class ISOCodes
      * Constructor.
      *
      * @param array $datasets
+     * @param array $defaultResolutions
+     * @param array $defaultOptions
      */
-    public function __construct(array $datasets = [])
+    public function __construct(
+        array $datasets = [],
+        array $defaultResolutions = [],
+        array $defaultOptions = [],
+    )
     {
         $this->datasets = array_merge($this->datasets, $datasets);
+        $this->defaultResolutions = array_merge($this->defaultResolutions, $defaultResolutions);
+        $this->defaultOptions = array_merge($this->defaultOptions, $defaultOptions);
     }
 
 
@@ -80,7 +111,13 @@ public function __call(string $name, array $args)
             }
         }
 
-        return $this->modelInstances[$model];
+
+        foreach ($this->defaultResolutions as $node => $resolution) {
+            $this->modelInstances[$model]->setResolution($node, $resolution);
+        }
+
+        return $this->modelInstances[$model]
+            ->setCurrencyAsNumber($this->defaultOptions['currencyAsNumber'] ?? false);
     }
 
 

diff --git a/src/Models/BasicModelBase.php b/src/Models/BasicModelBase.php
@@ -4,8 +4,10 @@
 
 use Illuminate\Support\Collection;
 use Illuminate\Support\Traits\Macroable;
+use Juanparati\ISOCodes\Enums\NodeResolution;
 use Juanparati\ISOCodes\Exceptions\ISONodeAttributeMissing;
 use Juanparati\ISOCodes\ISOCodes;
+use SebastianBergmann\CodeCoverage\Report\Xml\Node;
 
 /**
  * Base class used by the models.
@@ -15,24 +17,16 @@ abstract class BasicModelBase
 
     use Macroable;
 
-    /**
-     * Subnode resolution formats.
-     */
-    public const NODE_AS_CODE      = 'code';
-    public const NODE_AS_NAME      = 'name';
-    public const NODE_AS_ALL       = 'all';
-    public const NODE_AS_NONE      = 'none';
-
 
     /**
      * Define node resolution formats.
      *
-     * @var array
+     * @var NodeResolution[]
      */
     protected array $nodeResolution = [
-        'currencies'  => self::NODE_AS_CODE,
-        'continents'  => self::NODE_AS_CODE,
-        'languages'   => self::NODE_AS_CODE,
+        'currencies'  => NodeResolution::NODE_AS_CODE,
+        'continents'  => NodeResolution::NODE_AS_CODE,
+        'languages'   => NodeResolution::NODE_AS_CODE,
     ];
 
 
@@ -79,11 +73,11 @@ public function setCurrencyAsNumber(bool $state): static
      * Set the node resolution.
      *
      * @param string $node
-     * @param string $format
+     * @param NodeResolution $format
      * @return $this
      * @throws ISONodeAttributeMissing
      */
-    public function setResolution(string $node, string $format = self::NODE_AS_CODE): static
+    public function setResolution(string $node, NodeResolution $format = NodeResolution::NODE_AS_CODE): static
     {
         if (!isset($this->nodeResolution[$node])) {
             throw new ISONodeAttributeMissing('Node attribute is missing');
@@ -122,6 +116,17 @@ public function setOptions(array $options): static
     }
 
 
+    /**
+     * Clone current model.
+     *
+     * @return $this
+     */
+    public function clone() : static
+    {
+        return clone $this;
+    }
+
+
     /**
      * Resolve node data.
      *
@@ -135,16 +140,16 @@ protected function resolveNodeData(
         Collection $modelData,
         array $codes,
     ): ?array {
-        if ($this->nodeResolution[$node] === self::NODE_AS_NONE) {
+        if ($this->nodeResolution[$node] === NodeResolution::NODE_AS_NONE) {
             return null;
         }
 
         $list = [];
 
         foreach ($codes as $code) {
-            if ($this->nodeResolution[$node] === self::NODE_AS_CODE) {
+            if ($this->nodeResolution[$node] === NodeResolution::NODE_AS_CODE) {
                 $list[] = $code;
-            } elseif ($this->nodeResolution[$node] === self::NODE_AS_NAME) {
+            } elseif ($this->nodeResolution[$node] === NodeResolution::NODE_AS_NAME) {
                 $list[] = $modelData[$code] ?? null;
             } else {
                 $list[$code] = $modelData[$code] ?? null;

diff --git a/src/Models/CountryModel.php b/src/Models/CountryModel.php
@@ -5,6 +5,7 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use Juanparati\ISOCodes\Contracts\ISOModelContract;
+use Juanparati\ISOCodes\Enums\NodeResolution;
 use Juanparati\ISOCodes\Models\Extensions\CollectionMethodCallable;
 use Juanparati\ISOCodes\Models\Extensions\NodeSearchable;
 
@@ -171,8 +172,8 @@ public function all(bool $asArray = false): Collection
                     } else {
                         if ($this->options['currencyAsNumber'] && $nodeName === 'currencies') {
                             $data = match ($this->nodeResolution['currencies']) {
-                                static::NODE_AS_CODE => array_map(fn ($cur) => (string) $currencyNumbers[$cur], $data),
-                                static::NODE_AS_ALL  => collect($data)->mapWithKeys(fn ($name, $cur) => [(string) $currencyNumbers[$cur] => $name])->toArray(),
+                                NodeResolution::NODE_AS_CODE => array_map(fn ($cur) => (string) $currencyNumbers[$cur], $data),
+                                NodeResolution::NODE_AS_ALL  => collect($data)->mapWithKeys(fn ($name, $cur) => [(string) $currencyNumbers[$cur] => $name])->toArray(),
                             };
                         }
 

diff --git a/src/Providers/ISOCodesProvider.php b/src/Providers/ISOCodesProvider.php
@@ -25,7 +25,12 @@ public function register()
         $this->mergeConfigFrom(__DIR__ . '/../../config/isocodes.php', 'isocodes');
 
         $this->app->singleton(ISOCodes::class, function () {
-            return new ISOCodes($this->app['config']['isocodes']['datasets'] ?? []);
+            $config = $this->app['config']['isocodes'] ?? [];
+            return new ISOCodes(
+                $config['datasets'] ?? [],
+                $config['resolutions'] ?? [],
+                $config['options'] ?? []
+            );
         });
     }
 }