Merge pull request #5 from 21TORR/next

Add proper autogeneration of aliases in `BundleExtension`

CHANGELOG.md

@@ -1,3 +1,9 @@
+2.1.0
+=====
+
+*   (feature) Add proper autogeneration of aliases in `BundleExtension`.
+
+
 2.0.0
 =====
 

composer.json

@@ -34,6 +34,11 @@
 			"Torr\\BundleHelpers\\": "src/"
 		}
 	},
+	"autoload-dev": {
+		"psr-4": {
+			"Tests\\Torr\\BundleHelpers\\": "tests/"
+		}
+	},
 	"scripts": {
 		"post-install-cmd": [
 			"@composer bin all install --ansi"

phpunit.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         colors="true"
+         bootstrap="vendor/autoload.php"
+>
+    <php>
+        <ini name="error_reporting" value="-1" />
+        <server name="APP_ENV" value="test" force="true" />
+        <server name="SHELL_VERBOSITY" value="-1" />
+        <server name="SYMFONY_PHPUNIT_REMOVE" value="" />
+        <server name="SYMFONY_PHPUNIT_VERSION" value="9.3" />
+        <env name="SYMFONY_DEPRECATIONS_HELPER" value="max[direct]=0"/>
+    </php>
+
+    <testsuites>
+        <testsuite name="Bundle tests">
+            <directory>tests</directory>
+            <exclude>tests/fixtures</exclude>
+        </testsuite>
+    </testsuites>
+
+    <listeners>
+        <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener" />
+    </listeners>
+</phpunit>

src/Bundle/BundleExtension.php

@@ -3,10 +3,12 @@
 namespace Torr\BundleHelpers\Bundle;
 
 use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\HttpKernel\Bundle\BundleInterface;
+use Torr\BundleHelpers\Exception\BundleHelpersException;
 
 /**
  * Base bundle extension, that can be used without needing a custom class.
@@ -47,6 +49,22 @@ public function load (array $configs, ContainerBuilder $container) : void
 	 */
 	public function getAlias () : string
 	{
-		return $this->alias ?? parent::getAlias();
+		if (null !== $this->alias)
+		{
+			return $this->alias;
+		}
+
+		$className = \get_class($this->bundle);
+
+		if ('Bundle' !== \substr($className, -6))
+		{
+			throw new BundleHelpersException(\sprintf(
+				"The bundle does not follow the naming convention; you must pass an explicit alias. Its name should end on 'Bundle', but it is '%s'.",
+				$className
+			));
+		}
+		$classBaseName = \substr(\strrchr($className, '\\'), 1, -6);
+
+		return Container::underscore($classBaseName);
 	}
 }

src/Exception/BundleHelpersException.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace Torr\BundleHelpers\Exception;
+
+final class BundleHelpersException extends \Exception
+{
+}

tests/Bundle/BundleExtensionTest.php

@@ -0,0 +1,36 @@
+<?php declare(strict_types=1);
+
+namespace Tests\Torr\BundleHelpers\Bundle;
+
+use PHPUnit\Framework\TestCase;
+use Tests\Torr\BundleHelpers\Fixtures\ExampleBundle;
+use Tests\Torr\BundleHelpers\Fixtures\OtherExample;
+use Torr\BundleHelpers\Bundle\BundleExtension;
+use Torr\BundleHelpers\Exception\BundleHelpersException;
+
+final class BundleExtensionTest extends TestCase
+{
+	/**
+	 *
+	 */
+	public function testAliasGeneration () : void
+	{
+		$extension = new BundleExtension(new ExampleBundle());
+		$extensionOverwritten = new BundleExtension(new ExampleBundle(), "overwritten");
+
+		self::assertSame("example", $extension->getAlias());
+		self::assertSame("overwritten", $extensionOverwritten->getAlias());
+	}
+
+	/**
+	 *
+	 */
+	public function testInvalidAliasGeneration () : void
+	{
+		$this->expectException(BundleHelpersException::class);
+		$this->expectExceptionMessage("The bundle does not follow the naming convention; you must pass an explicit alias.");
+
+		$extension = new BundleExtension(new OtherExample());
+		$extension->getAlias();
+	}
+}

tests/Fixtures/ExampleBundle.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace Tests\Torr\BundleHelpers\Fixtures;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+final class ExampleBundle extends Bundle
+{
+}

tests/Fixtures/OtherExample.php

@@ -0,0 +1,12 @@
+<?php declare(strict_types=1);
+
+namespace Tests\Torr\BundleHelpers\Fixtures;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+/**
+ * Should specifically not end in "bundle"
+ */
+final class OtherExample extends Bundle
+{
+}