Merge pull request #154 from Chi-teck/sort-tag

[3.x] Add sort_namespaces filter and update sort tag

Author: Chi-teck

src/Twig/TwigEnvironment.php

@@ -26,13 +26,8 @@ public function __construct(FilesystemLoader $loader, array $options = []) {
 
     $this->addFilter(new TwigFilter('pluralize', [Utils::class, 'pluralize']));
     $this->addFilter(new TwigFilter('camelize', [Utils::class, 'camelize']));
-
-    $article = static function (string $input): string {
-      $first_char = \strtolower($input[0]);
-      $article = \in_array($first_char, ['a', 'e', 'i', 'o', 'u']) ? 'an' : 'a';
-      return $article . ' ' . $input;
-    };
-    $this->addFilter(new TwigFilter('article', $article));
+    $this->addFilter(new TwigFilter('sort_namespaces', [self::class, 'sortNamespaces']));
+    $this->addFilter(new TwigFilter('article', [self::class, 'article']));
 
     $u2h = static fn (string $input): string => \str_replace('_', '-', $input);
     $this->addFilter(new TwigFilter('u2h', $u2h));
@@ -64,4 +59,23 @@ public function tokenize(Source $source): TokenStream {
     return parent::tokenize($source);
   }
 
+  /**
+   * {@selfdoc}
+   */
+  public static function sortNamespaces(string $input): string {
+    $lines = \explode(\PHP_EOL, $input);
+    $lines = \array_unique($lines);
+    \sort($lines, \SORT_FLAG_CASE | \SORT_NATURAL);
+    return \trim(\implode(\PHP_EOL, $lines)) . \PHP_EOL;
+  }
+
+  /**
+   * {@selfdoc}
+   */
+  public static function article(string $input): string {
+    $first_char = \strtolower($input[0]);
+    $article = \in_array($first_char, ['a', 'e', 'i', 'o', 'u']) ? 'an' : 'a';
+    return $article . ' ' . $input;
+  }
+
 }

src/Twig/TwigSortSetNode.php

@@ -4,12 +4,14 @@
 
 namespace DrupalCodeGenerator\Twig;
 
+use Twig\Attribute\YieldReady;
 use Twig\Compiler;
 use Twig\Node\Node;
 
 /**
  * A class that defines the compiler for 'sort' token.
  */
