[Feature] Add helpers

.github/workflows/release.yml

@@ -0,0 +1,40 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*.*.*'
+
+jobs:
+  release:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: '0'
+
+      # @see https://github.com/actions/create-release/issues/38#issuecomment-715327220
+      # @see https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#environment-files
+      - name: Prepare the changelog from the tag message
+        id: prepare_changelog
+        run: |
+          PRERELEASE=false
+          # Check release type
+          if [[ $GITHUB_REF_NAME =~ 'alpha' || $GITHUB_REF_NAME =~ 'beta' || $GITHUB_REF_NAME =~ 'rc' ]]; then
+            echo "This is a prerelease."
+            PRERELEASE=true
+          fi
+          echo "is_prerelease=$PRERELEASE" >> $GITHUB_ENV
+
+      # @see https://github.com/actions/create-release
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: v${{ github.ref_name }}
+          body: Please refer to [CHANGELOG.md](https://github.com/studiometa/wp-toolkit/blob/${{ github.ref_name }}/CHANGELOG.md) for details.
+          draft: false
+          prerelease: ${{ env.is_prerelease }}

CHANGELOG.md

@@ -8,4 +8,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Added
 
+- **Helpers:**
+  + Add a `RequestHelper` class ([#25](https://github.com/studiometa/wp-toolkit/pull/25))
+  + Add a `request(): Request` function based on [symfony/http-foundation](https://github.com/symfony/http-foundation) ([#25](https://github.com/studiometa/wp-toolkit/pull/25))
+  + Add an `EnvHelper` class ([#25](https://github.com/studiometa/wp-toolkit/pull/25))
+  + Add an `env( string $key ): string` function ([#25](https://github.com/studiometa/wp-toolkit/pull/25))
 - **CleanupManager:** Disable XML-RPC by default ([#21](https://github.com/studiometa/wp-toolkit/pull/21))

composer.json

@@ -7,7 +7,8 @@
   "require": {
     "php": "^7.3|^8.0",
     "symfony/yaml": "^5.1",
-    "studiometa/webpack-config": "^4.0"
+    "studiometa/webpack-config": "^4.0|^5.0",
+    "symfony/http-foundation": "^5.4|^6.3"
   },
   "require-dev": {
     "squizlabs/php_codesniffer": "^3.4",
@@ -21,7 +22,10 @@
   "autoload": {
     "psr-4": {
       "Studiometa\\WPToolkit\\": "src/"
-    }
+    },
+    "files": [
+      "src/functions.php"
+    ]
   },
   "scripts": {
     "phpcs": "phpcs -s --colors --standard=./phpcs.xml",

src/Helpers/EnvHelper.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Request helper functions.
+ *
+ * @package    studiometa/wp-toolkit
+ * @author     Studio Meta <[email protected]>
+ * @copyright  2021 Studio Meta
+ * @license    https://opensource.org/licenses/MIT
+ * @since      1.1.0
+ */
+
+namespace Studiometa\WPToolkit\Helpers;
+
+/**
+ * Request helper class.
+ */
+class EnvHelper {
+	/**
+	 * 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 );
+	}
+}

src/Helpers/PluginHelper.php

@@ -7,7 +7,6 @@
  * @copyright  2021 Studio Meta
  * @license    https://opensource.org/licenses/MIT
  * @since      1.0.0
- * @version    1.0.0
  */
 
 namespace Studiometa\WPToolkit\Helpers;

src/Helpers/RequestHelper.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ * Request helper functions.
+ *
+ * @package    studiometa/wp-toolkit
+ * @author     Studio Meta <[email protected]>
+ * @copyright  2021 Studio Meta
+ * @license    https://opensource.org/licenses/MIT
+ * @since      1.1.0
+ */
+
+namespace Studiometa\WPToolkit\Helpers;
+
+use Symfony\Component\HttpFoundation\HeaderBag;
+use Symfony\Component\HttpFoundation\InputBag;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\ParameterBag;
+
+/**
+ * Request helper class.
+ */
+class RequestHelper {
+	/**
+	 * Request instance.
+	 *
+	 * @var Request|null
+	 */
+	private static $request = null;
+
+	/**
+	 * Get the Request instance.
+	 *
+	 * @return Request
+	 */
+	public static function get(): Request {
+		if ( is_null( self::$request ) ) {
+			self::$request = Request::createFromGlobals();
+		}
+
+		return self::$request;
+	}
+}

src/functions.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * Helper functions.
+ *
+ * @package    studiometa/wp-toolkit
+ * @author     Studio Meta <[email protected]>
+ * @copyright  2023 Studio Meta
+ * @license    https://opensource.org/licenses/MIT
+ * @since      1.1.0
+ */
+
+namespace Studiometa\WPToolkit;
+
+use Symfony\Component\HttpFoundation\Request;
+use Studiometa\WPToolkit\Helpers\RequestHelper;
+use Studiometa\WPToolkit\Helpers\EnvHelper;
+
+/**
+ * Get the Request instance.
+ *
+ * @return Request
+ */
+function request(): Request {
+	return RequestHelper::get();
+}
+
+/**
+ * Get an environment variable value.
+ *
+ * @param  string $key The variable name.
+ * @return string
+ */
+function env( string $key ): string {
+	return EnvHelper::get( $key );
+}