@flarum/cli 2.0.0-beta.9 → 3.0.0

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

@@ -0,0 +1,94 @@
+<?php
+
+namespace Flarum\CliPhpSubsystem\Upgrade\TwoPointOh;
+
+use Flarum\CliPhpSubsystem\NodeVisitors\ChangeSignatures;
+use Flarum\CliPhpSubsystem\Upgrade\Replacement;
+use Flarum\CliPhpSubsystem\Upgrade\ReplacementResult;
+use PhpParser\Modifiers;
+use PhpParser\Node;
+use PhpParser\Node\ArrayItem;
+use PhpParser\Node\PropertyItem;
+use PhpParser\NodeVisitor;
+
+class EmailViews extends Replacement
+{
+    protected function operations(): array
+    {
+        return ['run'];
+    }
+
+    function run(string $file, string $code, array $ast, array $data): ?ReplacementResult
+    {
+        if (strpos($file, 'extend.php') !== false || strpos($file, '.blade.php') !== false) {
+            return null;
+        }
+
+        $traverser = $this->traverser();
+
+        $traverser->addVisitor(new NodeVisitor\NameResolver(null, [
+            'replaceNodes' => false,
+        ]));
+
+        $traverser->addVisitor($visitor = new class () extends \PhpParser\NodeVisitorAbstract {
+            public $collect = [];
+
+            protected $interface = 'Flarum\Notification\MailableInterface';
+
+            public function enterNode(\PhpParser\Node $node)
+            {
+                if ($node instanceof \PhpParser\Node\Stmt\Class_ && (!$node->implements || ! in_array($this->interface, array_map(function ($interface) { return $interface->getAttribute('resolvedName')->name; }, $node->implements)))) {
+                    return NodeVisitor::DONT_TRAVERSE_CHILDREN;
+                }
+
+                // Find the getEmailViews method, and extract the array returned as a value.
+                if ($node instanceof \PhpParser\Node\Stmt\ClassMethod && $node->name->name === 'getEmailViews' && ! empty($node->stmts) && count($node->stmts) === 1 && $node->stmts[0] instanceof \PhpParser\Node\Stmt\Return_) {
+                    foreach ($node->stmts[0]->expr->items as $item) {
+                        if ($item instanceof ArrayItem && $item->key instanceof Node\Scalar\String_ && in_array($item->key->value, ['text', 'html'])) {
+                            $this->collect[$item->key->value] = $item->value->value;
+                        }
+                    }
+                }
+            }
+
+            public function leaveNode(Node $node)
+            {
+                if ($node instanceof \PhpParser\Node\Stmt\Class_ && (!$node->implements || ! in_array($this->interface, array_map(function ($interface) { return $interface->getAttribute('resolvedName')->name; }, $node->implements)))) {
+                    return NodeVisitor::STOP_TRAVERSAL;
+                }
+
+                // Find the getEmailViews method, and extract the array returned as a value.
+                if ($node instanceof \PhpParser\Node\Stmt\ClassMethod && $node->name->name === 'getEmailViews' && ! empty($node->stmts) && count($node->stmts) === 1 && $node->stmts[0] instanceof \PhpParser\Node\Stmt\Return_) {
+                    $hasViews = [];
+
+                    foreach ($node->stmts[0]->expr->items as $item) {
+                        if ($item instanceof ArrayItem && $item->key instanceof Node\Scalar\String_ && in_array($item->key->value, ['text', 'html'])) {
+                            $hasViews[] = $item->key->value;
+                        }
+                    }
+
+                    if (count($hasViews) === 1) {
+                        $view = $node->stmts[0]->expr->items[0]->value->value;
+                        $viewNamespace = explode('::', $view)[0];
+                        $viewName = explode('.', explode('::', $view)[1])[1];
+                        $newView = $viewNamespace . '::email.{type}.' . $viewName;
+                        $type = $node->stmts[0]->expr->items[0]->key->value === 'text' ? 'plain' : 'html';
+                        $node->stmts[0]->expr->items[0]->value->value = str_replace('{type}', $type, $newView);
+                        $otherType = $type === 'plain' ? 'html' : 'plain';
+
+                        $node->stmts[0]->expr->items[] = new ArrayItem(
+                            new Node\Scalar\String_(str_replace('{type}', $otherType, $newView)),
+                            new Node\Scalar\String_($otherType === 'plain' ? 'text' : 'html')
+                        );
+                    }
+                }
+            }
+        });
+
+        $ast = $traverser->traverse($ast);
+
+        $collected = $visitor->collect;
+
+        return new ReplacementResult($ast, compact('collected'));
+    }
+}

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

