Allow to define how many path components to strip per patch

Author: pinkeen

README.md

@@ -7,7 +7,8 @@ This plugin can automatically apply patches to any dependency of your project.
 
 One of the most distinguishing features is that it can apply patches from special composer packages of type `patchset`.
 This is quite convenient as you can store all your patches in one repository and apply them automatically on all
-systems including developer's machines in a very predictable way.
+systems including developer's machines in a very predictable way. Also you can easily distribute your patchset to the
+whole community via packagist.
 
 It's (kind-of) an alternative to two other great plugins (differences will become apparent once you read __Features__):
 
@@ -73,6 +74,16 @@ the actions necessary to get there.
  purpose. I can hardly imagine a legit use case when it would be desirable that installing package X will automatically 
  patch some other package Y in your project without explicitly being advertised as a patchset.
 
+## Usage
+
+### Create *patchset* composer package
+
+### Define patches in your root package
+
+### Options
+
+#### Strip defined number of components when applying patch (`-pX`)
+
 ## Running tests
 
 Just start `vendor/bin/phpunit`.
@@ -83,7 +94,3 @@ vendor/bin/phpunit --debug
 
 It's nice to also add the `--testdox` switch then.
 
-   
-### Notes to myself
-
-- Tests for skipping package aliases (BTW Maybe use localrepo->getCanonicalPackages)

src/Patch.php

@@ -43,25 +43,33 @@ class Patch
      */
     private $filename;
 
+    /**
+     * @var int
+     */
+    private $stripPathComponents = 1;
+
     /**
      * @param $sourcePackage
      * @param string $targetPackage
      * @param string $versionConstraint
      * @param string $filename
      * @param string $description
+     * @param int $stripPathComponents
      */
     public function __construct(
         $sourcePackage,
         $targetPackage,
         $versionConstraint,
         $filename,
-        $description
+        $description,
+        $stripPathComponents = 1
     ) {
         $this->sourcePackage = $sourcePackage;
         $this->targetPackage = $targetPackage;
         $this->versionConstraint = $versionConstraint;
         $this->filename = $filename;
         $this->description = $description;
+        $this->stripPathComponents = $stripPathComponents;
     }
 
     /**
@@ -73,16 +81,18 @@ public function __construct(
     public static function createFromConfig($sourcePackage, $targetPackage, array $config)
     {
         $config = array_merge([
-            'version_constraint' => '*',
+            'version-constraint' => '*',
             'description' => null,
+            'strip-path-components' => 1
         ], $config);
 
         return new static(
             $sourcePackage,
             $targetPackage,
-            $config['version_constraint'],
+            $config['version-constraint'],
             $config['filename'],
-            $config['description']
+            $config['description'],
+            $config['strip-path-components']
         );
     }
 
@@ -94,7 +104,8 @@ public static function createFromArray(array $data)
             $data['target_package'],
             $data['version_constraint'],
             $data['filename'],
-            $data['description']
+            $data['description'],
+            $data['strip_path_components']
         );
     }
 
@@ -155,6 +166,15 @@ public function getDescription()
         return $this->description;
     }
 
+    /**
+     * @return int
+     */
+    public function getStripPathComponents()
+    {
+        return $this->stripPathComponents;
+    }
+
+
     public function toArray()
     {
         return [
@@ -163,6 +183,7 @@ public function toArray()
             'version_constraint' => $this->versionConstraint,
             'filename' => $this->filename,
             'description' => $this->description,
+            'strip_path_components' => $this->stripPathComponents
         ];
     }
 }

src/PatchApplicator.php

@@ -106,7 +106,7 @@ public function applyPatch(Patch $patch, PackageInterface $sourcePackage, Packag
         $targetDirectory = $this->pathResolver->getPackageInstallPath($targetPackage);
         $patchFilename = $this->pathResolver->getPatchSourceFilePath($sourcePackage, $patch);
 
-        if (!$this->executePatchCommand($targetDirectory, $patchFilename, 1)) {
+        if (!$this->executePatchCommand($targetDirectory, $patchFilename, $patch->getStripPathComponents())) {
             throw new \RuntimeException('Could not apply patch: ' . $this->cmdErr);
         }
 

tests/Functional/CoreFeatureTest.php

@@ -226,4 +226,23 @@ public function testRootCanPatchItself()
         $installRun = $project->runComposerCommand('install');
         $this->assertThatComposerRunHasAppliedPatches($installRun, self::ROOT_PACKAGE_APPLICATIONS);
     }
+
+    public function testArbitraryNumberOfPathComponentsCanBeStripped()
+    {
+        $project = $this->getSandbox()->createProjectSandBox('test/project-template', 'dev-master', [
+            'require' => [
+                'test/patchset' => '2.0',
+                'test/package-a' => 'dev-master',
+            ]
+        ]);
+
+        $installRun = $project->runComposerCommand('install', '-vvv');
+
+        $this->assertThatComposerRunHasAppliedPatches($installRun,
+            array_merge_recursive(
+                self::PACKAGEA_PATCH1_APPLICATIONS,
+                self::PACKAGEA_PATCH2_APPLICATIONS
+            )
+        );
+    }
 }

tests/Functional/Fixtures/packages/patchset-extra/patches/package-a-patch-2.diff

@@ -1,5 +1,3 @@
-diff --git a/src/test.php b/src/test.php
-index 6cb2e72..255f36b 100644
 --- a/src/test.php
 +++ b/src/test.php
 @@ -1,6 +1,9 @@

tests/Functional/Fixtures/packages/patchset/v2.0/composer.json

@@ -0,0 +1,24 @@
+{
+    "name": "test/patchset",
+    "type": "patchset",
+    "version": "2.0",
+    "require": {
+        "creativestyle/composer-plugin-patchset": "dev-master"
+    },
+    "extra": {
+        "patchset": {
+            "test/package-a": [
+                {
+                    "description": "Patch in echo in the middle",
+                    "filename": "patches/package-a-patch-1-p0.diff",
+                    "strip-path-components": 0
+                },
+                {
+                    "description": "Patch in echo at the end",
+                    "filename": "patches/package-a-patch-2-p2.diff",
+                    "strip-path-components": 2
+                }
+            ]
+        }
+    }
+}

tests/Functional/Fixtures/packages/patchset/v2.0/patches/package-a-patch-1-p0.diff

@@ -0,0 +1,9 @@
+--- src/test.php
++++ src/test.php
+@@ -1,5 +1,6 @@
+ <?php
+ 
+ echo 'first-echo';
++echo 'patched-in-echo';
+ echo 'last-echo';
+ 

tests/Functional/Fixtures/packages/patchset/v2.0/patches/package-a-patch-2-p2.diff

@@ -0,0 +1,12 @@
+--- test/package-a/src/test.php
++++ test/package-a/src/test.php
+@@ -1,6 +1,9 @@
+ <?php
+ 
++echo 'layered-patch-line-1';
+ echo 'first-echo';
+ echo 'patched-in-echo';
++echo 'layered-patch-line-2';
+ echo 'last-echo';
++echo 'layered-patch-line-3';
+