techdivision / import-product-url-rewrite

RoboFile.php

Indentation +12 added lines, -12 removed lines

@@ -60,9 +60,9 @@ 
     {
         // optimize autoloader with custom path
         $this->taskComposerInstall()
-             ->preferDist()
-             ->optimizeAutoloader()
-             ->run();
+                ->preferDist()
+                ->optimizeAutoloader()
+                ->run();
     }
 
     /**
@@ -74,9 +74,9 @@ 
     {
         // optimize autoloader with custom path
         $this->taskComposerUpdate()
-             ->preferDist()
-             ->optimizeAutoloader()
-             ->run();
+                ->preferDist()
+                ->optimizeAutoloader()
+                ->run();
     }
 
     /**
@@ -97,10 +97,10 @@ 
     public function prepare()
     {
         $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();
     }
 
     /**
@@ -170,8 +170,8 @@ 
 
         // run PHPUnit
         $this->taskPHPUnit(sprintf('%s/bin/phpunit', $this->properties['vendor.dir']))
-             ->configFile('phpunit.xml')
-             ->run();
+                ->configFile('phpunit.xml')
+                ->run();
     }
 
     /**

src/Observers/UrlRewriteObserver.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,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()
     {

Indentation +37 added lines, -37 removed lines

@@ -172,14 +172,14 @@ 
         if ($this->storeViewHasBeenProcessed($sku, $storeViewCode)) {
             // log a message
             $this->getSubject()
-                 ->getSystemLogger()
-                 ->debug(
-                     sprintf(
-                         'URL rewrites for SKU "%s" + store view code "%s" has already been processed',
-                         $sku,
-                         $storeViewCode
-                     )
-                 );
+                    ->getSystemLogger()
+                    ->debug(
+                        sprintf(
+                            'URL rewrites for SKU "%s" + store view code "%s" has already been processed',
+                            $sku,
+                            $storeViewCode
+                        )
+                    );
 
             // return without creating any rewrites
             return;
@@ -189,14 +189,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;
@@ -206,14 +206,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;
@@ -229,13 +229,13 @@ 
         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',
-                         $sku
-                     )
-                 );
+                    ->getSystemLogger()
+                    ->debug(
+                        sprintf(
+                            'Product with SKU "%s" is not visible, so no URL rewrites will be created',
+                            $sku
+                        )
+                    );
 
             // return without creating any rewrites
             return;
@@ -267,8 +267,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;
                     }
@@ -334,8 +334,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;
                     }
@@ -384,8 +384,8 @@ 
                 $this->productCategoryIds[] = $categoryId;
             } else {
                 $this->getSubject()
-                     ->getSystemLogger()
-                     ->debug(sprintf('Don\'t create URL rewrite for category "%s" because of missing anchor flag', $category[MemberNames::PATH]));
+                        ->getSystemLogger()
+                        ->debug(sprintf('Don\'t create URL rewrite for category "%s" because of missing anchor flag', $category[MemberNames::PATH]));
             }
         }
 

tests/Observers/UrlRewriteObserverTest.php

Indentation +14 added lines, -14 removed lines

@@ -65,8 +65,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);
@@ -250,28 +250,28 @@ 
 
         // 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),
         );
 
         // create a mock configuration
         $mockSubjectConfiguration = $this->getMockBuilder('TechDivision\Import\Configuration\SubjectConfigurationInterface')
-                                         ->setMethods(get_class_methods('TechDivision\Import\Configuration\SubjectConfigurationInterface'))
-                                         ->getMock();
+                                            ->setMethods(get_class_methods('TechDivision\Import\Configuration\SubjectConfigurationInterface'))
+                                            ->getMock();
 
         // mock the methods
         $mockSubjectConfiguration->expects($this->once())
-                                 ->method('getDelimiter')
-                                 ->willReturn(',');
+                                    ->method('getDelimiter')
+                                    ->willReturn(',');
 
         // 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')

tests/Observers/UrlRewriteUpdateObserverTest.php

Indentation +17 added lines, -17 removed lines

@@ -65,8 +65,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);
@@ -103,30 +103,30 @@ 
 
         // 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),
         );
 
         // create a mock configuration
         $mockSubjectConfiguration = $this->getMockBuilder('TechDivision\Import\Configuration\SubjectConfigurationInterface')
-                                         ->setMethods(get_class_methods('TechDivision\Import\Configuration\SubjectConfigurationInterface'))
-                                         ->getMock();
+                                            ->setMethods(get_class_methods('TechDivision\Import\Configuration\SubjectConfigurationInterface'))
+                                            ->getMock();
 
         // mock the methods
         $mockSubjectConfiguration->expects($this->once())
-                                 ->method('getDelimiter')
-                                 ->willReturn(',');
+                                    ->method('getDelimiter')
+                                    ->willReturn(',');
 
         // 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(
@@ -312,7 +312,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(

src/Observers/UrlRewriteUpdateObserver.php

Indentation +10 added lines, -10 removed lines

@@ -97,8 +97,8 @@ 
 
                         // 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', $metadata[UrlRewriteObserver::CATEGORY_ID]));
+                                ->getSystemLogger()
+                                ->warning(sprintf('Category with ID %d is not longer available', $metadata[UrlRewriteObserver::CATEGORY_ID]));
                     }
                 }
 
@@ -121,14 +121,14 @@ 
 
                     // log a message, that old URL rewrites have been cleaned-up
                     $this->getSubject()
-                         ->getSystemLogger()
-                         ->notice(
-                             sprintf(
-                                 'Cleaned-up %d URL rewrite "%s" for product with SKU "%s"',
-                                 $existingUrlRewrite[MemberNames::REQUEST_PATH],
-                                 $this->getValue(ColumnKeys::SKU)
-                             )
-                         );
+                            ->getSystemLogger()
+                            ->notice(
+                                sprintf(
+                                    'Cleaned-up %d URL rewrite "%s" for product with SKU "%s"',
+                                    $existingUrlRewrite[MemberNames::REQUEST_PATH],
+                                    $this->getValue(ColumnKeys::SKU)
+                                )
+                            );
                 }
             }
         }

src/Services/ProductUrlRewriteProcessor.php

Doc Comments +1 added lines, -1 removed lines

@@ -151,7 +151,7 @@
      * Commits a transaction, returning the database connection to autocommit mode until the next call to
      * ProductProcessor::beginTransaction() starts a new transaction.
      *
-     * @return boolean Returns TRUE on success or FALSE on failure
+     * @return boolean|null Returns TRUE on success or FALSE on failure
      * @link http://php.net/manual/en/pdo.commit.php
      */
     public function commit()