WIP : PHP8

.github/workflows/integrate.yml

@@ -23,7 +23,7 @@ jobs:
     runs-on: "ubuntu-latest"
     steps:
       - name: "Checkout code"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: "Check file permissions"
         run: |
@@ -40,7 +40,7 @@ jobs:
           coverage: "none"
 
       - name: "Checkout code"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: "Find non-printable ASCII characters (box-drawing characters excluded)"
         run: |
@@ -63,10 +63,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version:
-          - "7.4"
+        php-version: ["7.4", "8.0", "8.1", "8.2"]
         dependencies:
-          - "lowest"
           - "highest"
     runs-on: "ubuntu-latest"
     steps:
@@ -77,14 +75,18 @@ jobs:
           coverage: "xdebug"
 
       - name: "Checkout code"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: "Install dependencies"
         uses: "ramsey/composer-install@v2"
         with:
           dependency-versions: "${{ matrix.dependencies }}"
 
-      - name: "Execute unit tests"
+      - name: "Execute unit tests without coverage"
+        run: "composer run test:unit"
+
+      - name: "Execute unit tests with coverage"
+        if: "${{ env.CODECOV_TOKEN && matrix.php-version == '7.4' && matrix.dependencies == 'highest' }}"
         run: "composer run test:coverage"
 
       - name: "Upload coverage to Codecov"
@@ -113,7 +115,7 @@ jobs:
           coverage: "none"
 
       - name: "Checkout code"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: "Validate Composer configuration"
         run: "composer validate --strict"
@@ -142,7 +144,7 @@ jobs:
           tools: "cs2pr"
 
       - name: "Checkout code"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: "Check adherence to EditorConfig"
         uses: "greut/eclint-action@v0"
@@ -166,7 +168,7 @@ jobs:
     runs-on: "ubuntu-latest"
     steps:
       - name: "Checkout code"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: "Check exported files"
         run: |

composer.json

