feature #22909 [Yaml] Deprecate using the non-specific tag (GuilhemN)

fabpot · fabpot · commit e992eae067ce · 2017-06-14T13:38:21.000-07:00
This PR was merged into the 3.4 branch. Discussion ---------- [Yaml] Deprecate using the non-specific tag | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no  | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | Values tagged with the non-specific tag must not be transformed in an integer, this tag means that they must not be evaluated (see [the spec](http://www.yaml.org/spec/1.2/spec.html#tag/non-specific/)). I applied this change in #22762 to comply with the spec. Commits ------- 60f5046 [Yaml] Deprecate using the non-specific tag
diff --git a/UPGRADE-3.4.md b/UPGRADE-3.4.md
@@ -10,7 +10,7 @@ Finder
 ------
 
  * The `Symfony\Component\Finder\Iterator\FilterIterator` class has been
-   deprecated and will be removed in 4.0 as it used to fix a bug which existed 
+   deprecated and will be removed in 4.0 as it used to fix a bug which existed
    before version 5.5.23/5.6.7.
 
 FrameworkBundle
@@ -54,3 +54,9 @@ Validator
 
  * Not setting the `strict` option of the `Choice` constraint to `true` is
    deprecated and will throw an exception in Symfony 4.0.
+
+Yaml
+----
+
+ * Using the non-specific tag `!` is deprecated and will have a different
+   behavior in 4.0. Use a plain integer or `!!float` instead.
diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -702,3 +702,6 @@ Yaml
 
  * The constructor arguments `$offset`, `$totalNumberOfLines` and
    `$skippedLineNumbers` of the `Parser` class were removed.
+
+ * The behavior of the non-specific tag `!` is changed and now forces
+   non-evaluating your values.
diff --git a/src/Symfony/Component/Yaml/CHANGELOG.md b/src/Symfony/Component/Yaml/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+3.4.0
+-----
+
+ * Deprecated using the non-specific tag `!` as its behavior will change in 4.0.
+   It will force non-evaluating your values in 4.0. Use plain integers or `!!float` instead.
+
 3.3.0
 -----
 
diff --git a/src/Symfony/Component/Yaml/Inline.php b/src/Symfony/Component/Yaml/Inline.php
@@ -611,6 +611,8 @@ private static function evaluateScalar($scalar, $flags, $references = array())
                     case 0 === strpos($scalar, '!str'):
                         return (string) substr($scalar, 5);
                     case 0 === strpos($scalar, '! '):
+                        @trigger_error('Using the non-specific tag "!" is deprecated since version 3.4 as its behavior will change in 4.0. It will force non-evaluating your values in 4.0. Use plain integers or !!float instead.', E_USER_DEPRECATED);
+
                         return (int) self::parseScalar(substr($scalar, 2), $flags);
                     case 0 === strpos($scalar, '!php/object:'):
                         if (self::$objectSupport) {
diff --git a/src/Symfony/Component/Yaml/Tests/Fixtures/YtsSpecificationExamples.yml b/src/Symfony/Component/Yaml/Tests/Fixtures/YtsSpecificationExamples.yml
@@ -928,6 +928,7 @@ documents: 2
 
 ---
 test: Explicit typing
+deprecated: Using the non-specific tag "!" is deprecated since version 3.4 as its behavior will change in 4.0.
 yaml: |
    integer: 12
    also int: ! "12"
diff --git a/src/Symfony/Component/Yaml/Tests/ParserTest.php b/src/Symfony/Component/Yaml/Tests/ParserTest.php
@@ -61,7 +61,7 @@ public function testSpecifications($expected, $yaml, $comment, $deprecated)
             restore_error_handler();
 
             $this->assertCount(1, $deprecations);
-            $this->assertContains('Using the comma as a group separator for floats is deprecated since version 3.2 and will be removed in 4.0.', $deprecations[0]);
+            $this->assertContains(true !== $deprecated ? $deprecated : 'Using the comma as a group separator for floats is deprecated since version 3.2 and will be removed in 4.0.', $deprecations[0]);
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function testSpecifications($expected, $yaml, $comment, $deprecated)`
`61`	`61`	`restore_error_handler();`
`62`	`62`
`63`	`63`	`$this->assertCount(1, $deprecations);`
`64`		`- $this->assertContains('Using the comma as a group separator for floats is deprecated since version 3.2 and will be removed in 4.0.', $deprecations[0]);`
	`64`	`+ $this->assertContains(true !== $deprecated ? $deprecated : 'Using the comma as a group separator for floats is deprecated since version 3.2 and will be removed in 4.0.', $deprecations[0]);`
`65`	`65`	`}`
`66`	`66`	`}`
`67`	`67`