Switch from yaml to php format services definition

Author: norkunas

.editorconfig

@@ -8,5 +8,18 @@ indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
 
-[*.{yml,yaml}]
+[.github/**/*.{yml,yaml}]
 indent_size = 2
+
+[*.{yml,yaml}]
+trim_trailing_whitespace = false
+
+[**.md]
+indent_size = unset
+indent_style = unset
+
+[*.json]
+insert_final_newline = false
+
+[*.{neon,neon.dist}]
+indent_style = tab

composer.json

@@ -74,9 +74,6 @@
     "symfony/var-exporter": "^5.4 || ^6.4 || ^7.0",
     "symfony/yaml": "^5.4 || ^6.4 || ^7.0"
   },
-  "conflict": {
-    "geocoder-php/nominatim-provider": "<5.0"
-  },
   "autoload": {
     "psr-4": {
       "Bazinga\\GeocoderBundle\\": "src/"
@@ -88,7 +85,7 @@
     }
   },
   "scripts": {
-    "test": "vendor/bin/simple-phpunit --testsuite main"
+    "test": "SYMFONY_DEPRECATIONS_HELPER=ignoreFile='./tests/baseline-ignore' vendor/bin/simple-phpunit --testsuite main"
   },
   "config": {
     "allow-plugins": {

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,53 @@
+<?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)
+        ->public();
+
+    $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()
+
+        ->set(ProviderAggregator::class)
+
+        ->set(FakeIpPlugin::class)
+            ->args([null, null, false])
+
+        ->set(GeocodeCommand::class)
+            ->args([
+                service(ProviderAggregator::class),
+            ])
+            ->tag('console.command')
+
+        ->set(AddressValidator::class)
+            ->args([
+                service(ProviderAggregator::class),
+            ])
+            ->tag('validator.constraint_validator')
+    ;
+};

config/services.php

@@ -24,7 +24,18 @@
 /**
  * @author Markus Bachmann <markus.bachmann@bachi.biz>
  */
-#[AsCommand(name: 'geocoder:geocode', description: 'Geocode an address or a ip address')]
+#[AsCommand(
+    name: 'geocoder:geocode',
+    description: 'Geocode an address or an IP address',
+    help: <<<'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
+)]
 class GeocodeCommand extends Command
 {
     private ProviderAggregator $geocoder;
@@ -43,16 +54,7 @@ protected function configure()
     {
         $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

config/services.yml

@@ -31,7 +31,7 @@
 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;
 
 /**
@@ -50,11 +50,11 @@ public function load(array $configs, ContainerBuilder $container)
         $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']) {

src/Command/GeocodeCommand.php

@@ -160,28 +160,6 @@ public function testBundleWithPluginsYml(): void
         self::assertInstanceOf(LoggerPlugin::class, $plugins[0]);
     }
 
-    public function testBundleWithPluginXml(): void
-    {
-        self::bootKernel(['config' => static function (TestKernel $kernel) {
-            $kernel->addTestConfig(__DIR__.'/config/framework.yml');
-
-            if ($kernel::VERSION_ID >= 60000) {
-                $kernel->addTestConfig(__DIR__.'/config/framework_sf6.yml');
-            }
-
-            $kernel->addTestConfig(__DIR__.'/config/service_plugin.xml');
-        }]);
-
-        $container = self::getContainer();
-
-        self::assertTrue($container->has('bazinga_geocoder.provider.acme'));
-        $service = $container->get('bazinga_geocoder.provider.acme');
-        self::assertInstanceOf(PluginProvider::class, $service);
-        $plugins = NSA::getProperty($service, 'plugins');
-        self::assertNotEmpty($plugins);
-        self::assertInstanceOf(LoggerPlugin::class, $plugins[0]);
-    }
-
     public function testBundleHasRegisteredDumpers(): void
     {
         self::bootKernel(['config' => static function (TestKernel $kernel) {