techdivision / import-product-url-rewrite

src/Observers/UrlRewriteObserver.php

Doc Comments +2 added lines, -2 removed lines

@@ -117,7 +117,7 @@ 
     /**
      * Return's the product bunch processor instance.
      *
-     * @return \TechDivision\Import\Product\Services\ProductBunchProcessorInterface The product bunch processor instance
+     * @return ProductUrlRewriteProcessorInterface The product bunch processor instance
      */
     protected function getProductUrlRewriteProcessor()
     {
@@ -622,7 +622,7 @@ 
      * @param string $path          The path of the category to return
      * @param string $storeViewCode The store view code of the category to return
      *
-     * @return array The category
+     * @return string The category
      */
     protected function getCategoryByPath($path, $storeViewCode = StoreViewCodes::ADMIN)
     {

Indentation +32 added lines, -32 removed lines

@@ -197,14 +197,14 @@ 
         if ($storeViewCode === StoreViewCodes::ADMIN) {
             // log a message and return
             $this->getSubject()
-                 ->getSystemLogger()
-                 ->debug(
-                     sprintf(
-                         'Store with code "%s" is not active, no URL rewrites will be created for product with SKU "%s"',
-                         $storeViewCode,
-                         $sku
-                     )
-                 );
+                    ->getSystemLogger()
+                    ->debug(
+                        sprintf(
+                            'Store with code "%s" is not active, no URL rewrites will be created for product with SKU "%s"',
+                            $storeViewCode,
+                            $sku
+                        )
+                    );
 
             // return without creating any rewrites
             return $this->getRow();
@@ -214,14 +214,14 @@ 
         if (!$this->getSubject()->storeIsActive($storeViewCode)) {
             // log a message and return
             $this->getSubject()
-                 ->getSystemLogger()
-                 ->debug(
-                     sprintf(
-                         'Store with code "%s" is not active, no URL rewrites will be created for product with SKU "%s"',
-                         $storeViewCode,
-                         $sku
-                     )
-                 );
+                    ->getSystemLogger()
+                    ->debug(
+                        sprintf(
+                            'Store with code "%s" is not active, no URL rewrites will be created for product with SKU "%s"',
+                            $storeViewCode,
+                            $sku
+                        )
+                    );
 
             // return without creating any rewrites
             return $this->getRow();
@@ -280,8 +280,8 @@ 
                     // query whether or not debug mode has been enabled
                     if ($this->getSubject()->isDebugMode()) {
                         $this->getSubject()
-                             ->getSystemLogger()
-                             ->warning($this->getSubject()->appendExceptionSuffix($e->getMessage()));
+                                ->getSystemLogger()
+                                ->warning($this->getSubject()->appendExceptionSuffix($e->getMessage()));
                     } else {
                         throw $e;
                     }
@@ -330,18 +330,18 @@ 
         // do NOT create new URL rewrites, if the product is NOT visible (any more), BUT
         // handle existing URL rewrites, e. g. to remove and clean up the URL rewrites
         if (!$this->isVisible()) {
-             // log a message
-             $this->getSubject()
-                 ->getSystemLogger()
-                 ->debug(
-                     sprintf(
-                         'Product with SKU "%s" is not visible, so no URL rewrites will be created',
-                         $this->getValue(ColumnKeys::SKU)
-                     )
-                 );
-
-             // return without creating any rewrites
-             return;
+                // log a message
+                $this->getSubject()
+                    ->getSystemLogger()
+                    ->debug(
+                        sprintf(
+                            'Product with SKU "%s" is not visible, so no URL rewrites will be created',
+                            $this->getValue(ColumnKeys::SKU)
+                        )
+                    );
+
+                // return without creating any rewrites
+                return;
         }
 
         // load the root category, because we need that to create the default product URL rewrite
@@ -366,8 +366,8 @@ 
                 // query whether or not debug mode has been enabled
                 if ($this->getSubject()->isDebugMode()) {
                     $this->getSubject()
-                         ->getSystemLogger()
-                         ->warning($this->getSubject()->appendExceptionSuffix($e->getMessage()));
+                            ->getSystemLogger()
+                            ->warning($this->getSubject()->appendExceptionSuffix($e->getMessage()));
                 } else {
                     throw $e;
                 }

tests/unit/Observers/UrlRewriteUpdateObserverTest.php

Indentation +13 added lines, -13 removed lines

@@ -66,8 +66,8 @@ 
 
         // initialize a mock processor instance
         $this->mockProductUrlRewriteProcessor = $this->getMockBuilder('TechDivision\Import\Product\UrlRewrite\Services\ProductUrlRewriteProcessorInterface')
-                                                     ->setMethods(get_class_methods('TechDivision\Import\Product\UrlRewrite\Services\ProductUrlRewriteProcessorInterface'))
-                                                     ->getMock();
+                                                        ->setMethods(get_class_methods('TechDivision\Import\Product\UrlRewrite\Services\ProductUrlRewriteProcessorInterface'))
+                                                        ->getMock();
 
         // initialize the observer
         $this->observer = new UrlRewriteUpdateObserver($this->mockProductUrlRewriteProcessor);
@@ -104,14 +104,14 @@ 
 
         // initialize the categories
         $categories = array(
-             $path1 = 'Default Category'                                => array(MemberNames::ENTITY_ID => 2, MemberNames::PARENT_ID => 1, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => null, MemberNames::PATH => $path1),
-             $path2 = 'Default Category/Men'                            => array(MemberNames::ENTITY_ID => 3, MemberNames::PARENT_ID => 2, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men', MemberNames::PATH => $path2),
-             $path3 = 'Default Category/Men/Tops'                       => array(MemberNames::ENTITY_ID => 4, MemberNames::PARENT_ID => 3, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men/tops-men', MemberNames::PATH => $path3),
-             $path4 = 'Default Category/Men/Tops/Hoodies & Sweatshirts' => array(MemberNames::ENTITY_ID => 5, MemberNames::PARENT_ID => 4, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men/tops-men/hoodies-and-sweatshirts-men', MemberNames::PATH => $path4),
-             $path5 = 'Default Category/Collections'                    => array(MemberNames::ENTITY_ID => 6, MemberNames::PARENT_ID => 3, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'collections', MemberNames::PATH => $path5),
-             $path6 = 'Default Category/Collections/Eco Friendly'       => array(MemberNames::ENTITY_ID => 7, MemberNames::PARENT_ID => 6, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'collections/eco-friendly', MemberNames::PATH => $path6),
-             $path7 = 'Default Category/Collections/Old'                => array(MemberNames::ENTITY_ID => 8, MemberNames::PARENT_ID => 6, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'collections/old', MemberNames::PATH => $path7),
-             $path8 = 'Default Category/Men/Old'                        => array(MemberNames::ENTITY_ID => 9, MemberNames::PARENT_ID => 3, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men/old', MemberNames::PATH => $path8),
+                $path1 = 'Default Category'                                => array(MemberNames::ENTITY_ID => 2, MemberNames::PARENT_ID => 1, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => null, MemberNames::PATH => $path1),
+                $path2 = 'Default Category/Men'                            => array(MemberNames::ENTITY_ID => 3, MemberNames::PARENT_ID => 2, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men', MemberNames::PATH => $path2),
+                $path3 = 'Default Category/Men/Tops'                       => array(MemberNames::ENTITY_ID => 4, MemberNames::PARENT_ID => 3, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men/tops-men', MemberNames::PATH => $path3),
+                $path4 = 'Default Category/Men/Tops/Hoodies & Sweatshirts' => array(MemberNames::ENTITY_ID => 5, MemberNames::PARENT_ID => 4, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men/tops-men/hoodies-and-sweatshirts-men', MemberNames::PATH => $path4),
+                $path5 = 'Default Category/Collections'                    => array(MemberNames::ENTITY_ID => 6, MemberNames::PARENT_ID => 3, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'collections', MemberNames::PATH => $path5),
+                $path6 = 'Default Category/Collections/Eco Friendly'       => array(MemberNames::ENTITY_ID => 7, MemberNames::PARENT_ID => 6, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'collections/eco-friendly', MemberNames::PATH => $path6),
+                $path7 = 'Default Category/Collections/Old'                => array(MemberNames::ENTITY_ID => 8, MemberNames::PARENT_ID => 6, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'collections/old', MemberNames::PATH => $path7),
+                $path8 = 'Default Category/Men/Old'                        => array(MemberNames::ENTITY_ID => 9, MemberNames::PARENT_ID => 3, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men/old', MemberNames::PATH => $path8),
         );
 
         // initialize a mock import adapter instance
@@ -123,8 +123,8 @@ 
 
         // mock the system logger
         $mockSystemLogger = $this->getMockBuilder('Psr\Log\LoggerInterface')
-                                 ->setMethods(get_class_methods('Psr\Log\LoggerInterface'))
-                                 ->getMock();
+                                    ->setMethods(get_class_methods('Psr\Log\LoggerInterface'))
+                                    ->getMock();
 
         // the found URL rewrites
         $urlRewrites = array(
@@ -317,7 +317,7 @@ 
                     ->method('getUrlRewritesByEntityTypeAndEntityIdAndStoreId')
                     ->with(UrlRewriteObserver::ENTITY_TYPE, $entityId, $storeId)
                     ->willReturn($urlRewrites);
-       $this->mockProductUrlRewriteProcessor->expects($this->exactly(6))
+        $this->mockProductUrlRewriteProcessor->expects($this->exactly(6))
                     ->method('persistUrlRewrite')
                     ->withConsecutive(
                         array(

Spacing +1 added lines, -1 removed lines

@@ -301,7 +301,7 @@
         $mockSubject->expects($this->any())
                     ->method('getCoreConfigData')
                     ->will(
-                        $this->returnCallback(function ($arg1, $arg2) {
+                        $this->returnCallback(function($arg1, $arg2) {
                             return $arg2;
                         })
                     );

RoboFile.php

Unused Use Statements -4 removed lines

@@ -18,10 +18,6 @@
  * @link      http://www.techdivision.com
  */
 
-use Lurker\Event\FilesystemEvent;
-
-use Symfony\Component\Finder\Finder;
-
 /**
  * Defines the available build tasks.
  *

Indentation +12 added lines, -12 removed lines

@@ -58,9 +58,9 @@ 
     {
         // optimize autoloader with custom path
         return $this->taskComposerInstall()
-             ->preferDist()
-             ->optimizeAutoloader()
-             ->run();
+                ->preferDist()
+                ->optimizeAutoloader()
+                ->run();
     }
 
     /**
@@ -72,9 +72,9 @@ 
     {
         // optimize autoloader with custom path
         return $this->taskComposerUpdate()
-             ->preferDist()
-             ->optimizeAutoloader()
-             ->run();
+                ->preferDist()
+                ->optimizeAutoloader()
+                ->run();
     }
 
     /**
@@ -95,10 +95,10 @@ 
     public function prepare()
     {
         return $this->taskFileSystemStack()
-             ->mkdir($this->properties['dist.dir'])
-             ->mkdir($this->properties['target.dir'])
-             ->mkdir(sprintf('%s/reports', $this->properties['target.dir']))
-             ->run();
+                ->mkdir($this->properties['dist.dir'])
+                ->mkdir($this->properties['target.dir'])
+                ->mkdir(sprintf('%s/reports', $this->properties['target.dir']))
+                ->run();
     }
 
     /**
@@ -168,8 +168,8 @@ 
 
         // run PHPUnit
         return $this->taskPHPUnit(sprintf('%s/bin/phpunit', $this->properties['vendor.dir']))
-             ->configFile('phpunit.xml')
-             ->run();
+                ->configFile('phpunit.xml')
+                ->run();
     }
 
     /**

src/Observers/UrlRewriteUpdateObserver.php

Indentation +24 added lines, -24 removed lines

@@ -100,14 +100,14 @@ 
 
                             // finally log a warning that the old category is not available ony more
                             $this->getSubject()
-                                 ->getSystemLogger()
-                                 ->warning(
-                                     sprintf(
-                                         'Category with ID "%d" is not longer available for URL rewrite with ID "%d"',
-                                         $metadata[UrlRewriteObserver::CATEGORY_ID],
-                                         $existingUrlRewrite[MemberNames::URL_REWRITE_ID]
-                                     )
-                                 );
+                                    ->getSystemLogger()
+                                    ->warning(
+                                        sprintf(
+                                            'Category with ID "%d" is not longer available for URL rewrite with ID "%d"',
+                                            $metadata[UrlRewriteObserver::CATEGORY_ID],
+                                            $existingUrlRewrite[MemberNames::URL_REWRITE_ID]
+                                        )
+                                    );
                         }
                     }
                 }
@@ -119,14 +119,14 @@ 
                 if ($targetPath === $existingUrlRewrite[MemberNames::REQUEST_PATH]) {
                     // finally log a warning that the old category is not available ony more
                     $this->getSubject()
-                         ->getSystemLogger()
-                         ->warning(
-                             sprintf(
-                                 'New target path "%s" eqals request path for URL rewrite with ID "%d"',
-                                 $existingUrlRewrite[MemberNames::REQUEST_PATH],
-                                 $existingUrlRewrite[MemberNames::URL_REWRITE_ID]
-                             )
-                         );
+                            ->getSystemLogger()
+                            ->warning(
+                                sprintf(
+                                    'New target path "%s" eqals request path for URL rewrite with ID "%d"',
+                                    $existingUrlRewrite[MemberNames::REQUEST_PATH],
+                                    $existingUrlRewrite[MemberNames::URL_REWRITE_ID]
+                                )
+                            );
 
                     // stop processing the URL rewrite
                     continue;
@@ -153,14 +153,14 @@ 
 
                     // log a message, that old URL rewrites have been cleaned-up
                     $this->getSubject()
-                         ->getSystemLogger()
-                         ->warning(
-                             sprintf(
-                                 'Cleaned-up URL rewrite "%s" for product with SKU "%s"',
-                                 $existingUrlRewrite[MemberNames::REQUEST_PATH],
-                                 $this->getValue(ColumnKeys::SKU)
-                             )
-                         );
+                            ->getSystemLogger()
+                            ->warning(
+                                sprintf(
+                                    'Cleaned-up URL rewrite "%s" for product with SKU "%s"',
+                                    $existingUrlRewrite[MemberNames::REQUEST_PATH],
+                                    $this->getValue(ColumnKeys::SKU)
+                                )
+                            );
                 }
             }
         }

Spacing +1 added lines, -1 removed lines

@@ -105,7 +105,7 @@
 
                 // skip update of URL rewrite, if nothing to change
                 if ($targetPath === $existingUrlRewrite[MemberNames::TARGET_PATH] &&
-                    301 === (int)$existingUrlRewrite[MemberNames::REDIRECT_TYPE]) {
+                    301 === (int) $existingUrlRewrite[MemberNames::REDIRECT_TYPE]) {
                     // stop processing the URL rewrite
                     continue;
                 }

tests/unit/Observers/UrlRewriteObserverTest.php

Indentation +11 added lines, -11 removed lines

@@ -68,8 +68,8 @@ 
 
         // initialize a mock processor instance
         $this->mockProductUrlRewriteProcessor = $this->getMockBuilder('TechDivision\Import\Product\UrlRewrite\Services\ProductUrlRewriteProcessorInterface')
-                                                     ->setMethods(get_class_methods('TechDivision\Import\Product\UrlRewrite\Services\ProductUrlRewriteProcessorInterface'))
-                                                     ->getMock();
+                                                        ->setMethods(get_class_methods('TechDivision\Import\Product\UrlRewrite\Services\ProductUrlRewriteProcessorInterface'))
+                                                        ->getMock();
 
         // initialize the observer
         $this->observer = new UrlRewriteObserver($this->mockProductUrlRewriteProcessor);
@@ -304,12 +304,12 @@ 
 
         // initialize the categories
         $categories = array(
-             $path1 = 'Default Category'                                => array(MemberNames::ENTITY_ID => 2, MemberNames::PARENT_ID => 1, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => null, MemberNames::PATH => $path1),
-             $path2 = 'Default Category/Men'                            => array(MemberNames::ENTITY_ID => 3, MemberNames::PARENT_ID => 2, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men', MemberNames::PATH => $path2),
-             $path3 = 'Default Category/Men/Tops'                       => array(MemberNames::ENTITY_ID => 4, MemberNames::PARENT_ID => 3, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men/tops-men', MemberNames::PATH => $path3),
-             $path4 = 'Default Category/Men/Tops/Hoodies & Sweatshirts' => array(MemberNames::ENTITY_ID => 5, MemberNames::PARENT_ID => 4, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men/tops-men/hoodies-and-sweatshirts-men', MemberNames::PATH => $path4),
-             $path5 = 'Default Category/Collections'                    => array(MemberNames::ENTITY_ID => 6, MemberNames::PARENT_ID => 3, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'collections', MemberNames::PATH => $path5),
-             $path6 = 'Default Category/Collections/Eco Friendly'       => array(MemberNames::ENTITY_ID => 7, MemberNames::PARENT_ID => 6, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'collections/eco-friendly', MemberNames::PATH => $path6),
+                $path1 = 'Default Category'                                => array(MemberNames::ENTITY_ID => 2, MemberNames::PARENT_ID => 1, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => null, MemberNames::PATH => $path1),
+                $path2 = 'Default Category/Men'                            => array(MemberNames::ENTITY_ID => 3, MemberNames::PARENT_ID => 2, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men', MemberNames::PATH => $path2),
+                $path3 = 'Default Category/Men/Tops'                       => array(MemberNames::ENTITY_ID => 4, MemberNames::PARENT_ID => 3, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men/tops-men', MemberNames::PATH => $path3),
+                $path4 = 'Default Category/Men/Tops/Hoodies & Sweatshirts' => array(MemberNames::ENTITY_ID => 5, MemberNames::PARENT_ID => 4, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'men/tops-men/hoodies-and-sweatshirts-men', MemberNames::PATH => $path4),
+                $path5 = 'Default Category/Collections'                    => array(MemberNames::ENTITY_ID => 6, MemberNames::PARENT_ID => 3, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'collections', MemberNames::PATH => $path5),
+                $path6 = 'Default Category/Collections/Eco Friendly'       => array(MemberNames::ENTITY_ID => 7, MemberNames::PARENT_ID => 6, MemberNames::IS_ANCHOR => null, MemberNames::URL_PATH => 'collections/eco-friendly', MemberNames::PATH => $path6),
         );
 
         // initialize a mock import adapter instance
@@ -331,8 +331,8 @@ 
 
         // mock the system logger
         $mockSystemLogger = $this->getMockBuilder('Psr\Log\LoggerInterface')
-                                 ->setMethods(get_class_methods('Psr\Log\LoggerInterface'))
-                                 ->getMock();
+                                    ->setMethods(get_class_methods('Psr\Log\LoggerInterface'))
+                                    ->getMock();
 
         // create a mock subject
         $mockSubject = $this->getMockBuilder('TechDivision\Import\Product\UrlRewrite\Subjects\UrlRewriteSubject')
@@ -463,7 +463,7 @@ 
                             return $arg2;
                         })
                     );
-       $mockSubject->expects(($this->exactly(4)))
+        $mockSubject->expects(($this->exactly(4)))
                     ->method('getImportAdapter')
                     ->willReturn($mockImportAdapter);
 

Spacing +1 added lines, -1 removed lines

@@ -301,7 +301,7 @@
         $mockSubject->expects($this->any())
                     ->method('getCoreConfigData')
                     ->will(
-                        $this->returnCallback(function ($arg1, $arg2) {
+                        $this->returnCallback(function($arg1, $arg2) {
                             return $arg2;
                         })
                     );

Doc Comments +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
      * Create's and invokes the UrlRewriteObserver instance.
      *
      * @param boolean $generateCategoryProductRewrites Whether or not the configuration to generare catagory/product URL rewrites has been activated
-     * @param array   $productCategoryIds              The array with the category IDs the product has been related with
+     * @param string[]   $productCategoryIds              The array with the category IDs the product has been related with
      * @param array   $category                        The array with the categories
      *
      * @return void

src/Repositories/UrlRewriteRepository.php

Doc Comments +1 added lines, -1 removed lines

@@ -54,7 +54,7 @@
      *
      * @param string $sku The SKU to load the URL rewrites for
      *
-     * @return array The URL rewrites
+     * @return \Generator The URL rewrites
      */
     public function findAllBySku($sku)
     {

src/Observers/ProductUrlRewriteObserver.php

Spacing +1 added lines, -1 removed lines

@@ -96,7 +96,7 @@
                     // query whether or not a URL key has be specfied and the store view codes are equal
                     if ($this->hasValue(ColumnKeys::URL_KEY) && $this->artefacts[$i][ColumnKeys::STORE_VIEW_CODE] === $storeViewCode) {
                         // update the URL key
-                        $this->artefacts[$i][ColumnKeys::URL_KEY]    = $this->getValue(ColumnKeys::URL_KEY);
+                        $this->artefacts[$i][ColumnKeys::URL_KEY] = $this->getValue(ColumnKeys::URL_KEY);
                         // update the visibility, if available
                         if ($this->hasValue(ColumnKeys::VISIBILITY)) {
                             $this->artefacts[$i][ColumnKeys::VISIBILITY] = $this->getValue(ColumnKeys::VISIBILITY);