Merge pull request #164 from magento-folks/bulk

[Folks] Asynchronous Operations Framework

Author: balex13

app/etc/di.xml

@@ -152,6 +152,7 @@
     <preference for="Cm\RedisSession\Handler\LoggerInterface" type="Magento\Framework\Session\SaveHandler\Redis\Logger"/>
     <preference for="Magento\Framework\EntityManager\MapperInterface" type="Magento\Framework\EntityManager\CompositeMapper"/>
     <preference for="Magento\Framework\Console\CommandListInterface" type="Magento\Framework\Console\CommandList"/>
+    <preference for="Magento\Framework\DataObject\IdentityGeneratorInterface" type="Magento\Framework\DataObject\IdentityService" />
     <type name="Magento\Framework\Model\ResourceModel\Db\TransactionManager" shared="false" />
     <type name="Magento\Framework\Logger\Handler\Base">
         <arguments>

composer.json

@@ -64,7 +64,8 @@
         "ext-mbstring": "*",
         "ext-openssl": "*",
         "ext-zip": "*",
-        "sjparkinson/static-review": "~4.1"
+        "sjparkinson/static-review": "~4.1",
+        "ramsey/uuid": "3.4"
     },
     "require-dev": {
         "phpunit/phpunit": "4.1.0",

composer.lock

@@ -86,6 +86,13 @@ class WordsFinder
      */
     protected $componentRegistrar;
 
+    /**
+     * Map of phrase to exclude from the file content
+     * 
+     * @var  array
+     */
+    private $exclude = [];
+
     /**
      * @param string|array $configFiles
      * @param string $baseDir
@@ -172,11 +179,14 @@ protected function _extractWords(\SimpleXMLElement $configXml)
      * @param \SimpleXMLElement $configXml
      * @return \Magento\TestFramework\Inspection\WordsFinder
      * @throws \Magento\TestFramework\Inspection\Exception
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @SuppressWarnings(PHPMD.NPathComplexity)
      */
     protected function _extractWhitelist(\SimpleXMLElement $configXml)
     {
         // Load whitelist entries
         $whitelist = [];
+        $exclude = [];
         $nodes = $configXml->xpath('//config/whitelist/item');
         foreach ($nodes as $node) {
             $path = $node->xpath('path');
@@ -203,8 +213,21 @@ protected function _extractWhitelist(\SimpleXMLElement $configXml)
                     $words[] = (string)$wordNode;
                 }
             }
-
             $whitelist[$path] = $words;
+            
+            $excludeNodes = $node->xpath('exclude');
+            $excludes = [];
+            if ($excludeNodes) {
+                foreach ($excludeNodes as $extractNode) {
+                    $excludes[] = (string)$extractNode;
+                }
+            }
+            
+            if (isset($exclude[$path])) {
+                $exclude[$path] = array_merge($excludes, $exclude[$path]) ;
+            } else {
+                $exclude[$path] = $excludes;
+            }
         }
 
         // Merge with already present whitelist
@@ -214,7 +237,13 @@ protected function _extractWhitelist(\SimpleXMLElement $configXml)
             }
             $this->_whitelist[$newPath] = array_unique($newWords);
         }
-
+        
+        foreach ($exclude as $newPath => $newWords) {
+            if (isset($this->exclude[$newPath])) {
+                $newWords = array_merge($this->exclude[$newPath], $newWords);
+            }
+            $this->exclude[$newPath] = array_unique($newWords);
+        }
         return $this;
     }
 
@@ -254,12 +283,18 @@ public function findWords($file)
      * @param  string $file
      * @return array
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @SuppressWarnings(PHPMD.NPathComplexity)
      */
     protected function _findWords($file)
     {
         $checkContents = !$this->_isBinaryFile($file);
         $path = $this->getSearchablePath($file);
         $contents = $checkContents ? file_get_contents($file) : '';
+        if (isset($this->exclude[$file]) && !empty($this->exclude[$file])) {
+            foreach ($this->exclude[$file] as $stringToEliminate) {
+                $contents = str_replace($stringToEliminate, "", $contents);
+            }
+        }
 
         $foundWords = [];
         foreach ($this->_words as $word) {

dev/tests/static/framework/Magento/TestFramework/Inspection/WordsFinder.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\DataObject;
+
+/**
+ * Interface UuidInterface
+ */
+interface IdentityGeneratorInterface
+{
+    /**
+     * Generate id
+     *
+     * @return string
+     **/
+    public function generateId();
+    
+    /**
+     * Generate id for data
+     *
+     * @param string $data
+     * @return string
+     **/
+    public function generateIdForData($data);
+}

lib/internal/Magento/Framework/DataObject/IdentityGeneratorInterface.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\DataObject;
+
+use Ramsey\Uuid\Uuid;
+
+/**
+ * Class IdentityService
+ */
+class IdentityService implements IdentityGeneratorInterface
+{
+    /**
+     * @var \Ramsey\Uuid\UuidFactoryInterface
+     */
+    private $uuidFactory;
+
+    /**
+     * IdentityService constructor.
+     * @param \Ramsey\Uuid\UuidFactory $uuidFactory
+     */
+    public function __construct(
+        \Ramsey\Uuid\UuidFactory $uuidFactory
+    ) {
+        $this->uuidFactory = $uuidFactory;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function generateId()
+    {
+        $uuid = $this->uuidFactory->uuid4();
+        return $uuid->toString();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function generateIdForData($data)
+    {
+        $uuid = $this->uuidFactory->uuid3(Uuid::NAMESPACE_DNS, $data);
+        return $uuid->toString();
+    }
+}

lib/internal/Magento/Framework/DataObject/IdentityService.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\DataObject\Test\Unit;
+
+use Ramsey\Uuid\Uuid;
+
+class IdentityServiceTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var \Magento\Framework\DataObject\IdentityService
+     */
+    private $identityService;
+
+    /**
+     * @var \PHPUnit_Framework_MockObject_MockObject
+     */
+    private $ramseyFactoryMock;
+
+    /**
+     * @var \PHPUnit_Framework_MockObject_MockObject
+     */
+    private $uuidMock;
+
+    protected function setUp()
+    {
+        $this->ramseyFactoryMock = $this->getMock(\Ramsey\Uuid\UuidFactory::class, [], [], '', false);
+        $this->uuidMock = $this->getMock(\Ramsey\Uuid\Uuid::class, [], [], '', false);
+        $this->identityService = new \Magento\Framework\DataObject\IdentityService(
+            $this->ramseyFactoryMock
+        );
+    }
+
+    public function testGenerateId()
+    {
+        $this->ramseyFactoryMock->expects($this->once())->method('uuid4')->willReturn($this->uuidMock);
+        $this->uuidMock->expects($this->once())->method('toString')->willReturn('string');
+        $this->assertEquals('string', $this->identityService->generateId());
+    }
+
+    public function testGenerateIdForData()
+    {
+        $this->ramseyFactoryMock
+            ->expects($this->once())
+            ->method('uuid3')
+            ->with(Uuid::NAMESPACE_DNS, 'name')
+            ->willReturn($this->uuidMock);
+        $this->uuidMock->expects($this->once())->method('toString')->willReturn('string');
+        $this->assertEquals('string', $this->identityService->generateIdForData('name'));
+    }
+}