Merge pull request geocoder-php#390 from norkunas/final

Make classes final and add some types

Author: norkunas

phpstan-baseline.php

@@ -95,7 +95,7 @@
 ];
 $ignoreErrors[] = [
     // identifier: argument.type
-    'message' => '#^Parameter \\#1 \\$factoryServiceId of static method Bazinga\\\\GeocoderBundle\\\\DependencyInjection\\\\Compiler\\\\FactoryValidatorPass\\:\\:addFactoryServiceId\\(\\) expects string, mixed given\\.$#',
+    'message' => '#^Parameter \\#1 \\$factoryServiceId of static method Bazinga\\\\GeocoderBundle\\\\DependencyInjection\\\\Compiler\\\\FactoryValidatorPass\\:\\:addFactoryServiceId\\(\\) expects non\\-empty\\-string, mixed given\\.$#',
     'count' => 1,
     'path' => __DIR__.'/src/DependencyInjection/BazingaGeocoderExtension.php',
 ];
@@ -131,7 +131,7 @@
 ];
 $ignoreErrors[] = [
     // identifier: argument.type
-    'message' => '#^Parameter \\#2 \\$config of method Bazinga\\\\GeocoderBundle\\\\DependencyInjection\\\\BazingaGeocoderExtension\\:\\:configureProviderPlugins\\(\\) expects array\\<int\\|string, mixed\\>, mixed given\\.$#',
+    'message' => '#^Parameter \\#2 \\$config of method Bazinga\\\\GeocoderBundle\\\\DependencyInjection\\\\BazingaGeocoderExtension\\:\\:configureProviderPlugins\\(\\) expects array, mixed given\\.$#',
     'count' => 1,
     'path' => __DIR__.'/src/DependencyInjection/BazingaGeocoderExtension.php',
 ];

src/BazingaGeocoderBundle.php

@@ -21,11 +21,8 @@
 /**
  * @author William Durand <[email protected]>
  */
-class BazingaGeocoderBundle extends Bundle
+final class BazingaGeocoderBundle extends Bundle
 {
-    /**
-     * @return void
-     */
     public function build(ContainerBuilder $container): void
     {
         parent::build($container);

src/Command/GeocodeCommand.php

@@ -24,15 +24,15 @@
 /**
  * @author Markus Bachmann <[email protected]>
  */
-#[AsCommand(name: 'geocoder:geocode', description: 'Geocode an address or an IP address')]
-class GeocodeCommand extends Command
+#[AsCommand(
+    name: 'geocoder:geocode',
+    description: 'Geocode an address or an IP address',
+)]
+final class GeocodeCommand extends Command
 {
-    private ProviderAggregator $geocoder;
-
-    public function __construct(ProviderAggregator $geocoder)
-    {
-        $this->geocoder = $geocoder;
-
+    public function __construct(
+        private readonly ProviderAggregator $geocoder,
+    ) {
         parent::__construct();
     }
 
@@ -48,8 +48,7 @@ protected function configure(): void
 You can force a provider with the "provider" option.
 
 <info>php bin/console geocoder:geocoder "Eiffel Tower" --provider=yahoo</info>
-HELP
-            );
+HELP);
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int

src/DataCollector/GeocoderDataCollector.php

@@ -21,7 +21,7 @@
 /**
  * @author Michal Dabrowski <[email protected]>
  */