@@ -24,24 +24,24 @@
 		"source": "https://github.com/infinum/eightshift-libs"
 	},
 	"require": {
-		"php": "^7.4",
+		"php": "^7.4 || >=8.0",
 		"ext-dom": "*",
 		"ext-json": "*",
 		"ext-libxml": "*",
-		"php-di/invoker": "^2.3",
-		"php-di/php-di": "^6.3"
+		"php-di/invoker": "^2.3.4",
+		"php-di/php-di": "^7"
 	},
 	"require-dev": {
-		"captainhook/captainhook": "^5.10",
 		"brain/monkey": "^2.6.1",
-		"dealerdirect/phpcodesniffer-composer-installer": "^0.7",
-		"infinum/eightshift-coding-standards": "^1.6",
+		"captainhook/captainhook": "^5.10",
+		"dealerdirect/phpcodesniffer-composer-installer": "^v1.0.0",
+		"infinum/eightshift-coding-standards": "2.0.0-beta",
 		"pestphp/pest": "^1.20",
 		"php-parallel-lint/php-parallel-lint": "^1.3",
-		"php-stubs/wordpress-stubs": "^5.9",
+		"php-stubs/wordpress-stubs": "^6.3",
 		"roave/security-advisories": "dev-master",
-		"szepeviktor/phpstan-wordpress": "^1.0.3",
-		"wp-cli/wp-cli": "^2.4",
+		"szepeviktor/phpstan-wordpress": "^1.3",
+		"wp-cli/wp-cli": "^2.9",
 		"yoast/wp-test-utils": "^1.0"
 	},
 	"autoload": {

phpcs.xml.dist

@@ -24,7 +24,7 @@
 	<rule ref="PHPCompatibilityWP"/>
 
 	<!-- Support only latest 3 WP versions. -->
-	<config name="minimum_supported_wp_version" value="5.6"/>
+	<config name="minimum_supported_wp_version" value="6.0"/>
 
 	<exclude-pattern>/src/CompiledContainer\.php</exclude-pattern>
 
@@ -55,9 +55,26 @@
 		<exclude-pattern>*/src/Cli/*</exclude-pattern>
 	</rule>
 
-	<rule ref="WordPress.Security.EscapeOutput.OutputNotEscaped">
-		<exclude-pattern>*/src/**/*Cli.php</exclude-pattern>
-		<exclude-pattern>*/src/Cli/*</exclude-pattern>
+	<!-- Ignore unescaped exceptions. All Eightshift exceptions are escaped. -->
+	<rule ref="Eightshift.Security.ComponentsEscape.ExceptionNotEscaped">
+		<severity>0</severity>
+	</rule>
+
+	<!-- Ignore filesystem alternative functions. -->
+	<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_mkdir">
+		<severity>0</severity>
+	</rule>
+	<rule ref="WordPress.WP.AlternativeFunctions.unlink_unlink">
+		<severity>0</severity>
+	</rule>
+	<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_fopen">
+		<severity>0</severity>
+	</rule>
+	<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_fwrite">
+		<severity>0</severity>
+	</rule>
+	<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_fclose">
+		<severity>0</severity>
 	</rule>
 
 	<rule ref="Generic.Files.LineLength">

phpstan.neon.dist

@@ -13,7 +13,6 @@ parameters:
 	excludePaths:
 		- src/**/*Example.php
 	ignoreErrors:
-		# Uses func_get_args()
-		- '/^Function apply_filters(_ref_array)? invoked with [34567] parameters, 2 required\.$/'
 		# Ignore errors about reflection class variable being undefined. Errors are caught.
 		- '/^Variable \$reflectionClass might not be defined\.$/'
+	checkGenericClassInNonGenericObjectType: false

src/AdminMenus/AdminReusableBlocksMenuCli.php

@@ -50,7 +50,7 @@ public function getDefaultArgs(): array
 			'title' => 'Reusable blocks',
 			'menu_title' => 'Reusable blocks',
 			'capability' => 'edit_posts',
-			'menu_icon' => '<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24"><path d="m18.492 2.33 3.179 3.179a2.25 2.25 0 0 1 0 3.182l-2.423 2.422A2.501 2.501 0 0 1 21 13.5v5a2.5 2.5 0 0 1-2.5 2.5h-13A2.5 2.5 0 0 1 3 18.5v-13A2.5 2.5 0 0 1 5.5 3h5a2.5 2.5 0 0 1 2.387 1.754L15.31 2.33a2.25 2.25 0 0 1 3.182 0ZM11 13H5v5.5a.5.5 0 0 0 .5.5H11v-6Zm7.5 0H13v6h5.5a.5.5 0 0 0 .5-.5v-5a.5.5 0 0 0-.5-.5Zm-4.06-2.001L13 9.559v1.44h1.44Zm-3.94-6h-5a.5.5 0 0 0-.5.5V11h6V5.5a.5.5 0 0 0-.5-.5Z" fill="black"/></svg>', // phpcs:ignore
+			'menu_icon' => 'dashicons-welcome-widgets-menus',
 			'menu_position' => 4,
 		];
 	}

src/AdminMenus/AdminReusableBlocksMenuExample.php

@@ -58,7 +58,7 @@
 					$this->getMenuTitle(),
 					$this->getCapability(),
 					$this->getMenuSlug(),
-					'',
+					'', // @phpstan-ignore-line
 					$this->getIcon(),
 					$this->getPosition()
 				);
