opdavies/drupal-module-generator
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add a readable module name

Browse source
This commit is contained in:
Oliver Davies 2020-02-09 19:16:57 +00:00
parent 20a6a011d9
commit 28696ce13f
4 changed files with 49 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
bin/dmg
View file

@ -2,6 +2,7 @@
<?php
use Opdavies\DrupalModuleGenerator\Command\GenerateDrupal7Command;
use Opdavies\DrupalModuleGenerator\Service\ModuleNameConverter;
use Opdavies\DrupalModuleGenerator\Service\TestNameConverter;
use Symfony\Component\Console\Application;
use Symfony\Component\Finder\Finder;
@ -11,10 +12,11 @@ require_once __DIR__.'/../vendor/autoload.php';
$app = new Application();
$finder = new Finder();
$moduleNameConverter = new ModuleNameConverter();
$testNameConverter = new TestNameConverter();
$app->addCommands([
new GenerateDrupal7Command($finder, $testNameConverter),
new GenerateDrupal7Command($finder, $moduleNameConverter, $testNameConverter),
]);
$app->run();

22
src/Command/GenerateDrupal7Command.php
View file

@ -3,6 +3,7 @@
namespace Opdavies\DrupalModuleGenerator\Command;
use Opdavies\DrupalModuleGenerator\Exception\CannotCreateModuleException;
use Opdavies\DrupalModuleGenerator\Service\ModuleNameConverter;
use Opdavies\DrupalModuleGenerator\Service\TestNameConverter;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
@ -17,6 +18,7 @@ use Tightenco\Collect\Support\Collection;
class GenerateDrupal7Command extends Command
{
private $moduleName;
private $machineName;
private $testName;
/** @var Filesystem */
@ -28,17 +30,22 @@ class GenerateDrupal7Command extends Command
/** @var SymfonyStyle $io */
private $io;
/** @var ModuleNameConverter */
private $moduleNameConverter;
/** @var TestNameConverter */
private $testNameConverter;
public function __construct(
Finder $finder,
ModuleNameConverter $moduleNameConverter,
TestNameConverter $testNameConverter,
string $name = null
) {
parent::__construct($name);
$this->finder = $finder;
$this->moduleNameConverter = $moduleNameConverter;
$this->testNameConverter = $testNameConverter;
}
@ -64,8 +71,9 @@ class GenerateDrupal7Command extends Command
{
$this->io = new SymfonyStyle($input, $output);
$this->moduleName = $input->getArgument('module-name');
$this->testName = $this->testNameConverter->__invoke($this->moduleName);
$this->machineName = $input->getArgument('module-name');
$this->moduleName = $this->moduleNameConverter->__invoke($this->machineName);
$this->testName = $this->testNameConverter->__invoke($this->machineName);
$this
->ensureDirectoryDoesNotExist()
@ -80,7 +88,7 @@ class GenerateDrupal7Command extends Command
*/
private function ensureDirectoryDoesNotExist()
{
if (is_dir($this->moduleName)) {
if (is_dir($this->machineName)) {
throw CannotCreateModuleException::directoryAlreadyExists();
}
@ -89,7 +97,7 @@ class GenerateDrupal7Command extends Command
private function createModuleDirectory()
{
mkdir($this->moduleName);
mkdir($this->machineName);
return $this;
}
@ -101,10 +109,10 @@ class GenerateDrupal7Command extends Command
/** @var SplFileInfo $file */
foreach ($this->finder->in('fixtures/drupal7_module')->files() as $file) {
$filename = "{$this->moduleName}.{$file->getExtension()}";
$filename = "{$this->machineName}.{$file->getExtension()}";
if ($file->getRelativePath()) {
mkdir("{$this->moduleName}/{$file->getRelativePath()}", 0777, $recursive = true);
mkdir("{$this->machineName}/{$file->getRelativePath()}", 0777, $recursive = true);
$filename = "{$this->testName}.php";
$filename = "{$file->getRelativePath()}/{$filename}";
@ -112,7 +120,7 @@ class GenerateDrupal7Command extends Command
$contents = $this->updateFileContents($file->getContents());
file_put_contents("{$this->moduleName}/{$filename}", $contents);
file_put_contents("{$this->machineName}/{$filename}", $contents);
$createdFiles->push($filename);
}

17
src/Service/ModuleNameConverter.php Normal file
View file

@ -0,0 +1,17 @@
<?php
namespace Opdavies\DrupalModuleGenerator\Service;
class ModuleNameConverter
{
public function __invoke(string $moduleName)
{
$parts = explode('_', $moduleName);
$parts = array_map(function ($part) {
return ucfirst($part);
}, $parts);
return implode(' ', $parts);
}
}

22
tests/Command/GenerateDrupal7ModuleCommandTest.php
View file

@ -4,6 +4,7 @@ namespace Opdavies\Tests\DrupalModuleGenerator\Command;
use Opdavies\DrupalModuleGenerator\Command\GenerateDrupal7Command;
use Opdavies\DrupalModuleGenerator\Exception\CannotCreateModuleException;
use Opdavies\DrupalModuleGenerator\Service\ModuleNameConverter;
use Opdavies\DrupalModuleGenerator\Service\TestNameConverter;
use Symfony\Component\Console\Tester\CommandTester;
use PHPUnit\Framework\TestCase;
@ -24,8 +25,9 @@ class GenerateDrupal7ModuleCommandTest extends TestCase
$this->expectExceptionObject(CannotCreateModuleException::directoryAlreadyExists());
$finder = new Finder();
$moduleNameConverter = new ModuleNameConverter();
$testNameConverter = new TestNameConverter();
$command = new GenerateDrupal7Command($finder, $testNameConverter);
$command = new GenerateDrupal7Command($finder, $moduleNameConverter, $testNameConverter);
$commandTester = new CommandTester($command);
$commandTester->execute([
@ -37,8 +39,9 @@ class GenerateDrupal7ModuleCommandTest extends TestCase
public function it_creates_a_new_module_directory()
{
$finder = new Finder();
$moduleNameConverter = new ModuleNameConverter();
$testNameConverter = new TestNameConverter();
$command = new GenerateDrupal7Command($finder, $testNameConverter);
$command = new GenerateDrupal7Command($finder, $moduleNameConverter, $testNameConverter);
$commandTester = new CommandTester($command);
$commandTester->execute([
@ -52,8 +55,9 @@ class GenerateDrupal7ModuleCommandTest extends TestCase
public function it_generates_an_info_file()
{
$finder = new Finder();
$moduleNameConverter = new ModuleNameConverter();
$testNameConverter = new TestNameConverter();
$command = new GenerateDrupal7Command($finder, $testNameConverter);
$command = new GenerateDrupal7Command($finder, $moduleNameConverter, $testNameConverter);
$commandTester = new CommandTester($command);
$commandTester->execute([
@ -64,16 +68,17 @@ class GenerateDrupal7ModuleCommandTest extends TestCase
$contents = file_get_contents('test_module/test_module.info');
$this->assertStringContainsString('name = test_module', $contents);
$this->assertStringContainsString('description = The description for test_module.', $contents);
$this->assertStringContainsString('name = Test Module', $contents);
$this->assertStringContainsString('description = The description for Test Module.', $contents);
}
/** @test */
public function it_generates_a_module_file()
{
$finder = new Finder();
$moduleNameConverter = new ModuleNameConverter();
$testNameConverter = new TestNameConverter();
$command = new GenerateDrupal7Command($finder, $testNameConverter);
$command = new GenerateDrupal7Command($finder, $moduleNameConverter, $testNameConverter);
$commandTester = new CommandTester($command);
$commandTester->execute([
@ -84,15 +89,16 @@ class GenerateDrupal7ModuleCommandTest extends TestCase
$contents = file_get_contents('test_module/test_module.module');
$this->assertStringContainsString('The main module file for test_module.', $contents);
$this->assertStringContainsString('The main module file for Test Module.', $contents);
}
/** @test */
public function it_generates_a_test_case()
{
$finder = new Finder();
$moduleNameConverter = new ModuleNameConverter();
$testNameConverter = new TestNameConverter();
$command = new GenerateDrupal7Command($finder, $testNameConverter);
$command = new GenerateDrupal7Command($finder, $moduleNameConverter, $testNameConverter);
$commandTester = new CommandTester($command);
$commandTester->execute([