feature symfony#28570 [Form] deprecate the unused scale option (xabbuh)

This PR was merged into the 4.2-dev branch.

Discussion
----------

[Form] deprecate the unused scale option

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | yes
| Tests pass?   | yes
| Fixed tickets |
| License       | MIT
| Doc PR        |

Commits
-------

40413aa deprecate the unused scale option

Author: fabpot

UPGRADE-4.2.md

@@ -55,6 +55,8 @@ Finder
 Form
 ----
 
+ * The `scale` option of the `IntegerType` is deprecated.
+
  * Deprecated calling `FormRenderer::searchAndRenderBlock` for fields which were already rendered.
    Instead of expecting such calls to return empty strings, check if the field has already been rendered.
 

UPGRADE-5.0.md

@@ -69,6 +69,11 @@ Finder
 
  * The `Finder::sortByName()` method has a new `$useNaturalSort` argument.
 
+Form
+----
+
+ * The `scale` option was removed from the `IntegerType`.
+
 FrameworkBundle
 ---------------
 

src/Symfony/Component/Form/CHANGELOG.md

@@ -6,6 +6,7 @@ CHANGELOG
 
  * added `Symfony\Component\Form\ClearableErrorsInterface`
  * deprecated calling `FormRenderer::searchAndRenderBlock` for fields which were already rendered
+ * deprecated the `scale` option of the `IntegerType`
 
 4.1.0
 -----

src/Symfony/Component/Form/Extension/Core/Type/IntegerType.php

@@ -25,7 +25,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
     {
         $builder->addViewTransformer(
             new IntegerToLocalizedStringTransformer(
-                $options['scale'],
+                null,
                 $options['grouping'],
                 $options['rounding_mode']
         ));
@@ -37,8 +37,6 @@ public function buildForm(FormBuilderInterface $builder, array $options)
     public function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setDefaults(array(
-            // default scale is locale specific (usually around 3)
-            'scale' => null,
             'grouping' => false,
             // Integer cast rounds towards 0, so do the same when displaying fractions
             'rounding_mode' => IntegerToLocalizedStringTransformer::ROUND_DOWN,
@@ -55,7 +53,9 @@ public function configureOptions(OptionsResolver $resolver)
             IntegerToLocalizedStringTransformer::ROUND_CEILING,
         ));
 
+        $resolver->setDefined('scale');
         $resolver->setAllowedTypes('scale', array('null', 'int'));
+        $resolver->setDeprecated('scale');
     }
 
     /**

src/Symfony/Component/Form/Tests/Command/DebugCommandTest.php

@@ -15,11 +15,13 @@
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Tester\CommandTester;
+use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Command\DebugCommand;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormRegistry;
 use Symfony\Component\Form\ResolvedFormTypeFactory;
-use Symfony\Component\Form\Tests\Console\Descriptor\FooType;
+use Symfony\Component\OptionsResolver\Options;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 
 class DebugCommandTest extends TestCase
 {
@@ -40,10 +42,15 @@ public function testDebugDeprecatedDefaults()
         $this->assertEquals(0, $ret, 'Returns 0 in case of success');
         $this->assertSame(<<<TXT
 
+Built-in form types (Symfony\Component\Form\Extension\Core\Type)
+----------------------------------------------------------------
+
+ IntegerType
+
 Service form types
 ------------------
 
- * Symfony\Component\Form\Tests\Console\Descriptor\FooType
+ * Symfony\Component\Form\Tests\Command\FooType
 
 
 TXT
@@ -147,3 +154,25 @@ private function createCommandTester(array $namespaces = array('Symfony\Componen
         return new CommandTester($application->find('debug:form'));
     }
 }
+
+class FooType extends AbstractType
+{
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setRequired('foo');
+        $resolver->setDefined('bar');
+        $resolver->setDeprecated('bar');
+        $resolver->setDefault('empty_data', function (Options $options) {
+            $foo = $options['foo'];
+
+            return function (FormInterface $form) use ($foo) {
+                return $form->getConfig()->getCompound() ? array($foo) : $foo;
+            };
+        });
+        $resolver->setAllowedTypes('foo', 'string');
+        $resolver->setAllowedValues('foo', array('bar', 'baz'));
+        $resolver->setNormalizer('foo', function (Options $options, $value) {
+            return (string) $value;
+        });
+    }
+}