@@ -122,7 +122,7 @@
 	{
 		// If it's a custom SVG; base64 it.
 		if (\substr(self::ADMIN_REUSABLE_BLOCKS_MENU_ICON, 0, 4) === '<svg') {
 			return 'data:image/svg+xml;base64,' . base64_encode(self::ADMIN_REUSABLE_BLOCKS_MENU_ICON); // phpcs:ignore;
 		}
 
 		// Otherwise just treat it as a DashIcon.

src/AdminMenus/ReusableBlocksHeaderFooterExample.php

@@ -34,7 +34,7 @@
 	/**
 	 * Admin icon.
 	 */
-	public const ADMIN_ICON = '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20" fill="none"><path fill-rule="evenodd" clip-rule="evenodd" d="M1.5 1A1.5 1.5 0 0 0 0 2.5V4h20V2.5A1.5 1.5 0 0 0 18.5 1h-17ZM20 5H0v10h20V5ZM0 17.5V16h20v1.5a1.5 1.5 0 0 1-1.5 1.5h-17A1.5 1.5 0 0 1 0 17.5ZM19 6H1v8h18V6Z" fill="black"/></svg>'; // phpcs:ignore
+	public const ADMIN_ICON = 'dashicons-embed-photo';
 
 	/**
 	 * Menu position for reusable blocks menu.
@@ -76,10 +76,10 @@
 	 *
 	 * @return void
 	 */
 	public function register(): void
 	{
 		\add_action('admin_init', [$this, 'registerWpSettings']);
 		\add_action('admin_menu', [$this, 'callback'], $this->getPriorityOrder());
 	}
 
 	/**
@@ -87,9 +87,9 @@
 	 *
 	 * @return string The text to be displayed in the title tags of the page when the menu is selected.
 	 */
 	protected function getTitle(): string
 	{
 		return \esc_html__('%title%', 'eightshift-libs');
 	}
 
 	/**
@@ -97,9 +97,9 @@
 	 *
 	 * @return string The text to be used for the menu.
 	 */
 	protected function getMenuTitle(): string
 	{
 		return \esc_html__('%menu_title%', 'eightshift-libs');
 	}
 
 	/**
@@ -107,9 +107,9 @@
 	 *
 	 * @return string The capability required for reusable block menu to be displayed to the user.
 	 */
 	protected function getCapability(): string
 	{
 		return self::ADMIN_MENU_CAPABILITY;
 	}
 
 	/**
@@ -119,9 +119,9 @@
 	 *                Should be unique for reusable block menu page and only include lowercase alphanumeric,
 	 *                dashes, and underscores characters to be compatible with sanitize_key().
 	 */
 	protected function getMenuSlug(): string
 	{
 		return self::ADMIN_MENU_SLUG;
 	}
 
 	/**
@@ -134,9 +134,9 @@
 	 *                  e.g. 'dashicons-chart-pie'.
 	 *                * Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS.
 	 */
 	protected function getIcon(): string
 	{
-		return 'data:image/svg+xml;base64,' . base64_encode(self::ADMIN_ICON); // phpcs:ignore;
+		return self::ADMIN_ICON;
 	}
 
 	/**
@@ -155,9 +155,9 @@
 	 * 80  - below Settings
 	 * 100 - below second separator
 	 */
 	protected function getPosition(): int
 	{
 		return self::ADMIN_MENU_POSITION;
 	}
 
 	/**
@@ -165,9 +165,9 @@
 	 *
 	 * @return string View URI.
 	 */
 	protected function getViewComponent(): string
 	{
 		return 'admin-header-footer-picker';
 	}
 
 	/**
@@ -182,9 +182,9 @@
 	 *
 	 * @return array<string, mixed> Processed admin menu attributes.
 	 */
 	protected function processAttributes($attr): array
 	{
 		return [];
 	}
 
 	// Supporting functions for defining settings and sections.
@@ -194,36 +194,36 @@
 	 *
 	 * @return void
 	 */
 	public function registerWpSettings(): void
 	{
 		\register_setting(self::ADMIN_MENU_SLUG, self::HEADER_PARTIAL);
 		\register_setting(self::ADMIN_MENU_SLUG, self::FOOTER_PARTIAL);
 
 		\add_settings_section(self::SETTINGS_SECTION_NAME, '', fn () => '', self::ADMIN_MENU_SLUG);
 
 		\add_settings_field(
 			self::HEADER_PARTIAL,
 			\__('Header partial', 'eightshift-libs'),
 			[$this, 'renderPartialSelector'],
 			self::ADMIN_MENU_SLUG,
 			self::SETTINGS_SECTION_NAME,
 			[
 				'label_for' => self::HEADER_PARTIAL,
 				'type' => 'header',
 			]
 		);
 
 		\add_settings_field(
 			self::FOOTER_PARTIAL,
 			\__('Footer partial', 'eightshift-libs'),
 			[$this, 'renderPartialSelector'],
 			self::ADMIN_MENU_SLUG,
 			self::SETTINGS_SECTION_NAME,
 			[
 				'label_for' => self::FOOTER_PARTIAL,
 				'type' => 'footer',
 			]
 		);
 	}
 
 	/**
@@ -232,45 +232,45 @@
 	 * @param array<mixed> $args Arguments to pass.
 	 * @return void
 	 */
 	public function renderPartialSelector($args): void
 	{
 		$type = isset($args['type']) && $args['type'] === 'header' ? self::HEADER_PARTIAL : self::FOOTER_PARTIAL;
 
 		$reusableBlocksQuery = new WP_Query([
 			'post_type' => 'wp_block',
 			'posts_per_page' => 1000, // phpcs:ignore WordPress.WP.PostsPerPage.posts_per_page_posts_per_page
 			'post_status' => 'publish',
 			'update_post_meta_cache' => false,
 			'update_post_term_cache' => false,
 		]);
 
 		if ($reusableBlocksQuery->have_posts()) {
 			$currentValue = \get_option($type);
 			?>
 			<select id="<?php echo \esc_attr($args['label_for']); ?>" name="<?php echo \esc_attr($type); ?>">
 				<option value="">
 					&mdash; <?php \esc_html_e('None', 'eightshift-libs'); ?> &mdash;
 				</option>
 
 				<?php
 				while ($reusableBlocksQuery->have_posts()) {
 					$reusableBlocksQuery->the_post();
 					$postId = (string) \get_the_ID();
 					$postTitle = \get_the_title();
 					?>
 					<option value="<?php echo \esc_attr($postId); ?>"
 						<?php \selected($currentValue, $postId, true); ?>
 					>
 						<?php echo \esc_html($postTitle); ?>
 					</option>
 					<?php
 				}
 
 				\wp_reset_postdata();
 				?>
 			</select>
 		<?php } else { ?>
 			<i><?php echo \esc_html__('No reusable blocks found.', 'eightshift-libs'); ?></i>
 			<?php
 		}
 	}
@@ -281,31 +281,31 @@
 	 * @param int|string $partialId Block partial ID.
 	 * @return void
 	 */
 	public static function renderPartial($partialId): void
 	{
 		if (empty((string) $partialId)) {
 			return;
 		}
 
 		$blocksToRender = \parse_blocks(\get_the_content(null, false, $partialId));
 
 		// Filter out empty blocks.
 		$blocksToRenderFiltered = \array_values(
 			\array_filter(
 				$blocksToRender,
 				static function ($blockArray) {
 					return !empty($blockArray['blockName']);
 				}
 			)
 		);
 
 		$blocksToRenderRendered = \array_map(
 			static function ($block) {
 				return \render_block($block);
 			},
 			$blocksToRenderFiltered // phpcs:ignore
 		);
 
 		echo Components::ensureString($blocksToRenderRendered); // phpcs:ignore
 	}
 }

