Adds path remapping for module directories

Author: petersooley

config/modules.php

@@ -55,4 +55,20 @@
  */
 
  'driver' => 'local',
+
+ /*
+ |--------------------------------------------------------------------------
+ | Remap Module Subdirectories
+ |--------------------------------------------------------------------------
+ |
+ | Redefine how module directories are structured. The mapping here will
+ | be respected by all commands and generators.
+ |
+ */
+
+ 'pathMap' => [
+ // To change where migrations go, specify the default
+ // location as the key and the new location as the value:
+ // 'Database/Migrations' => 'src/Database/Migrations',
+ ],
 ];

src/Console/Commands/ModuleMigrateCommand.php

@@ -136,9 +136,7 @@ protected function migrate($slug)
  */
  protected function getMigrationPath($slug)
  {
- $path = $this->module->getModulePath($slug);
-
- return $path.'Database/Migrations/';
+ return module_path($slug, 'Database/Migrations');
  }
 
  /**

src/Console/Commands/ModuleMigrateResetCommand.php

@@ -185,9 +185,7 @@ protected function getParameters($slug)
  */
  protected function getMigrationPath($slug)
  {
- $path = $this->module->getModulePath($slug).'Database/Migrations';
-
- return $path;
+ return module_path($slug, 'Database/Migrations');
  }
 
  /**

src/Console/GeneratorCommand.php

@@ -40,9 +40,16 @@ protected function parseName($name)
  */
  protected function getPath($name)
  {
- $rootNamespace = config('modules.namespace');
- $name = str_replace($rootNamespace, '', $name);
+ $slug = $this->argument('slug');
+
+ // take everything after the module name in the given path (ignoring case)
+ $key = array_search(strtolower($slug), explode('\\', strtolower($name)));
+ if ($key === false) {
+ $newPath = str_replace('\\', '/', $name);
+ } else {
+ $newPath = implode('/', array_slice(explode('\\', $name), $key + 1));
+ }
 
- return module_path().'/'.str_replace('\\', '/', $name).'.php';
+ return module_path($slug, "$newPath.php");
  }
 }

src/Console/Generators/MakeModuleCommand.php

@@ -154,17 +154,33 @@ protected function generateModule()
  $this->files->makeDirectory(module_path());
  }
 
+ $pathMap = config('modules.pathMap');
  $directory = module_path(null, $this->container['basename']);
  $source = __DIR__.'/../../../resources/stubs/module';
 
  $this->files->makeDirectory($directory);
- $this->files->copyDirectory($source, $directory, null);
 
- $files = $this->files->allFiles($directory);
+ $sourceFiles = $this->files->allFiles($source, true);
 
- foreach ($files as $file) {
+ if (!empty($pathMap)) {
+ $search = array_keys($pathMap);
+ $replace = array_values($pathMap);
+ }
+
+ foreach ($sourceFiles as $file) {
  $contents = $this->replacePlaceholders($file->getContents());
- $filePath = module_path(null, $this->container['basename'].'/'.$file->getRelativePathname());
+ $subPath = $file->getRelativePathname();
+
+ if (!empty($pathMap)) {
+ $subPath = str_replace($search, $replace, $subPath);
+ }
+
+ $filePath = $directory . '/' . $subPath;
+ $dir = dirname($filePath);
+
+ if (!$this->files->isDirectory($dir)) {
+ $this->files->makeDirectory($dir, 0755, true);
+ }
 
  $this->files->put($filePath, $contents);
  }

src/Helpers/module.php

@@ -10,25 +10,33 @@
  */
  function module_path($module = null, $file = '')
  {
+ $modulesPath = config('modules.path');
+ $pathMap = config('modules.pathMap');
+
+ if (!empty($file) && !empty($pathMap)) {
+ $file = str_replace(
+ array_keys($pathMap),
+ array_values($pathMap),
+ $file
+ );
+ }
+
+ $filePath = $file ? '/' . ltrim($file, '/') : '';
+
  if (is_null($module)) {
  if (empty($file)) {
- return config('modules.path');
+ return $modulesPath;
  }
 
- return config('modules.path').'/'.$file;
+ return $modulesPath . $filePath;
  }
 
  $module = Module::where('slug', $module);
 
- if (empty($file)) {
- return config('modules.path').'/'.$module['basename'];
- }
-
- return config('modules.path').'/'.$module['basename'].'/'.$file;
+ return $modulesPath . '/' . $module['basename'] . $filePath;
  }
 }
 
-
 if (! function_exists('module_class')) {
  /**
  * Return the full path to the given module class.