[Help wanted] Add PHAR

.gitignore

@@ -4,3 +4,7 @@
 /example
 /vendor
 composer.lock
+
+# phar related
+/build
+rector.phar

.travis.yml

@@ -3,7 +3,7 @@ language: php
 matrix:
   include:
     - php: 7.1
-      env: STATIC_ANALYSIS=true RUN_RECTOR=true
+      env: BUILD_PHAR=true PHPUNIT_FLAGS="--testsuite=main" STATIC_ANALYSIS=true
     - php: 7.2
       env: PHPUNIT_FLAGS="--coverage-clover coverage.xml --testsuite=contrib-rectors"
     - php: 7.2
@@ -24,8 +24,13 @@ script:
   - phpenv config-rm xdebug.ini || return 0
   - if [[ $STATIC_ANALYSIS != "" ]]; then composer check-cs; fi
   - if [[ $STATIC_ANALYSIS != "" ]]; then composer phpstan; fi
-  # Rector demo run
-  - if [[ $RUN_RECTOR != "" ]]; then bin/rector process src tests --level symfony40 --dry-run; fi
+  # build phar test - 1st group is "build-phar" test step by step; 2nd group is all-together
+  - |
+    if [[ $BUILD_PHAR != "" ]]; then
+      packages/PharBuilder/bin/compile
+      php rector.phar
+      vendor/bin/phpunit --testsuite=phar-build
+    fi
 
 after_script:
   # upload coverage to Coveralls.io

README.md

@@ -157,6 +157,7 @@ vendor/bin/ecs check --config vendor/rector/rector/ecs-after-rector.neon --fix
 - [How to Create Rector with Fluent Builder](/docs/FluentBuilderRector.md)
 - [How to Create Own Rector](/docs/HowToCreateOwnRector.md)
 - [Service Name to Type Provider](/docs/ServiceNameToTypeProvider.md)
+- [3 Steps to Build PHAR](/docs/BuildingRectorPhar.md)
 
 ## How to Contribute
 

bin/subtree-split-master-and-last-tag.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+git subsplit init [email protected]:rectorphp/rector.git
+
+LAST_TAG=$(git tag -l  --sort=committerdate | tail -n1);
+
+git subsplit publish --heads="master" --tags=$LAST_TAG packages/NodeTypeResolver:[email protected]:rectorphp/node-type-resolver.git
+
+rm -rf .subsplit/
+
+# inspired by laravel: https://github.com/laravel/framework/blob/5.4/build/illuminate-split-full.sh
+# they use SensioLabs now though: https://github.com/laravel/framework/pull/17048#issuecomment-269915319

composer.json

@@ -17,6 +17,7 @@
         "phpdocumentor/type-resolver": "^0.4",
         "rector/better-reflection": "^3.0.6",
         "sebastian/diff": "^3.0",
+        "seld/phar-utils": "^1.0",
         "symfony/console": "^4.0",
         "symfony/dependency-injection": "^4.0",
         "symfony/finder": "^4.0",
@@ -28,6 +29,9 @@
         "phpstan/phpstan-shim": "^0.9",
         "phpunit/phpunit": "^7.0",
         "slam/php-cs-fixer-extensions": "^1.13",
