From 070f8cc2dcee7e7e2a53a4534aaeb87df9268d9e Mon Sep 17 00:00:00 2001 From: Andreas Braun Date: Wed, 6 Dec 2023 15:02:37 +0100 Subject: [PATCH] Use snake_case for configuration options --- README.md | 6 ++--- src/DependencyInjection/Configuration.php | 4 ++-- src/DependencyInjection/MongoDBExtension.php | 4 ++-- .../DependencyInjection/ConfigurationTest.php | 24 +++++++++---------- .../MongoDBExtensionTest.php | 4 ++-- 5 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 27e9c5a..45cfba4 100644 --- a/README.md +++ b/README.md @@ -55,11 +55,11 @@ mongodb: clients: default: uri: '%env(MONGODB_URI)%' - uriOptions: #... - driverOptions: #... + uri_options: #... + driver_options: #... ``` -The `uriOptions` and `driverOptions` are passed directly to the underlying MongoDB driver. +The `uri_options` and `driver_options` are passed directly to the underlying MongoDB driver. See the [documentation](https://www.php.net/manual/en/mongodb-driver-manager.construct.php) for available options. If you want to configure multiple clients, you can do so by adding additional clients to the configuration: diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php index a15e512..2e106a5 100644 --- a/src/DependencyInjection/Configuration.php +++ b/src/DependencyInjection/Configuration.php @@ -32,11 +32,11 @@ public function getConfigTreeBuilder(): TreeBuilder ->scalarNode('uri') ->info('MongoDB connection string') ->end() - ->arrayNode('uriOptions') + ->arrayNode('uri_options') ->info('Additional connection string options') ->variablePrototype()->end() ->end() - ->arrayNode('driverOptions') + ->arrayNode('driver_options') ->info('Driver-specific options') ->variablePrototype()->end() ->end() diff --git a/src/DependencyInjection/MongoDBExtension.php b/src/DependencyInjection/MongoDBExtension.php index 4be5e36..a8b06e7 100644 --- a/src/DependencyInjection/MongoDBExtension.php +++ b/src/DependencyInjection/MongoDBExtension.php @@ -68,8 +68,8 @@ private function createClients(string $defaultClient, array $clients, ContainerB $clientDefinition = clone $clientPrototype; $clientDefinition->setArgument('$uri', $configuration['uri']); - $clientDefinition->setArgument('$uriOptions', $configuration['uriOptions'] ?? []); - $clientDefinition->setArgument('$driverOptions', $configuration['driverOptions'] ?? []); + $clientDefinition->setArgument('$uriOptions', $configuration['uri_options'] ?? []); + $clientDefinition->setArgument('$driverOptions', $configuration['driver_options'] ?? []); $container->setDefinition($serviceId, $clientDefinition); diff --git a/tests/Unit/DependencyInjection/ConfigurationTest.php b/tests/Unit/DependencyInjection/ConfigurationTest.php index 9a46878..6cfd26c 100644 --- a/tests/Unit/DependencyInjection/ConfigurationTest.php +++ b/tests/Unit/DependencyInjection/ConfigurationTest.php @@ -38,12 +38,12 @@ public function testProcess(): void [ 'id' => 'default', 'uri' => 'mongodb://localhost:27017', - 'uriOptions' => ['readPreference' => 'primary'], + 'uri_options' => ['readPreference' => 'primary'], ], [ 'id' => 'secondary', 'uri' => 'mongodb://localhost:27018', - 'driverOptions' => ['serverApi' => new ServerApi((string) ServerApi::V1)], + 'driver_options' => ['serverApi' => new ServerApi((string) ServerApi::V1)], ], ], ], @@ -58,13 +58,13 @@ public function testProcess(): void $this->assertArrayHasKey('default', $clients); $this->assertSame('mongodb://localhost:27017', $clients['default']['uri']); - $this->assertSame(['readPreference' => 'primary'], $clients['default']['uriOptions']); - $this->assertSame([], $clients['default']['driverOptions']); + $this->assertSame(['readPreference' => 'primary'], $clients['default']['uri_options']); + $this->assertSame([], $clients['default']['driver_options']); $this->assertArrayHasKey('secondary', $clients); $this->assertSame('mongodb://localhost:27018', $clients['secondary']['uri']); - $this->assertSame([], $clients['secondary']['uriOptions']); - $this->assertEquals(['serverApi' => new ServerApi((string) ServerApi::V1)], $clients['secondary']['driverOptions']); + $this->assertSame([], $clients['secondary']['uri_options']); + $this->assertEquals(['serverApi' => new ServerApi((string) ServerApi::V1)], $clients['secondary']['driver_options']); } public function testProcessWithYamlFile(): void @@ -74,11 +74,11 @@ public function testProcessWithYamlFile(): void clients: default: uri: mongodb://localhost:27017 - uriOptions: + uri_options: readPreference: primary secondary: uri: mongodb://localhost:27018 - driverOptions: + driver_options: serverApi: v1 YAML); @@ -91,13 +91,13 @@ public function testProcessWithYamlFile(): void $this->assertArrayHasKey('default', $clients); $this->assertSame('mongodb://localhost:27017', $clients['default']['uri']); - $this->assertSame(['readPreference' => 'primary'], $clients['default']['uriOptions']); - $this->assertSame([], $clients['default']['driverOptions']); + $this->assertSame(['readPreference' => 'primary'], $clients['default']['uri_options']); + $this->assertSame([], $clients['default']['driver_options']); $this->assertArrayHasKey('secondary', $clients); $this->assertSame('mongodb://localhost:27018', $clients['secondary']['uri']); - $this->assertSame([], $clients['secondary']['uriOptions']); - $this->assertSame(['serverApi' => 'v1'], $clients['secondary']['driverOptions']); + $this->assertSame([], $clients['secondary']['uri_options']); + $this->assertSame(['serverApi' => 'v1'], $clients['secondary']['driver_options']); } public function testProcessWithYamlFileWithoutUriKey(): void diff --git a/tests/Unit/DependencyInjection/MongoDBExtensionTest.php b/tests/Unit/DependencyInjection/MongoDBExtensionTest.php index 4a94d4a..c0cb90f 100644 --- a/tests/Unit/DependencyInjection/MongoDBExtensionTest.php +++ b/tests/Unit/DependencyInjection/MongoDBExtensionTest.php @@ -75,12 +75,12 @@ public function testLoadWithMultipleClients(): void [ 'id' => 'default', 'uri' => 'mongodb://localhost:27017', - 'uriOptions' => ['readPreference' => 'primary'], + 'uri_options' => ['readPreference' => 'primary'], ], [ 'id' => 'secondary', 'uri' => 'mongodb://localhost:27018', - 'driverOptions' => ['serverApi' => new ServerApi((string) ServerApi::V1)], + 'driver_options' => ['serverApi' => new ServerApi((string) ServerApi::V1)], ], ], ],