Modernize

Author: norkunas

composer.json

@@ -14,18 +14,17 @@
     }
   ],
   "require": {
-    "php": "^7.4 || ^8.0",
-    "geocoder-php/plugin": "^1.5",
+    "php": "^8.1",
+    "geocoder-php/plugin": "^1.6",
     "php-http/curl-client": "^2.3",
-    "php-http/discovery": "^1.14",
-    "symfony/console": "^5.4 || ^6.4 || ^7.0",
-    "symfony/framework-bundle": "^5.4 || ^6.4 || ^7.0",
-    "symfony/options-resolver": "^5.4 || ^6.4 || ^7.0",
+    "php-http/discovery": "^1.20",
+    "symfony/console": "^6.4 || ^7.0",
+    "symfony/framework-bundle": "^6.4 || ^7.0",
+    "symfony/options-resolver": "^6.4 || ^7.0",
     "willdurand/geocoder": "^4.6|^5.0"
   },
   "require-dev": {
-    "doctrine/annotations": "^1.11.1 || ^2.0",
-    "doctrine/doctrine-bundle": "^2.3",
+    "doctrine/doctrine-bundle": "^2.3 || ^3.0",
     "doctrine/orm": "^2.8 || ^3.0",
     "fakerphp/faker": "^1.20",
     "friendsofphp/php-cs-fixer": "^3.13",
@@ -69,6 +68,8 @@
     "psr/simple-cache": "^1.0 || ^2.0",
     "symfony/cache": "^5.4 || ^6.4 || ^7.0",
     "symfony/config": "^5.4 || ^6.4 || ^7.0",
+    "symfony/dependency-injection": "^5.4 || ^6.4 || ^7.0",
+    "symfony/doctrine-bridge": "^5.4 || ^6.4 || ^7.0",
     "symfony/phpunit-bridge": "^5.4 || ^6.4 || ^7.0",
     "symfony/validator": "^5.4 || ^6.4 || ^7.0",
     "symfony/var-exporter": "^5.4 || ^6.4 || ^7.0",

config/profiling.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+use Bazinga\GeocoderBundle\DataCollector\GeocoderDataCollector;
+
+return static function (ContainerConfigurator $container) {
+    $services = $container->services();
+
+    $services->set(GeocoderDataCollector::class)
+        ->tag('data_collector', ['template' => '@BazingaGeocoder/Collector/geocoder.html.twig', 'id' => 'geocoder']);
+};

config/profiling.yml

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+use Bazinga\GeocoderBundle\Command\GeocodeCommand;
+use Bazinga\GeocoderBundle\Plugin\FakeIpPlugin;
+use Bazinga\GeocoderBundle\Validator\Constraint\AddressValidator;
+use Geocoder\Dumper\Dumper;
+use Geocoder\Dumper\GeoArray;
+use Geocoder\Dumper\GeoJson;
+use Geocoder\Dumper\Gpx;
+use Geocoder\Dumper\Kml;
+use Geocoder\Dumper\Wkb;
+use Geocoder\Dumper\Wkt;
+use Geocoder\ProviderAggregator;
+
+return static function (ContainerConfigurator $container) {
+    $services = $container->services();
+    $services->instanceof(Dumper::class)
+        ->tag('bazinga_geocoder.dumper');
+
+    $services
+        ->set(GeoArray::class)
+        ->set(GeoJson::class)
+        ->set(Gpx::class)
+        ->set(Kml::class)
+        ->set(Wkb::class)
+        ->set(Wkt::class)
+
+        ->load('Bazinga\\GeocoderBundle\\ProviderFactory\\', __DIR__ . '/../src/ProviderFactory')
+            ->autowire()
+            ->autoconfigure()
+            ->private()
+
+        ->set(ProviderAggregator::class)
+
+        ->set(FakeIpPlugin::class)
+            ->args([
+                '$useFaker' => false,
+            ])
+
+        ->set(GeocodeCommand::class)
+            ->args([
+                service(ProviderAggregator::class),
+            ])
+            ->tag('console.command', ['command' => 'geocoder:geocode', 'description' => 'Geocode an address or a ip address'])
+
+        ->set(AddressValidator::class)
+            ->args([
+                service(ProviderAggregator::class),
+            ])
+            ->tag('validator.constraint_validator')
+    ;
+};

config/services.php

@@ -10,7 +10,7 @@ First of all, update your entity:
 
 ```php
 
-use Bazinga\GeocoderBundle\Mapping\Annotations as Geocoder;
+use Bazinga\GeocoderBundle\Mapping\Attributes as Geocoder;
 
 /**
  * @Geocoder\Geocodeable
@@ -38,7 +38,7 @@ Instead of annotating a property, you can also annotate a getter:
 
 ```php
 
-use Bazinga\GeocoderBundle\Mapping\Annotations as Geocoder;
+use Bazinga\GeocoderBundle\Mapping\Attributes as Geocoder;
 
 /**
  * @Geocoder\Geocodeable
@@ -103,7 +103,7 @@ If you are using PHP 8, you can use [Attributes](https://www.php.net/manual/en/l
 
 ```php
 
-use Bazinga\GeocoderBundle\Mapping\Annotations as Geocoder;
+use Bazinga\GeocoderBundle\Mapping\Attributes as Geocoder;
 
 #[Geocoder\Geocodeable()]
 class User

config/services.yml

@@ -21,12 +21,9 @@
 /**
  * @author William Durand <william.durand1@gmail.com>
  */
-class BazingaGeocoderBundle extends Bundle
+final class BazingaGeocoderBundle extends Bundle
 {
-    /**
-     * @return void
-     */
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 

doc/doctrine.md

@@ -24,35 +24,31 @@
 /**
  * @author Markus Bachmann <markus.bachmann@bachi.biz>
  */
-#[AsCommand(name: 'geocoder:geocode', description: 'Geocode an address or a ip address')]
-class GeocodeCommand extends Command
-{
-    private ProviderAggregator $geocoder;
+#[AsCommand(
+    name: 'geocoder:geocode',
+    description: 'Geocode an address or a ip address',
+    help: <<<'HELP'
+The <info>geocoder:geocoder</info> command will fetch the latitude
+and longitude from the given address.
 
-    public function __construct(ProviderAggregator $geocoder)
-    {
-        $this->geocoder = $geocoder;
+You can force a provider with the "provider" option.
 
+<info>php bin/console geocoder:geocoder "Eiffel Tower" --provider=yahoo</info>
+HELP
+)]
+final class GeocodeCommand extends Command
+{
+    public function __construct(
+        private readonly ProviderAggregator $geocoder
+    ) {
         parent::__construct();
     }
 
-    /**
-     * @return void
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->addArgument('address', InputArgument::REQUIRED, 'The address')
-            ->addOption('provider', null, InputOption::VALUE_OPTIONAL)
-            ->setHelp(<<<'HELP'
-The <info>geocoder:geocoder</info> command will fetch the latitude
-and longitude from the given address.
-
-You can force a provider with the "provider" option.
-
-<info>php bin/console geocoder:geocoder "Eiffel Tower" --provider=yahoo</info>
-HELP
-            );
+            ->addOption('provider', null, InputOption::VALUE_OPTIONAL);
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int

src/BazingaGeocoderBundle.php

@@ -21,7 +21,7 @@
 /**
  * @author Michal Dabrowski <dabrowski@brillante.pl>
  */
-class GeocoderDataCollector extends DataCollector
+final class GeocoderDataCollector extends DataCollector
 {
     /**
      * @var ProfilingPlugin[]
@@ -34,22 +34,16 @@ public function __construct()
         $this->data['providers'] = [];
     }
 
-    /**
-     * @return void
-     */
-    public function reset()
+    public function reset(): void
     {
         $this->instances = [];
         $this->data['queries'] = [];
         $this->data['providers'] = [];
     }
 
-    /**
-     * @return void
-     */
-    public function collect(Request $request, Response $response, ?\Throwable $exception = null)
+    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;
         }
@@ -106,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/Command/GeocodeCommand.php

@@ -31,30 +31,28 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 use Symfony\Component\DependencyInjection\Extension\Extension;
-use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
 use Symfony\Component\DependencyInjection\Reference;
 
 /**
  * @author William Durand <william.durand1@gmail.com>.
  */
-class BazingaGeocoderExtension extends Extension
+final class BazingaGeocoderExtension extends Extension
 {
     /**
      * @param array<mixed, mixed> $configs
-     *
-     * @return void
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $processor = new Processor();
         $configuration = $this->getConfiguration($configs, $container);
         $config = $processor->processConfiguration($configuration, $configs);
 
-        $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../../config'));
-        $loader->load('services.yml');
+        $loader = new PhpFileLoader($container, new FileLocator(__DIR__.'/../../config'));
+        $loader->load('services.php');
 
         if (true === $config['profiling']['enabled']) {
-            $loader->load('profiling.yml');
+            $loader->load('profiling.php');
         }
 
         if ($config['fake_ip']['enabled']) {
@@ -78,10 +76,8 @@ public function load(array $configs, ContainerBuilder $container)
 
     /**
      * @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 {
@@ -93,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']);