Support subplugins in install.

Co-authored-by: Ruslan Kabalin <[email protected]>

Author: micaherne

docs/CHANGELOG.md

@@ -9,7 +9,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 The format of this change log follows the advice given at [Keep a CHANGELOG](http://keepachangelog.com).
 
 ## [Unreleased]
-No unreleased changes.
+### Added
+- Support for subplugins in the extra-plugins directory for install.
 
 ## [3.2.1] - 2021-07-30
 ### Changed

src/Bridge/MoodlePlugin.php

@@ -60,6 +60,13 @@ class MoodlePlugin
      */
     protected $dependencies;
 
+    /**
+     * Cached subplugin types.
+     *
+     * @var string[]
+     */
+    protected $subpluginTypes;
+
     /**
      * @param string $directory Absolute path to a Moodle plugin
      */
@@ -138,6 +145,30 @@ public function getDependencies()
         return $this->dependencies;
     }
 
+    /**
+     * Get a plugin's subplugin types.
+     *
+     * @return string[]
+     */
+    public function getSubpluginTypes()
+    {
+        // Simple cache.
+        if (is_array($this->subpluginTypes)) {
+            return $this->subpluginTypes;
+        }
+        $this->subpluginTypes = [];
+
+        $subpluginsJsonLocation = $this->directory.'/db/subplugins.json';
+        if (file_exists($subpluginsJsonLocation)) {
+            $subpluginData = json_decode(file_get_contents($subpluginsJsonLocation));
+            if ($subpluginData && property_exists($subpluginData, 'plugintypes')) {
+                $this->subpluginTypes = array_keys((array) $subpluginData->plugintypes);
+            }
+        }
+
+        return $this->subpluginTypes;
+    }
+
     /**
      * Determine if the plugin has any PHPUnit tests.
      *

src/Bridge/MoodlePluginCollection.php

@@ -52,6 +52,13 @@ public function sortByDependencies()
             $elements[$item->getComponent()] = [];
         }
 
+        $subpluginTypes = [];
+        foreach ($this->items as $item) {
+            foreach ($item->getSubpluginTypes() as $type) {
+                $subpluginTypes[$type] = $item->getComponent();
+            }
+        }
+
         // Loop through a second time, only adding dependencies that exist in our list.
         foreach ($this->items as $item) {
             $dependencies = $item->getDependencies();
@@ -60,6 +67,12 @@ public function sortByDependencies()
                     $elements[$item->getComponent()][] = $dependency;
                 }
             }
+
+            // Add implied dependencies for subplugins.
+            list($type, $plugin) = explode('_', $item->getComponent(), 2);
+            if (array_key_exists($type, $subpluginTypes)) {
+                $elements[$item->getComponent()][] = $subpluginTypes[$type];
+            }
         }
 
         $sorter  = new StringSort($elements, false);

tests/Bridge/MoodlePluginCollectionTest.php

@@ -75,4 +75,24 @@ public function testSortByDependenciesCircularError()
         $this->assertSame($plugin3, $all[1]);
         $this->assertSame($plugin1, $all[2]);
     }
+
+    public function testSortByDependenciesWithSubplugins()
+    {
+        $plugin1                 = new DummyMoodlePlugin('');
+        $plugin1->component      = 'mod_1';
+        $plugin1->subpluginTypes = ['subplugin'];
+
+        $plugin2               = new DummyMoodlePlugin('');
+        $plugin2->component    = 'subplugin_1';
+
+        $plugins = new MoodlePluginCollection();
+        $plugins->add($plugin2);
+        $plugins->add($plugin1);
+
+        $sorted = $plugins->sortByDependencies();
+        $all    = $sorted->all();
+        $this->assertCount(2, $all);
+        $this->assertSame($plugin1, $all[0]);
+        $this->assertSame($plugin2, $all[1]);
+    }
 }

tests/Bridge/MoodlePluginTest.php

@@ -31,6 +31,14 @@ public function testGetDependencies()
         $this->assertSame(['mod_forum'], $plugin->getDependencies());
     }
 
+    public function testGetSubpluginTypes()
+    {
+        $plugintypes = ['subplugin' => 'some/plugin/dir'];
+        file_put_contents($this->pluginDir.'/db/subplugins.json', json_encode(['plugintypes' => $plugintypes]));
+        $plugin = new MoodlePlugin($this->pluginDir);
+        $this->assertSame(array_keys($plugintypes), $plugin->getSubpluginTypes());
+    }
+
     public function testHasUnitTests()
     {
         $plugin = new MoodlePlugin($this->pluginDir);

tests/Fake/Bridge/DummyMoodlePlugin.php

@@ -16,6 +16,7 @@
 
 class DummyMoodlePlugin extends MoodlePlugin
 {
-    public $component    = 'local_ci';
-    public $dependencies = ['mod_forum'];
+    public $component      = 'local_ci';
+    public $dependencies   = ['mod_forum'];
+    public $subpluginTypes = [];
 }