Initial commit

Author: Demoli

.gitignore

@@ -0,0 +1,2 @@
+vendor
+composer.lock

README.md

@@ -0,0 +1,13 @@
+# File Copy Composer Plugin
+
+Allows files to be copied on dependency installation, default composer behaviour only runs scripts for the root package.
+
+Will only work on modules with `skywire` in the package name, will only work with paths relative to the working directory, e.g. `dev`  instead of `./dev` or `../../dev`
+
+Uses https://github.com/slowprog/CopyFile to copy files, see their documentation for configuration, only the `extras.copy-files` section is rquired
+
+# Installation
+
+From your module repository run 
+
+`composer require skywire/file-copy-plugin` 

composer.json

@@ -0,0 +1,19 @@
+{
+  "name": "skywire/file-copy-plugin",
+  "type": "composer-plugin",
+  "description": "A plugin to allow for dependencies to copy files into the project on install / update",
+  "require": {
+    "php": ">=7.0",
+    "composer-plugin-api": "^1.1",
+    "slowprog/composer-copy-file": "*"
+  },
+  "minimum-stability": "dev",
+  "autoload": {
+    "psr-4": {
+      "Skywire\\FileCopyPlugin\\": "src/"
+    }
+  },
+  "extra": {
+    "class": "Skywire\\FileCopyPlugin\\Plugin"
+  }
+}

src/Plugin.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Skywire\FileCopyPlugin;
+
+use Composer\Composer;
+use Composer\EventDispatcher\EventSubscriberInterface;
+use Composer\IO\IOInterface;
+use Composer\Package\CompletePackage;
+use Composer\Plugin\PluginInterface;
+use Composer\Script\ScriptEvents;
+use SlowProg\CopyFile\ScriptHandler;
+
+class Plugin implements PluginInterface, EventSubscriberInterface
+{
+    /** @var \Composer\Composer */
+    protected $composer;
+
+    protected $io;
+
+    public function activate(Composer $composer, IOInterface $io)
+    {
+        $this->composer = $composer;
+        $this->io       = $io;
+    }
+
+    public static function getSubscribedEvents()
+    {
+        return array(
+            ScriptEvents::POST_INSTALL_CMD => [
+                array('copyPackageFiles', 0),
+            ],
+            ScriptEvents::POST_UPDATE_CMD  => [
+                array('copyPackageFiles', 0),
+            ]
+        );
+    }
+
+    public function copyPackageFiles($event)
+    {
+        $packages = $event->getComposer()->getRepositoryManager()->getLocalRepository()->getPackages();
+        // find skywire only packages
+        $packages = array_filter($packages, function (CompletePackage $package) {
+            return strpos($package->getName(), 'skywire') !== false;
+        });
+
+        $toCopy = [];
+
+        foreach ($packages as $package) {
+            /** @var CompletePackage $package */
+            if ($package->getExtra() && isset($package->getExtra()['copy-file'])) {
+                $toCopy += $package->getExtra()['copy-file'];
+            }
+        }
+
+        $this->validatePaths($toCopy);
+
+        // add our pacakge copy config to the root package config, so that slowprog can find it
+        $rootPackage      = $event->getComposer()->getPackage();
+        $rootPackageExtra = $rootPackage->getExtra();
+
+        $currentToCopy = $rootPackageExtra['copy-file'] ?? [];
+
+        $mergedCopy = $currentToCopy + $toCopy;
+
+        $rootPackageExtra['copy-file'] = $mergedCopy;
+
+        $rootPackage->setExtra($rootPackageExtra);
+
+        // do the copy via slowprog/composer-copy-file
+        ScriptHandler::copy($event);
+    }
+
+    protected function validatePaths(array $paths)
+    {
+        foreach ($paths as $path) {
+            if (strpos($path, './') !== false || $path[0] == '/' || strpos($path, '~/') !== false) {
+                throw new \InvalidArgumentException("path $path is not valid, all paths must be relative to the current working directory, and cannot go above it");
+            }
+        }
+    }
+}