Merge pull request #176 from localheinz/feature/rector

Enhancement: Add support for rector/rector:~0.6.0

Author: Kharhamel

.gitignore

@@ -3,6 +3,6 @@
 /generator/doc/doc-en/
 /generator/doc/entities/generated.ent
 /composer.lock
-/vendor/
-/generator/tests/rector/0.4/composer.lock
-/generator/tests/rector/0.4/vendor/
+vendor/
+/generator/tests/rector/0.5/composer.lock
+/generator/tests/rector/0.6/composer.lock

.travis.yml

@@ -62,6 +62,7 @@ script:
     exit 1;
   fi
 - cd generator/tests/rector/0.5 && composer install && composer rector && composer test && cd ../../../..
+- cd generator/tests/rector/0.6 && composer install && composer rector && composer test && cd ../../../..
 
 after_script:
 - cd generator && travis_retry php vendor/bin/php-coveralls -v --root_dir="./generator"

README.md

@@ -114,13 +114,13 @@ tool that performs instant refactoring of your application.
 First, you need to install Rector:
 
 ```bash
-$ composer require --dev rector/rector ^0.5
+$ composer require --dev rector/rector ^0.6
 ```
 
 Now, you simply need to run Rector with this command:
 
 ```bash
-vendor/bin/rector process src/ --config vendor/thecodingmachine/safe/rector-migrate.yml
+vendor/bin/rector process src/ --config vendor/thecodingmachine/safe/rector-migrate-0.6.yml
 ```
 
 *Note:* do not forget to replace "src/" with the path to your source directory.

generator/src/FileCreator.php

@@ -116,6 +116,8 @@ public function generateFunctionsList(array $functions, string $path): void
     }
 
     /**
+     * @deprecated Official support for rector/rector:~0.5 is not advertised anymore.
+     *
      * This function generate a rector yml file containing a replacer for all functions
      *
      * @param Method[] $functions
@@ -140,6 +142,39 @@ public function generateRectorFile(array $functions, string $path): void
         fclose($stream);
     }
 
+    /**
+     * Generates a configuration file for replacing all functions when using rector/rector:~0.6.
+     *
+     * @param Method[] $functions
+     * @param string $path
+     */
+    public function generateRectorFileForZeroPointSix(array $functions, string $path): void
+    {
+        $functionNames = $this->getFunctionsNameList($functions);
+
+        $stream = fopen($path, 'w');
+
+        if ($stream === false) {
+            throw new \RuntimeException('Unable to write to '.$path);
+        }
+
+        $header = <<<'TXT'
+# This file configures rector/rector:~0.6.0 to replace all PHP functions with their equivalent "safe" functions
+
+services:
+  Rector\Renaming\Rector\Function_\RenameFunctionRector:
+    $oldFunctionToNewFunction:
+
+TXT;
+
+        fwrite($stream, $header);
+
+        foreach ($functionNames as $functionName) {
+            fwrite($stream, '      '.$functionName.": 'Safe\\".$functionName."'\n");
+        }
+
+        fclose($stream);
+    }
 
     public function createExceptionFile(string $moduleName): void
     {

generator/src/GenerateCommand.php

@@ -38,6 +38,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $fileCreator->generatePhpFile($functions, __DIR__ . '/../../generated/');
         $fileCreator->generateFunctionsList($functions, __DIR__ . '/../../generated/functionsList.php');
         $fileCreator->generateRectorFile($functions, __DIR__ . '/../../rector-migrate.yml');
+        $fileCreator->generateRectorFileForZeroPointSix($functions, __DIR__ . '/../../rector-migrate-0.6.yml');
 
 
         $modules = [];
@@ -75,7 +76,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         // Finally, let's edit the composer.json file
         $output->writeln('Editing composer.json');
         ComposerJsonEditor::editFiles(\array_values($modules));
-        
+
         return 0;
     }
 

generator/tests/rector/0.6/composer.json

@@ -0,0 +1,18 @@
+{
+  "autoload": {
+    "psr-4": {
+      "Test\\": "src/"
+    }
+  },
+  "require": {
+    "php": "^7.2",
+    "rector/rector": "^0.6.7"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^7"
+  },
+  "scripts": {
+    "rector": "rector process src/ --config ../../../../rector-migrate-0.6.yml",
+    "test": "phpunit"
+  }
+}

generator/tests/rector/0.6/phpunit.xml.dist

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+    backupGlobals="false"
+    backupStaticAttributes="false"
+    bootstrap="vendor/autoload.php"
+    colors="true"
+    convertErrorsToExceptions="true"
+    convertNoticesToExceptions="true"
+    convertWarningsToExceptions="true"
+    processIsolation="false"
+    stopOnFailure="false"
+>
+    <testsuites>
+        <testsuite name="Main test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

generator/tests/rector/0.6/src/test.php

@@ -0,0 +1,3 @@
+<?php
+
+glob('*');

generator/tests/rector/0.6/tests/RectorTest.php

@@ -0,0 +1,13 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+
+final class RectorTest extends TestCase
+{
+    public function testRectorSucceeded()
+    {
+        $content = file_get_contents(__DIR__.'/../src/test.php');
+
+        $this->assertContains('Safe', $content);
+    }
+}