[WIP] Added reverse alias support in ExtendedTrait

src/Extension/ExtendableTrait.php

@@ -1,9 +1,11 @@
 <?php namespace Winter\Storm\Extension;
 
+use App;
 use ReflectionClass;
 use ReflectionMethod;
 use BadMethodCallException;
 use Exception;
+use Winter\Storm\Support\ClassLoader;
 
 /**
  * This extension trait is used when access to the underlying base class
@@ -26,6 +28,8 @@ trait ExtendableTrait
  'dynamicProperties' => []
  ];
 
+ protected $extendableClassLoader = null;
+
  /**
  * @var array Used to extend the constructor of an extendable class. Eg:
  *
@@ -93,6 +97,21 @@ public function extendableConstruct()
 
  $this->extendClassWith($useClass);
  }
+
+ // If App is available, bind the ClassLoader
+ if (class_exists('App')) {
+ $this->extendableClassLoader = App::make(ClassLoader::class);
+ }
+ }
+
+ /**
+ * Bind ClassLoader to this object
+ * @param ClassLoader $classLoader
+ * @return void
+ */
+ public function extendableRegisterClassLoader(ClassLoader $classLoader): void
+ {
+ $this->extendableClassLoader = $classLoader;
  }
 
  /**
@@ -204,7 +223,7 @@ public function extendClassWith($extensionName)
 
  $extensionName = str_replace('.', '\\', trim($extensionName));
 
- if (isset($this->extensionData['extensions'][$extensionName])) {
+ if ($this->isClassExtendedWith($extensionName)) {
  throw new Exception(sprintf(
  'Class %s has already been extended with %s',
  get_class($this),
@@ -225,6 +244,10 @@ public function extendClassWith($extensionName)
  public function isClassExtendedWith($name)
  {
  $name = str_replace('.', '\\', trim($name));
+ if ($this->extendableClassLoader && $alias = $this->extendableClassLoader->getReverseAlias($name)) {
+ return isset($this->extensionData['extensions'][$name])
+ || isset($this->extensionData['extensions'][$alias]);
+ }
  return isset($this->extensionData['extensions'][$name]);
  }
 

src/Support/Testing/MocksClassLoader.php

@@ -0,0 +1,55 @@
+<?php namespace Winter\Storm\Support\Testing;
+
+use Winter\Storm\Filesystem\Filesystem;
+use Winter\Storm\Support\ClassLoader;
+
+/**
+ * Helper trait to test classes which use the ClassLoader (ie. extensions).
+ *
+ * This trait will mock the ClassLoader so that it does not require the entire app to be instantiated.
+ */
+trait MocksClassLoader
+{
+ /** @var ClassLoader Mocked ClassLoader instance */
+ protected $classLoader;
+
+ /**
+ * Registers a mock class loader in the autoload stack.
+ *
+ * @param string $basePath
+ * @param string $manifestPath
+ * @return void
+ */
+ protected function registerMockClassLoader($basePath = null, $manifestPath = null)
+ {
+ if (is_null($basePath)) {
+ $basePath = dirname(dirname(__DIR__)) . '/fixtures/classes';
+ }
+ if (is_null($manifestPath)) {
+ $manifestPath = dirname(dirname(__DIR__)) . '/fixtures/classes/classes.php';
+ }
+
+ $this->classLoader = new ClassLoader(
+ new Filesystem(),
+ $basePath,
+ $manifestPath
+ );
+
+ $this->classLoader->register();
+ }
+
+ /**
+ * Inits a class and binds the ClassLoader to it, used by a class that uses the `Extendable` trait.
+ *
+ * The mock will use the class loader from this trait.
+ *
+ * @param string $class
+ * @return mixed
+ */
+ protected function extendableMakeClass($class)
+ {
+ $subject = new $class();
+ $subject->extendableRegisterClassLoader($this->classLoader);
+ return $subject;
+ }
+}

tests/Extension/ExtendableTest.php

@@ -2,40 +2,61 @@
 
 use Winter\Storm\Extension\Extendable;
 use Winter\Storm\Extension\ExtensionBase;
