Merge pull request #233 from c-harris/hookupClassFinder

Hookup class finder
Algo-Web · Mar 5, 2020 · 9f24e3d · 9f24e3d
2 parents 59d7253 + 937e627
commit 9f24e3d
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 125 deletions.
diff --git a/composer.json b/composer.json
@@ -8,19 +8,20 @@
         "sort-packages": true
     },
     "require": {
+        "php": "^7.1",
         "algo-web/podata": "0.3.*|dev-master",
+        "cruxinator/class-finder": "1.0.0-RC2|dev-master",
         "doctrine/dbal": "^2.5",
-        "php": "^7.1",
-        "laravel/framework": "^5.5|^6.0",
         "illuminate/http": "^5.5|^6.0",
-        "voku/anti-xss": "2.1.*",
-        "symfony/yaml": "^2.7|^3.0|^4.0",
-        "symfony/http-foundation": "^2.7|^3.0|^4.0"
+        "laravel/framework": "^5.5|^6.0",
+        "symfony/http-foundation": "^2.7|^3.0|^4.0",
+        "symfony/yaml": "^2.7|^3.0|^4.0"
     },
     "require-dev": {
         "mockery/mockery": "dev-master",
         "php-coveralls/php-coveralls": ">=v2.1",
         "phpunit/phpunit": "^6.0|^7.0|^8.0",
+        "ocramius/package-versions": "1.3.*|1.4.*|1.5.*",
         "orchestra/database": "3.5.*|3.6.*|3.7.*|3.8.*|^4.0",
         "orchestra/testbench": "3.5.*|3.6.*|3.7.*|3.8.*|^4.0",
         "infection/infection": "^0.13|dev-master"

diff --git a/src/Providers/MetadataBaseProvider.php b/src/Providers/MetadataBaseProvider.php
@@ -42,37 +42,6 @@ protected function handlePostBoot(bool $isCaching, $hasCache, string $key, $meta
         }
     }
 
