@flarum/cli 3.0.12 → 3.0.13

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flarum/cli",
   "description": "A CLI for developing Flarum extensions",
-  "version": "3.0.12",
+  "version": "3.0.13",
   "author": "Flarum Team",
   "flarum": "2.x",
   "bin": {

package/php-subsystem/index.php

@@ -45,6 +45,18 @@ try {
             $output = (new Flarum\CliPhpSubsystem\Upgrade\TwoPointOh\Search())->handle($input['file'], $input['code'] ?? null, $input['data'] ?? []);
             break;
 
+        case 'upgrade.2-0.migrations-schema':
+            $output = (new Flarum\CliPhpSubsystem\Upgrade\TwoPointOh\ModelFactories())->schema($input['data']['migrations'] ?? []);
+            break;
+
+        case 'upgrade.2-0.models':
+            $output = (new Flarum\CliPhpSubsystem\Upgrade\TwoPointOh\ModelFactories())->models($input['data']['files'] ?? []);
+            break;
+
+        case 'upgrade.2-0.model-factory':
+            $output = (new Flarum\CliPhpSubsystem\Upgrade\TwoPointOh\ModelFactories())->factory($input['file'], $input['code'], $input['data'] ?? []);
+            break;
+
         case 'upgrade.2-0.phpunit':
             $output = (new Flarum\CliPhpSubsystem\Upgrade\TwoPointOh\PhpUnit())->handle($input['file'], $input['code'] ?? null, $input['data'] ?? []);
             break;

package/php-subsystem/src/NodeUtil.php

@@ -55,18 +55,28 @@ class NodeUtil
             return true;
         }));
 
-        $lastUseStatement = null;
+        usort($uses, fn ($a, $b) => strcasecmp($a->uses[0]->name->toString(), $b->uses[0]->name->toString()));
 
-        foreach ($node->stmts as $index => $stmt) {
-            if ($stmt instanceof \PhpParser\Node\Stmt\Use_) {
-                $lastUseStatement = $index;
-            } elseif (! is_null($lastUseStatement)) {
-                break;
+        // Each goes where it sorts among the imports already there, as the
+        // Flarum StyleCI preset orders them, or after the last one.
+        foreach ($uses as $use) {
+            $lastUseStatement = null;
+            $position = null;
+
+            foreach ($node->stmts as $index => $stmt) {
+                if ($stmt instanceof \PhpParser\Node\Stmt\Use_) {
+                    $lastUseStatement = $index;
+
+                    if (is_null($position) && strcasecmp($stmt->uses[0]->name->toString(), $use->uses[0]->name->toString()) > 0) {
+                        $position = $index;
+                    }
+                } elseif (! is_null($lastUseStatement)) {
+                    break;
+                }
             }
-        }
 
-        if (! is_null($lastUseStatement)) {
-            array_splice($node->stmts, $lastUseStatement + 1, 0, $uses);
+            // Without any imports yet, it opens the namespace.
+            array_splice($node->stmts, $position ?? (is_null($lastUseStatement) ? 0 : $lastUseStatement + 1), 0, [$use]);
         }
     }
 

package/php-subsystem/src/NodeVisitors/AddExtender.php

@@ -28,9 +28,57 @@ class AddExtender extends NodeVisitorAbstract
     $this->nameContext = $nameContext;
   }
 