+use Winter\Storm\Filesystem\Filesystem;
+use Winter\Storm\Support\ClassLoader;
+use Winter\Storm\Support\Testing\MocksClassLoader;
 
 class ExtendableTest extends TestCase
 {
+ use MocksClassLoader;
+
+ public function setUp(): void
+ {
+ parent::setUp();
+
+ $this->registerMockClassLoader();
+
+ $this->classLoader->addDirectories([
+ 'plugins'
+ ]);
+
+ $this->classLoader->addNamespaceAliases([
+ 'Real\\ExtendableTest' => 'Alias\\ExtendableTest',
+ 'Real' => 'Alias',
+ ]);
+ }
+
  public function testExtendingExtendableClass()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $this->assertNull($subject->classAttribute);
 
  ExtendableTestExampleExtendableClass::extend(function ($extension) {
  $extension->classAttribute = 'bar';
  });
 
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $this->assertEquals('bar', $subject->classAttribute);
  }
 
  public function testSettingDeclaredPropertyOnClass()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $subject->classAttribute = 'Test';
  $this->assertEquals('Test', $subject->classAttribute);
  }
 
  public function testSettingUndeclaredPropertyOnClass()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $subject->newAttribute = 'Test';
  $this->assertNull($subject->newAttribute);
  $this->assertFalse(property_exists($subject, 'newAttribute'));
  }
 
  public function testSettingDeclaredPropertyOnBehavior()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $behavior = $subject->getClassExtension('ExtendableTestExampleBehaviorClass1');
 
  $subject->behaviorAttribute = 'Test';
@@ -46,7 +67,7 @@ public function testSettingDeclaredPropertyOnBehavior()
 
  public function testDynamicPropertyOnClass()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $this->assertFalse(property_exists($subject, 'newAttribute'));
  $subject->addDynamicProperty('dynamicAttribute', 'Test');
  $this->assertEquals('Test', $subject->dynamicAttribute);
@@ -55,7 +76,7 @@ public function testDynamicPropertyOnClass()
 
  public function testDynamicallyExtendingClass()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $subject->extendClassWith('ExtendableTestExampleBehaviorClass2');
 
  $this->assertTrue($subject->isClassExtendedWith('ExtendableTestExampleBehaviorClass1'));
@@ -64,7 +85,7 @@ public function testDynamicallyExtendingClass()
 
  public function testDynamicMethodOnClass()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $subject->addDynamicMethod('getFooAnotherWay', 'getFoo', 'ExtendableTestExampleBehaviorClass1');
 
  $this->assertEquals('foo', $subject->getFoo());
@@ -73,7 +94,7 @@ public function testDynamicMethodOnClass()
 
  public function testDynamicExtendAndMethodOnClass()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $subject->extendClassWith('ExtendableTestExampleBehaviorClass2');
  $subject->addDynamicMethod('getOriginalFoo', 'getFoo', 'ExtendableTestExampleBehaviorClass1');
 
@@ -83,9 +104,18 @@ public function testDynamicExtendAndMethodOnClass()
  $this->assertEquals('foo', $subject->getOriginalFoo());
  }
 
+ public function testExtendOnClassWithClassLoaderAliases()
+ {
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClassAlias1::class);
+ $this->assertTrue($subject->isClassExtendedWith('Real.ExtendableTest.ExampleBehaviorClass1'));
+
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClassAlias2::class);
+ $this->assertTrue($subject->isClassExtendedWith('Real.ExampleBehaviorClass1'));
+ }
+
  public function testDynamicClosureOnClass()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $subject->addDynamicMethod('sayHello', function () {
  return 'Hello world';
  });
@@ -95,7 +125,7 @@ public function testDynamicClosureOnClass()
 
  public function testDynamicCallableOnClass()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $subject->addDynamicMethod('getAppName', ['ExtendableTestExampleClass', 'getName']);
 
  $this->assertEquals('winter', $subject->getAppName());
@@ -121,7 +151,7 @@ public function testCallingUndefinedStaticMethod()
 
  public function testAccessingProtectedProperty()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $this->assertEmpty($subject->protectedFoo);
 
  $subject->protectedFoo = 'snickers';
@@ -130,10 +160,11 @@ public function testAccessingProtectedProperty()
 
  public function testAccessingProtectedMethod()
  {
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
+
  $this->expectException(BadMethodCallException::class);
- $this->expectExceptionMessage('Call to undefined method ExtendableTestExampleExtendableClass::protectedBar()');
+ $this->expectExceptionMessage('Call to undefined method ' . get_class($subject) . '::protectedBar()');
 
- $subject = new ExtendableTestExampleExtendableClass;
  echo $subject->protectedBar();
  }
 
