Merge branch 'v1-develop' into v1

hostep · hostep · commit 6ab34483c1e4 · 2024-03-22T17:45:58.000+01:00
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -9,27 +9,17 @@
 $config = new PhpCsFixer\Config();
 return $config
     ->setRules([
-        '@Symfony'               => true,
-        '@PSR12'                 => true,
-        'binary_operator_spaces' => ['default' => null, 'operators' => ['=>' => 'align']],
-        'concat_space'           => ['spacing' => 'one'],
-        'declare_strict_types'   => true,
-        'no_alias_functions'     => true,
-        'no_useless_sprintf'     => true,
-        'ordered_imports'        => [
-            'imports_order' => [
-                'class',
-                'function',
-                'const',
-            ],
-            'sort_algorithm' => 'alpha'
-        ],
-        'phpdoc_align'           => ['align' => 'left'],
-        'phpdoc_summary'         => false,
-        'self_accessor'          => true,
-        'single_line_throw'      => false,
-        'visibility_required'    => ['elements' => ['property', 'method']], // removed 'const' since we still support PHP 7.0 for now
-        'yoda_style'             => false,
+        '@PER-CS'                                          => true,
+        'binary_operator_spaces'                           => ['default' => 'at_least_single_space', 'operators' => ['=>' => 'align']],
+        'declare_strict_types'                             => true,
+        'no_alias_functions'                               => true,
+        'no_useless_sprintf'                               => true,
+        'nullable_type_declaration_for_default_null_value' => false, // should be 'true' when we drop support for PHP 7.0 which didn't support nullable types yet
+        'ordered_imports'                                  => ['sort_algorithm' => 'alpha'],
+        'phpdoc_align'                                     => ['align' => 'vertical'],
+        'phpdoc_separation'                                => ['skip_unlisted_annotations' => true],
+        'self_accessor'                                    => true,
+        'visibility_required'                              => ['elements' => ['property', 'method']], // removed 'const' since we still support PHP 7.0 for now
     ])
     ->setFinder($finder)
 ;