-    /**
-     * @return array
-     */
-    protected function getClassMap()
-    {
-        $classes   = get_declared_classes();
-        $autoClass = null;
-        foreach ($classes as $class) {
-            if (\Illuminate\Support\Str::startsWith($class, 'Composer\\Autoload\\ComposerStaticInit')) {
-                $autoClass = $class;
-            }
-        }
-
-        $classes = $autoClass::$classMap;
-        $this->checkClassMap($classes);
-        return array_keys($classes);
-    }
-
-    /**
-     * @param $classMap
-     * @throws \Exception
-     */
-    protected function checkClassMap($classMap)
-    {
-        $class = __CLASS__;
-        if (!isset($classMap[$class])) {
-            throw new \Exception(sprintf('%s was not found in autoload class map, this usually indicates you '.
-            'need to dump an optimised autoloader (`composer dump-autoload -o`)', $class));
-        }
-    }
-
     protected function getAppNamespace()
     {
         try {

diff --git a/src/Providers/MetadataControllerProvider.php b/src/Providers/MetadataControllerProvider.php
@@ -6,6 +6,7 @@
 
 use AlgoWeb\PODataLaravel\Controllers\MetadataControllerContainer;
 use AlgoWeb\PODataLaravel\Controllers\MetadataControllerTrait;
+use Cruxinator\ClassFinder\ClassFinder;
 use Illuminate\Routing\Controller;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Cache;
@@ -42,9 +43,7 @@ public function boot()
         /** @var MetadataControllerContainer $meta */
         $meta = App::make('metadataControllers');
 
-        $classes = $this->getClassMap();
-        $ends    = $this->getCandidateControllers($classes);
-
+        $ends = $this->getCandidateControllers();
         // now process each class that uses the metadata controller trait and stick results in $metamix
         $metamix = [];
         foreach ($ends as $end) {
@@ -96,43 +95,21 @@ function () {
     }
 
     /**
-     * @param  array      $classes
+     * @return mixed
      * @throws \Exception
-     * @return array
      */
-    protected function getCandidateControllers(array $classes)
+    protected function getCandidateControllers()
     {
-        $ends       = [];
-        $startName  = $this->getAppNamespace();
-        $rawClasses = [];
-        foreach ($classes as $name) {
-            // not in app namespace, keep moving
-            if (!\Illuminate\Support\Str::startsWith($name, $startName)) {
-                continue;
-            }
-            // if class doesn't exist (for whatever reason), skip it now rather than muck about later
-            if (!class_exists($name)) {
-                continue;
-            }
-            $rawClasses[] = $name;
-        }
-
-        foreach ($rawClasses as $name) {
-            try {
-                if (in_array(MetadataControllerTrait::class, class_uses($name, false))) {
-                    $result = $this->app->make($name);
-                    if (!$result instanceof Controller) {
-                        throw new InvalidOperationException('Resolved result not a controller');
-                    }
-                    $ends[] = $result;
-                }
-            } catch (\Exception $e) {
-                if (!$this->app->runningInConsole()) {
-                    throw $e;
-                }
-                // Squash exceptions thrown here when running from CLI so app can continue booting
-            }
-        }
+        $classes = ClassFinder::getClasses(
+            $this->getAppNamespace(),
+            function ($className) {
+                return in_array(MetadataControllerTrait::class, class_uses($className)) &&
+                    ($this->app->make($className) instanceof Controller);
+            }, true);
+        $ends = array_reduce($classes, function ($carry, $item) {
+            $carry[] = $this->app->make($item);
+            return $carry;
+        }, []);
         return $ends;
     }
 }
diff --git a/src/Providers/MetadataProvider.php b/src/Providers/MetadataProvider.php
@@ -14,6 +14,7 @@
 use AlgoWeb\PODataLaravel\Models\ObjectMap\Entities\EntityFieldType;
 use AlgoWeb\PODataLaravel\Models\ObjectMap\Entities\EntityGubbins;
 use AlgoWeb\PODataLaravel\Models\ObjectMap\Map;
+use Cruxinator\ClassFinder\ClassFinder;
 use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\App;
@@ -317,19 +318,11 @@ public function register()
      */
     protected function getCandidateModels()
     {
-        $classes   = $this->getClassMap();
-        $ends      = [];
-        $startName = $this->getAppNamespace();
-        foreach ($classes as $name) {
-            if (Str::startsWith($name, $startName)) {
-                if (in_array('AlgoWeb\\PODataLaravel\\Models\\MetadataTrait', class_uses($name))) {
-                    if (is_subclass_of($name, '\\Illuminate\\Database\\Eloquent\\Model')) {
-                        $ends[] = $name;
-                    }
-                }
-            }
-        }
-        return $ends;
+        return ClassFinder::getClasses($this->getAppNamespace(),
+            function ($className) {
+                return in_array(\AlgoWeb\PODataLaravel\Models\MetadataTrait::class, class_uses($className)) &&
+                    is_subclass_of($className, \Illuminate\Database\Eloquent\Model::class);
+            }, true);
     }
 
     /**

diff --git a/tests/Legacy/Unit/Providers/MetadataControllerProviderTest.php b/tests/Legacy/Unit/Providers/MetadataControllerProviderTest.php
@@ -264,7 +264,6 @@ public function testBootNonExistentControllers()
         Cache::shouldReceive('forget')->with('metadataControllers')->once();
 
         $foo = m::mock(MetadataControllerProvider::class)->makePartial()->shouldAllowMockingProtectedMethods();
-        $foo->shouldReceive('getClassMap')->andReturn(['abc', 'def'])->once();
         $foo->shouldReceive('getIsCaching')->andReturn(false)->once();
 
         $foo->boot();

diff --git a/tests/Orchestra/Providers/DummyMetadataBaseProvider.php b/tests/Orchestra/Providers/DummyMetadataBaseProvider.php
@@ -25,9 +25,4 @@ public function handlePostBoot(bool $isCaching, $hasCache, string $key, $meta)
     {
         return parent::handlePostBoot($isCaching, $hasCache, $key, $meta);
     }
-
-    public function checkClassMap($classMap)
-    {
-        parent::checkClassMap($classMap);
-    }
 }
diff --git a/tests/Orchestra/Providers/DummyMetadataControllerProvider.php b/tests/Orchestra/Providers/DummyMetadataControllerProvider.php
@@ -18,8 +18,8 @@ class DummyMetadataControllerProvider extends MetadataControllerProvider
      * @throws \Exception
      * @return array
      */
-    public function getCandidateControllers(array $classes)
+    public function getCandidateControllers()
     {
-        return parent::getCandidateControllers($classes);
+        return parent::getCandidateControllers();
     }
 }
diff --git a/tests/Orchestra/Unit/Providers/MetadataBaseProviderTest.php b/tests/Orchestra/Unit/Providers/MetadataBaseProviderTest.php
@@ -40,16 +40,4 @@ public function testExplicitZeroCacheDurationMeansOne()
 
         $foo->handlePostBoot(true, null, 'key', null);
     }