@@ -0,0 +1,88 @@
+<?php
+
+namespace Flarum\CliPhpSubsystem\Upgrade\TwoPointOh;
+
+use Flarum\CliPhpSubsystem\NodeVisitors\ReplaceUses;
+use Flarum\CliPhpSubsystem\Upgrade\Replacement;
+use Flarum\CliPhpSubsystem\Upgrade\ReplacementResult;
+use PhpParser\NodeVisitor;
+
+class Filesystem extends Replacement
+{
+    protected function operations(): array
+    {
+        return ['replaceUses', 'run'];
+    }
+
+    protected function replaceUses(string $file, string $code, array $ast): ?ReplacementResult
+    {
+        $traverser = $this->traverser();
+
+        // replace NullAdapter with InMemoryFilesystemAdapter (League\Flysystem\Adapter\NullAdapter -> League\Flysystem\Adapter\InMemoryFilesystemAdapter)
+        // replace Local with LocalFilesystemAdapter (League\Flysystem\Adapter\Local -> League\Flysystem\Local\LocalFilesystemAdapter)
+        // replace MemoryAdapter with InMemoryFilesystemAdapter (League\Flysystem\Memory\MemoryAdapter -> League\Flysystem\InMemory\InMemoryFilesystemAdapter)
+        $traverser->addVisitor(new ReplaceUses([
+            [
+                'from' => 'League\\Flysystem\\Adapter\\NullAdapter',
+                'to' => 'League\\Flysystem\\InMemory\\InMemoryFilesystemAdapter'
+            ],
+            [
+                'from' => 'League\\Flysystem\\Adapter\\Local',
+                'to' => 'League\\Flysystem\\Local\\LocalFilesystemAdapter'
+            ],
+            [
+                'from' => 'League\\Flysystem\\Memory\\MemoryAdapter',
+                'to' => 'League\\Flysystem\\InMemory\\InMemoryFilesystemAdapter'
+            ],
+            [
+                'from' => 'League\\Flysystem\\AdapterInterface',
+                'to' => 'League\\Flysystem\\FilesystemAdapter'
+            ],
+            [
+                'from' => 'League\\Flysystem\\AwsS3v3\\AwsS3Adapter',
+                'to' => 'League\\Flysystem\\AwsS3V3\\AwsS3V3Adapter'
+            ]
+        ]));
+
+        return new ReplacementResult($traverser->traverse($ast));
+    }
+
+    function run(string $file, string $code, array $ast, array $data): ?ReplacementResult
+    {
+        $traverser = $this->traverser();
+
+        // before
+        // new FilesystemAdapter(new Filesystem(new LocalAdapter($path)));
+        //
+        // after
+        // new FilesystemAdapter(new Filesystem($adapter = new LocalAdapter($path)), $adapter);
+        $traverser->addVisitor(new class () extends \PhpParser\NodeVisitorAbstract {
+            public function enterNode(\PhpParser\Node $node)
+            {
+                if ($node instanceof \PhpParser\Node\Expr\New_) {
+                    if ($node->class->name === 'FilesystemAdapter' && count($node->args) === 1) {
+                        $filesystem = $node->args[0]->value;
+
+                        if ($filesystem instanceof \PhpParser\Node\Expr\New_ && $filesystem->class->name === 'Filesystem') {
+                            $adapter = $filesystem->args[0]->value;
+
+                            if ($adapter instanceof \PhpParser\Node\Expr\New_) {
+                                // Turn into a variable assignment
+                                $filesystem->args[0] = new \PhpParser\Node\Arg(new \PhpParser\Node\Expr\Assign($var = new \PhpParser\Node\Expr\Variable('adapter'), $adapter));
+                            } else {
+                                $var = $adapter;
+                            }
+
+                            // Add the new argument
+                            $node->args[] = new \PhpParser\Node\Arg($var);
+
+                            return NodeVisitor::DONT_TRAVERSE_CHILDREN;
+                        }
+                    }
+                }
+            }
+        });
+
+        return new ReplacementResult($traverser->traverse($ast));
+    }
+}

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

