Framework\Module: Rename Dir\Resolver to Registrar and Dir\ResolverInterface to ModuleRegistryInterface

Author: joshdifabio

app/etc/di.xml

@@ -44,7 +44,7 @@
     <preference for="Magento\Framework\Config\CacheInterface" type="Magento\Framework\App\Cache\Type\Config" />
     <preference for="Magento\Framework\Config\ValidationStateInterface" type="Magento\Framework\App\Arguments\ValidationState" />
     <preference for="Magento\Framework\Module\ModuleListInterface" type="Magento\Framework\Module\ModuleList" />
-    <preference for="Magento\Framework\Module\Dir\ResolverInterface" type="Magento\Framework\Module\Dir\Resolver" />
+    <preference for="Magento\Framework\Module\ModuleRegistryInterface" type="Magento\Framework\Module\Registrar" />
     <preference for="Magento\Framework\Event\ConfigInterface" type="Magento\Framework\Event\Config" />
     <preference for="Magento\Framework\Event\InvokerInterface" type="Magento\Framework\Event\Invoker\InvokerDefault" />
     <preference for="Magento\Framework\Interception\PluginListInterface" type="Magento\Framework\Interception\PluginList\PluginList" />

lib/internal/Magento/Framework/Module/Dir.php

@@ -11,7 +11,7 @@
 use Magento\Framework\Filesystem;
 use Magento\Framework\Filesystem\Directory\ReadInterface;
 use Magento\Framework\Stdlib\String as StringHelper;