+#[YieldReady]
 final class TwigSortSetNode extends Node {
 
   /**
@@ -18,12 +20,13 @@ final class TwigSortSetNode extends Node {
   public function compile(Compiler $compiler): void {
     $compiler
       ->addDebugInfo($this)
-      ->write("ob_start();\n")
-      ->subcompile($this->getNode('body'))
-      ->write('$data = explode("\n", ob_get_clean());' . "\n")
+      ->write('$data = ')
+      ->subcompile($this->getNode('ref'))
+      ->raw(";\n")
+      ->write('$data = explode("\n", $data);' . "\n")
       ->write('$data = array_unique($data);' . "\n")
       ->write('sort($data, SORT_FLAG_CASE|SORT_NATURAL);' . "\n")
-      ->write('echo ltrim(implode("\n", $data)) . "\n";' . "\n");
+      ->write('yield ltrim(implode("\n", $data)) . "\n";' . "\n");
   }
 
 }

src/Twig/TwigSortTokenParser.php

@@ -4,6 +4,9 @@
 
 namespace DrupalCodeGenerator\Twig;
 
+use Twig\Node\Expression\TempNameExpression;
+use Twig\Node\Node;
+use Twig\Node\SetNode;
 use Twig\Token;
 use Twig\TokenParser\AbstractTokenParser;
 
@@ -15,16 +18,25 @@ final class TwigSortTokenParser extends AbstractTokenParser {
   /**
    * {@inheritdoc}
    */
-  public function parse(Token $token): TwigSortSetNode {
-
+  public function parse(Token $token): Node {
+    \trigger_error('The sort tag is deprecated in 3.6.0 and will be removed in 4.x, use the sort_namespaces twig filter.', \E_USER_WARNING);
     $this->parser->getStream()->expect(Token::BLOCK_END_TYPE);
     $body = $this->parser->subparse(
       static fn (Token $token): bool => $token->test('endsort'),
       TRUE,
     );
     $this->parser->getStream()->expect(Token::BLOCK_END_TYPE);
 
-    return new TwigSortSetNode(['body' => $body], [], $token->getLine(), $this->getTag());
+    $lineno = $token->getLine();
+    $name = $this->parser->getVarName();
+
+    $ref = new TempNameExpression($name, $lineno);
+    $ref->setAttribute('always_defined', TRUE);
+
+    return new Node([
+      new SetNode(TRUE, $ref, $body, $lineno, $this->getTag()),
+      new TwigSortSetNode(['ref' => $ref], [], $lineno, $this->getTag()),
+    ]);
   }
 
   /**

templates/Drush/_symfony-command/command.twig

@@ -5,15 +5,15 @@ declare(strict_types=1);
 
 namespace Drupal\{{ machine_name }}\Command;
 
-{% sort %}
+{% apply sort_namespaces %}
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
   {% if services %}
 {{ di.use(services) }}
   {% endif %}
-{% endsort %}
+{% endapply %}
 
 // phpcs:disable Drupal.Commenting.ClassComment.Missing
 #[AsCommand(

templates/Entity/_configuration-entity/src/Entity/Example.php.twig

@@ -4,10 +4,10 @@ declare(strict_types=1);
 
 namespace Drupal\{{ machine_name }}\Entity;
 
-{% sort %}
+{% apply sort_namespaces %}
 use Drupal\Core\Config\Entity\ConfigEntityBase;
 use Drupal\{{ machine_name }}\{{ class_prefix }}Interface;
-{% endsort %}
+{% endapply %}
 
 /**
  * Defines the {{ entity_type_label|lower }} entity type.

templates/Entity/_content-entity/model.module.twig

@@ -7,12 +7,12 @@ declare(strict_types=1);
  * Provides {{ entity_type_label|article|lower }} entity type.
  */
 
-{% sort %}
+{% apply sort_namespaces %}
 use Drupal\Core\Render\Element;
   {% if author_base_field %}
 use Drupal\user\UserInterface;
   {% endif %}
-{% endsort %}
+{% endapply %}
 
 /**
  * Implements hook_theme().

templates/Entity/_content-entity/src/Entity/Example.php.twig

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 namespace Drupal\{{ machine_name }}\Entity;
 
-{% sort %}
+{% apply sort_namespaces %}
   {% if not revisionable %}
 use Drupal\Core\Entity\ContentEntityBase;
   {% endif %}
@@ -25,7 +25,7 @@ use Drupal\user\EntityOwnerTrait;
   {% if changed_base_field %}
 use Drupal\Core\Entity\EntityChangedTrait;
   {% endif %}
-{% endsort %}
+{% endapply %}
 
 /**
  * Defines the {{ entity_type_label|lower }} entity class.

templates/Entity/_content-entity/src/Form/ExampleTypeForm.php.twig

@@ -4,12 +4,12 @@ declare(strict_types=1);
 
 namespace Drupal\{{ machine_name }}\Form;
 
-{% sort %}
+{% apply sort_namespaces %}
 use Drupal\Core\Entity\BundleEntityFormBase;
 use Drupal\Core\Entity\EntityTypeInterface;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\{{ machine_name }}\Entity\{{ class }}Type;
-{% endsort %}
+{% endapply %}
 
 /**
  * Form handler for {{ entity_type_label|lower }} type forms.

templates/Plugin/Field/_widget/widget.twig

@@ -5,7 +5,7 @@ declare(strict_types=1);
 
 namespace Drupal\{{ machine_name }}\Plugin\Field\FieldWidget;
 
-{% sort %}
+{% apply sort_namespaces %}
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\WidgetBase;
 use Drupal\Core\Form\FormStateInterface;
@@ -14,7 +14,7 @@ use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
   {% endif %}
-{% endsort %}
+{% endapply %}
 
 /**
  * Defines the '{{ plugin_id }}' field widget.

templates/Plugin/Migrate/_destination/destination.twig

@@ -5,7 +5,7 @@ declare(strict_types=1);
 
 namespace Drupal\{{ machine_name }}\Plugin\migrate\destination;
 
-{% sort %}
+{% apply sort_namespaces %}
 use Drupal\migrate\Plugin\migrate\destination\DestinationBase;
 use Drupal\migrate\Plugin\MigrationInterface;
 use Drupal\migrate\Row;
@@ -14,7 +14,7 @@ use Drupal\migrate\Row;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
   {% endif %}
-{% endsort %}
+{% endapply %}
 
 /**
  * The '{{ plugin_id }}' destination plugin.