-
-    public function testNotExistInClassMap()
-    {
-        $app = m::mock(Application::class);
-
-        $foo = new DummyMetadataBaseProvider($app);
-
-        $this->expectException(\Exception::class);
-        $this->expectExceptionMessage('AlgoWeb\PODataLaravel\Providers\MetadataBaseProvider was not found in autoload class map, this usually indicates you need to dump an optimised autoloader (`composer dump-autoload -o`)');
-
-        $foo->checkClassMap([]);
-    }
 }
diff --git a/tests/Orchestra/Unit/Providers/MetadataControllerProviderTest.php b/tests/Orchestra/Unit/Providers/MetadataControllerProviderTest.php
@@ -45,12 +45,14 @@ public function testDontFilterActiveControllers()
     public function testFilterControllerWithoutTrait()
     {
         $names    = [OrchestraNonTraitController::class, OrchestraTestController::class];
-        $expected = [new OrchestraTestController()];
+        $expected = [new OrchestraBallastController(), new OrchestraTestController()];
 
         $app = m::mock(Application::class);
         $app->shouldReceive('runningInConsole')->andReturn(true);
         $app->shouldReceive('make')->withArgs([OrchestraTestController::class])
             ->andReturn(new OrchestraTestController());
+        $app->shouldReceive('make')->withArgs([OrchestraBallastController::class])
+            ->andReturn(new OrchestraBallastController());
         $foo = new DummyMetadataControllerProvider($app);
 
         $actual = $foo->getCandidateControllers($names);
@@ -60,33 +62,18 @@ public function testFilterControllerWithoutTrait()
     public function testFilterFromOutsideNamespace()
     {
         $names    = [Role::class, OrchestraTestController::class];
-        $expected = [new OrchestraTestController()];
+        $expected = [new OrchestraBallastController(), new OrchestraTestController()];
 
         $app = m::mock(Application::class);
         $app->shouldReceive('runningInConsole')->andReturn(true);
         $app->shouldReceive('make')->withArgs([OrchestraTestController::class])
             ->andReturn(new OrchestraTestController());
+        $app->shouldReceive('make')->withArgs([OrchestraBallastController::class])
+            ->andReturn(new OrchestraBallastController());
 
         $foo = new DummyMetadataControllerProvider($app);
 
         $actual = $foo->getCandidateControllers($names);
         $this->assertEquals($expected, $actual);
     }
-
-    public function testKaboomOnSwitcheroo()
-    {
-        $names = [OrchestraTestController::class];
-
-        $app = m::mock(\Illuminate\Foundation\Application::class)->makePartial();
-        $app->shouldReceive('make')->withArgs([OrchestraTestController::class])
-            ->andReturn(new OrchestraTestModel());
-        $app->shouldReceive('runningInConsole')->andReturn(false)->once();
-        $foo = new DummyMetadataControllerProvider($app);
-
-        $this->expectException(InvalidOperationException::class);
-        $this->expectExceptionMessage('Resolved result not a controller');
-
-        App::instance('app', $app);
-        $foo->getCandidateControllers($names);
-    }
 }