ChangelogsPlugin::setupConfig() - Code Metrics - Inspection of "Merge pull request #29 from pyrech/feature/auto-co..." - pyrech/composer-changelogs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cff4e7...5ca23c )

by Loick

created 2016-03-08 17:38 UTC

ChangelogsPlugin::setupConfig() A

↳ Parent: ChangelogsPlugin

Complexity

Conditions	3
Paths	3

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3.512

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	16
ccs	8
cts	13
cp	0.6153
rs	9.4285
cc	3
eloc	9
nc	3
nop	0
crap	3.512

<?php

/*
 * This file is part of the composer-changelogs project.
 *
 * (c) Loïck Piera <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Pyrech\ComposerChangelogs;

use Composer\Composer;
use Composer\EventDispatcher\EventSubscriberInterface;
use Composer\Installer\PackageEvent;
use Composer\Installer\PackageEvents;
use Composer\IO\IOInterface;
use Composer\Plugin\PluginInterface;
use Composer\Script\Event;
use Composer\Script\ScriptEvents;
use Pyrech\ComposerChangelogs\Config\Config;
use Pyrech\ComposerChangelogs\Config\ConfigBuilder;
use Pyrech\ComposerChangelogs\Config\ConfigLocator;

class ChangelogsPlugin implements PluginInterface, EventSubscriberInterface
{
    const EXTRA_KEY = 'composer-changelogs';

    /** @var Composer */
    private $composer;

    /** @var IOInterface */
    private $io;

    /** @var Outputter */
    private $outputter;

    /** @var ConfigLocator */
    private $configLocator;

    /** @var Config */
    private $config;

    /**
     * {@inheritdoc}
     */
    public function activate(Composer $composer, IOInterface $io)
    {
        $this->composer = $composer;
        $this->io = $io;
        $this->outputter = Factory::createOutputter();
        $this->configLocator = new ConfigLocator($composer);

        $this->setupConfig();
        $this->autoloadNeededClasses();
    }

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()
    {
        return [
            PackageEvents::POST_PACKAGE_UPDATE => [
                ['postPackageOperation'],
            ],
            PackageEvents::POST_PACKAGE_INSTALL => [
                ['postPackageOperation'],
            ],
            PackageEvents::POST_PACKAGE_UNINSTALL => [
                ['postPackageOperation'],
            ],
            ScriptEvents::POST_UPDATE_CMD => [
                ['postUpdate'],
            ],
        ];
    }

    /**
     * @param PackageEvent $event
     */
    public function postPackageOperation(PackageEvent $event)
    {
        $operation = $event->getOperation();

        $this->outputter->addOperation($operation);
    }

    /**
     * @param Event $event
     */
    public function postUpdate(Event $event)

    {
        $this->io->write($this->outputter->getOutput());

        $this->handleCommit();
    }

    /**
     * This method ensures all the classes required to make the plugin working
     * are loaded.
     *
     * It's required to avoid composer looking for classes no longer existing
     * (after the plugin is updated or removed for example).
     *
     * Lot of classes (like operation handlers, url generators, Outputter, etc)
     * do not need this because they are already autoloaded at the activation
     * of the plugin.
     */
    private function autoloadNeededClasses()
    {
        $classes = [
            'Pyrech\ComposerChangelogs\Version',
        ];

        foreach ($classes as $class) {
            // Force the class to be autoloaded
            class_exists($class, true);
        }
    }

    private function setupConfig()
    {
        $builder = new ConfigBuilder();

        $this->config = $builder->build(
            $this->configLocator->getConfig(self::EXTRA_KEY),
            $this->configLocator->getPath(self::EXTRA_KEY)
        );

        if (count($builder->getWarnings()) > 0) {
            $this->io->writeError('<error>Invalid config for composer-changelogs plugin:</error>');
            foreach ($builder->getWarnings() as $warning) {
                $this->io->write('    ' . $warning);
            }
        }
    }

    private function handleCommit()
    {
        if ($this->outputter->isEmpty()) {
            return;
        }

        switch ($this->config->getCommitAuto()) {
            case 'never':
                return;
            case 'ask':
                if ($this->io->askConfirmation('<info>Would you like to commit the update? </info>[<comment>no</comment>]: ', false)) {
                    $this->doCommit();
                }
                break;
            case 'always':
                $this->doCommit();
        }
    }

    private function doCommit()
    {
        if (!$this->config->getCommitBinFile()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->io->writeError('<error>No "commit-bin-file" for composer-changelogs plugin. Commit not done.</error>');

            return;
        }

        $workingDirectory = getcwd();
        $filename = tempnam(sys_get_temp_dir(), 'composer-changelogs-');
        $message = 'Update dependencies' . PHP_EOL . PHP_EOL . strip_tags($this->outputter->getOutput());

        file_put_contents($filename, $message);

        $command = $this->config->getCommitBinFile() . ' ' . escapeshellarg($workingDirectory) . ' ' . escapeshellarg($filename);

        $this->io->write(sprintf('Executing following command: %s', $command));
        exec($command);
    }
}


