Fix the file discovery functionalities

Author: ahamed

src/Concerns/DiscoversClassFiles.php

@@ -0,0 +1,60 @@
+<?php
+/**
+ * Trait that walks a PSR-4 directory tree and returns each PHP file's class path relative to it.
+ * Discovery must see classes grouped into subfolders, which a flat glob() of the top level misses.
+ * Used by the listener and policy discovery to turn nested files into namespaced class names.
+ *
+ * @package    Framework
+ * @subpackage Concerns
+ * @since      1.0.0
+ */
+namespace Framework\Concerns;
+
+defined('ABSPATH') || exit;
+
+use FilesystemIterator;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+
+trait DiscoversClassFiles
+{
+    /**
+     * Get the class path of every PHP file beneath the directory, relative to it.
+     *
+     * A file at `Order/SendInvoice.php` yields `Order\SendInvoice`, ready to be appended to the
+     * directory's base namespace. The result is sorted so the generated cache files stay stable
+     * regardless of the order the filesystem returns entries in.
+     *
+     * @param string $directory The directory to walk.
+     *
+     * @return array
+     *
+     * @since 1.0.0
+     */
+    protected function class_files(string $directory)
+    {
+        $class_files = [];
+
+        if (!is_dir($directory)) {
+            return $class_files;
+        }
+
+        $prefix_length = strlen(rtrim($directory, '\/')) + 1;
+        $files = new RecursiveIteratorIterator(
+            new RecursiveDirectoryIterator($directory, FilesystemIterator::SKIP_DOTS)
+        );
+
+        foreach ($files as $file) {
+            if (!$file->isFile() || $file->getExtension() !== 'php') {
+                continue;
+            }
+
+            $relative_path = substr($file->getPathname(), $prefix_length, -strlen('.php'));
+            $class_files[] = str_replace('/', '\\', $relative_path);
+        }
+
+        sort($class_files);
+
+        return $class_files;
+    }
+}

src/Discovery/ListenerDiscovery.php

@@ -12,6 +12,7 @@
 
 defined('ABSPATH') || exit;
 
+use Framework\Concerns\DiscoversClassFiles;
 use Framework\Contracts\Cacheable;
 use Framework\Contracts\Discoverable;
 use Framework\Supports\Facades\File;
@@ -26,6 +27,8 @@
 
 class ListenerDiscovery implements Discoverable, Cacheable
 {
+    use DiscoversClassFiles;
+
     /**
      * The discovered listeners array .
      *
@@ -66,16 +69,14 @@ protected function create_cache_file()
             return $this;
         }
 
-        $listeners_files = glob($listeners_directory . '/*.php');
+        $listeners_files = $this->class_files($listeners_directory);
 
         if (empty($listeners_files)) {
             return $this;
         }
 
-        foreach ($listeners_files as $file) {
-            $listener = $this->listener_class(
-                $this->filename($file)
-            );
+        foreach ($listeners_files as $filename) {
+            $listener = $this->listener_class($filename);
 
             if (!$this->is_valid_listener($listener)) {
                 continue;
@@ -158,24 +159,10 @@ protected function event_class(string $listener)
         return $type_name;
     }
 
-    /**
-     * Get the filename of the listener.
-     *
-     * @param string $file The file.
-     *
-     * @return string
-     *
-     * @since 1.0.0
-     */
-    protected function filename(string $file)
-    {
-        return basename($file, '.php');
-    }
-
     /**
      * Get the listener class of the filename.
      *
-     * @param string $filename The filename.
+     * @param string $filename The class path relative to the listeners directory.
      *
      * @return string
      *

src/Discovery/PolicyDiscovery.php

@@ -12,6 +12,7 @@
 
 defined('ABSPATH') || exit;
 
+use Framework\Concerns\DiscoversClassFiles;
 use Framework\Contracts\Cacheable;
 use Framework\Contracts\Discoverable;
 use Framework\Supports\Facades\File;
@@ -23,6 +24,8 @@
 
 class PolicyDiscovery implements Discoverable, Cacheable
 {
+    use DiscoversClassFiles;
+
     /**
      * The discovered policies array.
      *
@@ -65,15 +68,13 @@ protected function create_cache_file()
             return $this;
         }
 
-        $policy_files = glob($policies_directory . '/*.php');
+        $policy_files = $this->class_files($policies_directory);
 
         if (empty($policy_files)) {
             return $this;
         }
 
-        foreach ($policy_files as $policy_file) {
-            $policy_name = $this->filename($policy_file);
-
+        foreach ($policy_files as $policy_name) {
             if (!$this->is_valid_policy_name($policy_name)) {
                 continue;
             }
@@ -87,20 +88,6 @@ protected function create_cache_file()
         return $this;
     }
 
-    /**
-     * Get the filename of the policy.
-     *
-     * @param string $path The path.
-     *
-     * @return string
-     *
-     * @since 1.0.0
-     */
-    protected function filename(string $path)
-    {
-        return basename($path, '.php');
-    }
-
     /**
      * Add a policy to the policies array.
      *
@@ -148,6 +135,9 @@ protected function policy_class(string $policy_name)
     /**
      * Get the model class from the policy name.
      *
+     * A policy in a subfolder maps to a model in the matching subfolder, so
+     * `Policies\Shop\ProductPolicy` is paired with `Models\Shop\Product`.
+     *
      * @param string $policy_name The policy name.
      *
      * @return string

tests/Support/Discovery/App/Events/OrderPlaced.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Framework\Tests\Support\Discovery\App\Events;
+
+class OrderPlaced
+{
+}

tests/Support/Discovery/App/Listeners/LogOrder.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Framework\Tests\Support\Discovery\App\Listeners;
+
+use Framework\Tests\Support\Discovery\App\Events\OrderPlaced;
+use Framework\Listener;
+
+class LogOrder extends Listener
+{
+    public function handle(OrderPlaced $event)
+    {
+    }
+}

tests/Support/Discovery/App/Listeners/Order/Paid/NotifyWarehouse.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Framework\Tests\Support\Discovery\App\Listeners\Order\Paid;
+
+use Framework\Tests\Support\Discovery\App\Events\OrderPlaced;
+use Framework\Listener;
+
+class NotifyWarehouse extends Listener
+{
+    public function handle(OrderPlaced $event)
+    {
+    }
+
+    public function priority()
+    {
+        return 10;
+    }
+}

tests/Support/Discovery/App/Listeners/Order/SendInvoice.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Framework\Tests\Support\Discovery\App\Listeners\Order;
+
+use Framework\Tests\Support\Discovery\App\Events\OrderPlaced;
+use Framework\Listener;
+
+class SendInvoice extends Listener
+{
+    public function handle(OrderPlaced $event)
+    {
+    }
+
+    public function priority()
+    {
+        return 5;
+    }
+}

tests/Support/Discovery/App/Models/Post.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Framework\Tests\Support\Discovery\App\Models;
+
+class Post
+{
+}

tests/Support/Discovery/App/Models/Shop/Product.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Framework\Tests\Support\Discovery\App\Models\Shop;
+
+class Product
+{
+}

tests/Support/Discovery/App/Policies/PostPolicy.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Framework\Tests\Support\Discovery\App\Policies;
+
+class PostPolicy
+{
+}