Bluz\Composer\Installers\Plugin

Complexity

Total Complexity

28

Size/Duplication

Total Lines	273
Duplicated Lines	23.81 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	3
A	activate()	0	5	1
A	getSubscribedEvents()	0	13	1
A	onPostPackageInstall()	16	16	2
A	onPrePackageUpdate()	0	6	2
A	onPostPackageUpdate()	0	6	2
A	onPrePackageRemove()	16	16	2
A	copy()	0	7	1
B	copyRecursive()	0	52	6
A	remove()	0	7	1
B	removeRecursive()	33	61	7

<?php
/**
 * Bluz composer plugin
 *
 * @copyright Bluz PHP Team
 * @link https://github.com/bluzphp/composer-plugin
 */

/**
 * @namespace
 */
namespace Bluz\Composer\Installers;

use Composer\Composer;
use Composer\EventDispatcher\EventSubscriberInterface;
use Composer\Installer\PackageEvent;
use Composer\IO\IOInterface;
use Composer\Plugin\PluginInterface;
use Composer\Script\ScriptEvents;

class Plugin implements PluginInterface, EventSubscriberInterface
{
    const PERMISSION_CODE = 0755;
    const REPEAT = 5;

    /**
     * @var Installer
     */
    protected $installer;

    /**
     * @var string
     */
    protected $environment;

    /**
     * Create instance, define constants
     */
    public function __construct()
    {
        defined('PATH_ROOT') ? : define('PATH_ROOT', realpath($_SERVER['DOCUMENT_ROOT']));
        defined('DS') ? : define('DS', DIRECTORY_SEPARATOR);
    }

    /**
     * Called after the plugin is loaded
     *
     * It setup composer installer
     *
     * {@inheritDoc}
     */
    public function activate(Composer $composer, IOInterface $io)
    {
        $this->installer = new Installer($io, $composer);
        $composer->getInstallationManager()->addInstaller($this->installer);
    }

    /**
     * Registered events after the plugin is loaded
     *
     * {@inheritDoc}
     */
    public static function getSubscribedEvents(): array
    {
        return [
            // copy files to working directory
            ScriptEvents::POST_PACKAGE_INSTALL => 'onPostPackageInstall',

The constant Composer\Script\ScriptEvents::POST_PACKAGE_INSTALL has been deprecated with message: Use Composer\Installer\PackageEvents::POST_PACKAGE_INSTALL instead.

            // removed unchanged files
            ScriptEvents::PRE_PACKAGE_UPDATE  => 'onPrePackageUpdate',

The constant Composer\Script\ScriptEvents::PRE_PACKAGE_UPDATE has been deprecated with message: Use Composer\Installer\PackageEvents::PRE_PACKAGE_UPDATE instead.

            // copy new files
            ScriptEvents::POST_PACKAGE_UPDATE  => 'onPostPackageUpdate',

The constant Composer\Script\ScriptEvents::POST_PACKAGE_UPDATE has been deprecated with message: Use Composer\Installer\PackageEvents::POST_PACKAGE_UPDATE instead.

            // removed all files
            ScriptEvents::PRE_PACKAGE_UNINSTALL  => 'onPrePackageRemove'

The constant Composer\Script\ScriptEvents::PRE_PACKAGE_UNINSTALL has been deprecated with message: Use Composer\Installer\PackageEvents::PRE_PACKAGE_UNINSTALL instead.

        ];
    }

    /**
     * Hook which is called after install package
     *
     * It copies bluz module
     */
    public function onPostPackageInstall(PackageEvent $event)

This method seems to be duplicated in your project.

    {
        $packageName = $event->getOperation()

It seems like you code against a concrete implementation and not the interface Composer\DependencyResolver\Operation\OperationInterface as the method getPackage() does only exist in the following implementations of said interface: Composer\DependencyResolver\Operation\InstallOperation, Composer\DependencyResolver\Operation\MarkAliasInstalledOperation, Composer\DependencyResolver\Operation\MarkAliasUninstalledOperation, Composer\DependencyResolver\Operation\UninstallOperation.

            ->getPackage()
            ->getName();

        $event->getIo()->write(
            "  - Installing module `$packageName`:",
            true,
            IOInterface::VERBOSE
        );

        if (file_exists($this->installer->getOption('vendorPath'))) {
            $this->copy();
        }
    }

    /**
     * Hook which is called before update package
     *
     * It checks bluz module
     */
    public function onPrePackageUpdate(PackageEvent $event)

The parameter $event is not used and could be removed.

    {
        if (file_exists($this->installer->getOption('vendorPath'))) {
            $this->remove();
        }
    }

    /**
     * Hook which is called after update package
     *
     * It copies bluz module
     */
    public function onPostPackageUpdate(PackageEvent $event)

The parameter $event is not used and could be removed.

    {
        if (file_exists($this->installer->getOption('vendorPath'))) {
            $this->copy();
        }
    }

