Plugin::getSubscribedEvents() - Code Metrics - Inspection of "Refactoring plugin" - bluzphp/composer-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 74e04b...099a74 )

by Anton

created 2017-03-27 12:36 UTC

Plugin::getSubscribedEvents() A

↳ Parent: Plugin

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	0

<?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',

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

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

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

        ];
    }

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

    {
        $packageName = $event->getOperation()
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->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)

    {
        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)

    {
        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)

    {
        $packageName = $event->getOperation()
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->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)) {

                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)) {

                // 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;
    }
}


Push — master ( 74e04b...099a74 )

Plugin::getSubscribedEvents() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1		<?php
2		/**
3		* Bluz composer plugin
4		*
5		* @copyright Bluz PHP Team
6		* @link https://github.com/bluzphp/composer-plugin
7		*/
8
9		/**
10		* @namespace
11		*/
12		namespace Bluz\Composer\Installers;
13
14		use Composer\Composer;
15		use Composer\EventDispatcher\EventSubscriberInterface;
16		use Composer\Installer\PackageEvent;
17		use Composer\IO\IOInterface;
18		use Composer\Plugin\PluginInterface;
19		use Composer\Script\ScriptEvents;
20
21		class Plugin implements PluginInterface, EventSubscriberInterface
22		{
23		const PERMISSION_CODE = 0755;
24		const REPEAT = 5;
25
26		/**
27		* @var Installer
28		*/
29		protected $installer;
30
31		/**
32		* @var string
33		*/
34		protected $environment;
35
36		/**
37		* Create instance, define constants
38		*/
39		public function __construct()
40		{
41		defined('PATH_ROOT') ? : define('PATH_ROOT', realpath($_SERVER['DOCUMENT_ROOT']));
42		defined('DS') ? : define('DS', DIRECTORY_SEPARATOR);
43		}
44
45		/**
46		* Called after the plugin is loaded
47		*
48		* It setup composer installer
49		*
50		* {@inheritDoc}
51		*/
52		public function activate(Composer $composer, IOInterface $io)
53		{
54		$this->installer = new Installer($io, $composer);
55		$composer->getInstallationManager()->addInstaller($this->installer);
56		}
57
58		/**
59		* Registered events after the plugin is loaded
60		*
61		* {@inheritDoc}
62		*/
63		public static function getSubscribedEvents(): array
64		{
65		return [
66		// copy files to working directory
67		ScriptEvents::POST_PACKAGE_INSTALL => 'onPostPackageInstall',
		0 ignored issues – show Deprecated Code introduced 2016-12-08 06:09 UTC by Report Bug Copy Issue Report The constant `Composer\Script\ScriptEvents::POST_PACKAGE_INSTALL` has been deprecated with message: Use Composer\Installer\PackageEvents::POST_PACKAGE_INSTALL instead. This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
68		// removed unchanged files
69		ScriptEvents::PRE_PACKAGE_UPDATE => 'onPrePackageUpdate',
		0 ignored issues – show Deprecated Code introduced 2017-03-27 12:38 UTC by Report Bug Copy Issue Report The constant `Composer\Script\ScriptEvents::PRE_PACKAGE_UPDATE` has been deprecated with message: Use Composer\Installer\PackageEvents::PRE_PACKAGE_UPDATE instead. This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
70		// copy new files
71		ScriptEvents::POST_PACKAGE_UPDATE => 'onPostPackageUpdate',
		0 ignored issues – show Deprecated Code introduced 2016-12-08 06:09 UTC by Report Bug Copy Issue Report The constant `Composer\Script\ScriptEvents::POST_PACKAGE_UPDATE` has been deprecated with message: Use Composer\Installer\PackageEvents::POST_PACKAGE_UPDATE instead. This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
72		// removed all files
73		ScriptEvents::PRE_PACKAGE_UNINSTALL => 'onPrePackageRemove'
		0 ignored issues – show Deprecated Code introduced 2017-03-27 12:38 UTC by Report Bug Copy Issue Report The constant `Composer\Script\ScriptEv...::PRE_PACKAGE_UNINSTALL` has been deprecated with message: Use Composer\Installer\PackageEvents::PRE_PACKAGE_UNINSTALL instead. This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
74		];
75		}
76
77		/**
78		* Hook which is called after install package
79		*
80		* It copies bluz module
81		*/
82	View Code Duplication	public function onPostPackageInstall(PackageEvent $event)
		0 ignored issues – show Duplication introduced 2017-03-27 12:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
83		{
84		$packageName = $event->getOperation()
		0 ignored issues – show Bug introduced 2017-03-27 12:38 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Composer\DependencyResol...tion\OperationInterface` as the method `getPackage()` does only exist in the following implementations of said interface: `Composer\DependencyResol...ration\InstallOperation`, `Composer\DependencyResol...AliasInstalledOperation`, `Composer\DependencyResol...iasUninstalledOperation`, `Composer\DependencyResol...tion\UninstallOperation`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
85		->getPackage()
86		->getName();
87
88		$event->getIo()->write(
89		" - Installing module `$packageName`:",
90		true,
91		IOInterface::VERBOSE
92		);
93
94		if (file_exists($this->installer->getOption('vendorPath'))) {
95		$this->copy();
96		}
97		}
98
99		/**
100		* Hook which is called before update package
101		*
102		* It checks bluz module
103		*/
104		public function onPrePackageUpdate(PackageEvent $event)
		0 ignored issues – show Unused Code introduced 2017-03-27 06:23 UTC by Report Bug Copy Issue Report The parameter `$event` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
105		{
106		if (file_exists($this->installer->getOption('vendorPath'))) {
107		$this->remove();
108		}
109		}
110
111		/**
112		* Hook which is called after update package
113		*
114		* It copies bluz module
115		*/
116		public function onPostPackageUpdate(PackageEvent $event)
		0 ignored issues – show Unused Code introduced 2017-03-27 06:23 UTC by Report Bug Copy Issue Report The parameter `$event` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
117		{
118		if (file_exists($this->installer->getOption('vendorPath'))) {
119		$this->copy();
120		}
121		}
122
123		/**
124		* Hook which is called before remove package
125		*
126		* It removes bluz module
127		*/
128	View Code Duplication	public function onPrePackageRemove(PackageEvent $event)
		0 ignored issues – show Duplication introduced 2017-03-27 12:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
129		{
130		$packageName = $event->getOperation()
		0 ignored issues – show Bug introduced 2017-03-27 12:38 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Composer\DependencyResol...tion\OperationInterface` as the method `getPackage()` does only exist in the following implementations of said interface: `Composer\DependencyResol...ration\InstallOperation`, `Composer\DependencyResol...AliasInstalledOperation`, `Composer\DependencyResol...iasUninstalledOperation`, `Composer\DependencyResol...tion\UninstallOperation`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
131		->getPackage()
132		->getName();
133
134		$event->getIo()->write(
135		" - Removing module `$packageName`:",
136		true,
137		IOInterface::VERBOSE
138		);
139
140		if (file_exists($this->installer->getOption('vendorPath'))) {
141		$this->remove();
142		}
143		}
144
145		/**
146		* It recursively copies the files and directories
147		* @return bool
148		*/
149		protected function copy()
150		{
151		$this->copyRecursive('application');
152		$this->copyRecursive('data');
153		$this->copyRecursive('public');
154		$this->copyRecursive('tests');
155		}
156
157		/**
158		* It recursively copies the files and directories
159		* @param $directory
160		* @return bool
161		*/
162		protected function copyRecursive($directory)
163		{
164		$sourcePath = $this->installer->getOption('vendorPath') . DS . $directory;
165
166		if (!is_dir($sourcePath)) {
167		return false;
168		}
169
170		foreach ($iterator = new \RecursiveIteratorIterator(
171		new \RecursiveDirectoryIterator(
172		$sourcePath,
173		\RecursiveDirectoryIterator::SKIP_DOTS
174		),
175		\RecursiveIteratorIterator::SELF_FIRST
176		) as $item) {
177		$filePath = PATH_ROOT . DS . $directory . DS . $iterator->getSubPathName();
178
179		if ($item->isDir()) {
180		if (is_dir($filePath)) {
181		$this->installer->getIo()->write(
182		" - <comment>Directory `{$iterator->getSubPathName()}` already exists</comment>",
183		true,
184		IOInterface::VERBOSE
185		);
186		} else {
187		mkdir($filePath, self::PERMISSION_CODE);
188		$this->installer->getIo()->write(
189		" - Created directory `{$iterator->getSubPathName()}`",
190		true,
191		IOInterface::VERBOSE
192		);
193		}
194		} else {
195		if (file_exists($filePath)) {
196		$this->installer->getIo()->write(
197		" - <comment>File `{$iterator->getSubPathName()}` already exists</comment>",
198		true,
199		IOInterface::VERBOSE
200		);
201		} else {
202		copy($item, $filePath);
203		$this->installer->getIo()->write(
204		" - Copied file `{$iterator->getSubPathName()}`",
205		true,
206		IOInterface::VERBOSE
207		);
208		}
209		}
210		}
211
212		return true;
213		}
214
215		/**
216		* It recursively removes the files and directories
217		* @return bool
218		*/
219		protected function remove()
220		{
221		$this->removeRecursive('application');
222		$this->removeRecursive('data');
223		$this->removeRecursive('public');
224		$this->removeRecursive('tests');
225		}
226
227		/**
228		* It recursively removes the files and directories
229		* @param $directory
230		* @return bool
231		*/
232		protected function removeRecursive($directory)
233		{
234		$sourcePath = $this->installer->getOption('vendorPath') . DS . $directory;
235
236		if (!is_dir($sourcePath)) {
237		return false;
238		}
239		foreach ($iterator = new \RecursiveIteratorIterator(
240		new \RecursiveDirectoryIterator(
241		$sourcePath,
242		\RecursiveDirectoryIterator::SKIP_DOTS
243		),
244		\RecursiveIteratorIterator::CHILD_FIRST
245		) as $item) {
246		// path to copied file
247		$current = PATH_ROOT . DS . $directory . DS . $iterator->getSubPathName();
248
249		// remove empty directories
250	View Code Duplication	if (is_dir($current)) {
		0 ignored issues – show Duplication introduced 2017-03-27 12:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
251		if (sizeof(scandir($current)) == 2) {
252		rmdir($current);
253		$this->installer->getIo()->write(
254		" - Removed directory `{$iterator->getSubPathName()}`",
255		true,
256		IOInterface::VERBOSE
257		);
258		} else {
259		$this->installer->getIo()->write(
260		" - <comment>Skip directory `{$iterator->getSubPathName()}`</comment>",
261		true,
262		IOInterface::VERBOSE
263		);
264		}
265		continue;
266		}
267
268		// skip already removed files
269		if (!is_file($current)) {
270		continue;
271		}
272
273	View Code Duplication	if (md5_file($item) == md5_file($current)) {
		0 ignored issues – show Duplication introduced 2017-03-27 12:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
274		// remove file
275		unlink($current);
276		$this->installer->getIo()->write(
277		" - Removed file `{$iterator->getSubPathName()}`",
278		true,
279		IOInterface::VERBOSE
280		);
281		} else {
282		// or skip changed files
283		$this->installer->getIo()->write(
284		" - <comment>File `{$iterator->getSubPathName()}` has changed</comment>",
285		true,
286		IOInterface::VERBOSE
287		);
288		}
289		}
290
291		return false;
292		}
293		}
294

bluzphp / composer-plugin

Push — master ( 74e04b...099a74 )

Plugin::getSubscribedEvents() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like