+        "symfony/expression-language": "^4.0",
+        "symfony/form": "^4.0",
+        "symplify/coding-standard": "^3.2",
         "tracy/tracy": "^2.4"
     },
     "autoload": {
@@ -36,6 +40,7 @@
             "Rector\\BetterReflection\\": "packages/BetterReflection/src",
             "Rector\\ConsoleDiffer\\": "packages/ConsoleDiffer/src",
             "Rector\\RectorBuilder\\": "packages/RectorBuilder/src",
+            "Rector\\PharBuilder\\": "packages/PharBuilder/src",
             "Rector\\ReflectionDocBlock\\": "packages/ReflectionDocBlock/src",
             "Rector\\NodeTypeResolver\\": "packages/NodeTypeResolver/src",
             "Rector\\NodeTraverserQueue\\": "packages/NodeTraverserQueue/src"

docs/BuildingRectorPhar.md

@@ -0,0 +1,7 @@
+# How to Build `rector.phar`
+
+To build `rector.phar` just run:
+
+```bash
+packages/PharBuilder/bin/compile 
+```

easy-coding-standard.neon

@@ -26,6 +26,9 @@ checkers:
             - 'Rector\BetterReflection\SourceLocator\Located\LocatedSource'
             - 'phpDocumentor\Reflection\Types\*'
             - 'Rector\Reporting\FileDiff'
+            - 'Phar'
+            - 'Symfony\Component\Finder\Finder'
+            - 'Seld\PharUtils\Timestamps'
 
     Symplify\CodingStandard\Fixer\Naming\PropertyNameMatchingTypeFixer:
         extra_skipped_classes:

packages/PharBuilder/bin/compile

@@ -0,0 +1,36 @@
+#!/usr/bin/env php
+<?php declare(strict_types=1);
+
+require_once __DIR__ . '/../../../vendor/autoload.php';
+
+use Rector\PharBuilder\DependencyInjection\ContainerFactory;
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symplify\PackageBuilder\Console\Style\SymfonyStyleFactory;
+
+error_reporting(-1);
+ini_set('display_errors', '1');
+
+try {
+    $container = (new ContainerFactory())->create();
+
+    // 3. Run Console Application
+    /** @var Application $application */
+    $application = $container->get(Application::class);
+    /** @var InputInterface $input */
+    $input = $container->get(InputInterface::class);
+    /** @var OutputInterface $output */
+    $output = $container->get(OutputInterface::class);
+    $statusCode = $application->run($input, $output);
+    exit($statusCode);
+} catch (Throwable $throwable) {
+    $symfonyStyle = SymfonyStyleFactory::create();
+    $symfonyStyle->error(sprintf(
+        '%s in %s on line %d',
+        $throwable->getMessage(),
+        $throwable->getFile(),
+        $throwable->getLine()
+    ));
+    exit($throwable->getCode());
+}

packages/PharBuilder/src/Command/CompileCommand.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types=1);
+
+namespace Rector\PharBuilder\Command;
+
+use Rector\PharBuilder\Compiler\Compiler;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symplify\PackageBuilder\Console\Command\CommandNaming;
+
+final class CompileCommand extends Command
+{
+    /**
+     * @var Compiler
+     */
+    private $compiler;
+
+    public function __construct(Compiler $compiler)
+    {
+        $this->compiler = $compiler;
+
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this->setName(CommandNaming::classToName(self::class));
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): void
+    {
+        $this->compiler->compile();
+    }
+}

packages/PharBuilder/src/Compiler/Compiler.php

