MAGETWO-44440: Register URN resolver to resolve internal dependencies

- Fixed CR comments

Author: Eugene Tulika

app/code/Magento/Developer/Console/Command/XmlCatalogGenerateCommand.php

@@ -12,17 +12,10 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
-use Magento\Framework\App\Utility\Files;
-use Magento\Framework\Config\Dom\UrnResolver;
-use Magento\Developer\Model\XmlCatalog\Format\FormatInterface;
-use Magento\Framework\Filesystem;
-use Magento\Framework\Filesystem\Directory\ReadInterface;
 use Magento\Framework\App\Filesystem\DirectoryList;
-use Magento\Framework\Filesystem\Directory\ReadFactory;
 
 /**
  * Class XmlCatalogGenerateCommand Generates dictionary of URNs for the IDE
- * @SuppressWarnings("PMD.CouplingBetweenObjects")
  */
 class XmlCatalogGenerateCommand extends Command
 {
@@ -37,50 +30,42 @@ class XmlCatalogGenerateCommand extends Command
     const IDE_FILE_PATH_ARGUMENT = 'path';
 
     /**
-     * @var Files
+     * @var \Magento\Framework\App\Utility\Files
      */
     private $filesUtility;
 
     /**
-     * @var UrnResolver
+     * @var \Magento\Framework\Config\Dom\UrnResolver
      */
     private $urnResolver;
 
     /**
-     * @var ReadInterface
-     */
-    private $currentDirRead;
-
-    /**
-     * @var ReadInterface
+     * @var \Magento\Framework\Filesystem\Directory\ReadInterface
      */
     private $rootDirRead;
 
     /**
      * Supported formats
      *
-     * @var FormatInterface[]
+     * @var \Magento\Developer\Model\XmlCatalog\Format\FormatInterface[]
      */
     private $formats;
 
     /**
-     * @param Files $filesUtility
-     * @param UrnResolver $urnResolver
-     * @param Filesystem $filesystemFactory
-     * @param ReadFactory $readFactory
-     * @param FormatInterface[] $formats
+     * @param \Magento\Framework\App\Utility\Files $filesUtility
+     * @param \Magento\Framework\Config\Dom\UrnResolver $urnResolver
+     * @param \Magento\Framework\Filesystem $filesystemFactory
+     * @param \Magento\Developer\Model\XmlCatalog\Format\FormatInterface[] $formats
      */
     public function __construct(
-        Files $filesUtility,
-        UrnResolver $urnResolver,
-        Filesystem $filesystemFactory,
-        ReadFactory $readFactory,
+        \Magento\Framework\App\Utility\Files $filesUtility,
+        \Magento\Framework\Config\Dom\UrnResolver $urnResolver,
+        \Magento\Framework\Filesystem $filesystemFactory,
         array $formats = []
     ) {
         $this->filesUtility = $filesUtility;
         $this->urnResolver = $urnResolver;
         $this->formats = $formats;
-        $this->currentDirRead = $readFactory->create(getcwd());
         $this->rootDirRead = $filesystemFactory->getDirectoryRead(DirectoryList::ROOT);
         parent::__construct();
     }
@@ -156,11 +141,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
     {
         $ideName = $input->getOption(self::IDE_OPTION);
         $ideFilePath = $input->getArgument(self::IDE_FILE_PATH_ARGUMENT);
-        $absolutePath = $this->currentDirRead->getAbsolutePath($ideFilePath);
 
         $urnDictionary = $this->getUrnDictionary($output);
         if ($formatter = $this->getFormatters($ideName)) {
-            $formatter->generateCatalog($urnDictionary, $absolutePath);
+            $formatter->generateCatalog($urnDictionary, $ideFilePath);
         } else {
             throw new InputException(__("Format for IDE '%1' is not supported", $ideName));
         }
@@ -170,7 +154,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
      * Get formatter based on format
      *
      * @param string $format
-     * @return FormatInterface|false
+     * @return \Magento\Developer\Model\XmlCatalog\Format\FormatInterface|false
      */
     private function getFormatters($format)
     {

app/code/Magento/Developer/Model/XmlCatalog/Format/PhpStorm.php

@@ -6,6 +6,7 @@
 
 namespace Magento\Developer\Model\XmlCatalog\Format;
 
+use Magento\Framework\Exception\FileSystemException;
 use Magento\Framework\Filesystem\Directory\ReadFactory;
 use Magento\Framework\Filesystem\Directory\ReadInterface;
 use Magento\Framework\Filesystem\Directory\WriteFactory;
@@ -26,37 +27,49 @@ class PhpStorm implements FormatInterface
      */
     private $currentDirWrite;
 
+    /**
+     * @var \Magento\Framework\Filesystem\File\WriteFactory
+     */
+    private $fileWriteFactory;
+
     /**
      * @param ReadFactory $readFactory
-     * @param WriteFactory $writeFactory
+     * @param \Magento\Framework\Filesystem\File\WriteFactory $fileWriteFactory
      */
     public function __construct(
         ReadFactory $readFactory,
-        WriteFactory $writeFactory
+        \Magento\Framework\Filesystem\File\WriteFactory $fileWriteFactory
     ) {
         $this->currentDirRead = $readFactory->create(getcwd());
-        $this->currentDirWrite = $writeFactory->create(getcwd());
+        $this->fileWriteFactory = $fileWriteFactory;
     }
 
     /**
      * Generate Catalog of URNs for the PhpStorm 9
      *
      * @param string[] $dictionary
-     * @param string $configFile absolute path to the PhpStorm misc.xml
+     * @param string $configFilePath relative path to the PhpStorm misc.xml
      * @return void
      */
-    public function generateCatalog(array $dictionary, $configFile)
+    public function generateCatalog(array $dictionary, $configFilePath)
     {
         $componentNode = null;
         $projectNode = null;
-        $configFile = $this->currentDirRead->getRelativePath($configFile);
-        if ($this->currentDirRead->isExist($configFile) && $this->currentDirRead->isFile($configFile)) {
+
+        try {
+            $file = $this->fileWriteFactory->create(
+                $configFilePath,
+                \Magento\Framework\Filesystem\DriverPool::FILE,
+                'r'
+            );
             $dom = new \DOMDocument();
-            $dom->load($configFile);
+            $dom->loadXML($file->readAll());
             $xpath = new \DOMXPath($dom);
             $nodeList = $xpath->query('/project');
             $projectNode = $nodeList->item(0);
-        } else {
+            $file->close();
+        } catch (FileSystemException $f){
+            //create file if does not exists
             $dom = new \DOMDocument();
             $projectNode = $dom->createElement('project');
 
@@ -87,6 +100,12 @@ public function generateCatalog(array $dictionary, $configFile)
             $componentNode->appendChild($node);
         }
         $dom->formatOutput = true;
-        $this->currentDirWrite->writeFile($configFile, $dom->saveXML());
+        $file = $this->fileWriteFactory->create(
+            $configFilePath,
+            \Magento\Framework\Filesystem\DriverPool::FILE,
+            'w'
+        );
+        $file->write($dom->saveXML());
+        $file->close();
     }
 }

app/code/Magento/Developer/Test/Unit/Console/Command/XmlCatalogGenerateCommandTest.php

@@ -32,12 +32,13 @@ public function testExecuteBadType()
             ->method('getRealPath')
             ->with($this->equalTo('urn:magento:framework:Module/etc/module.xsd'))
             ->will($this->returnValue($fixtureXmlFile));
+
         $phpstormFormatMock = $this->getMock('\Magento\Developer\Model\XmlCatalog\Format\PhpStorm', [], [], '', false);
         $phpstormFormatMock->expects($this->once())
             ->method('generateCatalog')
             ->with(
                 $this->equalTo(['urn:magento:framework:Module/etc/module.xsd' => $fixtureXmlFile]),
-                $this->equalTo('test_absolute_path')
+                $this->equalTo('test')
             )->will($this->returnValue(null));
 
         $formats = ['phpstorm' => $phpstormFormatMock];
@@ -58,21 +59,10 @@ public function testExecuteBadType()
             ->method('getDirectoryRead')
             ->will($this->returnValue($readDirMock));
 
-        $currDirMock = $this->getMock('\Magento\Framework\Filesystem\Directory\ReadInterface', [], [], '', false);
-        $currDirMock->expects($this->once())
-            ->method('getAbsolutePath')
-            ->with($this->equalTo('test'))
-            ->will($this->returnValue('test_absolute_path'));
-        $readDirFactory = $this->getMock('\Magento\Framework\Filesystem\Directory\ReadFactory', [], [], '', false);
-        $readDirFactory->expects($this->once())
-            ->method('create')
-            ->will($this->returnValue($currDirMock));
-
         $this->command = new XmlCatalogGenerateCommand(
             $filesMock,
             $urnResolverMock,
             $filesystem,
-            $readDirFactory,
             $formats
         );