MAGETWO-44440: Register URN resolver to resolve internal dependencies

Eugene Tulika · Eugene Tulika · commit fede586a7630 · 2015-10-26T22:34:47.000-05:00
- Fixed CR comments
diff --git a/app/code/Magento/Developer/Console/Command/XmlCatalogGenerateCommand.php b/app/code/Magento/Developer/Console/Command/XmlCatalogGenerateCommand.php
@@ -114,9 +114,10 @@ protected function configure()
     /**
      * Get an array of URNs
      *
+     * @param OutputInterface $output
      * @return array
      */
-    private function getUrnDictionary()
+    private function getUrnDictionary(OutputInterface $output)
     {
         $files = $this->filesUtility->getXmlCatalogFiles('*.xml');
         $files = array_merge($files, $this->filesUtility->getXmlCatalogFiles('*.xsd'));
@@ -139,6 +140,9 @@ private function getUrnDictionary()
                 $paths[$urn] = $this->urnResolver->getRealPath($urn);
             } catch (\Exception $e) {
                 // don't add unsupported element to array
+                if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
+                    $output->writeln($e->getMessage());
+                }
             }
         }
         return $paths;
@@ -154,7 +158,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $ideFilePath = $input->getArgument(self::IDE_FILE_PATH_ARGUMENT);
         $absolutePath = $this->currentDirRead->getAbsolutePath($ideFilePath);
 
-        $urnDictionary = $this->getUrnDictionary();
+        $urnDictionary = $this->getUrnDictionary($output);
         if ($formatter = $this->getFormatters($ideName)) {
             $formatter->generateCatalog($urnDictionary, $absolutePath);
         } else {
diff --git a/app/code/Magento/Developer/Model/XmlCatalog/Format/FormatInterface.php b/app/code/Magento/Developer/Model/XmlCatalog/Format/FormatInterface.php
@@ -15,8 +15,8 @@ interface FormatInterface
      * Generate Catalog of URNs
      *
      * @param string[] $dictionary
-     * @param string $path
+     * @param string $configFile absolute path to the file to write the catalog
      * @return void
      */
-    public function generateCatalog(array $dictionary, $path);
+    public function generateCatalog(array $dictionary, $configFile);
 }
