Merge pull request #1 from jenkoian/proper-plugin

Automatically register as plugin

Author: jenkoian

README.md

@@ -26,16 +26,6 @@ as is. Therefore, once this library has done it's thing you should definitely re
 composer require jenko/sunscreen --dev
 ```
 
-Then add this to your `composer.json`:
-
-```json
-    "scripts": {
-        "post-package-install": [
-            "Jenko\\Sunscreen\\Sunscreen::postPackageInstall"
-        ]
-    }
-```
-
 ## How it works
 
 The script will kick in after a package is installed via composer. It will check that package's composer file and look for 

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "jenko/sunscreen",
     "description": "Protecting your web app from the harmful rays of external dependencies.",
-    "type": "library",
+    "type": "composer-plugin",
     "license": "MIT",
     "authors": [
         {
@@ -11,17 +11,13 @@
     ],
     "minimum-stability": "stable",
     "require": {
-        "php": ">=5.6,<8.0-DEV"
+        "php": ">=5.6,<8.0-DEV",
+        "composer-plugin-api": "^1.0"
     },
     "require-dev": {
-        "composer/composer": "~1.1",
         "phpunit/phpunit": "~5.3",
-        "etsy/phpunit-extensions": "0.7.*"
-    },
-    "scripts": {
-        "post-package-install": [
-            "Jenko\\Sunscreen\\Sunscreen::postPackageInstall"
-        ]
+        "etsy/phpunit-extensions": "0.7.*",
+        "composer/composer": "^1.1"
     },
     "autoload": {
         "psr-4": {"Jenko\\Sunscreen\\": "src"}
@@ -30,6 +26,7 @@
         "psr-4": {"Jenko\\Sunscreen\\Tests\\": "tests"}
     },
     "extra": {
+        "class": "Jenko\\Sunscreen\\Sunscreen",
         "sunscreen": {
             "interfaces": [
                 "Jenko\\Sunscreen\\SunscreenInterface"

src/Sunscreen.php

@@ -2,55 +2,89 @@
 
 namespace Jenko\Sunscreen;
 
+use Composer\Composer;
+use Composer\EventDispatcher\EventSubscriberInterface;
 use Composer\Installer\PackageEvent;
+use Composer\Installer\PackageEvents;
+use Composer\IO\IOInterface;
+use Composer\Plugin\PluginInterface;
 use Jenko\Sunscreen\Guesser\AbstractClassGuesser;
 use Jenko\Sunscreen\Guesser\InterfaceGuesser;
 use Jenko\Sunscreen\Processor\AdapterProcessor;
 use Jenko\Sunscreen\Processor\ClassProcessor;
 use Jenko\Sunscreen\Processor\InterfaceProcessor;
 
-class Sunscreen implements SunscreenInterface
+class Sunscreen implements PluginInterface, EventSubscriberInterface, SunscreenInterface
 {
     /**
      * @var string
      */
     const PRECONFIGURED_DIR = 'preconfigured';
 
+    /**
+     * @var Composer
+     */
+    protected $composer;
+
+    /**
+     * @var IOInterface
+     */
+    protected $io;
+
+    /**
+     * @param Composer $composer
+     * @param IOInterface $io
+     */
+    public function activate(Composer $composer, IOInterface $io)
+    {
+        $this->composer = $composer;
+        $this->io = $io;
+    }
+
+    /**
+     * @return array
+     */
+    public static function getSubscribedEvents()
+    {
+        return [
+            PackageEvents::POST_PACKAGE_INSTALL => 'onPostPackageInstall'
+        ];
+    }
+
     /**
      * @param PackageEvent $event
      *
      * @return mixed|void
      */
-    public static function postPackageInstall(PackageEvent $event)
+    public function onPostPackageInstall(PackageEvent $event)
     {
-        $mainPackage = $event->getComposer()->getPackage();
+        $mainPackage = $this->composer->getPackage();
         $installedPackage = $event->getOperation()->getPackage();
         $extra = $installedPackage->getExtra();
-        $io = $event->getIO();
 
         if ($installedPackage->isDev()) {
-            if ($io->isVeryVerbose()) {
-                $io->write('Sunscreen: Ignoring dev dependency.' . "\n");
+            if ($this->io->isVeryVerbose()) {
+                $this->io->write('Sunscreen: Ignoring dev dependency.' . "\n");
             }
             return;
         }
 
-        $vendorDir = $event->getComposer()->getConfig()->get('vendor-dir');
+        $vendorDir = $this->composer->getConfig()->get('vendor-dir');
         $baseDir = $vendorDir . Util::DS  . '..';
 
         $mainNamespace = Util::extractNamespaceFromPackage($mainPackage);
         $src = Util::extractSourceDirectoryFromPackage($mainPackage);
         if (empty($mainNamespace)) {
-            $io->writeError('Sunscreen: Main Namespace not found.' . "\n");
+            $this->io->writeError('Sunscreen: Main Namespace not found.' . "\n");
             return;
         }
 
         if (isset($extra['sunscreen'])) {
-            $interfaces = self::configuredInterfaces($extra['sunscreen']);
-            $classes = self::configuredClasses($extra['sunscreen']);
-        } elseif ($preconfiguredExtra = self::findPreconfiguredExtra($installedPackage->getName())) {
-            $interfaces = self::configuredInterfaces($preconfiguredExtra['sunscreen']);
-            $classes = self::configuredClasses($preconfiguredExtra['sunscreen']);
+            $interfaces = $this->configuredInterfaces($extra['sunscreen']);
+            $classes = $this->configuredClasses($extra['sunscreen']);
+        } elseif ($preconfiguredExtra = $this->findPreconfiguredExtra($installedPackage->getName())) {
+            $interfaces = $this->configuredInterfaces($preconfiguredExtra['sunscreen']);
+            $classes = $this->configuredClasses($preconfiguredExtra['sunscreen']);
         } else {
             $interfaceGuesser = new InterfaceGuesser($vendorDir);
             $interfaces = $interfaceGuesser->guess($installedPackage);
@@ -59,26 +93,26 @@ public static function postPackageInstall(PackageEvent $event)
         }
 
         if (empty($interfaces) && empty($classes)) {
-            if ($io->isVerbose()) {
-                $io->write('Sunscreen: No interfaces or classes could be found.' . "\n");
+            if ($this->io->isVerbose()) {
+                $this->io->write('Sunscreen: No interfaces or classes could be found.' . "\n");
             }
             return;
         }
 
         if (!empty($interfaces)) {
-            self::processInterfaces($interfaces, $mainNamespace, $baseDir, $src, $io);
+            $this->processInterfaces($interfaces, $mainNamespace, $baseDir, $src);
         }
 
         if (!empty($classes)) {
-            self::processClasses($classes, $mainNamespace, $baseDir, $src, $io);
+            $this->processClasses($classes, $mainNamespace, $baseDir, $src);
         }
     }
 
     /**
      * @param $sunscreenConfig
      * @return array ['FQN']
      */
-    private static function configuredInterfaces($sunscreenConfig)
+    private function configuredInterfaces($sunscreenConfig)
     {
         if (isset($sunscreenConfig['interfaces'])) {
             return $sunscreenConfig['interfaces'];
@@ -91,7 +125,7 @@ private static function configuredInterfaces($sunscreenConfig)
      * @param $sunscreenConfig
      * @return array ['FQN']
      */
-    private static function configuredClasses($sunscreenConfig)
+    private function configuredClasses($sunscreenConfig)
     {
         if (isset($sunscreenConfig['classes'])) {
             return $sunscreenConfig['classes'];
@@ -105,23 +139,22 @@ private static function configuredClasses($sunscreenConfig)
      * @param string $mainNamespace
      * @param string $baseDir
      * @param string $src
-     * @param IO $io
      */
-    private static function processInterfaces(array $interfaces, $mainNamespace, $baseDir, $src, $io)
+    private function processInterfaces(array $interfaces, $mainNamespace, $baseDir, $src)
     {
         foreach ($interfaces as $interface) {
             $interfaceProcessor = new InterfaceProcessor($interface, $mainNamespace, $baseDir . Util::DS . $src);
             $interfaceProcessor->process();
 
-            if ($io->isVeryVerbose()) {
-                $io->write('Sunscreen: Interface created.' . "\n");
+            if ($this->io->isVeryVerbose()) {
+                $this->io->write('Sunscreen: Interface created.' . "\n");
             }
 
             $adapterProcessor = new AdapterProcessor($interface, $mainNamespace, $baseDir . Util::DS . $src);
             $adapterProcessor->process();
 
-            if ($io->isVeryVerbose()) {
-                $io->write('Sunscreen: Adapter created.' . "\n");
+            if ($this->io->isVeryVerbose()) {
+                $this->io->write('Sunscreen: Adapter created.' . "\n");
             }
         }
     }
@@ -131,23 +164,22 @@ private static function processInterfaces(array $interfaces, $mainNamespace, $ba
      * @param string $mainNamespace
      * @param string $baseDir
      * @param string $src
-     * @param IO $io
      */
-    private static function processClasses(array $classes, $mainNamespace, $baseDir, $src, $io)
+    private function processClasses(array $classes, $mainNamespace, $baseDir, $src)
     {
         foreach ($classes as $class) {
             $classProcessor = new ClassProcessor($class, $mainNamespace, $baseDir . Util::DS . $src);
             $classProcessor->process();
 
-            if ($io->isVeryVerbose()) {
-                $io->write('Sunscreen: Class created.' . "\n");
+            if ($this->io->isVeryVerbose()) {
+                $this->io->write('Sunscreen: Class created.' . "\n");
             }
 
             $adapterProcessor = new AdapterProcessor($class, $mainNamespace, $baseDir . Util::DS . $src);
             $adapterProcessor->process();
 
-            if ($io->isVeryVerbose()) {
-                $io->write('Sunscreen: Adapter created.' . "\n");
+            if ($this->io->isVeryVerbose()) {
+                $this->io->write('Sunscreen: Adapter created.' . "\n");
             }
         }
     }
@@ -156,7 +188,7 @@ private static function processClasses(array $classes, $mainNamespace, $baseDir,
      * @param string $packageName
      * @return null
      */
-    private static function findPreconfiguredExtra($packageName)
+    private function findPreconfiguredExtra($packageName)
     {
         list($dirName, $filename) = explode('/', $packageName);
         $filePath = __DIR__ . Util::DS . '..' . Util::DS . self::PRECONFIGURED_DIR . Util::DS . $dirName . Util::DS . $filename . '.json';

src/SunscreenInterface.php

@@ -10,5 +10,5 @@ interface SunscreenInterface
      * @param PackageEvent $event
      * @return mixed
      */
-    public static function postPackageInstall(PackageEvent $event);
+    public function onPostPackageInstall(PackageEvent $event);
 }