src/AnalyticsGdpr/AnalyticsGdprExample.php

@@ -836,7 +836,7 @@ public function registerGdprModalSettings(): void
 	/**
 	 * Prepare the data for usage inside of the GDPR modal template.
 	 *
-	 * @return array<string, array> Prepared array filled with the data from options page.
+	 * @return array<string, array<mixed>> Prepared array filled with the data from options page.
 	 */
 	public function prepareGdprModalData(): array
 	{

src/Blocks/AbstractBlocks.php

@@ -153,39 +153,6 @@ public function getAllBlocksList($allowedBlockTypes, WP_Block_Editor_Context $bl
 		return $this->getAllAllowedBlocksList([], $blockEditorContext);
 	}
 
-	/**
-	 * Get all blocks with full block name - legacy.
-	 *
-	 * Used to limit what blocks are going to be used in your project using allowed_block_types filter.
-	 *
-	 * @hook allowed_block_types This is a WP 5 - WP 5.7 compatible hook callback. Will not work with WP 5.8!
-	 *
-	 * @param bool|string[] $allowedBlockTypes Array of block type slugs, or boolean to enable/disable all.
-	 * @param WP_Post $post The post resource data.
-	 *
-	 * @return bool|string[] Boolean if you want to disallow or allow all blocks, or a list of allowed blocks.
-	 */
-	public function getAllBlocksListOld($allowedBlockTypes, WP_Post $post)
-	{
-		if (\gettype($allowedBlockTypes) === 'boolean') {
-			return $allowedBlockTypes;
-		}
-
-		$allowedBlockTypes = \array_map(
-			function ($block) {
-				return $block['blockFullName'];
-			},
-			Components::getBlocks()
-		);
-
-		// Allow reusable block.
-		$allowedBlockTypes[] = 'eightshift-forms/forms';
-		$allowedBlockTypes[] = 'core/block';
-		$allowedBlockTypes[] = 'core/template';
-
-		return $allowedBlockTypes;
-	}
-
 	/**
 	 * Method used to register all custom blocks with data fetched from blocks manifest.json.
 	 *
@@ -274,32 +241,6 @@ public function getCustomCategory(array $categories, WP_Block_Editor_Context $bl
 		);
 	}
 
-	/**
-	 * Create custom category to assign all custom blocks - legacy.
-	 *
-	 * This category will be shown on all blocks list in "Add Block" button.
-	 *
-	 * @hook block_categories This is a WP 5 - WP 5.7 compatible hook callback. Will not work with WP 5.8!
-	 *
-	 * @param array<int, array<string, string|null>> $categories Array of categories for block types.
-	 * @param WP_Post $post Post being loaded.
-	 *
-	 * @return array<int, array<string, string|null>> Array of categories for block types.
-	 */
-	public function getCustomCategoryOld(array $categories, WP_Post $post): array
-	{
-		return \array_merge(
-			$categories,
-			[
-				[
-					'slug' => 'eightshift',
-					'title' => \esc_html__('Eightshift', 'eightshift-libs'),
-					'icon' => 'admin-settings',
-				],
-			]
-		);
-	}
-
 	/**
 	 * Locate and return template part with passed attributes for wrapper.
 	 *

src/Blocks/AbstractBlocksCli.php

@@ -56,7 +56,7 @@
 			self::cliError(
 				\sprintf(
 					// translators: %s will be replaced with type of item, and shorten cli path.
-					"%s files doesn't exist on this path: `%s`. Please check if you have eightshift-frontend-libs installed.",
+					"%s file doesn't exist on this path: `%s`. Please check if you have eightshift-frontend-libs installed.",
 					$type,
 					$this->getShortenCliPathOutput($source)
 				)
@@ -67,32 +67,41 @@
 		$sourceItems = \array_fill_keys(\array_values($sourceItems), $source);
 		$sourceItemsPrivate = [];
 
-		if ($sourcePrivate) {
+		if (\is_dir($sourcePrivate)) {
 			$sourceItemsPrivate = \array_diff(\scandir($sourcePrivate) ?: [], ['..', '.']); // phpcs:ignore WordPress.PHP.DisallowShortTernary.Found
 			$sourceItemsPrivate = \array_fill_keys(\array_values($sourceItemsPrivate), $sourcePrivate);
 		}
 
 		$sourceItems = \array_merge($sourceItems, $sourceItemsPrivate);
 
-		if (($isSingleFolder || $isFile) && isset($sourceItems[$name])) {
-			$sourceItems = [
-				$name => $sourceItems[$name],
-			];
-		}
-
 		if (!$sourceItems) {
 			self::cliError(
 				\sprintf(
-					// translators: %s will be replaced with type of item, and shorten cli path.
-					"%s files doesn't exist on this path: `%s`. Please check if you have eightshift-frontend-libs installed.",
+					// translators: %1$s will be replaced with type of item, %2$s the type and %3$s and shorten cli path.
+					'%1$s %2$s doesn\'t exist on this path: `%3$s`. Please check if you have eightshift-frontend-libs installed.',
 					$type,
+					$isFile ? 'file' : 'folder',
 					$this->getShortenCliPathOutput($source)
 				)
 			);
 		}
 
+		$itemExists = false;
 		foreach ($itemsList as $item) {
-			if (!isset($sourceItems[$item])) {
+			foreach ($sourceItems as $sourceItem => $sourceFolder) {
+				if (\strpos($sourceItem, $item) !== false) {
+					$itemExists = true;
+					break;
+				}
+
+				// in the case of folders, we should also check the source folders.
+				if (\strpos($sourceFolder, $item) !== false) {
+					$itemExists = true;
+					break;
+				}
+			}
+
+			if (!$itemExists) {
 				self::cliError(
 					\sprintf(
 						// translators: %s will be replaced with type of item, item name and shorten cli path.
@@ -104,8 +113,6 @@
 				);
 			}
 
-			$source = $sourceItems[$item];
-
 			$fullSource = Components::joinPaths([$source, $item]);
 			$fullDestination = Components::joinPaths([$destination, $item]);
 
@@ -224,17 +231,34 @@
 
 		if ($dependencies) {
 			$componentsCommandName = UseComponentCli::COMMAND_NAME;
-			$allDependencies = \array_map(static fn ($item) => Components::camelToKebabCase($item), $dependencies);
-			$allDependencies = \implode(', ', \array_unique(\array_values($allDependencies)));
+			$blocksCommandName = UseBlockCli::COMMAND_NAME;
 
-			$this->cliLogAlert(\implode("\n", [
-				"This {$type} may need some dependencies to work correctly.",
-				'',
-				'To add them to your project, run:',
-				"%Uwp boilerplate {$this->getCommandParentName()} {$componentsCommandName} --name='{$allDependencies}'%n",
-				'',
-				'If a dependency already exists in your project, you can skip it.',
-			]), 'info', 'Dependencies found');
+			$outputComand = [];
+
+			if ($componentsDependencies) {
+				$componentsDependenciesAll = \array_map(static fn ($item) => Components::camelToKebabCase($item), $componentsDependencies);
+				$componentsDependenciesAll = \implode(', ', \array_unique(\array_values($componentsDependenciesAll)));
+
+				$outputComand[] = "%Uwp boilerplate {$this->getCommandParentName()} {$componentsCommandName} --name='{$componentsDependenciesAll}'%n";
+			}
+
+			if ($innerBlocksDependency) {
+				$innerBlocksDependencyAll = \array_map(static fn ($item) => Components::camelToKebabCase($item), $innerBlocksDependency);
+				$innerBlocksDependencyAll = \implode(', ', \array_unique(\array_values($innerBlocksDependencyAll)));
+
+				$outputComand[] = "%Uwp boilerplate {$this->getCommandParentName()} {$blocksCommandName} --name='{$innerBlocksDependencyAll}'%n";
+			}
+
+			if ($outputComand) {
+				$this->cliLogAlert(\implode("\n", [
+					"This {$type} may need some dependencies to work correctly.",
+					'',
+					'To add them to your project, run:',
+					...$outputComand,
+					'',
+					'If a dependency already exists in your project, you can skip it.',
+				]), 'info', 'Dependencies found');
+			}
 		}
 	}
 
@@ -254,14 +278,14 @@
 		$nodeDependencies = $manifest['nodeDependency'] ?? [];
 
 		if ($nodeDependencies) {
 			$this->cliLogAlert(\implode("\n", [
 				"This {$type} requires some external dependencies to work correctly.",
 				'',
 				'To add them to your project, run:',
 				...\array_map(fn ($package) => "%Unpm install {$package}%n", $nodeDependencies),
 				'',
 				'If a dependency already exists in your project, you can skip it.',
 			]), 'info', 'Packages needed');
 		}
 	}
 }