    /**
     * Hook which is called before remove package
     *
     * It removes bluz module
     */
    public function onPrePackageRemove(PackageEvent $event)

This method seems to be duplicated in your project.

    {
        $packageName = $event->getOperation()

It seems like you code against a concrete implementation and not the interface Composer\DependencyResolver\Operation\OperationInterface as the method getPackage() does only exist in the following implementations of said interface: Composer\DependencyResolver\Operation\InstallOperation, Composer\DependencyResolver\Operation\MarkAliasInstalledOperation, Composer\DependencyResolver\Operation\MarkAliasUninstalledOperation, Composer\DependencyResolver\Operation\UninstallOperation.

            ->getPackage()
            ->getName();

        $event->getIo()->write(
            "  - Removing module `$packageName`:",
            true,
            IOInterface::VERBOSE
        );

        if (file_exists($this->installer->getOption('vendorPath'))) {
            $this->remove();
        }
    }

    /**
     * It recursively copies the files and directories
     * @return bool
     */
    protected function copy()
    {
        $this->copyRecursive('application');
        $this->copyRecursive('data');
        $this->copyRecursive('public');
        $this->copyRecursive('tests');
    }

    /**
     * It recursively copies the files and directories
     * @param $directory
     * @return bool
     */
    protected function copyRecursive($directory)
    {
        $sourcePath = $this->installer->getOption('vendorPath') . DS . $directory;

        if (!is_dir($sourcePath)) {
            return false;
        }

        foreach ($iterator = new \RecursiveIteratorIterator(
            new \RecursiveDirectoryIterator(
                $sourcePath,
                \RecursiveDirectoryIterator::SKIP_DOTS
            ),
            \RecursiveIteratorIterator::SELF_FIRST
        ) as $item) {
            $filePath = PATH_ROOT . DS . $directory . DS . $iterator->getSubPathName();

            if ($item->isDir()) {
                if (is_dir($filePath)) {
                    $this->installer->getIo()->write(
                        "    - <comment>Directory `{$iterator->getSubPathName()}` already exists</comment>",
                        true,
                        IOInterface::VERBOSE
                    );
                } else {
                    mkdir($filePath, self::PERMISSION_CODE);
                    $this->installer->getIo()->write(
                        "    - Created directory `{$iterator->getSubPathName()}`",
                        true,
                        IOInterface::VERBOSE
                    );
                }
            } else {
                if (file_exists($filePath)) {
                    $this->installer->getIo()->write(
                        "    - <comment>File `{$iterator->getSubPathName()}` already exists</comment>",
                        true,
                        IOInterface::VERBOSE
                    );
                } else {
                    copy($item, $filePath);
                    $this->installer->getIo()->write(
                        "    - Copied file `{$iterator->getSubPathName()}`",
                        true,
                        IOInterface::VERBOSE
                    );
                }
            }
        }

        return true;
    }

    /**
     * It recursively removes the files and directories
     * @return bool
     */
    protected function remove()
    {
        $this->removeRecursive('application');
        $this->removeRecursive('data');
        $this->removeRecursive('public');
        $this->removeRecursive('tests');
    }

    /**
     * It recursively removes the files and directories
     * @param $directory
     * @return bool
     */
    protected function removeRecursive($directory)
    {
        $sourcePath = $this->installer->getOption('vendorPath') . DS . $directory;

        if (!is_dir($sourcePath)) {
            return false;
        }
        foreach ($iterator = new \RecursiveIteratorIterator(
            new \RecursiveDirectoryIterator(
                $sourcePath,
                \RecursiveDirectoryIterator::SKIP_DOTS
            ),
            \RecursiveIteratorIterator::CHILD_FIRST
        ) as $item) {
            // path to copied file
            $current = PATH_ROOT . DS . $directory . DS . $iterator->getSubPathName();

            // remove empty directories
            if (is_dir($current)) {

This code seems to be duplicated across your project.

                if (sizeof(scandir($current)) == 2) {
                    rmdir($current);
                    $this->installer->getIo()->write(
                        "    - Removed directory `{$iterator->getSubPathName()}`",
                        true,
                        IOInterface::VERBOSE
                    );
                } else {
                    $this->installer->getIo()->write(
                        "    - <comment>Skip directory `{$iterator->getSubPathName()}`</comment>",
                        true,
                        IOInterface::VERBOSE
                    );
                }
                continue;
            }

            // skip already removed files
            if (!is_file($current)) {
                continue;
            }

            if (md5_file($item) == md5_file($current)) {

This code seems to be duplicated across your project.

                // remove file
                unlink($current);
                $this->installer->getIo()->write(
                    "    - Removed file `{$iterator->getSubPathName()}`",
                    true,
                    IOInterface::VERBOSE
                );
            } else {
                // or skip changed files
                $this->installer->getIo()->write(
                    "    - <comment>File `{$iterator->getSubPathName()}` has changed</comment>",
                    true,
                    IOInterface::VERBOSE
                );
            }
        }

        return false;
    }
}