Initial commit

Author: teppokoivula

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Added required classes (Plugin, BaseInstaller, ModuleInstaller, SiteProfileInstaller).
+- Added markdown files to describe the project (LICENSE, README.md, CHANGELOG.md.)
+- Added the composer.json file.

LICENSE

@@ -0,0 +1,12 @@
+# ProcessWire Composer installers
+
+This project contains [Composer custom installers](https://getcomposer.org/doc/articles/custom-installers.md) for
+ProcessWire CMS/CMF modules and site profiles. 
+
+## Requirements
+
+- PHP 5.5 or newer
+
+## License
+
+This project is licensed under the Mozilla Public License Version 2.0.

README.md

@@ -0,0 +1,26 @@
+{
+    "name": "wireframe-framework/processwire-composer-installer",
+    "type": "composer-plugin",
+    "description": "Custom Composer installer for the ProcessWire CMS/CMF modules and site profiles.",
+    "keywords": [ "composer", "processwire", "installer" ],
+    "homepage": "https://wireframe-framework.com",
+    "license": "MPL-2.0",
+    "authors": [
+        {
+            "name": "Teppo Koivula",
+            "homepage": "https://wireframe-framework.com",
+            "email": "teppo@wireframe-framework.com"
+        }
+    ],
+    "require": {
+        "composer-plugin-api": "^1.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "wireframe\\": "src/"
+        }
+    },
+    "extra": {
+        "class": "wireframe\\ComposerInstaller\\Plugin"
+    }
+}

composer.json

@@ -0,0 +1,95 @@
+<?php
+
+namespace wireframe\ComposerInstaller;
+
+use Composer\Package\PackageInterface;
+use Composer\Installer\LibraryInstaller;
+
+/**
+ * BaseInstaller class
+ *
+ * This is a base class for ProcessWire CMS/CMF module and site profile
+ * installers.
+ *
+ * @author Teppo Koivula <teppo@wireframe-framework.com>
+ * @license Mozilla Public License v2.0 http://mozilla.org/MPL/2.0/
+ */
+class BaseInstaller extends LibraryInstaller
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function getInstallPath(PackageInterface $package)
+    {
+        return parent::getInstallPath($package);
+    }
+    
+    /**
+     * {@inheritDoc}
+     */
+    public function supports($packageType)
+    {
+        return parent::supports($packageType);
+    }
+
+    /**
+     * Get the base path for current installer
+     *
+     * Default base path is provided as an argument. This can be overridden by
+     * specifying pw-[type]-path extra argument in composer.json, where "type"
+     * is either "module" or "site-profile".
+     *
+     * @param string $defaultBasePath Default base path.
+     * @return string Base path.
+     */
+    protected function getBasePath($defaultBasePath) {
+        // get the extra configuration of the top-level package
+        $extra = [];
+        if ($rootPackage = $this->composer->getPackage()) {
+            $extra = $rootPackage->getExtra();
+        }
+
+        // use base path from configuration, otherwise fall back to default
+        $class = basename(str_replace('\\', '/', static::class));
+        $type = strtolower(preg_replace('/(?<!^)[A-Z]/', '-$0', substr($class, 0, strrpos($class, 'Installer'))));
+        $basePath = $extra['pw-' . $type . '-path'] ?? $defaultBasePath;
+
+        return $basePath;
+    }
+
+    /**
+     * Get the directory name from package name
+     *
+     * Default directory name can be overridden by specifying extra argument
+     * "installer-name" in the composer.json of the package in question.
+     *
+     * @param PackageInterface $package
+     * @return string Module or site profile name.
+     */
+    protected function getName(PackageInterface $package) {
+        // determine the directory name from its package name
+        $name = explode('/', $package->getPrettyName())[1];
+        
+        // allow overriding module directory name via composer.json
+        $extra = $package->getExtra();
+        if (!empty($extra['installer-name'])) {
+            $name = $extra['installer-name'];
+        }
+
+        return $name;
+    }
+
+    /**
+     * Get the full path with base part and package directory name
+     *
+     * @param PackageInterface $package
+     * @param string $defaultBasePath Default base path.
+     * @return string Path.
+     */
+    protected function getFullPath(PackageInterface $package, $defaultBasePath) {
+        $basePath = $this->getBasePath($defaultBasePath);
+        $name = $this->getName($package);
+        $path = trim($basePath, '/') . '/' . $name;
+        return $path;
+    }
+}

src/ComposerInstaller/BaseInstaller.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace wireframe\ComposerInstaller;
+
+use Composer\Package\PackageInterface;
+
+/**
+ * ModuleInstaller class
+ *
+ * This class implements a custom Composer installer for ProcessWire CMS/CMF
+ * modules.
+ *
+ * @author Teppo Koivula <teppo@wireframe-framework.com>
+ * @license Mozilla Public License v2.0 http://mozilla.org/MPL/2.0/
+ */
+class ModuleInstaller extends BaseInstaller
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function getInstallPath(PackageInterface $package)
+    {
+        return $this->getFullPath($package, 'site/modules');)
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function supports($packageType)
+    {
+        return $packageType === 'pw-module';
+    }
+}

src/ComposerInstaller/ModuleInstaller.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace wireframe\ComposerInstaller;
+
+use Composer\Composer;
+use Composer\IO\IOInterface;
+use Composer\Plugin\PluginInterface;
+
+/**
+ * The Plugin class
+ *
+ * This class registers our custom installers.
+ *
+ * @author Teppo Koivula <teppo@wireframe-framework.com>
+ * @license Mozilla Public License v2.0 http://mozilla.org/MPL/2.0/
+ */
+class Plugin implements PluginInterface
+{
+    /**
+     * Register custom installers for ProcessWire modules and site profiles.
+     *
+     * @param Composer $composer
+     * @param IOInterface $io
+     */
+    public function activate(Composer $composer, IOInterface $io)
+    {
+        $installationManager = $composer->getInstallationManager();
+        $installationManager->addInstaller(new ModuleInstaller($io, $composer));
+        $installationManager->addInstaller(new SiteProfileInstaller($io, $composer));
+    }
+}

src/ComposerInstaller/Plugin.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace wireframe\ComposerInstaller;
+
+use Composer\Package\PackageInterface;
+
+/**
+ * SiteProfileInstaller class
+ *
+ * This class implements a custom Composer installer for ProcessWire CMS/CMF
+ * site profiles.
+ *
+ * @author Teppo Koivula <teppo@wireframe-framework.com>
+ * @license Mozilla Public License v2.0 http://mozilla.org/MPL/2.0/
+ */
+class SiteProfileInstaller extends BaseInstaller
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function getInstallPath(PackageInterface $package)
+    {
+        return $this->getFullPath($package, '');
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function supports($packageType)
+    {
+        return $packageType === 'pw-site-profile';
+    }
+}