@@ -149,27 +180,27 @@ public function testInvalidImplementValue()
  {
  $this->expectException(Exception::class);
  $this->expectExceptionMessage('Class ExtendableTestInvalidExtendableClass contains an invalid $implement value');
- 
+
  $result = new ExtendableTestInvalidExtendableClass;
  }
 
  public function testSoftImplementFake()
  {
- $result = new ExtendableTestExampleExtendableSoftImplementFakeClass;
+ $result = $this->extendableMakeClass(ExtendableTestExampleExtendableSoftImplementFakeClass::class);
  $this->assertFalse($result->isClassExtendedWith('RabbleRabbleRabble'));
  $this->assertEquals('working', $result->getStatus());
  }
 
  public function testSoftImplementReal()
  {
- $result = new ExtendableTestExampleExtendableSoftImplementRealClass;
+ $result = $this->extendableMakeClass(ExtendableTestExampleExtendableSoftImplementRealClass::class);
  $this->assertTrue($result->isClassExtendedWith('ExtendableTestExampleBehaviorClass1'));
  $this->assertEquals('foo', $result->getFoo());
  }
 
  public function testSoftImplementCombo()
  {
- $result = new ExtendableTestExampleExtendableSoftImplementComboClass;
+ $result = $this->extendableMakeClass(ExtendableTestExampleExtendableSoftImplementComboClass::class);
  $this->assertFalse($result->isClassExtendedWith('RabbleRabbleRabble'));
  $this->assertTrue($result->isClassExtendedWith('ExtendableTestExampleBehaviorClass1'));
  $this->assertTrue($result->isClassExtendedWith('ExtendableTestExampleBehaviorClass2'));
@@ -178,7 +209,7 @@ public function testSoftImplementCombo()
 
  public function testDotNotation()
  {
- $subject = new ExtendableTestExampleExtendableClassDotNotation();
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClassDotNotation::class);
  $subject->extendClassWith('ExtendableTest.ExampleBehaviorClass2');
 
  $this->assertTrue($subject->isClassExtendedWith('ExtendableTest.ExampleBehaviorClass1'));
@@ -187,27 +218,27 @@ public function testDotNotation()
 
  public function testMethodExists()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $this->assertTrue($subject->methodExists('extend'));
  }
 
  public function testMethodNotExists()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $this->assertFalse($subject->methodExists('missingFunction'));
  }
 
  public function testDynamicMethodExists()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $subject->addDynamicMethod('getFooAnotherWay', 'getFoo', 'ExtendableTestExampleBehaviorClass1');
 
  $this->assertTrue($subject->methodExists('getFooAnotherWay'));
  }
 
  public function testGetClassMethods()
  {
- $subject = new ExtendableTestExampleExtendableClass;
+ $subject = $this->extendableMakeClass(ExtendableTestExampleExtendableClass::class);
  $subject->addDynamicMethod('getFooAnotherWay', 'getFoo', 'ExtendableTestExampleBehaviorClass1');
  $methods = $subject->getClassMethods();
 
@@ -297,6 +328,22 @@ public function getProtectedFooAttribute()
  }
 }
 
+/*
+ * Example class that has extensions enabled via `ClassLoader` alias
+ */
+class ExtendableTestExampleExtendableClassAlias1 extends Extendable
+{
+ public $implement = ['Alias.ExtendableTest.ExampleBehaviorClass1'];
+}
+
+/*
+ * Example class that has extensions enabled via `ClassLoader` alias
+ */
+class ExtendableTestExampleExtendableClassAlias2 extends Extendable
+{
+ public $implement = ['Alias.ExampleBehaviorClass1'];
+}
+
 /**
  * A normal class without extensions enabled
  */
@@ -378,3 +425,9 @@ public function getProtectedFooAttribute()
  */
 class_alias('ExtendableTestExampleBehaviorClass1', 'ExtendableTest\\ExampleBehaviorClass1');
 class_alias('ExtendableTestExampleBehaviorClass2', 'ExtendableTest\\ExampleBehaviorClass2');
+
+/*
+ * Add namespaces for `ClassLoader` aliasing
+ */
+class_alias('ExtendableTestExampleBehaviorClass1', 'Real\\ExtendableTest\\ExampleBehaviorClass1');
+class_alias('ExtendableTestExampleBehaviorClass1', 'Real\\ExampleBehaviorClass1');