Friendica/friendica
Friendica/friendica
1
0
Fork 1
mirror of https://git.friendi.ca/friendica/friendica.git synced 2025-06-08 21:04:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add Addon::getId() method

Browse source
This commit is contained in:
Art4 2025-01-08 12:52:21 +00:00
parent 66fb982124
commit 1f25fe9bf5
8 changed files with 89 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/Service/Addon/Addon.php
View file

@ -14,6 +14,8 @@ namespace Friendica\Service\Addon;
*/
interface Addon
{
public function getId(): string;
public function getRequiredDependencies(): array;
public function getSubscribedEvents(): array;

2
src/Service/Addon/AddonFactory.php
View file

@ -65,7 +65,7 @@ final class AddonFactory implements AddonLoader
throw new \RuntimeException(sprintf('Bootstrap file for addon "%s" MUST return an instance of AddonBootstrap.', $addonName));
}
$addon = new AddonProxy($bootstrap);
$addon = new AddonProxy($addonName, $bootstrap);
$this->logger->info(sprintf('Addon "%s" loaded.', $addonName));

12
src/Service/Addon/AddonManager.php
View file

@ -41,6 +41,18 @@ final class AddonManager
return array_unique($dependencies);
}
public function getRequiredDependencies(): array
{
$dependencies = [];
foreach ($this->addons as $addon) {
// @TODO Here we can filter or deny dependencies from addons
$dependencies[$addon->getId()] = $addon->getRequiredDependencies();
}
return $dependencies;
}
public function getProvidedDependencyRules(): array
{
$dependencyRules = [];

10
src/Service/Addon/AddonProxy.php
View file

@ -19,15 +19,23 @@ use Friendica\Addon\InstallableAddon;
*/
final class AddonProxy implements Addon
{
private string $id;
private AddonBootstrap $bootstrap;
private bool $isInit = false;
public function __construct(AddonBootstrap $bootstrap)
public function __construct(string $id, AddonBootstrap $bootstrap)
{
$this->id = $id;
$this->bootstrap = $bootstrap;
}
public function getId(): string
{
return $this->id;
}
public function getRequiredDependencies(): array
{
return $this->bootstrap->getRequiredDependencies();

23
src/Service/Addon/LegacyAddonProxy.php
View file

@ -14,18 +14,23 @@ namespace Friendica\Service\Addon;
*/
final class LegacyAddonProxy implements Addon
{
private string $name;
private string $id;
private string $path;
private bool $isInit = false;
public function __construct(string $name, string $path)
public function __construct(string $id, string $path)
{
$this->name = $name;
$this->id = $id;
$this->path = $path;
}
public function getId(): string
{
return $this->id;
}
public function getRequiredDependencies(): array
{
return [];
@ -38,7 +43,7 @@ final class LegacyAddonProxy implements Addon
public function getProvidedDependencyRules(): array
{
$fileName = $this->path . '/' . $this->name . '/static/dependencies.config.php';
$fileName = $this->path . '/' . $this->id . '/static/dependencies.config.php';
if (is_file($fileName)) {
return include_once($fileName);
@ -55,20 +60,20 @@ final class LegacyAddonProxy implements Addon
$this->isInit = true;
include_once($this->path . '/' . $this->name . '/' . $this->name . '.php');
include_once($this->path . '/' . $this->id . '/' . $this->id . '.php');
}
public function installAddon(): void
{
if (function_exists($this->name . '_install')) {
call_user_func($this->name . '_install');
if (function_exists($this->id . '_install')) {
call_user_func($this->id . '_install');
}
}
public function uninstallAddon(): void
{
if (function_exists($this->name . '_uninstall')) {
call_user_func($this->name . '_uninstall');
if (function_exists($this->id . '_uninstall')) {
call_user_func($this->id . '_uninstall');
}
}
}

27
tests/Unit/Service/Addon/AddonManagerTest.php
View file

@ -29,11 +29,11 @@ class AddonManagerTest extends TestCase
public function testGetAllSubscribedEventsReturnsEvents(): void
{
$addon = $this->createMock(Addon::class);
$addon->expects($this->once())->method('getSubscribedEvents')->willReturn([[HtmlFilterEvent::PAGE_END, [Addon::class, 'onPageEnd']]]);
$addon = $this->createStub(Addon::class);
$addon->method('getSubscribedEvents')->willReturn([[HtmlFilterEvent::PAGE_END, [Addon::class, 'onPageEnd']]]);
$loader = $this->createMock(AddonLoader::class);
$loader->expects($this->once())->method('getAddons')->willReturn(['helloaddon' => $addon]);
$loader = $this->createStub(AddonLoader::class);
$loader->method('getAddons')->willReturn(['helloaddon' => $addon]);
$manager = new AddonManager($loader);
@ -44,4 +44,23 @@ class AddonManagerTest extends TestCase
$manager->getAllSubscribedEvents()
);
}
public function testGetRequiredDependenciesReturnsArray(): void
{
$addon = $this->createStub(Addon::class);
$addon->method('getId')->willReturn('helloaddon');
$addon->method('getRequiredDependencies')->willReturn(['foo', 'bar']);
$loader = $this->createStub(AddonLoader::class);
$loader->method('getAddons')->willReturn(['helloaddon' => $addon]);
$manager = new AddonManager($loader);
$manager->bootstrapAddons(['helloaddon' => []]);
$this->assertSame(
['helloaddon' => ['foo', 'bar']],
$manager->getRequiredDependencies()
);
}
}

27
tests/Unit/Service/Addon/AddonProxyTest.php
View file

@ -38,17 +38,26 @@ class AddonProxyTest extends TestCase
{
$bootstrap = $this->createStub(AddonBootstrap::class);
$addon = new AddonProxy($bootstrap);
$addon = new AddonProxy('id', $bootstrap);
$this->assertInstanceOf(Addon::class, $addon);
}
public function testGetIdReturnsId(): void
{
$bootstrap = $this->createStub(AddonBootstrap::class);
$addon = new AddonProxy('id', $bootstrap);
$this->assertSame('id', $addon->getId());
}
public function testGetRequiredDependenciesCallsBootstrap(): void
{
$bootstrap = $this->createMock(AddonBootstrap::class);
$bootstrap->expects($this->once())->method('getRequiredDependencies')->willReturn([]);
$addon = new AddonProxy($bootstrap);
$addon = new AddonProxy('id', $bootstrap);
$addon->getRequiredDependencies();
}
@ -58,7 +67,7 @@ class AddonProxyTest extends TestCase
$bootstrap = $this->createMock(CombinedAddonBootstrapDependencyProvider::class);
$bootstrap->expects($this->once())->method('provideDependencyRules')->willReturn([]);
$addon = new AddonProxy($bootstrap);
$addon = new AddonProxy('id', $bootstrap);
$addon->getProvidedDependencyRules();
}
@ -68,7 +77,7 @@ class AddonProxyTest extends TestCase
$bootstrap = $this->createMock(AddonBootstrap::class);
$bootstrap->expects($this->once())->method('getSubscribedEvents')->willReturn(['foo' => 'bar']);
$addon = new AddonProxy($bootstrap);
$addon = new AddonProxy('id', $bootstrap);
$this->assertSame(
[
@ -86,7 +95,7 @@ class AddonProxyTest extends TestCase
$this->assertInstanceOf(AddonStartEvent::class, $event);
});
$addon = new AddonProxy($bootstrap);
$addon = new AddonProxy('id', $bootstrap);
$addon->initAddon([]);
}
@ -98,7 +107,7 @@ class AddonProxyTest extends TestCase
$this->assertInstanceOf(AddonStartEvent::class, $event);
});
$addon = new AddonProxy($bootstrap);
$addon = new AddonProxy('id', $bootstrap);
$addon->initAddon([]);
$addon->initAddon([]);
@ -115,7 +124,7 @@ class AddonProxyTest extends TestCase
$this->assertInstanceOf(LoggerInterface::class, $dependencies[LoggerInterface::class]);
});
$addon = new AddonProxy($bootstrap);
$addon = new AddonProxy('id', $bootstrap);
$addon->initAddon(
[LoggerInterface::class => $this->createStub(LoggerInterface::class)]
@ -127,7 +136,7 @@ class AddonProxyTest extends TestCase
$bootstrap = $this->createMock(CombinedAddonBootstrapInstallableAddon::class);
$bootstrap->expects($this->once())->method('install');
$addon = new AddonProxy($bootstrap);
$addon = new AddonProxy('id', $bootstrap);
$addon->initAddon([]);
$addon->installAddon();
@ -138,7 +147,7 @@ class AddonProxyTest extends TestCase
$bootstrap = $this->createMock(CombinedAddonBootstrapInstallableAddon::class);
$bootstrap->expects($this->once())->method('uninstall');
$addon = new AddonProxy($bootstrap);
$addon = new AddonProxy('id', $bootstrap);
$addon->initAddon([]);
$addon->uninstallAddon();

11
tests/Unit/Service/Addon/LegacyAddonProxyTest.php
View file

@ -16,7 +16,7 @@ use PHPUnit\Framework\TestCase;
class LegacyAddonProxyTest extends TestCase
{
public function testCreateWithNameAndPath(): void
public function testCreateWithIdAndPath(): void
{
$root = vfsStream::setup('addons', 0777, ['helloaddon' => []]);
@ -25,6 +25,15 @@ class LegacyAddonProxyTest extends TestCase
$this->assertInstanceOf(Addon::class, $addon);
}
public function testGetIdReturnsId(): void
{
$root = vfsStream::setup('addons', 0777, ['helloaddon' => []]);
$addon = new LegacyAddonProxy('helloaddon', $root->url());
$this->assertSame('helloaddon', $addon->getId());
}
public function testGetRequiredDependenciesReturnsEmptyArray(): void
{
$root = vfsStream::setup('addons', 0777, ['helloaddon' => []]);