@@ -0,0 +1,165 @@
+<?php declare(strict_types=1);
+
+namespace Rector\PharBuilder\Compiler;
+
+use FilesystemIterator;
+use Phar;
+use Rector\PharBuilder\Exception\BinFileNotFoundException;
+use Rector\PharBuilder\Filesystem\PathNormalizer;
+use Rector\PharBuilder\Filesystem\PharFilesFinder;
+use Rector\PharBuilder\FinderToPharAdder;
+use Seld\PharUtils\Timestamps;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Process\Process;
+
+final class Compiler
+{
+    /**
+     * @var string
+     */
+    private $pharName;
+
+    /**
+     * @var PharFilesFinder
+     */
+    private $pharFilesFinder;
+
+    /**
+     * @var SymfonyStyle
+     */
+    private $symfonyStyle;
+
+    /**
+     * @var string
+     */
+    private $binFileName;
+
+    /**
+     * @var PathNormalizer
+     */
+    private $pathNormalizer;
+
+    /**
+     * @var FinderToPharAdder
+     */
+    private $finderToPharAdder;
+
+    /**
+     * @var string
+     */
+    private $buildDirectory;
+
+    public function __construct(
+        string $pharName,
+        string $binFileName,
+        string $buildDirectory,
+        PharFilesFinder $pharFilesFinder,
+        SymfonyStyle $symfonyStyle,
+        PathNormalizer $pathNormalizer,
+        FinderToPharAdder $finderToPharAdder
+    ) {
+        $this->pharName = $pharName;
+        $this->pharFilesFinder = $pharFilesFinder;
+        $this->binFileName = $binFileName;
+        $this->symfonyStyle = $symfonyStyle;
+        $this->pathNormalizer = $pathNormalizer;
+        $this->finderToPharAdder = $finderToPharAdder;
+        $this->buildDirectory = realpath($buildDirectory);
+    }
+
+    public function compile(): void
+    {
+        $this->symfonyStyle->note(sprintf('Starting PHAR build in "%s" directory', $this->buildDirectory));
+
+        // flags: KEY_AS_PATHNAME - use relative paths from Finder keys
+        $phar = new Phar($this->pharName, FilesystemIterator::KEY_AS_PATHNAME, $this->pharName);
+        $phar->setSignatureAlgorithm(Phar::SHA1);
+        $phar->startBuffering();
+
+        // use only dev deps + rebuild dump autoload
+//        $this->symfonyStyle->note('Removing dev packages from composer');
+//        $process = new Process('composer update --no-dev', $buildDirectory);
+//        $process->run();
+
+        // dump autoload
+//        $this->symfonyStyle->note('Dumping new composer autoload');
+//        $process = new Process('composer dump-autoload --optimize', $buildDirectory);
+//        $process->run();
+
+        $finder = $this->pharFilesFinder->createForDirectory($this->buildDirectory);
+
+        $fileCount = $this->getFileCountFromFinder($finder);
+        $this->symfonyStyle->note(sprintf('Adding %d files', $fileCount));
+        $this->symfonyStyle->progressStart($fileCount);
+
+        $this->finderToPharAdder->addFinderToPhar($finder, $phar);
+
+        $this->symfonyStyle->newLine(2);
+        $this->symfonyStyle->note('Adding bin');
+        $this->addRectorBin($phar, $this->buildDirectory);
+
+        $this->symfonyStyle->note('Setting stub');
+        $phar->setStub($this->getStub());
+        $phar->stopBuffering();
+
+        $timestamps = new Timestamps($this->pharName);
+        $timestamps->save($this->pharName, Phar::SHA1);
+
+        // return dev deps
+//        $this->symfonyStyle->note('Returning dev packages to composer');
+//        $process = new Process('composer update', $buildDirectory);
+//        $process->run();
+
+        $this->symfonyStyle->success(sprintf('Phar file "%s" build successful!', $this->pharName));
+    }
+
+    private function addRectorBin(Phar $phar, string $buildDirectory): void
+    {
+        $binFilePath = $buildDirectory . DIRECTORY_SEPARATOR . $this->binFileName;
+        $this->ensureBinFileExists($binFilePath);
+
+        $content = file_get_contents($binFilePath);
+        $content = $this->removeShebang($content);
+
+        // replace absolute paths by phar:// paths
+        $content = $this->pathNormalizer->normalizeAbsoluteToPharInContent($content);
+
+        $phar->addFromString($this->binFileName, $content);
+    }
+
+    private function getStub(): string
+    {
+        $stubTemplate = <<<'EOF'
+#!/usr/bin/env php
+<?php
+Phar::mapPhar('%s');
+require 'phar://%s/%s';
+__HALT_COMPILER();
+EOF;
+
+        return sprintf($stubTemplate, $this->pharName, $this->pharName, $this->binFileName);
+    }
+
+    private function removeShebang(string $content): string
+    {
+        return preg_replace('~^#!/usr/bin/env php\s*~', '', $content);
+    }
+
+    private function getFileCountFromFinder(Finder $finder): int
+    {
+        return count(iterator_to_array($finder->getIterator()));
+    }
+
+    private function ensureBinFileExists(string $binFilePath): void
+    {
+        if (file_exists($binFilePath)) {
+            return;
+        }
+
+        throw new BinFileNotFoundException(sprintf(
+            'Bin file not found in "%s". Have you set it up in config.yml file?',
+            $binFilePath
+        ));
+    }
+}

packages/PharBuilder/src/DependencyInjection/ContainerFactory.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+
+namespace Rector\PharBuilder\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+final class ContainerFactory
+{
+    public function create(): ContainerInterface
+    {
+        $appKernel = new PharBuilderKernel();
+        $appKernel->boot();
+
+        // this is require to keep CLI verbosity independent on AppKernel dev/prod mode
+        // see: https://github.com/symfony/symfony/blob/c12c07865a6fe3a8e0edd8540ac3ab9a3bc75543/src/Symfony/Component/HttpKernel/Kernel.php#L115
+        putenv('SHELL_VERBOSITY=0');
+
+        return $appKernel->getContainer();
+    }
+}

packages/PharBuilder/src/DependencyInjection/PharBuilderKernel.php

@@ -0,0 +1,39 @@
+<?php declare(strict_types=1);
+
+namespace Rector\PharBuilder\DependencyInjection;
+
+use Symfony\Component\Config\Loader\LoaderInterface;
+use Symfony\Component\HttpKernel\Bundle\BundleInterface;
+use Symfony\Component\HttpKernel\Kernel;
+
+final class PharBuilderKernel extends Kernel
+{
+    public function __construct()
+    {
+        // debug: true is require to invalidate container on service files change
+        parent::__construct('cli' . random_int(1, 1000), true);
+    }
+
+    public function registerContainerConfiguration(LoaderInterface $loader): void
+    {
+        $loader->load(__DIR__ . '/../config/config.yml');
+    }
+
+    public function getCacheDir(): string
+    {
+        return sys_get_temp_dir() . '/_rector_phar_builder_cache';
+    }
+
+    public function getLogDir(): string
+    {
+        return sys_get_temp_dir() . '/_rector_phar_bulider_log';
+    }
+
+    /**
+     * @return BundleInterface[]
+     */
+    public function registerBundles(): array
+    {
+        return [];
+    }
+}