+  /**
+   * The return statements whose array of extenders gets the new one.
+   *
+   * @var array<int, true>
+   */
+  protected $targets = [];
+
+  /**
+   * Picks the arrays of extenders the file returns: those returned outside any
+   * function, or failing that, from the fewest nested functions. An array a
+   * Conditional's closure returns is left alone, as it holds the extenders for
+   * when another extension is enabled.
+   */
+  public function beforeTraverse(array $nodes)
+  {
+    $returns = [];
+
+    $find = function (array $nodes, int $depth) use (&$find, &$returns) {
+      foreach ($nodes as $node) {
+        if (! $node instanceof Node) {
+          continue;
+        }
+
+        if ($node instanceof Node\Stmt\Return_ && $node->expr instanceof Node\Expr\Array_) {
+          $returns[] = [$node, $depth];
+        }
+
+        $nested = $node instanceof Node\FunctionLike ? $depth + 1 : $depth;
+
+        foreach ($node->getSubNodeNames() as $name) {
+          $find(is_array($node->$name) ? $node->$name : [$node->$name], $nested);
+        }
+      }
+    };
+
+    $find($nodes, 0);
+
+    $outermost = min(array_column($returns, 1) ?: [0]);
+
+    foreach ($returns as [$return, $depth]) {
+      if ($depth === $outermost) {
+        $this->targets[spl_object_id($return)] = true;
+      }
+    }
+
+    return null;
+  }
+
   public function leaveNode(Node $node)
   {
-    if ($node instanceof Node\Stmt\Return_ && $node->expr instanceof Node\Expr\Array_) {
+    if ($node instanceof Node\Stmt\Return_ && $node->expr instanceof Node\Expr\Array_ && isset($this->targets[spl_object_id($node)])) {
         if (! isset($this->params['extender'])) {
             $params = json_encode($this->params);
             throw new \Exception("Invalid Extender Schema. Provided params: $params");

package/php-subsystem/src/Upgrade/TwoPointOh/JsonApi.php

@@ -135,9 +135,9 @@ class JsonApi extends Replacement
 
         $traverser->addVisitor(new NodeVisitor\ParentConnectingVisitor());
 
+        // The TODO says what to write instead. Imports are left to whoever
+        // writes it: added now, they would go unused until then.
         $traverser->addVisitor(new class () extends \PhpParser\NodeVisitorAbstract {
-            public $hasExtenders = false;
-
             const LINK_TO_DOCS = 'https://docs.flarum.org/2.x/extend/api#extending-api-resources';
             const COMMENT = '// @TODO: Replace with the new implementation '.self::LINK_TO_DOCS;
 
@@ -157,28 +157,10 @@ class JsonApi extends Replacement
                             if ($parent) {
                                 $parent->setAttribute('comments', [new \PhpParser\Comment\Doc(self::COMMENT)]);
                             }
-
-                            $this->hasExtenders = true;
                         }
                     }
                 }
             }
-
-            public function leaveNode(\PhpParser\Node $node)
-            {
-                if (! $this->hasExtenders) {
-                    return null;
-                }
-
-                if ($node instanceof \PhpParser\Node\Stmt\Namespace_) {
-                    NodeUtil::addUsesToNamespace($node, [
-                        'Flarum\Api\Context',
-                        'Flarum\Api\Endpoint',
-                        'Flarum\Api\Resource',
-                        'Flarum\Api\Schema',
-                    ]);
-                }
-            }
         });
 
         return new ReplacementResult($traverser->traverse($ast));

package/php-subsystem/src/Upgrade/TwoPointOh/Misc.php

@@ -2,6 +2,7 @@
 
 namespace Flarum\CliPhpSubsystem\Upgrade\TwoPointOh;
 
+use Flarum\CliPhpSubsystem\NodeUtil;
 use Flarum\CliPhpSubsystem\NodeVisitors\ChangeSignatures;
 use Flarum\CliPhpSubsystem\Upgrade\Replacement;
 use Flarum\CliPhpSubsystem\Upgrade\ReplacementResult;
@@ -198,7 +199,11 @@ class Misc extends Replacement
                 if ($node instanceof \PhpParser\Node\Expr\MethodCall) {
                     if ($class = $this->getClass($node)) {
                         if ($class === 'Extend\Notification') {
-                            if ($node->name->name === 'type') {
+                            // 1.x's second argument is the serializer. 2.x's is the
+                            // drivers enabled by default, an array, which stays.
+                            $serializer = $node->args[1]->value ?? null;
+
+                            if ($node->name->name === 'type' && ($serializer instanceof \PhpParser\Node\Expr\ClassConstFetch || $serializer instanceof \PhpParser\Node\Scalar\String_)) {
                                 $args = $node->args;
                                 unset($args[1]);
                                 $node->args = array_values($args);
@@ -371,14 +376,13 @@ class Misc extends Replacement
 
             public function enterNode(Node $node)
             {
-                // Does this class implement the Flarum\Notification\Blueprint\BlueprintInterface ?
+                // Does this class implement the Flarum\Notification\Blueprint\BlueprintInterface,
+                // and not yet the Flarum\Notification\AlertableInterface ?
                 if ($node instanceof Node\Stmt\Class_) {
-                    foreach ($node->implements as $interface) {
-                        if ($interface->getAttribute('resolvedName')->name === 'Flarum\Notification\Blueprint\BlueprintInterface') {
-                            $this->valid = true;
-                            break;
-                        }
-                    }
+                    $implements = array_map(fn ($interface) => $interface->getAttribute('resolvedName')->name, $node->implements);
+
+                    $this->valid = in_array('Flarum\Notification\Blueprint\BlueprintInterface', $implements)
+                        && ! in_array('Flarum\Notification\AlertableInterface', $implements);
                 }
             }
 
@@ -389,15 +393,7 @@ class Misc extends Replacement
                 }
 
                 if ($node instanceof Node\Stmt\Namespace_) {
-                    // Add the Flarum\Notification\AlertableInterface import
-                    $node->stmts = array_merge(
-                        [
-                            new Node\Stmt\Use_([
-                                new Node\Stmt\UseUse(new Node\Name('Flarum\Notification\AlertableInterface'))
-                            ])
-                        ],
-                        $node->stmts
-                    );
+                    NodeUtil::addUsesToNamespace($node, ['Flarum\Notification\AlertableInterface']);
                 }
 
                 if ($node instanceof \PhpParser\Node\Stmt\Class_) {