Build phar file of Codeception 5.0

Author: Naktibalda

RoboFile.php

@@ -10,7 +10,8 @@ class RoboFile extends \Robo\Tasks
     use DocumentationHelpers;
 
     const REPO_BLOB_URL = 'https://github.com/Codeception/Codeception/blob';
-    const STABLE_BRANCH = '4.2';
+    const BRANCH_4x = '4.2';
+    const BRANCH_5x = '5.0';
 
     function post()
     {
@@ -180,12 +181,11 @@ public function buildDocsUtils()
         $utils = [
             'Autoload'   => null,
             'Fixtures'   => null,
-            'Locator'    => null,
-            'XmlBuilder' => null,
+            'Locator'    => 'lib-web',
+            'XmlBuilder' => 'lib-xml',
             'JsonType'   => 'module-rest',
             'HttpCode'   => 'lib-innerbrowser',
         ];
-        //JsonType is in module-rest, HttpCode - in lib-innerbrowser
 
         foreach ($utils as $utilName => $repositoryName) {
             $className         = '\Codeception\Util\\' . $utilName;
@@ -322,7 +322,7 @@ public function buildDocsExtensions()
             ->prepend("# Official Extensions\n")
             ->processClassSignature(function (ReflectionClass $r, $text) {
                 $name = $r->getShortName();
-                return "## $name\n\n[See Source](" . self::REPO_BLOB_URL . "/" . self::STABLE_BRANCH . "/ext/$name.php)";
+                return "## $name\n\n[See Source](" . self::REPO_BLOB_URL . "/" . self::BRANCH_5x . "/ext/$name.php)";
             })
             ->filterMethods(function (ReflectionMethod $r) {
                 return false;
@@ -336,7 +336,7 @@ public function buildDocsExtensions()
     protected function documentApiClass($file, $className, $all = false, $repositoryName = null)
     {
         if ($repositoryName === null) {
-            $repositoryUrl = self::REPO_BLOB_URL . "/" . self::STABLE_BRANCH;
+            $repositoryUrl = self::REPO_BLOB_URL . "/" . self::BRANCH_5x;
         } else {
             $repositoryUrl = 'https://github.com/Codeception/' . $repositoryName . '/blob/master';
         }
@@ -471,9 +471,31 @@ private function postProcessFile($pageName, $documentationFile)
         file_put_contents($documentationFile, $contents);
     }
 
+    public function buildPhar80()
+    {
+        $version    = self::BRANCH_5x . '.' . date('Ymd');
+        $releaseDir = "releases/$version";
+        $this->stopOnFail();
+
+        $this->taskFilesystemStack()->mkdir('build/80')->run();
+        $this->setCodeceptionVersionTo('^5.0');
+        $this->setPlatformVersionTo('8.0.2');
+        $buildFile = 'build/80/codecept.phar';
+        $this->buildPhar($buildFile);
+        $this->updateVersionFile($buildFile, 'php80/codecept.version');
+        $versionedFile = "$releaseDir/codecept.phar";
+        $this->taskFilesystemStack()
+            ->stopOnFail()
+            ->mkdir($releaseDir)
+            ->copy($buildFile, $versionedFile)
+            ->remove('php80/codecept.phar')
+            ->symlink($versionedFile, 'php80/codecept.phar')
+            ->run();
+    }
+
     public function buildPhar72()
     {
-        $version    = self::STABLE_BRANCH . '.' . date('Ymd');
+        $version    = self::BRANCH_4x . '.' . date('Ymd');
         $releaseDir = "releases/$version";
         $this->stopOnFail();
 
@@ -494,7 +516,7 @@ public function buildPhar72()
 
     public function buildPhar56()
     {
-        $version    = self::STABLE_BRANCH . '.' . date('Ymd');
+        $version    = self::BRANCH_4x . '.' . date('Ymd');
         $releaseDir = "releases/$version";
         $this->stopOnFail();
 
@@ -522,7 +544,7 @@ public function findReleases()
 
     public function release()
     {
-        $version    = self::STABLE_BRANCH . '.' . date('Ymd');
+        $version    = self::BRANCH_4x . '.' . date('Ymd');
         $releaseDir = "releases/$version";
         $this->updateBuildsPage();
 
@@ -538,12 +560,37 @@ public function release()
             ->run();
     }
 
+    public function release80()
+    {
+        $version    = self::BRANCH_5x . '.' . date('Ymd');
+        $releaseDir = "releases/$version";
+        $this->updateBuildsPage();
+
+        $this->taskGitStack()
+            ->stopOnFail()
+            ->checkout('-- package/composer.json')
+            ->add('builds.markdown')
+            ->add('php80/codecept.phar')
+            ->add('php80/codecept.version')
+            ->add($releaseDir)
+            ->run();
+    }
+
     private function setPlatformVersionTo($version)
     {
         $this->taskComposerConfig()->workingDir('package')->set('platform.php', $version)->run();
         $this->taskComposerUpdate()->preferDist()->optimizeAutoloader()->workingDir('package')->run();
     }
 
+    private function setCodeceptionVersionTo($version)
+    {
+        $this->taskComposerRequire()
+            ->dependency('codeception/codeception', $version)
+            ->ignorePlatformRequirements()
+            ->workingDir('package')
+            ->run();
+    }
+
     /**
      * @desc creates codecept.phar
      * @throws Exception
@@ -701,8 +748,10 @@ public function updateBuildsPage()
                     $releaseFile->line("*Requires: PHP 5.3 and higher + CURL*\n");
                 } elseif ($major == 2 && $minor < 4) {
                     $releaseFile->line("*Requires: PHP 5.4 and higher + CURL*\n");
-                } else {
+                } elseif ($major < 5) {
                     $releaseFile->line("*Requires: PHP 5.6 and higher + CURL*\n");
+                } else {
+                    $releaseFile->line("*Requires: PHP 8.0 and higher + CURL*\n");
                 }
                 $releaseFile->line("* **[Download Latest $branch Release]($downloadUrl)**");
             }

package/README.md

@@ -17,7 +17,13 @@ Additional dependency compared with codeception/codecepion:
 ### Build instructions
 1. Install dependencies by running `composer install` in parent directory.
 2. Disable phar.readonly in your php.ini file, it must be `phar.readonly = Off`
-3. Run `./vendor/bin/robo build:phar72`
-4. Run `./vendor/bin/robo build:phar56`
-5. Run `./vendor/bin/robo release`
-6. Commit added files and push
+3. Build Codeception 4 phar file:
+    1. Run `./vendor/bin/robo build:phar72`
+    2. Run `./vendor/bin/robo build:phar56`
+    3. Run `./vendor/bin/robo release`
+4. Build Codeception 5 phar file:
+    1. Run `./vendor/bin/robo build:phar80`
+    2. Run `./vendor/bin/robo release80`
+5. Commit added files and push
+
+Note: it is necessary to delete package/composer.lock and package/vendor between Codeception 4 and 5 builds.