diff --git a/app/code/Magento/Developer/Model/XmlCatalog/Format/PhpStorm.php b/app/code/Magento/Developer/Model/XmlCatalog/Format/PhpStorm.php
@@ -12,7 +12,7 @@
 use Magento\Framework\Filesystem\Directory\WriteInterface;
 
 /**
- * Class PhpStormNine generates URN catalog for PhpStorm 9
+ * Class PhpStorm generates URN catalog for PhpStorm 9
  */
 class PhpStorm implements FormatInterface
 {
@@ -42,17 +42,17 @@ public function __construct(
      * Generate Catalog of URNs for the PhpStorm 9
      *
      * @param string[] $dictionary
-     * @param string $path
+     * @param string $configFile absolute path to the PhpStorm misc.xml
      * @return void
      */
-    public function generateCatalog(array $dictionary, $path)
+    public function generateCatalog(array $dictionary, $configFile)
     {
         $componentNode = null;
         $projectNode = null;
-        $path = $this->currentDirRead->getRelativePath($path);
-        if ($this->currentDirRead->isExist($path) && $this->currentDirRead->isFile($path)) {
+        $configFile = $this->currentDirRead->getRelativePath($configFile);
+        if ($this->currentDirRead->isExist($configFile) && $this->currentDirRead->isFile($configFile)) {
             $dom = new \DOMDocument();
-            $dom->load($path);
+            $dom->load($configFile);
             $xpath = new \DOMXPath($dom);
             $nodeList = $xpath->query('/project');
             $projectNode = $nodeList->item(0);
@@ -87,6 +87,6 @@ public function generateCatalog(array $dictionary, $path)
             $componentNode->appendChild($node);
         }
         $dom->formatOutput = true;
-        $this->currentDirWrite->writeFile($path, $dom->saveXML());
+        $this->currentDirWrite->writeFile($configFile, $dom->saveXML());
     }
 }
diff --git a/app/code/Magento/Developer/Test/Unit/Console/Command/XmlCatalogGenerateCommandTest.php b/app/code/Magento/Developer/Test/Unit/Console/Command/XmlCatalogGenerateCommandTest.php
@@ -16,7 +16,7 @@ class XmlCatalogGenerateCommandTest extends \PHPUnit_Framework_TestCase
      */
     private $command;
 
-    public function setUp()
+    public function testExecuteBadType()
     {
         $fixtureXmlFile = __DIR__ . '/_files/test.xml';
 
@@ -75,10 +75,7 @@ public function setUp()
             $readDirFactory,
             $formats
         );
-    }
 
-    public function testExecuteBadType()
-    {
         $commandTester = new CommandTester($this->command);
         $commandTester->execute([XmlCatalogGenerateCommand::IDE_FILE_PATH_ARGUMENT => 'test']);
         $this->assertEquals('', $commandTester->getDisplay());
diff --git a/lib/internal/Magento/Framework/Config/Dom/UrnResolver.php b/lib/internal/Magento/Framework/Config/Dom/UrnResolver.php
@@ -11,6 +11,7 @@
 
 use Magento\Framework\Component\ComponentRegistrar;
 use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NotFoundException;
 use Magento\Framework\Phrase;
 
 class UrnResolver
@@ -20,43 +21,37 @@ class UrnResolver
      *
      * @param string $schema
      * @return string
-     * @throws \UnexpectedValueException
+     * @throws NotFoundException
      */
     public function getRealPath($schema)
     {
+        if (strpos($schema, 'urn:') !== 0) {
+            return $schema;
+        }
+
         $componentRegistrar = new ComponentRegistrar();
-        if (substr($schema, 0, 4) == 'urn:') {
-            // resolve schema location
-            $urnParts = explode(':', $schema);
-            if ($urnParts[2] == 'module') {
-                // urn:magento:module:Magento_Catalog:etc/catalog_attributes.xsd
-                // 0 : urn, 1: magento, 2: module, 3: Magento_Catalog, 4: etc/catalog_attributes.xsd
-                // moduleName -> Magento_Catalog
-                $schemaPath = $componentRegistrar->getPath(
-                    ComponentRegistrar::MODULE,
-                    $urnParts[3]
-                ) . '/' . $urnParts[4];
-            } else if (strpos($urnParts[2], 'framework') === 0) {
-                // urn:magento:framework:Module/etc/module.xsd
-                // 0: urn, 1: magento, 2: framework, 3: Module/etc/module.xsd
-                // libaryName -> magento/framework
-                $libraryName = $urnParts[1] . '/' . $urnParts[2];
-                $schemaPath = $componentRegistrar->getPath(
-                    ComponentRegistrar::LIBRARY,
-                    $libraryName
-                ) . '/' . $urnParts[3];
-            } else {
-                throw new \UnexpectedValueException("Unsupported format of schema location: " . $schema);
-            }
-            if (!empty($schemaPath) && file_exists($schemaPath)) {
-                $schema = $schemaPath;
-            } else {
-                throw new \UnexpectedValueException(
-                    "Could not locate schema: '" . $schema . "' at '" . $schemaPath . "'"
-                );
-            }
+        $matches = [];
+        $modulePattern = '/urn:(?<vendor>([a-zA-Z]*)):module:(?<module>([A-Za-z\_]*)):(?<path>(.+))/';
+        $frameworkPattern = '/urn:(?<vendor>([a-zA-Z]*)):(?<framework>(framework[A-Za-z\-]*)):(?<path>(.+))/';
+        if (preg_match($modulePattern, $schema, $matches)) {
+            //urn:magento:module:Magento_Catalog:etc/catalog_attributes.xsd
+            $package = $componentRegistrar
+                ->getPath(ComponentRegistrar::MODULE, $matches['module']);
+        } else if (preg_match($frameworkPattern, $schema, $matches)) {
+            //urn:magento:framework:Module/etc/module.xsd
+            //urn:magento:framework-amqp:Module/etc/module.xsd
+            $package = $componentRegistrar
+                ->getPath(ComponentRegistrar::LIBRARY, $matches['vendor'] . '/' . $matches['framework']);
+        } else {
+            throw new NotFoundException(__("Unsupported format of schema location: '%1'", $schema));
+        }
+        $schemaPath = $package . '/' . $matches['path'];
+        if (empty($package) || !file_exists($schemaPath)) {
+            throw new NotFoundException(
+                __("Could not locate schema: '%1' at '%2'", $schema, $schemaPath)
+            );
         }
-        return $schema;
+        return $schemaPath;
     }
 
     /**
diff --git a/lib/internal/Magento/Framework/Config/Test/Unit/Dom/UrnResolverTest.php b/lib/internal/Magento/Framework/Config/Test/Unit/Dom/UrnResolverTest.php
@@ -5,7 +5,7 @@
  */
 namespace Magento\Framework\Config\Test\Unit\Dom;
 
-use \Magento\Framework\Config\Dom\UrnResolver;
+use Magento\Framework\Config\Dom\UrnResolver;
 use Magento\Framework\Component\ComponentRegistrar;
 
 class UrnResolverTest extends \PHPUnit_Framework_TestCase
@@ -53,8 +53,8 @@ public function testGetRealPathWithModuleUrn()
     }
 
     /**
-     * @expectedException \UnexpectedValueException
-     * @expectedExceptionMessage Unsupported format of schema location: urn:magento:test:test:etc/test_test.xsd
+     * @expectedException \Magento\Framework\Exception\NotFoundException
+     * @expectedExceptionMessage Unsupported format of schema location: 'urn:magento:test:test:etc/test_test.xsd'
      */
     public function testGetRealPathWrongSection()
     {
@@ -63,7 +63,7 @@ public function testGetRealPathWrongSection()
     }
 
     /**
-     * @expectedException \UnexpectedValueException
+     * @expectedException \Magento\Framework\Exception\NotFoundException
      * @expectedExceptionMessage Could not locate schema: 'urn:magento:module:Magento_Test:test.xsd' at '/test.xsd'
      */
     public function testGetRealPathWrongModule()

Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,8 @@ interface FormatInterface`
`15`	`15`	`* Generate Catalog of URNs`
`16`	`16`	`*`
`17`	`17`	`* @param string[] $dictionary`
`18`		`- * @param string $path`
	`18`	`+ * @param string $configFile absolute path to the file to write the catalog`
`19`	`19`	`* @return void`
`20`	`20`	`*/`
`21`		`- public function generateCatalog(array $dictionary, $path);`
	`21`	`+ public function generateCatalog(array $dictionary, $configFile);`
`22`	`22`	`}`