refactor!: No implicit dependencies (#160)

Issue: #151

docs/Shared/Upgrade/FromV6.md

@@ -0,0 +1 @@
+* [ ] Direct usages of `Container::getInstances()` were replaced by explicit constructor parameters. You may need to update your code accordingly (#151).

packages/core/UPGRADE.md

@@ -27,6 +27,18 @@ Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases)
 
 [//]: # (end: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
 
+# Upgrade from v6
+
+[include:file]: ../../docs/Shared/Upgrade/FromV6.md
+[//]: # (start: 6b55bf5daea407a4590344596d41efd8368a783e2666bfe431a88a5eeaff3a95)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+* [ ] Direct usages of `Container::getInstances()` were replaced by explicit constructor parameters. You may need to update your code accordingly (#151).
+
+[//]: # (end: 6b55bf5daea407a4590344596d41efd8368a783e2666bfe431a88a5eeaff3a95)
+
+* [ ] `\LastDragon_ru\LaraASP\Core\Provider\WithRoutes::bootRoutes()` requires settings.
+
 # Upgrade from v5
 
 [include:file]: ../../docs/Shared/Upgrade/FromV5.md

packages/core/src/Helpers/Translator.php

@@ -16,12 +16,15 @@
 abstract class Translator {
     public function __construct(
         protected TranslatorContract $translator,
-        protected string $package,
-        protected string|null $group = 'messages',
     ) {
         // empty
     }
 
+    /**
+     * Should return the name of the package.
+     */
+    abstract protected function getName(): string;
+
     /**
      * @param list<string>|string  $key
      * @param array<string, mixed> $replace
@@ -59,9 +62,7 @@ public function setLocale(string $locale): static {
     }
 
     protected function key(string $key): string {
-        return $this->group
-            ? "{$this->package}::{$this->group}.{$key}"
-            : "{$this->package}::{$key}";
+        return "{$this->getName()}::messages.{$key}";
     }
 
     /**

packages/core/src/Helpers/TranslatorTest.php

@@ -2,12 +2,12 @@
 
 namespace LastDragon_ru\LaraASP\Core\Helpers;
 
-use Illuminate\Container\Container;
 use Illuminate\Contracts\Translation\Translator;
 use LastDragon_ru\LaraASP\Core\Helpers\Translator as PackageTranslator;
 use LastDragon_ru\LaraASP\Core\Package;
 use LastDragon_ru\LaraASP\Core\Testing\Package\TestCase;
 use LastDragon_ru\LaraASP\Testing\Utils\WithTranslations;
+use Override;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 
@@ -36,9 +36,12 @@ public function testChoice(
     ): void {
         $this->setTranslations($translations);
 
-        $implementation = Container::getInstance()->make(Translator::class);
-        $translator     = new class($implementation, Package::Name, null) extends PackageTranslator {
-            // empty
+        $implementation = $this->app()->make(Translator::class);
+        $translator     = new class($implementation) extends PackageTranslator {
+            #[Override]
+            protected function getName(): string {
+                return Package::Name;
+            }
         };
 
         self::assertEquals($expected, $translator->choice($key, $number, $replace, $locale));
@@ -59,9 +62,12 @@ public function testGet(
     ): void {
         $this->setTranslations($translations);
 
-        $implementation = Container::getInstance()->make(Translator::class);
-        $translator     = new class($implementation, Package::Name, null) extends PackageTranslator {
-            // empty
+        $implementation = $this->app()->make(Translator::class);
+        $translator     = new class($implementation) extends PackageTranslator {
+            #[Override]
+            protected function getName(): string {
+                return Package::Name;
+            }
         };
 
         self::assertEquals($expected, $translator->get($key, $replace, $locale));
@@ -89,7 +95,7 @@ public static function dataProviderGet(): array {
                 static function (TestCase $test, string $currentLocale, string $fallbackLocale): array {
                     return [
                         $currentLocale => [
-                            Package::Name.'::should.be.translated' => 'translated :value',
+                            Package::Name.'::messages.should.be.translated' => 'translated :value',
                         ],
                     ];
                 },
@@ -104,7 +110,7 @@ static function (TestCase $test, string $currentLocale, string $fallbackLocale):
                 static function (TestCase $test, string $currentLocale, string $fallbackLocale): array {
                     return [
                         $currentLocale => [
-                            Package::Name.'::should.be.translated' => 'translated',
+                            Package::Name.'::messages.should.be.translated' => 'translated',
                         ],
                     ];
                 },
@@ -119,7 +125,7 @@ static function (TestCase $test, string $currentLocale, string $fallbackLocale):
                 static function (TestCase $test, string $currentLocale, string $fallbackLocale): array {
                     return [
                         'unk' => [
-                            Package::Name.'::should.be.translated' => 'translated :value',
+                            Package::Name.'::messages.should.be.translated' => 'translated :value',
                         ],
                     ];
                 },
@@ -152,7 +158,7 @@ public static function dataProviderChoice(): array {
                 static function (TestCase $test, string $currentLocale, string $fallbackLocale): array {
                     return [
                         $currentLocale => [
-                            Package::Name.'::should.be.translated' => '{1} one |[2,*] translated :value',
+                            Package::Name.'::messages.should.be.translated' => '{1} one |[2,*] translated :value',
                         ],
                     ];
                 },
@@ -168,7 +174,7 @@ static function (TestCase $test, string $currentLocale, string $fallbackLocale):
                 static function (TestCase $test, string $currentLocale, string $fallbackLocale): array {
                     return [
                         $currentLocale => [
-                            Package::Name.'::should.be.translated' => '{1} one |[2,*] translated :value',
+                            Package::Name.'::messages.should.be.translated' => '{1} one |[2,*] translated :value',
                         ],
                     ];
                 },
@@ -184,7 +190,7 @@ static function (TestCase $test, string $currentLocale, string $fallbackLocale):
                 static function (TestCase $test, string $currentLocale, string $fallbackLocale): array {
                     return [
                         'unk' => [
-                            Package::Name.'::should.be.translated' => '{1} one |[2,*] translated :value',
+                            Package::Name.'::messages.should.be.translated' => '{1} one |[2,*] translated :value',
                         ],
                     ];
                 },

packages/core/src/Helpers/Viewer.php

@@ -10,21 +10,21 @@
  */
 abstract class Viewer {
     public function __construct(
-        protected readonly Translator $translator,
         protected readonly ViewFactoryContract $factory,
-        protected readonly string $package,
     ) {
         // empty
     }
 
+    /**
+     * Should return the name of the package.
+     */
+    abstract protected function getName(): string;
+
     /**
      * @param array<string, mixed> $data
      */
     public function get(string $view, array $data = []): ViewContract {
-        return $this->factory->make(
-            "{$this->package}::{$view}",
-            $this->getDefaultData() + $data,
-        );
+        return $this->factory->make("{$this->getName()}::{$view}", $data);
     }
 
     /**
@@ -33,13 +33,4 @@ public function get(string $view, array $data = []): ViewContract {
     public function render(string $view, array $data = []): string {
         return $this->get($view, $data)->render();
     }
-
-    /**
-     * @return array<string, mixed>
-     */
-    protected function getDefaultData(): array {
-        return [
-            'translator' => $this->translator,
-        ];
-    }
 }

packages/core/src/Helpers/ViewerTest.php

@@ -6,6 +6,7 @@
 use Illuminate\Contracts\View\View as ViewContract;
 use LastDragon_ru\LaraASP\Core\Testing\Package\TestCase;
 use Mockery;
+use Override;
 use PHPUnit\Framework\Attributes\CoversClass;
 
 /**
@@ -14,40 +15,48 @@
 #[CoversClass(Viewer::class)]
 final class ViewerTest extends TestCase {
     public function testGet(): void {
-        $view       = 'view';
-        $data       = ['a' => 123];
-        $package    = 'package';
-        $translator = Mockery::mock(Translator::class);
-        $factory    = Mockery::mock(ViewFactory::class);
+        $view    = 'view';
+        $data    = ['a' => 123];
+        $package = 'package';
+        $factory = Mockery::mock(ViewFactory::class);
         $factory
             ->shouldReceive('make')
-            ->with("{$package}::{$view}", ['translator' => $translator] + $data)
+            ->with("{$package}::{$view}", $data)
             ->once()
             ->andReturn(
                 Mockery::mock(ViewContract::class),
             );
 
-        $viewer = new class($translator, $factory, $package) extends Viewer {
-            // empty
+        $viewer = new class($factory, $package) extends Viewer {
+            public function __construct(
+                ViewFactory $factory,
+                private readonly string $package,
+            ) {
+                parent::__construct($factory);
+            }
+
+            #[Override]
+            protected function getName(): string {
+                return $this->package;
+            }
         };
 
         $viewer->get($view, $data);
     }
 
     public function testRender(): void {
-        $view       = 'view';
-        $data       = ['a' => 123];
-        $package    = 'package';
-        $content    = 'content';
-        $translator = Mockery::mock(Translator::class);
-        $factory    = Mockery::mock(ViewFactory::class);
-        $template   = Mockery::mock(ViewContract::class);
+        $view     = 'view';
+        $data     = ['a' => 123];
+        $package  = 'package';
+        $content  = 'content';
+        $factory  = Mockery::mock(ViewFactory::class);
+        $template = Mockery::mock(ViewContract::class);
         $template
             ->shouldReceive('render')
             ->once()
             ->andReturn($content);
 
-        $viewer = Mockery::mock(Viewer::class, [$translator, $factory, $package]);
+        $viewer = Mockery::mock(Viewer::class, [$factory, $package]);
         $viewer->makePartial();
         $viewer
             ->shouldReceive('get')

packages/core/src/Provider/Helper.php

@@ -2,15 +2,11 @@
 
 namespace LastDragon_ru\LaraASP\Core\Provider;
 
-use Illuminate\Support\ServiceProvider;
 use ReflectionClass;
 
 use function dirname;
 use function ltrim;
 
-/**
- * @mixin ServiceProvider
- */
 trait Helper {
     /**
      * Should return the name of the package.

packages/core/src/Provider/WithConfig.php

@@ -2,14 +2,13 @@
 
 namespace LastDragon_ru\LaraASP\Core\Provider;
 
-use Illuminate\Container\Container;
 use Illuminate\Contracts\Config\Repository;
 use Illuminate\Contracts\Foundation\CachesConfiguration;
 use Illuminate\Support\ServiceProvider;
 use LastDragon_ru\LaraASP\Core\Utils\ConfigMerger;
 
 /**
- * @mixin ServiceProvider
+ * @phpstan-require-extends ServiceProvider
  */
 trait WithConfig {
     use Helper;
@@ -26,7 +25,7 @@ protected function bootConfig(): void {
 
     protected function loadConfigFrom(string $path, string $key): void {
         if (!($this->app instanceof CachesConfiguration && $this->app->configurationIsCached())) {
-            $repository = Container::getInstance()->make(Repository::class);
+            $repository = $this->app->make(Repository::class);
             $merger     = new ConfigMerger();
             $target     = (array) require $path;
             $current    = (array) $repository->get($key, []);

packages/core/src/Provider/WithRoutes.php

@@ -2,15 +2,41 @@
 
 namespace LastDragon_ru\LaraASP\Core\Provider;
 
+use Closure;
+use Illuminate\Contracts\Foundation\CachesRoutes;
+use Illuminate\Contracts\Routing\Registrar;
 use Illuminate\Support\ServiceProvider;
 
 /**
- * @mixin ServiceProvider
+ * @phpstan-require-extends ServiceProvider
  */
 trait WithRoutes {
     use Helper;
 
-    protected function bootRoutes(): void {
-        $this->loadRoutesFrom($this->getPath('../defaults/routes.php'));
+    /**
+     * @param Closure(): array{enabled: bool, attributes: array<string, mixed>} $settings
+     */
+    protected function bootRoutes(Closure $settings): void {
+        // Cached?
+        if ($this->app instanceof CachesRoutes && $this->app->routesAreCached()) {
+            return;
+        }
+
+        // Load (config may be incomplete until boot)
+        $this->booted(function () use ($settings): void {
+            // Enabled?
+            $settings = $settings();
+
+            if (!$settings['enabled'] || !$this->app->bound(Registrar::class)) {
+                return;
+            }
+
+            // Add
+            $path      = $this->getPath('../defaults/routes.php');
+            $routes    = require $path;
+            $registrar = $this->app->make(Registrar::class);
+
+            $registrar->group($settings['attributes'], $routes);
+        });
     }
 }

packages/core/src/Provider/WithSchedule.php

@@ -3,12 +3,12 @@
 namespace LastDragon_ru\LaraASP\Core\Provider;
 
 use Illuminate\Console\Scheduling\Schedule;
-use Illuminate\Container\Container;
+use Illuminate\Contracts\Container\Container;
 use Illuminate\Support\ServiceProvider;
 use LastDragon_ru\LaraASP\Core\Utils\Scheduler;
 
 /**
- * @mixin ServiceProvider
+ * @phpstan-require-extends ServiceProvider
  */
 trait WithSchedule {
     /**
@@ -21,8 +21,8 @@ protected function bootSchedule(string ...$jobs): void {
 
         $this->callAfterResolving(
             Schedule::class,
-            static function (Schedule $schedule) use ($jobs): void {
-                $scheduler = Container::getInstance()->make(Scheduler::class);
+            static function (Schedule $schedule, Container $container) use ($jobs): void {
+                $scheduler = $container->make(Scheduler::class);
 
                 foreach ($jobs as $job) {
                     $scheduler->register($schedule, $job);