-use Magento\Framework\Module\Dir\ResolverInterface;
+use Magento\Framework\Module\ModuleRegistryInterface;
 
 class Dir
 {
@@ -28,22 +28,25 @@ class Dir
     protected $_string;
 
     /**
-     * Module directory resolver
+     * Module registry
      *
-     * @var ResolverInterface
+     * @var ModuleRegistryInterface
      */
-    private $dirResolver;
+    private $moduleRegistry;
 
     /**
      * @param Filesystem $filesystem
      * @param StringHelper $string
-     * @param ResolverInterface $resolver
+     * @param ModuleRegistryInterface $moduleRegistry
      */
-    public function __construct(Filesystem $filesystem, StringHelper $string, ResolverInterface $resolver)
-    {
+    public function __construct(
+        Filesystem $filesystem,
+        StringHelper $string,
+        ModuleRegistryInterface $moduleRegistry
+    ) {
         $this->_modulesDirectory = $filesystem->getDirectoryRead(DirectoryList::MODULES);
         $this->_string = $string;
-        $this->dirResolver = $resolver;
+        $this->moduleRegistry = $moduleRegistry;
     }
 
     /**
@@ -56,7 +59,7 @@ public function __construct(Filesystem $filesystem, StringHelper $string, Resolv
      */
     public function getDir($moduleName, $type = '')
     {
-        if (null === $path = $this->dirResolver->getModulePath($moduleName)) {
+        if (null === $path = $this->moduleRegistry->getModulePath($moduleName)) {
             $relativePath = $this->_string->upperCaseWords($moduleName, '_', '/');
             $path = $this->_modulesDirectory->getAbsolutePath($relativePath);
         }

lib/internal/Magento/Framework/Module/ModuleList/Loader.php

@@ -10,7 +10,7 @@
 use Magento\Framework\Filesystem;
 use Magento\Framework\Module\Declaration\Converter\Dom;
 use Magento\Framework\Xml\Parser;
-use Magento\Framework\Module\Dir\ResolverInterface;
+use Magento\Framework\Module\ModuleRegistryInterface;
 use Magento\Framework\Filesystem\DriverInterface;
 
 /**
@@ -40,11 +40,11 @@ class Loader
     private $parser;
 
     /**
-     * Module directory resolver
+     * Module registry
      *
-     * @var ResolverInterface
+     * @var ModuleRegistryInterface
      */
-    private $dirResolver;
+    private $moduleRegistry;
 
     /**
      * Filesystem driver to allow reading of module.xml files which live outside of app/code
@@ -59,21 +59,21 @@ class Loader
      * @param Filesystem $filesystem
      * @param Dom $converter
      * @param Parser $parser
-     * @param ResolverInterface $resolver
+     * @param ModuleRegistryInterface $moduleRegistry
      * @param DriverInterface $filesystemDriver
      */
     public function __construct(
         Filesystem $filesystem,
         Dom $converter,
         Parser $parser,
-        ResolverInterface $resolver,
+        ModuleRegistryInterface $moduleRegistry,
         DriverInterface $filesystemDriver
     ) {
         $this->filesystem = $filesystem;
         $this->converter = $converter;
         $this->parser = $parser;
         $this->parser->initErrorHandler();
-        $this->dirResolver = $resolver;
+        $this->moduleRegistry = $moduleRegistry;
         $this->filesystemDriver = $filesystemDriver;
     }
 
@@ -120,7 +120,7 @@ private function getModuleConfigs()
             yield $modulesDir->readFile($filePath);
         }
 
-        foreach ($this->dirResolver->getModulePaths() as $modulePath) {
+        foreach ($this->moduleRegistry->getModulePaths() as $modulePath) {
             $filePath =  str_replace(['\\', '/'], DIRECTORY_SEPARATOR, "$modulePath/etc/module.xml");
             yield $this->filesystemDriver->fileGetContents($filePath);
         }

lib/internal/Magento/Framework/Module/Dir/ResolverInterface.php renamed to lib/internal/Magento/Framework/Module/ModuleRegistryInterface.php

@@ -3,12 +3,12 @@
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
-namespace Magento\Framework\Module\Dir;
+namespace Magento\Framework\Module;
 
 /**
  * @author Josh Di Fabio <joshdifabio@gmail.com>
  */
-interface ResolverInterface
+interface ModuleRegistryInterface
 {
     /**
      * Get list of Magento module paths

lib/internal/Magento/Framework/Module/Dir/Resolver.php renamed to lib/internal/Magento/Framework/Module/Registrar.php

@@ -3,15 +3,14 @@
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
-
-namespace Magento\Framework\Module\Dir;
+namespace Magento\Framework\Module;
 
 /**
  * Provides ability to statically register modules which do not reside in the modules directory
  *
  * @author Josh Di Fabio <joshdifabio@gmail.com>
  */
-final class Resolver implements ResolverInterface
+class Registrar implements ModuleRegistryInterface
 {
     /**
      * Paths to modules
@@ -26,7 +25,7 @@ final class Resolver implements ResolverInterface
      * @param string $moduleName Fully-qualified module name
      * @param string $path Absolute file path to the module
      */
-    public static function setModulePath($moduleName, $path)
+    public static function registerModule($moduleName, $path)
     {
         self::$modulePaths[$moduleName] = $path;
     }

lib/internal/Magento/Framework/Module/Test/Unit/DirTest.php

@@ -28,9 +28,9 @@ class DirTest extends \PHPUnit_Framework_TestCase
     protected $directoryMock;
 
     /**
-     * @var \Magento\Framework\Module\Dir\ResolverInterface|\PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Framework\Module\ModuleRegistryInterface|\PHPUnit_Framework_MockObject_MockObject
      */
-    protected $dirResolverMock;
+    protected $moduleRegistryMock;
 
     protected function setUp()
     {
@@ -44,8 +44,8 @@ protected function setUp()
             false
         );
         $this->_stringMock = $this->getMock('Magento\Framework\Stdlib\String', [], [], '', false, false);
-        $this->dirResolverMock = $this->getMock(
-            'Magento\Framework\Module\Dir\ResolverInterface',
+        $this->moduleRegistryMock = $this->getMock(
+            'Magento\Framework\Module\ModuleRegistryInterface',
             [],
             [],
             '',
@@ -64,13 +64,13 @@ protected function setUp()
         $this->_model = new \Magento\Framework\Module\Dir(
             $this->filesystemMock,
             $this->_stringMock,
-            $this->dirResolverMock
+            $this->moduleRegistryMock
         );
     }
 
     public function testGetDirModuleRoot()
     {
-        $this->dirResolverMock->expects(
+        $this->moduleRegistryMock->expects(
             $this->once()
         )->method(
             'getModulePath'
@@ -97,7 +97,7 @@ public function testGetDirModuleRoot()
 
     public function testGetDirModuleRootFromResolver()
     {
-        $this->dirResolverMock->expects(
+        $this->moduleRegistryMock->expects(
             $this->once()
         )->method(
             'getModulePath'

lib/internal/Magento/Framework/Module/Test/Unit/ModuleList/LoaderTest.php

@@ -43,7 +43,7 @@ class LoaderTest extends \PHPUnit_Framework_TestCase
     /*
      * @var \PHPUnit_Framework_MockObject_MockObject
      */
-    private $resolver;
+    private $registry;
 
     /*
      * @var \PHPUnit_Framework_MockObject_MockObject
@@ -66,9 +66,9 @@ protected function setUp()
         $this->converter = $this->getMock('Magento\Framework\Module\Declaration\Converter\Dom', [], [], '', false);
         $this->parser = $this->getMock('Magento\Framework\Xml\Parser', [], [], '', false);
         $this->parser->expects($this->once())->method('initErrorHandler');
-        $this->resolver = $this->getMock('Magento\Framework\Module\Dir\ResolverInterface', [], [], '', false, false);
+        $this->registry = $this->getMock('Magento\Framework\Module\ModuleRegistryInterface', [], [], '', false, false);
         $this->driver = $this->getMock('Magento\Framework\Filesystem\DriverInterface', [], [], '', false, false);
-        $this->loader = new Loader($this->filesystem, $this->converter, $this->parser, $this->resolver, $this->driver);
+        $this->loader = new Loader($this->filesystem, $this->converter, $this->parser, $this->registry, $this->driver);
     }
 
     public function testLoad()
@@ -82,7 +82,7 @@ public function testLoad()
             // so expected sequence is a -> e -> c -> d -> b
         ];
         $this->dir->expects($this->once())->method('search')->willReturn(['a', 'b', 'c']);
-        $this->resolver->expects($this->once())->method('getModulePaths')->willReturn(['/path/to/d', '/path/to/e']);
+        $this->registry->expects($this->once())->method('getModulePaths')->willReturn(['/path/to/d', '/path/to/e']);
         $this->dir->expects($this->exactly(3))->method('readFile')->will($this->returnValueMap([
             ['a', null, null, self::$sampleXml],
             ['b', null, null, self::$sampleXml],
@@ -122,7 +122,7 @@ public function testLoadCircular()
         ]));
         $this->converter->expects($this->at(0))->method('convert')->willReturn(['a' => $fixture['a']]);
         $this->converter->expects($this->at(1))->method('convert')->willReturn(['b' => $fixture['b']]);
-        $this->resolver->expects($this->once())->method('getModulePaths')->willReturn([]);
+        $this->registry->expects($this->once())->method('getModulePaths')->willReturn([]);
         $this->loader->load();
     }
 }