From 8671d1347d31fdb013323e835da60429e551de71 Mon Sep 17 00:00:00 2001
From: Titouan Mathis <titouan@studiometa.fr>
Date: Fri, 8 Mar 2024 16:01:05 +0100
Subject: [PATCH] Add env helpers

---
 src/Helpers/Env.php           | 20 ++++++++++++++
 src/Helpers/Request.php       | 50 +++++++++++++++++++++++++++++++++++
 src/helpers.php               | 33 +++++++++++++++++++++++
 tests/Helpers/EnvTest.php     | 20 ++++++++++++++
 tests/Helpers/RequestTest.php | 24 +++++++++++++++++
 5 files changed, 147 insertions(+)
 create mode 100644 src/Helpers/Env.php
 create mode 100644 src/Helpers/Request.php
 create mode 100644 src/helpers.php
 create mode 100644 tests/Helpers/EnvTest.php
 create mode 100644 tests/Helpers/RequestTest.php

diff --git a/src/Helpers/Env.php b/src/Helpers/Env.php
new file mode 100644
index 0000000..78876b6
--- /dev/null
+++ b/src/Helpers/Env.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Studiometa\WPToolkit\Helpers;
+
+class Env {
+	/**
+	 * Get an environment variable value.
+	 *
+	 * @param  string $key The variable name.
+	 * @return string
+	 */
+	public static function get( string $key ): string {
+		// phpcs:ignore
+		/** @var array<string, string> Good type. */
+		$env = $_ENV;
+		// In some environment, values are not available in the `$_ENV` variables,
+		// so we use `getenv` as a fallback to try and get the value.
+		return $env[ $key ] ?? (string) getenv( $key );
+	}
+}
diff --git a/src/Helpers/Request.php b/src/Helpers/Request.php
new file mode 100644
index 0000000..3dc3eaa
--- /dev/null
+++ b/src/Helpers/Request.php
@@ -0,0 +1,50 @@
+<?php
+
+namespace Studiometa\WPToolkit\Helpers;
+
+use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
+
+class Request {
+	/**
+	 * Private variable to hold the helpers instance.
+	 *
+	 * @var ?Request
+	 */
+	private static $instance = null;
+
+	/**
+	 * Private variables to hold the current request instance.
+	 *
+	 * @var SymfonyRequest
+	 */
+	private SymfonyRequest $request;
+
+	/**
+	 * Private constructor.
+	 */
+	private function __construct() {
+		$this->request = SymfonyRequest::createFromGlobals();
+	}
+
+	/**
+	 * Get singleton instance.
+	 *
+	 * @return Request
+	 */
+	private static function get_instance() {
+		if ( is_null( self::$instance ) ) {
+			self::$instance = new self();
+		}
+
+		return self::$instance;
+	}
+
+	/**
+	 * Work with the current HTTP request.
+	 *
+	 * @return SymfonyRequest
+	 */
+	public static function request(): SymfonyRequest {
+		return self::get_instance()->request;
+	}
+}
diff --git a/src/helpers.php b/src/helpers.php
new file mode 100644
index 0000000..dc3fc66
--- /dev/null
+++ b/src/helpers.php
@@ -0,0 +1,33 @@
+<?php
+/**
+ * Helpers
+ *
+ * @package Studiometa
+ */
+
+namespace Studiometa\WPToolkit;
+
+use Studiometa\WPToolkit\Helpers\Env;
+use Studiometa\WPToolkit\Helpers\Request;
+use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
+
+/**
+ * Get an environment variable value.
+ *
+ * @param  string $key The variable name.
+ * @return string
+ */
+function env( string $key ): string {
+	return Env::get( $key );
+}
+
+/**
+ * Get a Request instance from the symfony/http-foundation package.
+ *
+ * @see https://symfony.com/doc/current/components/http_foundation.html#request
+ *
+ * @return SymfonyRequest
+ */
+function request(): SymfonyRequest {
+	return Request::request();
+}
diff --git a/tests/Helpers/EnvTest.php b/tests/Helpers/EnvTest.php
new file mode 100644
index 0000000..5a8e7c7
--- /dev/null
+++ b/tests/Helpers/EnvTest.php
@@ -0,0 +1,20 @@
+<?php
+
+use Studiometa\WPToolkit\Helpers\Env as EnvClass;
+use function Studiometa\WPToolkit\env;
+
+/**
+ * EnvTest test case.
+ */
+class EnvTest extends WP_UnitTestCase {
+
+	/**
+	 * Test the request() function
+	 *
+	 * @return void
+	 */
+	public function test_type_of_request_function_helper() {
+		$this->assertTrue(is_string(env('missing')));
+		$this->assertTrue(is_string(EnvClass::get('missing')));
+	}
+}
diff --git a/tests/Helpers/RequestTest.php b/tests/Helpers/RequestTest.php
new file mode 100644
index 0000000..0b39486
--- /dev/null
+++ b/tests/Helpers/RequestTest.php
@@ -0,0 +1,24 @@
+<?php
+
+use Studiometa\WPToolkit\Helpers\Request as RequestClass;
+use function Studiometa\WPToolkit\request;
+use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
+
+/**
+ * RequestTest test case.
+ */
+class RequestTest extends WP_UnitTestCase {
+
+	/**
+	 * Test the request() function
+	 *
+	 * @return void
+	 */
+	public function test_type_of_request_function_helper() {
+		$request1 = RequestClass::request();
+		$request2 = request();
+		$this->assertTrue($request1 instanceof SymfonyRequest);
+		$this->assertTrue($request2 instanceof SymfonyRequest);
+		$this->assertTrue($request1 === $request2);
+	}
+}