Merge pull request #427 from mcg-web/remove-deprecated-messages

Remove deprecation messages for symfony 4.2
overblog · Dec 5, 2018 · 93b4abf · 93b4abf
2 parents 4d85286 + 6325269
commit 93b4abf
Show file tree

Hide file tree

Showing 12 changed files with 58 additions and 52 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -48,7 +48,9 @@ jobs:
           env: SYMFONY_VERSION=4.2.*
         - php: nightly
           env: COMPOSER_UPDATE_FLAGS=--ignore-platform-reqs
-        - php: 7.2
+
+        - stage: Code Quality
+          php: 7.2
           env: COVERAGE
           before_script:
             - mv ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini{.disabled,}

diff --git a/src/Config/CustomScalarTypeDefinition.php b/src/Config/CustomScalarTypeDefinition.php
@@ -2,14 +2,11 @@
 
 namespace Overblog\GraphQLBundle\Config;
 
-use Symfony\Component\Config\Definition\Builder\TreeBuilder;
-
 class CustomScalarTypeDefinition extends TypeDefinition
 {
     public function getDefinition()
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root('_custom_scalar_config');
+        $node = self::createNode('_custom_scalar_config');
 
         $node
             ->children()

diff --git a/src/Config/EnumTypeDefinition.php b/src/Config/EnumTypeDefinition.php
@@ -2,14 +2,11 @@
 
 namespace Overblog\GraphQLBundle\Config;
 
-use Symfony\Component\Config\Definition\Builder\TreeBuilder;
-
 class EnumTypeDefinition extends TypeDefinition
 {
     public function getDefinition()
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root('_enum_config');
+        $node = self::createNode('_enum_config');
 
         $node
             ->children()

diff --git a/src/Config/InputObjectTypeDefinition.php b/src/Config/InputObjectTypeDefinition.php
@@ -2,14 +2,11 @@
 
 namespace Overblog\GraphQLBundle\Config;
 
-use Symfony\Component\Config\Definition\Builder\TreeBuilder;
-
 class InputObjectTypeDefinition extends TypeDefinition
 {
     public function getDefinition()
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root('_input_object_config');
+        $node = self::createNode('_input_object_config');
 
         $node
             ->children()

diff --git a/src/Config/InterfaceTypeDefinition.php b/src/Config/InterfaceTypeDefinition.php
@@ -2,14 +2,11 @@
 
 namespace Overblog\GraphQLBundle\Config;
 
-use Symfony\Component\Config\Definition\Builder\TreeBuilder;
-
 class InterfaceTypeDefinition extends TypeWithOutputFieldsDefinition
 {
     public function getDefinition()
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root('_interface_config');
+        $node = self::createNode('_interface_config');
 
         $node
             ->children()

diff --git a/src/Config/ObjectTypeDefinition.php b/src/Config/ObjectTypeDefinition.php
@@ -3,14 +3,12 @@
 namespace Overblog\GraphQLBundle\Config;
 
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
-use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 
 class ObjectTypeDefinition extends TypeWithOutputFieldsDefinition
 {
     public function getDefinition()
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root('_object_config');
+        $node = self::createNode('_object_config');
 
         $node
             ->children()

diff --git a/src/Config/TypeDefinition.php b/src/Config/TypeDefinition.php
@@ -2,6 +2,7 @@
 
 namespace Overblog\GraphQLBundle\Config;
 
+use Overblog\GraphQLBundle\DependencyInjection\Configuration;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 
 abstract class TypeDefinition
@@ -22,16 +23,14 @@ public static function create()
 
     protected function resolveTypeSection()
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root('resolveType', 'variable');
+        $node = self::createNode('resolveType', 'variable');
 
         return $node;
     }
 
     protected function nameSection()
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root('name', 'scalar');
+        $node = self::createNode('name', 'scalar');
         $node->isRequired();
         $node->validate()
             ->ifTrue(function ($name) {
@@ -45,24 +44,21 @@ protected function nameSection()
 
     protected function defaultValueSection()
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root('defaultValue', 'variable');
+        $node = self::createNode('defaultValue', 'variable');
 
         return $node;
     }
 
     protected function descriptionSection()
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root('description', 'scalar');
+        $node = self::createNode('description', 'scalar');
 
         return $node;
     }
 
     protected function deprecationReasonSelection()
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root('deprecationReason', 'scalar');
+        $node = self::createNode('deprecationReason', 'scalar');
 
         $node->info('Text describing why this field is deprecated. When not empty - field will not be returned by introspection queries (unless forced)');
 
@@ -71,8 +67,7 @@ protected function deprecationReasonSelection()
 
     protected function typeSelection($isRequired = false)
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root('type', 'scalar');
+        $node = self::createNode('type', 'scalar');
 
         $node->info('One of internal or custom types.');
 
@@ -82,4 +77,17 @@ protected function typeSelection($isRequired = false)
 
         return $node;
     }
+
+    /**
+     * @internal
+     *
+     * @param string $name
+     * @param string $type
+     *
+     * @return \Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition|\Symfony\Component\Config\Definition\Builder\NodeDefinition
+     */
+    protected static function createNode($name, $type = 'array')
+    {
+        return Configuration::getRootNodeWithoutDeprecation(new TreeBuilder($name, $type), $name, $type);
+    }
 }
diff --git a/src/Config/TypeWithOutputFieldsDefinition.php b/src/Config/TypeWithOutputFieldsDefinition.php
@@ -3,7 +3,6 @@
 namespace Overblog\GraphQLBundle\Config;
 
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
-use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 
 abstract class TypeWithOutputFieldsDefinition extends TypeDefinition
 {
@@ -14,8 +13,7 @@ abstract class TypeWithOutputFieldsDefinition extends TypeDefinition
      */
     protected function outputFieldsSelection($name = 'fields')
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root($name);
+        $node = self::createNode($name);
         $node
             ->isRequired()
             ->requiresAtLeastOneElement();

diff --git a/src/Config/UnionTypeDefinition.php b/src/Config/UnionTypeDefinition.php
@@ -2,14 +2,11 @@
 
 namespace Overblog\GraphQLBundle\Config;
 
-use Symfony\Component\Config\Definition\Builder\TreeBuilder;
-
 class UnionTypeDefinition extends TypeDefinition
 {
     public function getDefinition()
     {
-        $builder = new TreeBuilder();
-        $node = $builder->root('_union_config');
+        $node = self::createNode('_union_config');
 
         $node
             ->children()

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -39,8 +39,7 @@ public function getConfigTreeBuilder()
     {
         $treeBuilder = new TreeBuilder(self::NAME);
 
-        // BC layer for symfony/config 4.1 and older
-        $rootNode = \method_exists($treeBuilder, 'getRootNode') ? $treeBuilder->getRootNode() : $treeBuilder->root(self::NAME);
+        $rootNode = self::getRootNodeWithoutDeprecation($treeBuilder, self::NAME);
 
         $rootNode
             ->children()
@@ -58,7 +57,7 @@ private function batchingMethodSection()
     {
         $builder = new TreeBuilder('batching_method', 'enum');
         /** @var EnumNodeDefinition $node */
-        $node = \method_exists($builder, 'getRootNode') ? $builder->getRootNode() : $builder->root('batching_method', 'enum');
+        $node = self::getRootNodeWithoutDeprecation($builder, 'batching_method', 'enum');
 
         $node
             ->values(['relay', 'apollo'])
@@ -72,7 +71,7 @@ private function errorsHandlerSection()
     {
         $builder = new TreeBuilder('errors_handler');
         /** @var ArrayNodeDefinition $node */
-        $node = \method_exists($builder, 'getRootNode') ? $builder->getRootNode() : $builder->root('errors_handler');
+        $node = self::getRootNodeWithoutDeprecation($builder, 'errors_handler');
         $node
             ->treatFalseLike(['enabled' => false])
             ->treatTrueLike(['enabled' => true])
@@ -138,7 +137,7 @@ private function servicesSection()
     {
         $builder = new TreeBuilder('services');
         /** @var ArrayNodeDefinition $node */
-        $node = \method_exists($builder, 'getRootNode') ? $builder->getRootNode() : $builder->root('services');
+        $node = self::getRootNodeWithoutDeprecation($builder, 'services');
         $node
             ->addDefaultsIfNotSet()
             ->children()
@@ -180,7 +179,7 @@ private function definitionsSchemaSection()
     {
         $builder = new TreeBuilder('schema');
         /** @var ArrayNodeDefinition $node */
-        $node = \method_exists($builder, 'getRootNode') ? $builder->getRootNode() : $builder->root('schema');
+        $node = self::getRootNodeWithoutDeprecation($builder, 'schema');
         $node
             ->beforeNormalization()
                 ->ifTrue(function ($v) {
@@ -216,7 +215,7 @@ private function definitionsAutoMappingSection()
     {
         $builder = new TreeBuilder('auto_mapping');
         /** @var ArrayNodeDefinition $node */
-        $node = \method_exists($builder, 'getRootNode') ? $builder->getRootNode() : $builder->root('auto_mapping');
+        $node = self::getRootNodeWithoutDeprecation($builder, 'auto_mapping');
         $node
             ->treatFalseLike(['enabled' => false])
             ->treatTrueLike(['enabled' => true])
@@ -237,7 +236,7 @@ private function definitionsAutoMappingSection()
     private function definitionsMappingsSection()
     {
         $builder = new TreeBuilder('mappings');
-        $node = \method_exists($builder, 'getRootNode') ? $builder->getRootNode() : $builder->root('mappings');
+        $node = self::getRootNodeWithoutDeprecation($builder, 'mappings');
         $node
             ->children()
                 ->arrayNode('auto_discover')
@@ -292,7 +291,7 @@ private function builderSection($name)
     {
         $builder = new TreeBuilder($name);
         /** @var ArrayNodeDefinition $node */
-        $node = \method_exists($builder, 'getRootNode') ? $builder->getRootNode() : $builder->root($name);
+        $node = self::getRootNodeWithoutDeprecation($builder, $name);
         $node->beforeNormalization()
             ->ifTrue(function ($v) {
                 return \is_array($v) && !empty($v);
@@ -332,7 +331,7 @@ private function securityQuerySection($name, $disabledValue)
     {
         $builder = new TreeBuilder($name, 'scalar');
         /** @var ScalarNodeDefinition $node */
-        $node = \method_exists($builder, 'getRootNode') ? $builder->getRootNode() : $builder->root($name, 'scalar');
+        $node = self::getRootNodeWithoutDeprecation($builder, $name, 'scalar');
         $node->beforeNormalization()
                 ->ifTrue(function ($v) {
                     return \is_string($v) && \is_numeric($v);
@@ -363,4 +362,19 @@ private function securityQuerySection($name, $disabledValue)
 
         return $node;
     }
+
+    /**
+     * @internal
+     *
+     * @param TreeBuilder $builder
+     * @param string|null $name
+     * @param string      $type
+     *
+     * @return ArrayNodeDefinition|\Symfony\Component\Config\Definition\Builder\NodeDefinition
+     */
+    public static function getRootNodeWithoutDeprecation(TreeBuilder $builder, $name, $type = 'array')
+    {
+        // BC layer for symfony/config 4.1 and older
+        return \method_exists($builder, 'getRootNode') ? $builder->getRootNode() : $builder->root($name, $type);
+    }
 }
diff --git a/src/DependencyInjection/TypesConfiguration.php b/src/DependencyInjection/TypesConfiguration.php
@@ -21,8 +21,8 @@ class TypesConfiguration implements ConfigurationInterface
 
     public function getConfigTreeBuilder()
     {
-        $treeBuilder = new TreeBuilder();
-        $rootNode = $treeBuilder->root('overblog_graphql_types');
+        $treeBuilder = new TreeBuilder('overblog_graphql_types');
+        $rootNode = Configuration::getRootNodeWithoutDeprecation($treeBuilder, 'overblog_graphql_types');
 
         $configTypeKeys = \array_map(
             function ($type) {

diff --git a/tests/Functional/Inheritance/InheritanceTest.php b/tests/Functional/Inheritance/InheritanceTest.php
@@ -21,7 +21,8 @@ protected function setUp()
     public function testObjectInheritance()
     {
         $this->assertArrayHasKey('Query', $this->config);
-        $this->assertSame(
+        // TODO(mcg-web): understand why travis fields order diffed from local test
+        $this->assertEquals(
             [
                 'type' => 'object',
                 InheritanceProcessor::INHERITS_KEY => ['QueryFoo', 'QueryBar', 'QueryHelloWord'],