-class GeocoderDataCollector extends DataCollector
+final class GeocoderDataCollector extends DataCollector
 {
     /**
      * @var ProfilingPlugin[]
@@ -43,7 +43,7 @@ public function reset(): void
 
     public function collect(Request $request, Response $response, ?\Throwable $exception = null): void
     {
-        if (!empty($this->data['queries'])) {
+        if ([] !== $this->data['queries']) {
             // To avoid collection more that once.
             return;
         }
@@ -100,10 +100,7 @@ public function getProviderQueries(string $provider): array
         });
     }
 
-    /**
-     * @return void
-     */
-    public function addInstance(ProfilingPlugin $instance)
+    public function addInstance(ProfilingPlugin $instance): void
     {
         $this->instances[] = $instance;
         $this->data['providers'][] = $instance->getName();

src/DependencyInjection/BazingaGeocoderExtension.php

@@ -76,10 +76,8 @@ public function load(array $configs, ContainerBuilder $container): void
 
     /**
      * @param array<mixed, mixed> $config
-     *
-     * @return void
      */
-    private function loadProviders(ContainerBuilder $container, array $config)
+    private function loadProviders(ContainerBuilder $container, array $config): void
     {
         foreach ($config['providers'] as $providerName => $providerConfig) {
             try {
@@ -91,7 +89,7 @@ private function loadProviders(ContainerBuilder $container, array $config)
                 // See if any option has a service reference
                 $providerConfig['options'] = $this->findReferences($providerConfig['options']);
                 $factoryClass::validate($providerConfig['options'], $providerName);
-            } catch (ServiceNotFoundException $e) {
+            } catch (ServiceNotFoundException) {
                 // Assert: We are using a custom factory. If invalid config, it will be caught in FactoryValidatorPass
                 $providerConfig['options'] = $this->findReferences($providerConfig['options']);
                 FactoryValidatorPass::addFactoryServiceId($providerConfig['factory']);
@@ -118,9 +116,9 @@ private function loadProviders(ContainerBuilder $container, array $config)
     /**
      * Configure plugins for a client.
      *
-     * @param array<mixed, mixed> $config
+     * @param array<mixed> $config
      *
-     * @return Reference[]
+     * @return list<Reference>
      */
     public function configureProviderPlugins(ContainerBuilder $container, array $config, string $providerServiceId): array
     {

src/DependencyInjection/Compiler/FactoryValidatorPass.php

@@ -24,9 +24,9 @@
 class FactoryValidatorPass implements CompilerPassInterface
 {
     /**
-     * @var string[]
+     * @var list<non-empty-string>
      */
-    private static $factoryServiceIds = [];
+    private static array $factoryServiceIds = [];
 
     public function process(ContainerBuilder $container): void
     {
@@ -38,11 +38,9 @@ public function process(ContainerBuilder $container): void
     }
 
     /**
-     * @param string $factoryServiceId
-     *
-     * @return void
+     * @param non-empty-string $factoryServiceId
      */
-    public static function addFactoryServiceId($factoryServiceId)
+    public static function addFactoryServiceId(string $factoryServiceId): void
     {
         self::$factoryServiceIds[] = $factoryServiceId;
     }

src/DependencyInjection/Configuration.php

@@ -19,13 +19,11 @@
 /**
  * @author William Durand <[email protected]>
  */
-class Configuration implements ConfigurationInterface
+final class Configuration implements ConfigurationInterface
 {
-    private bool $debug;
-
-    public function __construct(bool $debug)
-    {
-        $this->debug = $debug;
+    public function __construct(
+        private readonly bool $debug,
+    ) {
     }
 
     /**

src/Doctrine/ORM/GeocoderListener.php

@@ -24,7 +24,7 @@
 /**
  * @author Markus Bachmann <[email protected]>
  */
-class GeocoderListener implements EventSubscriber
+final class GeocoderListener implements EventSubscriber
 {
     public function __construct(
         private readonly Provider $geocoder,

src/Plugin/FakeIpPlugin.php

@@ -24,17 +24,15 @@
  *
  * @author Tobias Nyholm <[email protected]>
  */
-class FakeIpPlugin implements Plugin
+final class FakeIpPlugin implements Plugin
 {
-    private ?string $needle;
-    private ?string $replacement;
     private ?Generator $faker = null;
 
-    public function __construct(?string $needle, ?string $replacement = null, bool $useFaker = false)
-    {
-        $this->needle = $needle;
-        $this->replacement = $replacement;
-
+    public function __construct(
+        private readonly ?string $needle,
+        private readonly ?string $replacement = null,
+        bool $useFaker = false,
+    ) {
         if ($useFaker) {
             $this->faker = new Generator();
             $this->faker->addProvider(new Internet($this->faker));

src/Plugin/ProfilingPlugin.php

@@ -24,27 +24,22 @@
 /**
  * @author Tobias Nyholm <[email protected]>
  */
-class ProfilingPlugin implements Plugin
+final class ProfilingPlugin implements Plugin
 {
     /**
      * @var list<array{query: Query, queryString: string, duration: float, providerName: string, result: mixed, resultCount: int}>
      */
-    private $queries = [];
+    private array $queries = [];
 
     /**
-     * @var string service id of the provider
+     * @param non-empty-string $name service id of the provider
      */
-    private $name;
-
-    public function __construct(string $name)
-    {
-        $this->name = $name;
+    public function __construct(
+        private readonly string $name,
+    ) {
     }
 
-    /**
-     * @return Promise
-     */
-    public function handleQuery(Query $query, callable $next, callable $first)
+    public function handleQuery(Query $query, callable $next, callable $first): Promise
     {
         $startTime = microtime(true);
 
@@ -61,12 +56,7 @@ public function handleQuery(Query $query, callable $next, callable $first)
         });
     }
 
-    /**
-     * @param mixed $result
-     *
-     * @return void
-     */
-    private function logQuery(Query $query, float $duration, $result = null)
+    private function logQuery(Query $query, float $duration, mixed $result = null): void
     {
         if ($query instanceof GeocodeQuery) {
             $queryString = $query->getText();
@@ -94,6 +84,9 @@ public function getQueries(): array
         return $this->queries;
     }
 
+    /**
+     * @return non-empty-string
+     */
     public function getName(): string
     {
         return $this->name;