diff --git a/Checker/Catalog/Category/UrlKey/DuplicateUrlKey.php b/Checker/Catalog/Category/UrlKey/DuplicateUrlKey.php
@@ -11,7 +11,7 @@
 class DuplicateUrlKey
 {
     const DUPLICATED_PROBLEM_DESCRIPTION =
-          '%s categories were found which have a duplicated url_key value: "%s" within the same parent.'
+        '%s categories were found which have a duplicated url_key value: "%s" within the same parent.'
         . ' Please fix because this will cause problems.';
 
     private $storesUtil;
diff --git a/Checker/Catalog/Category/UrlPath.php b/Checker/Catalog/Category/UrlPath.php
@@ -18,7 +18,7 @@ class UrlPath
     const URL_PATH_ATTRIBUTE = 'url_path';
     const URL_PATH_SEPARATOR = '/';
     const PROBLEM_DESCRIPTION =
-          'Category has an incorrect url_path value "%s". It should be "%s".'
+        'Category has an incorrect url_path value "%s". It should be "%s".'
         . ' Unfortunately this is not easily fixable using the backend of Magento.';
     const STORAGE_IDENTIFIER = 'category-url-path';
 
diff --git a/Checker/Catalog/Product/UrlKey/DuplicateUrlKey.php b/Checker/Catalog/Product/UrlKey/DuplicateUrlKey.php
@@ -19,7 +19,7 @@
 class DuplicateUrlKey
 {
     const DUPLICATED_PROBLEM_DESCRIPTION =
-          'Product has a duplicated url_key value (%s). It\'s the same as another product (ID: %s, Store: %s).'
+        'Product has a duplicated url_key value (%s). It\'s the same as another product (ID: %s, Store: %s).'
         . ' Please fix because this will cause problems.';
 
     private $storesUtil;
@@ -214,9 +214,10 @@ function ($urlKey) use ($urlKeysWhichExistMoreThanOnce) {
                                 $conflictingStoreId
                             ),
                         ];
-                    // if same product id, we don't care,
-                    // since it wouldn't be a conflict if they exist in another storeview
                     } elseif ($productId !== $conflictingProductId) {
+                        // ^^^ if same product id, we don't care,
+                        // since it wouldn't be a conflict if they exist in another storeview
+
                         if (array_key_exists("$conflictingStoreId-$productId", $inheritedProductUrlKeyData)
                             && $inheritedProductUrlKeyData["$conflictingStoreId-$productId"] === $urlKey
                         ) {
diff --git a/Checker/Catalog/Product/UrlPath.php b/Checker/Catalog/Product/UrlPath.php
@@ -18,7 +18,7 @@ class UrlPath
 {
     const URL_PATH_ATTRIBUTE = 'url_path';
     const PROBLEM_DESCRIPTION =
-          'Product has a non-null url_path attribute, this is known to cause problems with url rewrites in Magento.'
+        'Product has a non-null url_path attribute, this is known to cause problems with url rewrites in Magento.'
         . ' It\'s advised to remove this value from the database.';
     const STORAGE_IDENTIFIER = 'product-url-path';
 
diff --git a/Exception/AlreadyRefreshingException.php b/Exception/AlreadyRefreshingException.php
@@ -6,6 +6,4 @@
 
 use Magento\Framework\Exception\LocalizedException;
 
-class AlreadyRefreshingException extends LocalizedException
-{
-}
+class AlreadyRefreshingException extends LocalizedException {}
diff --git a/Exception/MissingConfigurationException.php b/Exception/MissingConfigurationException.php
@@ -6,6 +6,4 @@
 
 use Magento\Framework\Exception\LocalizedException;
 
-class MissingConfigurationException extends LocalizedException
-{
-}
+class MissingConfigurationException extends LocalizedException {}
diff --git a/Exception/SerializationException.php b/Exception/SerializationException.php
@@ -6,6 +6,4 @@
 
 use Magento\Framework\Exception\LocalizedException;
 
-class SerializationException extends LocalizedException
-{
-}
+class SerializationException extends LocalizedException {}
diff --git a/Makefile b/Makefile
@@ -11,7 +11,7 @@ check: checkstyle checkquality test
 .PHONY: checkstyle
 checkstyle:
 	vendor-bin/php-cs-fixer/vendor/bin/php-cs-fixer fix --dry-run --diff --stop-on-violation --allow-risky=yes
-	vendor-bin/phpcs/vendor/bin/phpcs -s --standard=Magento2 --exclude=Magento2.Security.InsecureFunction,Magento2.Commenting.ClassPropertyPHPDocFormatting,Magento2.Annotation.MethodAnnotationStructure,Magento2.Annotation.MethodArguments,PSR12.Properties.ConstantVisibility --ignore=./vendor/,./vendor-bin/ .
+	vendor-bin/phpcs/vendor/bin/phpcs -s --standard=Magento2 --exclude=Magento2.Security.InsecureFunction,Magento2.Commenting.ClassPropertyPHPDocFormatting,Magento2.Annotation.MethodAnnotationStructure,Magento2.Annotation.MethodArguments,PSR12.Properties.ConstantVisibility,PSR2.Classes.ClassDeclaration,Squiz.WhiteSpace.ScopeClosingBrace,Magento2.Legacy.EscapeMethodsOnBlockClass --ignore=./vendor/,./vendor-bin/ .
 	vendor-bin/phpcs/vendor/bin/phpcs -s --standard=PHPCompatibility --runtime-set testVersion 7.0- --ignore=./vendor/,./vendor-bin/,./Test/ .
 	vendor-bin/phpcs/vendor/bin/phpcs -s --standard=PHPCompatibility --runtime-set testVersion 7.1- ./Test/
 	vendor/bin/composer normalize --dry-run
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ It should be up to the store owner to figure out how he/she wants to fix these p
 This module should be compatible with Magento 2.1.x, 2.2.x, 2.3.x and 2.4.x versions.  
 Some code in this module is using old ways of doing things. It could have been written in a more modern way (using message queues instead of cronjobs, use newer syntax for UI components, ...). But we wanted this module to be compatible with older versions of Magento, so we've chosen this route for now.
 
-The module should be compatible with PHP 7.0, 7.1, 7.2, 7.3, 7.4, 8.1 and 8.2
+The module should be compatible with PHP 7.0, 7.1, 7.2, 7.3, 7.4, 8.1, 8.2 and 8.3
 
 ## Installation
 
diff --git a/Storage/Meta.php b/Storage/Meta.php
@@ -91,9 +91,9 @@ public function isRefreshing(string $storageIdentifier): bool
 
         $metaData = $this->storage->read($storageIdentifier);
 
-        if (!empty($metaData) &&
-            array_key_exists('status', $metaData) &&
-            $metaData['status'] === self::STATUS_REFRESHING
+        if (!empty($metaData)
+            && array_key_exists('status', $metaData)
+            && $metaData['status'] === self::STATUS_REFRESHING
         ) {
             return true;
         }
diff --git a/composer.json b/composer.json
@@ -11,7 +11,7 @@
         }
     ],
     "require": {
-        "php": "~7.0.0 || ~7.1.0 || ~7.2.0 || ~7.3.0 || ~7.4.0 || ~8.1.0 || ~8.2.0",
+        "php": "~7.0.0 || ~7.1.0 || ~7.2.0 || ~7.3.0 || ~7.4.0 || ~8.1.0 || ~8.2.0 || ~8.3.0",
         "magento/framework": "^100.1 || ^101.0 || ^102.0 || ^103.0",
         "magento/module-backend": "^100.1 || ^101.0 || ^102.0",
         "magento/module-catalog": "^101.0 || ^102.0 || ^103.0 || ^104.0",
@@ -20,7 +20,7 @@
         "magento/module-store": "^100.1 || ^101.0",
         "magento/module-theme": "^100.1 || ^101.0",
         "magento/module-ui": "^100.1 || ^101.0",
-        "symfony/console": "^2.5 || ^3.0 || ^4.0 || ^5.0"
+        "symfony/console": "^2.5 || ^3.0 || ^4.0 || ^5.0 || ^6.0"
     },
     "require-dev": {
         "bamarni/composer-bin-plugin": "^1.7",
diff --git a/composer.lock b/composer.lock
diff --git a/vendor-bin/php-cs-fixer/composer.lock b/vendor-bin/php-cs-fixer/composer.lock
diff --git a/vendor-bin/phpcs/composer.lock b/vendor-bin/phpcs/composer.lock
diff --git a/vendor-bin/phpstan/composer.json b/vendor-bin/phpstan/composer.json
diff --git a/vendor-bin/phpstan/composer.lock b/vendor-bin/phpstan/composer.lock

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`class DuplicateUrlKey`
`12`	`12`	`{`
`13`	`13`	`const DUPLICATED_PROBLEM_DESCRIPTION =`
`14`		`- '%s categories were found which have a duplicated url_key value: "%s" within the same parent.'`
	`14`	`+ '%s categories were found which have a duplicated url_key value: "%s" within the same parent.'`
`15`	`15`	`. ' Please fix because this will cause problems.';`
`16`	`16`
`17`	`17`	`private $storesUtil;`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ class UrlPath`
`18`	`18`	`{`
`19`	`19`	`const URL_PATH_ATTRIBUTE = 'url_path';`
`20`	`20`	`const PROBLEM_DESCRIPTION =`
`21`		`- 'Product has a non-null url_path attribute, this is known to cause problems with url rewrites in Magento.'`
	`21`	`+ 'Product has a non-null url_path attribute, this is known to cause problems with url rewrites in Magento.'`
`22`	`22`	`. ' It\'s advised to remove this value from the database.';`
`23`	`23`	`const STORAGE_IDENTIFIER = 'product-url-path';`
`24`	`24`