Merge branch 'v1-develop' into v1

Author: hostep

.gitattributes

@@ -0,0 +1,10 @@
+/.gitattributes        export-ignore
+/.gitignore            export-ignore
+/.php-auto-version     export-ignore
+/.php-cs-fixer.php     export-ignore
+/composer.lock         export-ignore
+/Makefile              export-ignore
+/phpstan-baseline.neon export-ignore
+/phpstan.neon          export-ignore
+/Test                  export-ignore
+/vendor-bin            export-ignore

.php-cs-fixer.php

@@ -1,25 +1,31 @@
 <?php
 
-$finder = PhpCsFixer\Finder::create()
+use PhpCsFixer\Finder as PhpCsFixerFinder;
+use PhpCsFixer\Config as PhpCsFixerConfig;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+
+$finder = PhpCsFixerFinder::create()
     ->in(__DIR__)
     ->exclude('vendor')
     ->exclude('vendor-bin')
 ;
 
-$config = new PhpCsFixer\Config();
+$config = new PhpCsFixerConfig();
 return $config
+    ->setParallelConfig(ParallelConfigFactory::detect())
     ->setRules([
         '@PER-CS'                                          => true,
         'binary_operator_spaces'                           => ['default' => 'at_least_single_space', 'operators' => ['=>' => 'align']],
         'declare_strict_types'                             => true,
         'no_alias_functions'                               => true,
+        'no_unused_imports'                                => 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
+        'nullable_type_declaration_for_default_null_value' => true,
         '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
+        'trailing_comma_in_multiline'                      => ['after_heredoc' => true, 'elements' => ['arrays']], // remove this line when we drop support for PHP < 8.0
     ])
     ->setFinder($finder)
 ;

Block/Adminhtml/Metadata.php

@@ -35,6 +35,7 @@ public function getMetadata()
         if ($storageIdentifier === null || $storageIdentifier === '') {
             throw new MissingConfigurationException(__('No storage identifier was setup for this block!'));
         }
+        assert(is_string($storageIdentifier));
 
         $metaData = $this->metaStorage->getData($storageIdentifier);
         $metaData = $this->format($metaData);

Checker/Catalog/Category/UrlKey.php

@@ -9,8 +9,8 @@
 
 class UrlKey
 {
-    const URL_KEY_ATTRIBUTE = 'url_key';
-    const STORAGE_IDENTIFIER = 'category-url-key';
+    public const URL_KEY_ATTRIBUTE = 'url_key';
+    public const STORAGE_IDENTIFIER = 'category-url-key';
 
     private $duplicateUrlKeyChecker;
     private $emptyUrlKeyChecker;

Checker/Catalog/Category/UrlKey/DuplicateUrlKey.php

@@ -10,7 +10,7 @@
 
 class DuplicateUrlKey
 {
-    const DUPLICATED_PROBLEM_DESCRIPTION =
+    public const DUPLICATED_PROBLEM_DESCRIPTION =
         '%s categories were found which have a duplicated url_key value: "%s" within the same parent.'
         . ' Please fix because this will cause problems.';
 

Checker/Catalog/Category/UrlKey/EmptyUrlKey.php

@@ -15,7 +15,7 @@
 
 class EmptyUrlKey
 {
-    const EMPTY_PROBLEM_DESCRIPTION = 'Category has an empty url_key value. This needs to be fixed.';
+    public const EMPTY_PROBLEM_DESCRIPTION = 'Category has an empty url_key value. This needs to be fixed.';
 
     private $storesUtil;
     private $categoryCollectionFactory;

Checker/Catalog/Category/UrlPath.php

@@ -15,12 +15,12 @@
 
 class UrlPath
 {
-    const URL_PATH_ATTRIBUTE = 'url_path';
-    const URL_PATH_SEPARATOR = '/';
-    const PROBLEM_DESCRIPTION =
+    public const URL_PATH_ATTRIBUTE = 'url_path';
+    public const URL_PATH_SEPARATOR = '/';
+    public const PROBLEM_DESCRIPTION =
         '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';
+    public const STORAGE_IDENTIFIER = 'category-url-path';
 
     private $storesUtil;
     private $categoryCollectionFactory;
@@ -70,6 +70,7 @@ public function checkForIncorrectUrlPathAttributeValues(): array
                     $correctUrlPath = $this->getCalculatedUrlPathForCategory($category, $storeId);
 
                     assert(is_numeric($category->getId()));
+                    assert(is_string($category->getUrlPath()));
 
                     $problems[] = [
                         'catId'   => (int) $category->getId(),
@@ -164,7 +165,7 @@ public function getCalculatedUrlPathForCategory(Category $category, int $storeId
         ));
     }
 
-    private function fetchAllCategoriesWithUrlPathCalculatedByUrlKey()
+    private function fetchAllCategoriesWithUrlPathCalculatedByUrlKey(): void
     {
         $this->calculatedUrlPathPerCategoryAndStoreId = [];
 

Checker/Catalog/Product/UrlKey.php

@@ -9,8 +9,8 @@
 
 class UrlKey
 {
-    const URL_KEY_ATTRIBUTE = 'url_key';
-    const STORAGE_IDENTIFIER = 'product-url-key';
+    public const URL_KEY_ATTRIBUTE = 'url_key';
+    public const STORAGE_IDENTIFIER = 'product-url-key';
 
     private $duplicateUrlKeyChecker;
     private $emptyUrlKeyChecker;

Checker/Catalog/Product/UrlKey/DuplicateUrlKey.php

@@ -18,7 +18,7 @@
 
 class DuplicateUrlKey
 {
-    const DUPLICATED_PROBLEM_DESCRIPTION =
+    public const DUPLICATED_PROBLEM_DESCRIPTION =
         '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.';
 
@@ -118,10 +118,11 @@ private function checkForDuplicatedUrlKeyAttributeValues(): array
     /**
      * @param ProductCollection<ProductModel> $collection
      */
-    private function storeProductUrlKeyData(int $storeId, ProductCollection $collection)
+    private function storeProductUrlKeyData(int $storeId, ProductCollection $collection): void
     {
         foreach ($collection as $product) {
             assert(is_numeric($product->getEntityId()));
+            assert(is_string($product->getUrlKey()));
 
             $productId     = $product->getEntityId();
             $productSku    = $product->getSku();

Checker/Catalog/Product/UrlKey/EmptyUrlKey.php

@@ -18,7 +18,7 @@
 
 class EmptyUrlKey
 {
-    const EMPTY_PROBLEM_DESCRIPTION = 'Product has an empty url_key value. This needs to be fixed.';
+    public const EMPTY_PROBLEM_DESCRIPTION = 'Product has an empty url_key value. This needs to be fixed.';
 
     private $storesUtil;
     private $progress;