Add event for applying patches

phpunit.xml.dist

@@ -0,0 +1,18 @@
+<!--?xml version="1.0" encoding="UTF-8"?-->
+
+<phpunit colors="true" bootstrap="vendor/autoload.php">
+ <testsuites>
+ <testsuite name="composer-patches">
+ <directory>./tests/</directory>
+ </testsuite>
+ </testsuites>
+ <!-- Filter for coverage reports. -->
+ <filter>
+ <whitelist>
+ <directory>src/</directory>
+ </whitelist>
+ <blacklist>
+ <directory>vendor/</directory>
+ </blacklist>
+ </filter>
+</phpunit>

src/PatchEvent.php

@@ -0,0 +1,70 @@
+<?php
+
+/**
+ * @file
+ * Dispatch events when patches are applied.
+ */
+
+namespace cweagans\Composer;
+
+use Composer\EventDispatcher\Event;
+use Composer\Package\PackageInterface;
+
+class PatchEvent extends Event {
+
+ /**
+ * @var PackageInterface $package
+ */
+ protected $package;
+ /**
+ * @var string $url
+ */
+ protected $url;
+ /**
+ * @var string $description
+ */
+ protected $description;
+
+ /**
+ * Constructs a PatchEvent object.
+ *
+ * @param string $eventName
+ * @param PackageInterface $package
+ * @param string $url
+ * @param string $description
+ */
+ public function __construct($eventName, PackageInterface $package, $url, $description) {
+ parent::__construct($eventName);
+ $this->package = $package;
+ $this->url = $url;
+ $this->description = $description;
+ }
+
+ /**
+ * Returns the package that is patched.
+ *
+ * @return PackageInterface
+ */
+ public function getPackage() {
+ return $this->package;
+ }
+
+ /**
+ * Returns the url of the patch.
+ *
+ * @return string
+ */
+ public function getUrl() {
+ return $this->url;
+ }
+
+ /**
+ * Returns the description of the patch.
+ *
+ * @return string
+ */
+ public function getDescription() {
+ return $this->description;
+ }
+
+}

src/PatchEvents.php

@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * @file
+ * Dispatch events when patches are applied.
+ */
+
+namespace cweagans\Composer;
+
+class PatchEvents {
+
+ /**
+ * The PRE_PATCH_APPLY event occurs before a patch is applied.
+ *
+ * The event listener method receives a cweagans\Composer\PatchEvent instance.
+ *
+ * @var string
+ */
+ const PRE_PATCH_APPLY = 'pre-patch-apply';
+
+ /**
+ * The POST_PATCH_APPLY event occurs after a patch is applied.
+ *
+ * The event listener method receives a cweagans\Composer\PatchEvent instance.
+ *
+ * @var string
+ */
+ const POST_PATCH_APPLY = 'post-patch-apply';
+
+}

src/Patches.php

@@ -35,6 +35,10 @@ class Patches implements PluginInterface, EventSubscriberInterface {
  * @var IOInterface $io
  */
  protected $io;
+ /**
+ * @var EventDispatcher $eventDispatcher
+ */
+ protected $eventDispatcher;
  /**
  * @var ProcessExecutor $executor
  */
@@ -53,6 +57,7 @@ class Patches implements PluginInterface, EventSubscriberInterface {
  public function activate(Composer $composer, IOInterface $io) {
  $this->composer = $composer;
  $this->io = $io;
+ $this->eventDispatcher = $composer->getEventDispatcher();
  $this->executor = new ProcessExecutor($this->io);
  $this->patches = array();
  }
@@ -226,7 +231,9 @@ public function postInstall(PackageEvent $event) {
  foreach ($this->patches[$package_name] as $description => $url) {
  $this->io->write(' <info>' . $url . '</info> (<comment>' . $description. '</comment>)');
  try {
+ $this->eventDispatcher->dispatch(NULL, new PatchEvent(PatchEvents::PRE_PATCH_APPLY, $package, $url, $description));
  $this->getAndApplyPatch($downloader, $install_path, $url);
+ $this->eventDispatcher->dispatch(NULL, new PatchEvent(PatchEvents::POST_PATCH_APPLY, $package, $url, $description));
  $extra['patches_applied'][$description] = $url;
  }
  catch (\Exception $e) {

tests/PatchEventTest.php

@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * @file
+ * Tests event dispatching.
+ */
+
+namespace cweagans\Composer\Tests;
+
+use cweagans\Composer\PatchEvent;
+use cweagans\Composer\PatchEvents;
+use Composer\Package\PackageInterface;
+
+class PatchEventTest extends \PHPUnit_Framework_TestCase {
+
+ /**
+ * Tests all the getters.
+ *
+ * @dataProvider patchEventDataProvider
+ */
+ public function testGetters($event_name, PackageInterface $package, $url, $description) {
+ $patch_event = new PatchEvent($event_name, $package, $url, $description);
+ $this->assertEquals($event_name, $patch_event->getName());
+ $this->assertEquals($package, $patch_event->getPackage());
+ $this->assertEquals($url, $patch_event->getUrl());
+ $this->assertEquals($description, $patch_event->getDescription());
+ }
+
+ public function patchEventDataProvider() {
+ $prophecy = $this->prophesize('Composer\Package\PackageInterface');
+ $package = $prophecy->reveal();
+
+ return array(
+ array(PatchEvents::PRE_PATCH_APPLY, $package, 'https://www.drupal.org', 'A test patch'),
+ array(PatchEvents::POST_PATCH_APPLY, $package, 'https://www.drupal.org', 'A test patch'),
+ );
+ }
+
+}