feature #4409 Deprecate the range function (fabpot)

This PR was merged into the 3.x branch. Discussion ---------- Deprecate the range function Commits ------- 3d99e59 Deprecate the range function
twigphp · Oct 24, 2024 · 99c6fbd · 99c6fbd
2 parents 868b429 + 3d99e59
commit 99c6fbd
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 3 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,5 +1,6 @@
 # 3.15.0 (2024-XX-XX)
 
+ * Deprecate the `range` function, use the `..` operator
  * Deprecate `TempNameExpression` in favor of `LocalVariable`
  * Deprecate `NameExpression` in favor of `ContextVariable`
  * Deprecate `AssignNameExpression` in favor of `AssignContextVariable`

diff --git a/doc/deprecated.rst b/doc/deprecated.rst
@@ -28,6 +28,9 @@ Functions
 
   Note that it won't be removed in 4.0 to allow a smoother upgrade path.
 
+* The ``range`` function is deprecated as of Twig 3.15, use the ``..`` operator
+  instead.
+
 Extensions
 ----------
 

diff --git a/doc/functions/range.rst b/doc/functions/range.rst
@@ -1,6 +1,11 @@
 ``range``
 =========
 
+.. warning::
+
+    The ``range`` function is deprecated as of Twig 3.15. Use the ``..``
+    operator instead.
+
 Returns a list containing an arithmetic progression of integers:
 
 .. code-block:: twig

diff --git a/src/Extension/CoreExtension.php b/src/Extension/CoreExtension.php
@@ -260,7 +260,7 @@ public function getFunctions(): array
             new TwigFunction('attribute', null, ['parser_callable' => [self::class, 'parseAttributeFunction']]),
             new TwigFunction('max', 'max'),
             new TwigFunction('min', 'min'),
-            new TwigFunction('range', 'range'),
+            new TwigFunction('range', 'range', ['deprecation_info' => new DeprecatedCallableInfo('twig/twig', '3.15')]),
             new TwigFunction('constant', [self::class, 'constant']),
             new TwigFunction('cycle', [self::class, 'cycle']),
             new TwigFunction('random', [self::class, 'random'], ['needs_charset' => true]),

diff --git a/src/NodeVisitor/SandboxNodeVisitor.php b/src/NodeVisitor/SandboxNodeVisitor.php
@@ -69,6 +69,7 @@ public function enterNode(Node $node, Environment $env): Node
             }
 
             // the .. operator is equivalent to the range() function
+            // To be removed in 4.0
             if ($node instanceof RangeBinary && !isset($this->functions['range'])) {
                 $this->functions['range'] = $node->getTemplateLine();
             }

diff --git a/tests/Fixtures/functions/range.test → tests/Fixtures/functions/range.legacy.test b/tests/Fixtures/functions/range.test → tests/Fixtures/functions/range.legacy.test
@@ -1,5 +1,7 @@
 --TEST--
 "range" function
+--DEPRECATION--
+Since twig/twig 3.15: Twig Function "range" is deprecated in index.twig at line 2.
 --TEMPLATE--
 {{ range(low=0+1, high=10+0, step=2)|join(',') }}
 --DATA--

diff --git a/tests/Fixtures/whitespace/trim_block.test b/tests/Fixtures/whitespace/trim_block.test
@@ -2,13 +2,13 @@
 Whitespace trimming on tags.
 --TEMPLATE--
 Trim on control tag:
-{% for i in range(1, 9) -%}
+{% for i in 1..9 -%}
 	{{ i }}
 {%- endfor %}
 
 
 Trim on output tag:
-{% for i in range(1, 9) %}
+{% for i in 1..9 %}
 	{{- i -}}
 {% endfor %}