@@ -0,0 +1,86 @@
+<?php
+
+namespace Flarum\CliPhpSubsystem\Upgrade\TwoPointOh;
+
+use Flarum\CliPhpSubsystem\NodeVisitors\ReplaceUses;
+use Flarum\CliPhpSubsystem\Upgrade\Replacement;
+use Flarum\CliPhpSubsystem\Upgrade\ReplacementResult;
+use PhpParser\Node;
+use PhpParser\Node\Expr\Cast\Object_;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\PropertyFetch;
+use PhpParser\NodeVisitor;
+
+class InterventionImage extends Replacement
+{
+    protected function operations(): array
+    {
+        return ['run'];
+    }
+
+    function run(string $file, string $code, array $ast, array $data): ?ReplacementResult
+    {
+        $traverser = $this->traverser();
+
+        $traverser->addVisitor(new NodeVisitor\NameResolver(null, [
+            'replaceNodes' => false,
+        ]));
+        $traverser->addVisitor(new NodeVisitor\ParentConnectingVisitor());
+
+        $traverser->addVisitor(new class () extends \PhpParser\NodeVisitorAbstract {
+            protected $propertyTypes = [];
+
+            public function enterNode(Node $node)
+            {
+                if ($node instanceof Node\Stmt\Property
+                    && $node->type
+                    && $node->type->hasAttribute('resolvedName')
+                    && strpos($node->type->getAttribute('resolvedName')->name, 'Intervention\\Image\\') === 0
+                ) {
+                    $this->propertyTypes[$node->props[0]->name->name] = $node->type->getAttribute('resolvedName')->name;
+                }
+
+                if ($node instanceof Node\Stmt\ClassMethod && $node->name->name === '__construct') {
+                    foreach ($node->params as $param) {
+                        if (! $param->flags
+                            || ! $param->type
+                            || ! $param->type->hasAttribute('resolvedName')
+                            || ! is_string($param->var->name)
+                            || strpos($param->type->getAttribute('resolvedName')->name, 'Intervention\\Image\\') !== 0
+                        ) {
+                            continue;
+                        }
+
+                        $this->propertyTypes[$param->var->name] = $param->type->getAttribute('resolvedName')->name;
+                    }
+                }
+            }
+
+            public function leaveNode(\PhpParser\Node $node)
+            {
+                // if we are accessing an object under the Intervention\Image namespace
+                if ($node instanceof PropertyFetch && isset($this->propertyTypes[$node->name->name])) {
+                    $primeParent = $this->findPrimeParent($node);
+
+                    $primeParent->setAttribute('comments', [new \PhpParser\Comment\Doc(<<<PHPDOC
+                    /**
+                     * @TODO: confirm if this still works with intervention/image v3
+                     *        see: https://image.intervention.io/v3/introduction/upgrade
+                     */
+                    PHPDOC)]);
+                }
+            }
+
+            protected function findPrimeParent($node)
+            {
+                if ($node->getAttribute('parent') instanceof Node\Stmt\ClassMethod || $node->getAttribute('parent') instanceof Node\Stmt\Function_) {
+                    return $node;
+                }
+
+                return $this->findPrimeParent($node->getAttribute('parent'));
+            }
+        });
+
+        return new ReplacementResult($traverser->traverse($ast));
+    }
+}

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

