Merge pull request #39 from lion-packages/new

Extended helper support

src/LionBundle/Helpers/Bundle/helpers.php

@@ -8,6 +8,8 @@
 use GuzzleHttp\Psr7\Response;
 use Lion\Bundle\Enums\LogTypeEnum;
 use Lion\Bundle\Enums\StatusResponseEnum;
+use Lion\Bundle\Helpers\Env;
+use Lion\Bundle\Helpers\Fake;
 use Lion\Files\Store;
 use Lion\Request\Request;
 use Lion\Security\JWT;
@@ -256,6 +258,21 @@ function jwt(): array|object|string
      */
     function fake(string $locale = Factory::DEFAULT_LOCALE): Generator
     {
-        return Factory::create($locale);
+        return Fake::get($locale);
+    }
+}
+
+if (!function_exists('env')) {
+    /**
+     * Gets the value defined for an environment variable
+     *
+     * @param  string $key [Property name]
+     * @param  mixed $default [Default value]
+     *
+     * @return mixed
+     */
+    function env(string $key, mixed $default = null): mixed
+    {
+        return Env::get($key, $default);
     }
 }

src/LionBundle/Helpers/Env.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Lion\Bundle\Helpers;
+
+/**
+ * Environment variable manager
+ *
+ * @package Lion\Bundle\Helpers
+ */
+class Env
+{
+    /**
+     * Gets the value defined for an environment variable
+     *
+     * @param  string $key [Property name]
+     * @param  mixed $default [Default value]
+     *
+     * @return mixed
+     */
+    public static function get(string $key, mixed $default = null): mixed
+    {
+        return self::getOption($key, $default);
+    }
+
+    /**
+     * Gets and transforms the possible value of environment variables
+     *
+     * @param  string $key [Property name]
+     * @param  mixed $default [Default value]
+     *
+     * @return mixed
+     */
+    private static function getOption(string $key, mixed $default): mixed
+    {
+        $transform = function(mixed $value): mixed {
+            switch ($value) {
+                case 'true':
+                case '(true)':
+                    return true;
+                case 'false':
+                case '(false)':
+                    return false;
+                case 'empty':
+                case '(empty)':
+                    return '';
+                case 'null':
+                case '(null)':
+                    return null;
+                default:
+                    return $value;
+            }
+        };
+
+        if (empty($_ENV[$key])) {
+            return $transform($default);
+        }
+
+        $value = $transform($_ENV[$key]);
+
+        if (preg_match('/\A([\'"])(.*)\1\z/', $value, $matches)) {
+            return $matches[2];
+        }
+
+        return $value;
+    }
+}

src/LionBundle/Helpers/Fake.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Lion\Bundle\Helpers;
+
+use Faker\Factory;
+use Faker\Generator;
+
+/**
+ * Create Generator objects with a single instance
+ *
+ * @package Lion\Bundle\Helpers
+ */
+class Fake
+{
+    /**
+     * [Generator class object]
+     *
+     * @var Generator|null $generator
+     */
+    private static ?Generator $generator = null;
+
+    /**
+     * Function that generates a Generator object to obtain fake data
+     *
+     * @param  string $locale [Regional configuration]
+     *
+     * @return Generator
+     */
+    public static function get(string $locale = Factory::DEFAULT_LOCALE): Generator
+    {
+        if (null === self::$generator) {
+            self::$generator = Factory::create($locale);
+        }
+
+        return self::$generator;
+    }
+}

tests/Helpers/Bundle/HelpersTest.php

@@ -12,10 +12,12 @@
 use Lion\Route\Route;
 use Lion\Test\Test;
 use Tests\Providers\EnviromentProviderTrait;
+use Tests\Providers\Helpers\HelpersProviderTrait;
 
 class HelpersTest extends Test
 {
     use EnviromentProviderTrait;
+    use HelpersProviderTrait;
 
     const PATH_URL = 'storage/';
     const PATH_URL_INDEX = '../storage/';
@@ -153,5 +155,14 @@ public function testIsSuccess(): void
     public function testFake(): void
     {
         $this->assertInstanceOf(Generator::class, fake());
+        $this->assertSame(fake(), fake());
+    }
+
+    /**
+     * @dataProvider envProvider
+     */
+    public function testEnv(string $envKey, mixed $envValue, mixed $return): void
+    {
+        $this->assertSame($return, env($envKey, $envValue));
     }
 }

tests/Providers/Helpers/HelpersProviderTrait.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Providers\Helpers;
+
+trait HelpersProviderTrait
+{
+    public static function envProvider(): array
+    {
+        return [
+            [
+                'envKey' => 'APP_NAME',
+                'envValue' => 'lion-bundle',
+                'return' => 'lion-bundle'
+            ],
+            [
+                'envKey' => 'SERVER_URL',
+                'envValue' => 'http://127.0.0.1:8000',
+                'return' => 'http://127.0.0.1:8000'
+            ],
+            [
+                'envKey' => 'APP_NAME_TEST',
+                'envValue' => 'lion-bundle',
+                'return' => 'lion-bundle'
+            ],
+            [
+                'envKey' => 'SERVER_URL_TEST',
+                'envValue' => 'http://127.0.0.1:8000',
+                'return' => 'http://127.0.0.1:8000'
+            ],
+            [
+                'envKey' => 'MAIL_DEBUG_SUPP_TEST',
+                'envValue' => 'true',
+                'return' => true
+            ],
+            [
+                'envKey' => 'MAIL_DEBUG_SUPP_TEST',
+                'envValue' => '(true)',
+                'return' => true
+            ],
+            [
+                'envKey' => 'MAIL_DEBUG_SUPP_TEST',
+                'envValue' => 'false',
+                'return' => false
+            ],
+            [
+                'envKey' => 'MAIL_DEBUG_SUPP_TEST',
+                'envValue' => '(false)',
+                'return' => false
+            ],
+            [
+                'envKey' => 'APP_DEBUG',
+                'envValue' => 'empty',
+                'return' => ''
+            ],
+            [
+                'envKey' => 'APP_DEBUG',
+                'envValue' => '(empty)',
+                'return' => ''
+            ],
+            [
+                'envKey' => 'APP_DEBUG_TEST',
+                'envValue' => 'null',
+                'return' => null
+            ],
+            [
+                'envKey' => 'APP_DEBUG_TEST',
+                'envValue' => '(null)',
+                'return' => null
+            ]
+        ];
+    }
+}