Validate services

Author: Chi-teck

src/Helper/Drupal/ServiceInfo.php

@@ -74,7 +74,7 @@ public function getServiceClasses(): array {
   /**
    * Gets service definition.
    *
-   * @psalm-return array<string, string>|null
+   * @psalm-return array{class: class-string}|null
    */
   public function getServiceDefinition(string $service_id): ?array {
     $serialized_definitions = $this->getSerializedDefinitions();
@@ -91,6 +91,7 @@ public function getServiceDefinition(string $service_id): ?array {
    * @todo Add extended description.
    */
   public function getServiceMeta(string $service_id): array {
+    /** @psalm-suppress UnresolvableInclude */
     $dumped_meta = require Application::ROOT . '/resources/service-meta.php';
     // Most used core services are described statically.
     if (\array_key_exists($service_id, $dumped_meta)) {
@@ -99,10 +100,11 @@ public function getServiceMeta(string $service_id): array {
     // For services from contrib and custom modules we build meta on demand.
     elseif ($definition = $this->getServiceDefinition($service_id)) {
       $class = $definition['class'];
+      /** @psalm-var class-string $interface */
       $interface = $class . 'Interface';
       $meta = [
         'name' => Utils::camelize($service_id, FALSE),
-        'type' => \is_subclass_of($class, $interface) ? $interface : $class
+        'type' => \is_subclass_of($class, $interface) ? $interface : $class,
       ];
     }
     else {
@@ -115,6 +117,7 @@ public function getServiceMeta(string $service_id): array {
     $type_parts = \explode('\\', $meta['type']);
     $meta['short_type'] = \end($type_parts);
 
+    \ksort($meta);
     return $meta;
   }
 

src/InputOutput/Interviewer.php

@@ -14,6 +14,7 @@
 use DrupalCodeGenerator\Validator\Required;
 use DrupalCodeGenerator\Validator\RequiredClassName;
 use DrupalCodeGenerator\Validator\RequiredMachineName;
+use DrupalCodeGenerator\Validator\ServiceExists;
 use DrupalCodeGenerator\Validator\ServiceName;
 use Symfony\Component\Console\Question\ChoiceQuestion;
 use Symfony\Component\Console\Question\Question;
@@ -173,9 +174,13 @@ public function askServices(bool $default = TRUE, array $forced_services = []):
 
     if ($this->io->confirm('Would you like to inject dependencies?', $default)) {
       $service_ids = $this->serviceInfo->getServicesIds();
+      $validator = new Chained(
+        new Optional(new ServiceName()),
+        new Optional(new ServiceExists($this->serviceInfo)),
+      );
       while (TRUE) {
         $question = new Question('Type the service name or use arrows up/down. Press enter to continue');
-        $question->setValidator(new Optional(new ServiceName()));
+        $question->setValidator($validator);
         $question->setAutocompleterValues($service_ids);
         $service = $this->io->askQuestion($question);
         if (!$service) {
@@ -187,7 +192,7 @@ public function askServices(bool $default = TRUE, array $forced_services = []):
 
     $definitions = [];
     foreach (\array_unique($services) as $service_id) {
-      $definitions[$service_id] = $this->getServiceDefinition($service_id);
+      $definitions[$service_id] = $this->serviceInfo->getServiceMeta($service_id);
     }
     return $definitions;
   }

templates/_lib/di.twig

@@ -12,7 +12,7 @@ use {{ service.type }};
 
 {% macro signature(services) %}
   {% for service in services %}
-    private readonly {{ service.short_type }} ${{ service.name|camelize(false) }},{{ loop.last ? '' : constant('PHP_EOL') }}
+    private readonly {{ service.short_type }} ${{ service.name }},{{ loop.last ? '' : constant('PHP_EOL') }}
   {%- endfor %}
 {% endmacro %}
 

tests/functional/Helper/Drupal/ServiceInfoTest.php

@@ -169,8 +169,8 @@ public function testGetServiceMeta(string $id, string $name, string $type, strin
 
     $expected = [
       'name' => $name,
-      'type' => $type,
       'short_type' => $short_type,
+      'type' => $type,
     ];
     self::assertSame($expected, $meta);
   }
@@ -189,10 +189,10 @@ public function serviceMetaProvider(): array {
     ];
 
     $data[] = [
-      'logger.channel.user',
-      'loggerChannelUser',
-      'Drupal\Core\Logger\LoggerChannelInterface',
-      'LoggerChannelInterface',
+      'views.views_data_helper',
+      'viewsViewsDataHelper',
+      'Drupal\views\ViewsDataHelper',
+      'ViewsDataHelper',
       NULL,
     ];
 
@@ -201,7 +201,7 @@ public function serviceMetaProvider(): array {
       'render_placeholder_generator',
       'Drupal\Core\EventSubscriber\AuthenticationSubscriber',
       'AuthenticationSubscriber',
-      new \LogicException('Service "not.exists" does not exist.')
+      new \LogicException('Service "not.exists" does not exist.'),
     ];
 
     return $data;

tests/functional/InputOutput/InterviewerTest.php

@@ -504,10 +504,9 @@ public function testAskServices(): void {
     $answer = $interviewer->askServices();
     $expected_answer = [
       'entity_type.manager' => [
-        'type' => 'Drupal\Core\Entity\EntityTypeManagerInterface',
-        'name' => 'entity_type_manager',
-        'description' => 'The entity type manager.',
+        'name' => 'entityTypeManager',
         'short_type' => 'EntityTypeManagerInterface',
+        'type' => 'Drupal\Core\Entity\EntityTypeManagerInterface',
       ],
     ];
     self::assertSame($expected_answer, $answer);
@@ -538,22 +537,16 @@ public function testAskServices(): void {
     // -- Non-existing service..
     $this->setStream("\nmissing\n\n");
     $answer = $interviewer->askServices();
-    $expected_answer = [
-      'missing' => [
-        'name' => 'missing',
-        'type' => 'Drupal\example\ExampleInterface',
-        'description' => 'The missing service.',
-        'short_type' => 'ExampleInterface',
-      ],
-    ];
+    $expected_answer = [];
     self::assertSame($expected_answer, $answer);
 
     $expected_output = <<< 'TXT'
 
        Would you like to inject dependencies? [Yes]:
        ➤ 
        Type the service name or use arrows up/down. Press enter to continue:
-       ➤ 
+       ➤  Service does not exists.
+
        Type the service name or use arrows up/down. Press enter to continue:
        ➤ 
       TXT;