@@ -0,0 +1,186 @@
+<?php
+
+namespace Flarum\CliPhpSubsystem\Upgrade\TwoPointOh;
+
+use Flarum\CliPhpSubsystem\NodeUtil;
+use Flarum\CliPhpSubsystem\Upgrade\Replacement;
+use Flarum\CliPhpSubsystem\Upgrade\ReplacementResult;
+use PhpParser\NodeVisitor;
+
+class JsonApi extends Replacement
+{
+    protected function operations(): array
+    {
+        return ['run', 'extenders'];
+    }
+
+    function run(string $file, string $code, array $ast, array $data): ?ReplacementResult
+    {
+        if (strpos($file, 'extend.php') !== false) {
+            return null;
+        }
+
+        $traverser = $this->traverser();
+
+        $traverser->addVisitor(new NodeVisitor\NameResolver(null, [
+            'replaceNodes' => false,
+        ]));
+        $traverser->addVisitor(new NodeVisitor\ParentConnectingVisitor());
+
+        // Go through every class that extends Flarum\Api\Serializer\AbstractSerializer
+        // Add a comment to remove the class.
+        // Collect the value of the `type` property of the class.
+        // Collect the type (doctype) of the first arg of the getDefaultAttributes method.
+
+        $traverser->addVisitor($visitor = new class () extends \PhpParser\NodeVisitorAbstract {
+            public $collect = [];
+
+            const STALE = [
+                'Flarum\Api\Serializer\AbstractSerializer',
+                'Flarum\Api\Controller\AbstractSerializeController',
+                'Flarum\Api\Controller\AbstractShowController',
+                'Flarum\Api\Controller\AbstractCreateController',
+                'Flarum\Api\Controller\AbstractUpdateController',
+                'Flarum\Api\Controller\AbstractDeleteController',
+                'Flarum\Api\Controller\AbstractListController',
+            ];
+
+            public function enterNode(\PhpParser\Node $node)
+            {
+                if ($node instanceof \PhpParser\Node\Stmt\Class_ && $node->extends) {
+                    if (in_array($node->extends->getAttribute('resolvedName')->name, self::STALE)) {
+                        $node->setAttribute('comments', [new \PhpParser\Comment\Doc(<<<PHPDOC
+                        /**
+                         * @TODO: Remove this in favor of one of the API resource classes that were added.
+                         *      Or extend an existing API Resource to add this to.
+                         *      Or use a vanilla RequestHandlerInterface controller.
+                         *      @link https://docs.flarum.org/2.x/extend/api#endpoints
+                         */
+                        PHPDOC)]);
+                    } else {
+                        return NodeVisitor::DONT_TRAVERSE_CHILDREN;
+                    }
+                }
+
+                if ($node instanceof \PhpParser\Node\Stmt\Property) {
+                    if (! $node->isStatic() && $node->props[0]->name->name === 'type') {
+                        $this->collect['type'] = $node->props[0]->default->value;
+                        $this->collect['serializer'] = $node->getAttribute('parent')->name->name;
+                    }
+                }
+
+                if ($node instanceof \PhpParser\Node\Stmt\ClassMethod) {
+                    if ($node->name->name === 'getDefaultAttributes') {
+                        // Get the type from the docblock
+                        preg_match('/@param\s+([^\s]+)\s+\$'.$node->params[0]->var->name.'/', $node->getDocComment()->getText(), $matches);
+
+                        $model = null;
+
+                        if (! empty($matches[1])) {
+                            $model = ltrim($matches[1], '\\');
+
+                            $types = array_values(array_filter(explode('|', $model), function ($model) {
+                                return $model !== 'null' && $model !== 'array';
+                            }));
+
+                            $model = ! empty($types[0]) && !in_array($types[0], ['object', 'array']) ? trim($types[0]) : null;
+                        }
+
+                        $this->collect['model'] = $model;
+                    }
+                }
+
+                if ($node instanceof \PhpParser\Node\Stmt\Return_) {
+                    if ($node->expr instanceof \PhpParser\Node\Expr\MethodCall && in_array($node->expr->name->name, ['hasOne', 'hasMany'])) {
+                        $parent = $node->getAttribute('parent');
+
+                        if ($parent instanceof \PhpParser\Node\Stmt\ClassMethod) {
+                            $this->collect['relations'][] = [$parent->name->name, $node->expr->name->name];
+                        }
+                    }
+                }
+            }
+        });
+
+        $ast = $traverser->traverse($ast);
+
+        $collected = $visitor->collect;
+
+        if (isset($collected['model']) && strpos($collected['model'], '\\') === false) {
+            $fqn = preg_match("/use (.+\\\\{$collected['model']});/", $code, $matches) ? $matches[1] : null;
+
+            if ($fqn) {
+                $collected['model'] = $fqn;
+            }
+        }
+
+        return new ReplacementResult($ast, compact('collected'));
+    }
+
+    function extenders(string $file, string $code, array $ast): ?ReplacementResult
+    {
+        if (strpos($file, 'extend.php') === false) {
+            return null;
+        }
+
+        if (strpos($code, 'use Flarum\Api\Schema') !== false) {
+            return null;
+        }
+
+        $traverser = $this->traverser();
+
+        $traverser->addVisitor(new NodeVisitor\NameResolver(null, [
+            'replaceNodes' => false,
+        ]));
+
+        $traverser->addVisitor(new NodeVisitor\ParentConnectingVisitor());
+
+        $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;
+
+            public function enterNode(\PhpParser\Node $node)
+            {
+                if ($node instanceof \PhpParser\Node\Expr\New_) {
+                    if ($node->class instanceof \PhpParser\Node\Name) {
+                        $class = $node->class->getAttribute('resolvedName')->name;
+
+                        if (in_array($class, ['Flarum\Extend\ApiSerializer', 'Flarum\Extend\ApiController', 'Flarum\Foundation\AbstractValidator'])) {
+                            $parent = $node->getAttribute('parent');
+
+                            while ($parent && ! $parent instanceof \PhpParser\Node\Expr\ArrayItem) {
+                                $parent = $parent->getAttribute('parent');
+                            }
+
+                            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));
+    }
+}