Merge pull request #14 from alleyinteractive/feature/12-structure-improve

Add support for environments of the same name

Author: srtfisher

CHANGELOG.md

@@ -2,18 +2,22 @@
 
 All notable changes to `WordPress Environment Switcher` will be documented in this file.
 
-## 1.1.0 - 2024-07-02
+## 1.2.0
+
+- Added support for more flexible environment configurations.
+
+## 1.1.0
 
 - Upgrade to PHP 8.1.
 - Change the environment switcher to show if the user has the
   `view_environment_switcher` capability (which is mapped to `manage_options`).
   This allows for more fine-grained control over who can see the environment
   switcher.
 
-## 1.0.1 - 2023-07-20
+## 1.0.1
 
 - Infer the environment from the hosting provider, allow it to be filtered via `wp_environment_switcher_current_environment`.
 
-## 1.0.0 - 2023-07-10
+## 1.0.0
 
 - Initial release

README.md

@@ -47,6 +47,33 @@ add_filter(
 );
 ```
 
+The environments can also be defined as an array of associative arrays, which allows for more flexibility:
+
+```php
+add_filter(
+	'wp_environment_switcher_environments',
+	fn () => [
+		[
+			'type'  => 'production',
+			'url'   => 'https://example.org',
+			'label' => 'Production Site',
+		],
+		[
+			'type'  => 'staging',
+			'url'   => 'https://staging.example.org',
+			'label' => 'Staging Site',
+		],
+		[
+			'type'  => 'local',
+			'url'   => 'https://example.test',
+			'label' => 'Local Development',
+		],
+	]
+);
+```
+
+The `type`, `url`, and `label` keys are required for each environment.
+
 The plugin will automatically detect the current environment and highlight it in
 the switcher. By default, the plugin will show the switcher to anybody with the
 `manage_options` capability. You can change this by modifying the capability

package.json

@@ -6,6 +6,7 @@
     "test": "tests"
   },
   "scripts": {
+    "release": "npx @alleyinteractive/create-release@latest",
     "start": "wp-env start",
     "test": "playwright test"
   },

tests/test.spec.ts

@@ -1,3 +1,4 @@
+import { Page } from '@playwright/test';
 import { test, expect } from '@wordpress/e2e-test-utils-playwright';
 
 test.beforeEach(async ({ page }) => {
@@ -12,9 +13,7 @@ test.beforeEach(async ({ page }) => {
   ).toBeVisible();
 });
 
-test('switcher is in the admin bar', async ({ page }) => {
-  await page.goto('/wp-admin/index.php');
-
+const testPage = async (page: Page) => {
   const switcher = page.locator('#wp-admin-bar-wp-environment-switcher');
   await expect(switcher).toBeVisible();
   await expect(switcher.locator('> a')).toHaveText('Staging');
@@ -28,4 +27,17 @@ test('switcher is in the admin bar', async ({ page }) => {
   await expect(dropdown.getByText('Production')).toBeVisible();
   await expect(dropdown.getByText('Staging')).toBeVisible();
   await expect(dropdown.getByText('Local')).toBeVisible();
+};
+
+test('switcher is in the admin bar', async ({ page }) => {
+  await page.goto('/wp-admin/');
+
+  await testPage(page);
+});
+
+test('switcher is in the admin bar (key-value pairs)', async ({ page }) => {
+  // Simulate a key-value pair environment configuration.
+  await page.goto('/wp-admin/?keyvalue=true');
+
+  await testPage(page);
 });

tests/wp-env.php.stub

@@ -3,9 +3,31 @@
 add_filter( 'wp_environment_switcher_current_environment', fn () => 'staging' );
 add_filter(
 	'wp_environment_switcher_environments',
-	fn () => [
-		'production' => 'https://example.org',
-		'staging'    => 'https://localhost:8000',
-		'local'      => 'https://example.test',
-	],
+	function () {
+		if ( ! empty( $_GET['keyvalue'] ) ) {
+			return [
+				'production' => 'https://example.org',
+				'staging'    => 'https://localhost:8000',
+				'local'      => 'https://example.test',
+			];
+		}
+
+		return [
+			[
+				'type'  => 'production',
+				'url'   => 'https://example.org',
+				'label' => 'Production',
+			],
+			[
+				'type'  => 'staging',
+				'url'   => 'https://localhost:8000',
+				'label' => 'Staging',
+			],
+			[
+				'type'  => 'local',
+				'url'   => 'https://example.test',
+				'label' => 'Local',
+			],
+		];
+	},
 );

wp-environment-switcher.php

@@ -3,7 +3,7 @@
  * Plugin Name: WordPress Environment Switcher
  * Plugin URI: https://github.com/alleyinteractive/wp-environment-switcher
  * Description: Easily switch between different site environments from the WordPress admin bar.
- * Version: 1.1.0
+ * Version: 1.2.0
  * Author: Sean Fisher
  * Author URI: https://github.com/alleyinteractive/wp-environment-switcher
  * Requires at least: 5.5.0
@@ -33,7 +33,7 @@ function main(): void {
 /**
  * Retrieve all the available environments for the switcher.
  *
- * @return array<string, string>
+ * @return array<string, string>|array<array{type?: string, url?: string, label?: string}>
  */
 function get_environments(): array {
 	return (array) apply_filters( 'wp_environment_switcher_environments', [] ); // @phpstan-ignore-line return.type
@@ -109,8 +109,17 @@ function register_admin_bar(): void {
 		return;
 	}
 
+	// Determine if the environments are a key-value pair or an array of
+	// associative arrays. Key-value pairs are of the form of 'environment' => 'url',
+	// while associative arrays are of the form of
+	// [ 'type' => 'environment', 'url' => 'url', 'label' => 'Label' ].
+	$is_key_value = ! array_is_list( $environments );
+
 	// Fire a warning if the current environment is not in the list of environments.
-	if ( ! isset( $environments[ $current ] ) ) {
+	if (
+		( $is_key_value && ! isset( $environments[ $current ] ) )
+		|| ( ! $is_key_value && ! in_array( $current, array_column( $environments, 'type' ), true ) )
+	) {
 		_doing_it_wrong(
 			__FUNCTION__,
 			sprintf(
@@ -159,18 +168,42 @@ function register_admin_bar(): void {
 		$callback = __NAMESPACE__ . '\\get_translated_url';
 	}
 
-	foreach ( $environments as $environment => $url ) {
-		$wp_admin_bar->add_menu(
-			[
-				'id'     => 'wp-environment-switcher-' . $environment,
-				'parent' => 'wp-environment-switcher',
-				'title'  => ucwords( $environment ),
-				'href'   => $callback( $url ),
-				'meta'   => [
-					'class' => 'wp-environment-switcher__item ' . ( $environment === $current ? 'wp-environment-switcher__item--active' : '' ),
-				],
-			]
-		);
+	if ( $is_key_value ) {
+		foreach ( $environments as $environment => $url ) {
+			if ( ! is_string( $url ) ) {
+				continue;
+			}
+
+			$wp_admin_bar->add_menu(
+				[
+					'id'     => 'wp-environment-switcher-' . $environment,
+					'parent' => 'wp-environment-switcher',
+					'title'  => ucwords( $environment ),
+					'href'   => $callback( $url ),
+					'meta'   => [
+						'class' => 'wp-environment-switcher__item ' . ( $environment === $current ? 'wp-environment-switcher__item--active' : '' ),
+					],
+				]
+			);
+		}
+	} else {
+		foreach ( $environments as $environment ) {
+			if ( ! is_array( $environment ) || ! isset( $environment['type'], $environment['url'], $environment['label'] ) ) {
+				continue;
+			}
+
+			$wp_admin_bar->add_menu(
+				[
+					'id'     => 'wp-environment-switcher-' . esc_attr( "{$environment['type']}-{$environment['label']}" ),
+					'parent' => 'wp-environment-switcher',
+					'title'  => $environment['label'],
+					'href'   => $callback( $environment['url'] ),
+					'meta'   => [
+						'class' => 'wp-environment-switcher__item ' . ( $environment['type'] === $current ? 'wp-environment-switcher__item--active' : '' ),
+					],
+				]
+			);
+		}
 	}
 }
 
@@ -195,7 +228,7 @@ function add_switcher_css(): void {
 		 *
 		 * @param bool $warn_production Whether to warn the user when they are on production. Defaults to true when on production.
 		 */
-		if ( apply_filters( 'wp_environment_switcher_warn_production', 'production' === wp_get_environment_type() ) ) {
+		if ( apply_filters( 'wp_environment_switcher_warn_production', 'production' === get_current_environment() ) ) {
 			?>
 				#wpadminbar #wp-admin-bar-wp-environment-switcher:not(.hover) > .ab-item {
 					background: #d63638;