1		<?php
2
3		/*
4		* This file is part of the composer-changelogs project.
5		*
6		* (c) Loïck Piera <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Pyrech\ComposerChangelogs;
13
14		use Composer\Composer;
15		use Composer\EventDispatcher\EventSubscriberInterface;
16		use Composer\Installer\PackageEvent;
17		use Composer\Installer\PackageEvents;
18		use Composer\IO\IOInterface;
19		use Composer\Plugin\PluginInterface;
20		use Composer\Script\Event;
21		use Composer\Script\ScriptEvents;
22		use Pyrech\ComposerChangelogs\Config\Config;
23		use Pyrech\ComposerChangelogs\Config\ConfigBuilder;
24		use Pyrech\ComposerChangelogs\Config\ConfigLocator;
25
26		class ChangelogsPlugin implements PluginInterface, EventSubscriberInterface
27		{
28		const EXTRA_KEY = 'composer-changelogs';
29
30		/** @var Composer */
31		private $composer;
32
33		/** @var IOInterface */
34		private $io;
35
36		/** @var Outputter */
37		private $outputter;
38
39		/** @var ConfigLocator */
40		private $configLocator;
41
42		/** @var Config */
43		private $config;
44
45		/**
46		* {@inheritdoc}
47		*/
48	6	public function activate(Composer $composer, IOInterface $io)
49		{
50	6	$this->composer = $composer;
51	6	$this->io = $io;
52	6	$this->outputter = Factory::createOutputter();
53	6	$this->configLocator = new ConfigLocator($composer);
54
55	6	$this->setupConfig();
56	6	$this->autoloadNeededClasses();
57	6	}
58
59		/**
60		* {@inheritdoc}
61		*/
62	3	public static function getSubscribedEvents()
63		{
64		return [
65	2	PackageEvents::POST_PACKAGE_UPDATE => [
66	2	['postPackageOperation'],
67	2	],
68	2	PackageEvents::POST_PACKAGE_INSTALL => [
69	2	['postPackageOperation'],
70	2	],
71	2	PackageEvents::POST_PACKAGE_UNINSTALL => [
72	2	['postPackageOperation'],
73	2	],
74	2	ScriptEvents::POST_UPDATE_CMD => [
75	2	['postUpdate'],
76	2	],
77	2	];
78	2	}
79
80		/**
81		* @param PackageEvent $event
82		*/
83	5	public function postPackageOperation(PackageEvent $event)
84		{
85	5	$operation = $event->getOperation();
86
87	5	$this->outputter->addOperation($operation);
88	5	}
89
90		/**
91		* @param Event $event
92		*/
93	5	public function postUpdate(Event $event)
		0 ignored issues – show Unused Code introduced 2016-02-12 16:57 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...
94		{
95	5	$this->io->write($this->outputter->getOutput());
96
97	5	$this->handleCommit();
98	5	}
99
100		/**
101		* This method ensures all the classes required to make the plugin working
102		* are loaded.
103		*
104		* It's required to avoid composer looking for classes no longer existing
105		* (after the plugin is updated or removed for example).
106		*
107		* Lot of classes (like operation handlers, url generators, Outputter, etc)
108		* do not need this because they are already autoloaded at the activation
109		* of the plugin.
110		*/
111	6	private function autoloadNeededClasses()
112		{
113		$classes = [
114	6	'Pyrech\ComposerChangelogs\Version',
115	6	];
116
117	6	foreach ($classes as $class) {
118		// Force the class to be autoloaded
119	6	class_exists($class, true);
120	6	}
121	6	}
122
123	6	private function setupConfig()
124		{
125	6	$builder = new ConfigBuilder();
126
127	6	$this->config = $builder->build(
128	6	$this->configLocator->getConfig(self::EXTRA_KEY),
129	6	$this->configLocator->getPath(self::EXTRA_KEY)
130	6	);
131
132	6	if (count($builder->getWarnings()) > 0) {
133		$this->io->writeError('<error>Invalid config for composer-changelogs plugin:</error>');
134		foreach ($builder->getWarnings() as $warning) {
135		$this->io->write(' ' . $warning);
136		}
137		}
138	6	}
139
140	5	private function handleCommit()
141		{
142	5	if ($this->outputter->isEmpty()) {
143		return;
144		}
145
146	5	switch ($this->config->getCommitAuto()) {
147	5	case 'never':
148	3	return;
149	2	case 'ask':
150		if ($this->io->askConfirmation('<info>Would you like to commit the update? </info>[<comment>no</comment>]: ', false)) {
151		$this->doCommit();
152		}
153		break;
154	2	case 'always':
155	2	$this->doCommit();
156	2	}
157	2	}
158
159	2	private function doCommit()
160		{
161	2	if (!$this->config->getCommitBinFile()) {
		0 ignored issues – show Bug Best Practice introduced 2016-02-27 17:08 UTC by Report Bug Copy Issue Report The expression `$this->config->getCommitBinFile()` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
162		$this->io->writeError('<error>No "commit-bin-file" for composer-changelogs plugin. Commit not done.</error>');
163
164		return;
165		}
166
167	2	$workingDirectory = getcwd();
168	2	$filename = tempnam(sys_get_temp_dir(), 'composer-changelogs-');
169	2	$message = 'Update dependencies' . PHP_EOL . PHP_EOL . strip_tags($this->outputter->getOutput());
170
171	2	file_put_contents($filename, $message);
172
173	2	$command = $this->config->getCommitBinFile() . ' ' . escapeshellarg($workingDirectory) . ' ' . escapeshellarg($filename);
174
175	2	$this->io->write(sprintf('Executing following command: %s', $command));
176	2	exec($command);
177	2	}
178		}
179

pyrech / composer-changelogs

GitHub Access Token became invalid

Push — master ( cff4e7...5ca23c )

ChangelogsPlugin::setupConfig() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like