Merge branch 'hotfix/1-escape-chars'

Fixes #1 Conflicts: CHANGELOG.md
laminas · Oct 30, 2019 · f0c5e03 · f0c5e03
2 parents 3ed0833 + be407c5
commit f0c5e03
Show file tree

Hide file tree

Showing 6 changed files with 81 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 0.1.1 - 2019-10-30
+
+### Added
+
+- Nothing.
+
+### Changed
+
+- Nothing.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- [#1](https://github.com/laminas/laminas-migration/pull/1) provides updates to replacements for strings containing escape characters, to ensure the same number of escape characters are used in replacements.
+
 ## 0.1.0 - 2019-10-30
 
 ### Added

diff --git a/phpcs.xml b/phpcs.xml
@@ -1,9 +1,13 @@
 <?xml version="1.0"?>
-<ruleset>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="./vendor/squizlabs/php_codesniffer/phpcs.xsd">
     <rule ref="PSR12"/>
 
     <arg value="p"/>
     <arg name="colors"/>
 
     <file>src</file>
+    <file>test</file>
+
+    <exclude-pattern>test/TestAsset/</exclude-pattern>
 </ruleset>
diff --git a/src/Helper.php b/src/Helper.php
@@ -19,29 +19,25 @@ private static function replacements()
             // Package namespaces.
             // Duplicates with varying numbers of escapes provided to ensure
             // matching occurs properly across all edge cases.
-            'Zend\ProblemDetails' => 'Expressive\\ProblemDetails',
             'Zend\\ProblemDetails' => 'Expressive\\ProblemDetails',
-            'Zend\\\\ProblemDetails' => 'Expressive\\ProblemDetails',
-            'Zend\Expressive' => 'Expressive',
+            'Zend\\\\ProblemDetails' => 'Expressive\\\\ProblemDetails',
             'Zend\\Expressive' => 'Expressive',
             'Zend\\\\Expressive' => 'Expressive',
-            'ZF\ComposerAutoloading' => 'Laminas\\ComposerAutoloading',
             'ZF\\ComposerAutoloading' => 'Laminas\\ComposerAutoloading',
-            'ZF\\\\ComposerAutoloading' => 'Laminas\\ComposerAutoloading',
-            'ZF\Deploy' => 'Laminas\\Deploy',
+            'ZF\\\\ComposerAutoloading' => 'Laminas\\\\ComposerAutoloading',
             'ZF\\Deploy' => 'Laminas\\Deploy',
-            'ZF\\\\Deploy' => 'Laminas\\Deploy',
-            'ZF\DevelopmentMode' => 'Laminas\\DevelopmentMode',
+            'ZF\\\\Deploy' => 'Laminas\\\\Deploy',
             'ZF\\DevelopmentMode' => 'Laminas\\DevelopmentMode',
-            'ZF\\\\DevelopmentMode' => 'Laminas\\DevelopmentMode',
-            'ZF\Apigility' => 'Apigility',
+            'ZF\\\\DevelopmentMode' => 'Laminas\\\\DevelopmentMode',
             'ZF\\Apigility' => 'Apigility',
             'ZF\\\\Apigility' => 'Apigility',
             'ZendXml' => 'Laminas\\Xml',
             'ZendOAuth' => 'Laminas\\OAuth',
             'ZendDiagnostics' => 'Laminas\\Diagnostics',
             'ZendService\\ReCaptcha' => 'Laminas\\ReCaptcha',
+            'ZendService\\\\ReCaptcha' => 'Laminas\\\\ReCaptcha',
             'ZendService\\Twitter' => 'Laminas\\Twitter',
+            'ZendService\\\\Twitter' => 'Laminas\\\\Twitter',
 
             // Do not rewrite:
             'Doctrine\Zend' => 'Doctrine\Zend',

diff --git a/test/HelperTest.php b/test/HelperTest.php
@@ -11,10 +11,16 @@
 use Laminas\Migration\Helper;
 use PHPUnit\Framework\TestCase;
 
+use function file_get_contents;
+
 class HelperTest extends TestCase
 {
-    public function edgeCases() : iterable
+    public function edgeCases(): iterable
     {
+        yield 'Example class' => [
+            file_get_contents(__DIR__ . '/TestAsset/TestClass.php'),
+            file_get_contents(__DIR__ . '/TestAsset/TestClass.php.out'),
+        ];
         yield 'Apigility module' => ['ZF\Apigility', 'Apigility'];
         yield 'Apigility documentation module' => ['ZF\Apigility\Documentation', 'Apigility\Documentation'];
         yield 'Apigility modules.config.php' => [
@@ -28,7 +34,7 @@ public function edgeCases() : iterable
      * @param string $string
      * @param string $expected
      */
-    public function testEdgeCases($string, $expected) : void
+    public function testEdgeCases($string, $expected): void
     {
         $this->assertSame($expected, Helper::replace($string));
     }

diff --git a/test/TestAsset/TestClass.php b/test/TestAsset/TestClass.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Zend\ProblemDetails;
+
+use ZF\ComposerAutoloading\Something;
+use ZF\Apigility\Doctrine\MyDoctrine;
+use Zend\Version;
+use ZendService\Amazon;
+use ZendPdf\Renderer;
+
+class MyClass extends \Zend\Expressive\Router
+{
+    /** @var string|\Zend\View\Renderer */
+    private $class;
+
+    public function __construct()
+    {
+        $this->class = 'Zend\\View\\Renderer';
+    }
+}
diff --git a/test/TestAsset/TestClass.php.out b/test/TestAsset/TestClass.php.out
@@ -0,0 +1,20 @@
+<?php
+
+namespace Expressive\ProblemDetails;
+
+use Laminas\ComposerAutoloading\Something;
+use Apigility\Doctrine\MyDoctrine;
+use Zend\Version;
+use ZendService\Amazon;
+use ZendPdf\Renderer;
+
+class MyClass extends \Expressive\Router
+{
+    /** @var string|\Laminas\View\Renderer */
+    private $class;
+
+    public function __construct()
+    {
+        $this->class = 'Laminas\\View\\Renderer';
+    }
+}