CerbereProgressBarListener - Code Metrics - smalot/drush-cerbere - Measure and Improve Code Quality continuously with Scrutinizer

CerbereProgressBarListener A
last analyzed 2017-03-23 18:27 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	116
Duplicated Lines	6.9 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	8
loc	116
rs	10
c	1
b	0
f	0
wmc	11
lcom	1
cbo	5

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getOutput()	0	4	1
A	setOutput()	0	4	1
A	__construct()	8	8	2
A	getSubscribedEvents()	0	8	1
A	onCerbereDoAction()	0	7	2
A	onCerberePostAction()	0	12	2
A	onCerberePreAction()	0	17	2

How to fix Duplicated Code

<?php

/**
 * Drush Cerbere command line tools.
 * Copyright (C) 2015 - Sebastien Malot <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

namespace Cerbere\Event;

use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Class CerbereProgressBarListener
 * @package Cerbere\Event
 */
class CerbereProgressBarListener implements EventSubscriberInterface
{
    /**
     * @var OutputInterface
     */
    protected $output = null;

    /**
     * @var ProgressBar
     */
    protected $progress = null;

    /**
     * CerbereConsoleListener constructor.
     * @param OutputInterface|null $output
     */
    public function __construct(OutputInterface $output = null)

    {
        if (null === $output) {
            $output = new ConsoleOutput();
        }

        $this->output = $output;
    }

    /**
     * @return OutputInterface
     */
    public function getOutput()
    {
        return $this->output;
    }

    /**
     * @param OutputInterface $output
     */
    public function setOutput($output)
    {
        $this->output = $output;
    }

    /**
     * Returns an array of event names this subscriber wants to listen to.
     *
     * The array keys are event names and the value can be:
     *
     *  * The method name to call (priority defaults to 0)
     *  * An array composed of the method name to call and the priority
     *  * An array of arrays composed of the method names to call and respective
     *    priorities, or 0 if unset
     *
     * For instance:
     *
     *  * array('eventName' => 'methodName')
     *  * array('eventName' => array('methodName', $priority))
     *  * array('eventName' => array(array('methodName1', $priority), array('methodName2'))
     *
     * @return array The event names to listen to
     */
    public static function getSubscribedEvents()
    {
        return array(
          CerbereEvents::CERBERE_PRE_ACTION  => array('onCerberePreAction', 0),
          CerbereEvents::CERBERE_DO_ACTION   => array('onCerbereDoAction', 0),
          CerbereEvents::CERBERE_POST_ACTION => array('onCerberePostAction', 0),
        );
    }

    /**
     * @param CerbereDoActionEvent $event
     */
    public function onCerbereDoAction(CerbereDoActionEvent $event)
    {
        if (null !== $this->progress) {
            $this->progress->setMessage($event->getProject()->getName(), 'project');
            $this->progress->advance();
        }
    }

    /**
     * @param CerberePostActionEvent $event
     */
    public function onCerberePostAction(CerberePostActionEvent $event)

    {
        if (null !== $this->progress) {
            $this->progress->setMessage('Action ended');
            $this->progress->setMessage('', 'project');
            $this->progress->finish();

            // Returns and jump new line.
            $this->output->getErrorOutput()->writeln('');
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.
    }
}
            $this->output->getErrorOutput()->writeln('');
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.
    }
}
        }
    }

    /**
     * @param CerberePreActionEvent $event
     */
    public function onCerberePreAction(CerberePreActionEvent $event)
    {
        if ($max = count($event->getProjects())) {
            // Returns and jump new line.
            $this->output->getErrorOutput()->writeln('');
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.
    }
}

            $format = " Project: %project%\n";
            $format .= ProgressBar::getFormatDefinition('debug');

            $progress = new ProgressBar($this->output, $max);
            $progress->setFormat($format);
            $progress->setRedrawFrequency(1);
            $progress->setMessage('Action starts');

            $this->progress = $progress;
        }
    }
}


1		<?php
2
3		/**
4		* Drush Cerbere command line tools.
5		* Copyright (C) 2015 - Sebastien Malot <[email protected]>
6		*
7		* This program is free software; you can redistribute it and/or modify
8		* it under the terms of the GNU General Public License as published by
9		* the Free Software Foundation; either version 2 of the License, or
10		* (at your option) any later version.
11		*
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		* GNU General Public License for more details.
16		*
17		* You should have received a copy of the GNU General Public License along
18		* with this program; if not, write to the Free Software Foundation, Inc.,
19		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20		*/
21
22		namespace Cerbere\Event;
23
24		use Symfony\Component\Console\Helper\ProgressBar;
25		use Symfony\Component\Console\Output\ConsoleOutput;
26		use Symfony\Component\Console\Output\OutputInterface;
27		use Symfony\Component\EventDispatcher\EventSubscriberInterface;
28
29		/**
30		* Class CerbereProgressBarListener
31		* @package Cerbere\Event
32		*/
33		class CerbereProgressBarListener implements EventSubscriberInterface
34		{
35		/**
36		* @var OutputInterface
37		*/
38		protected $output = null;
39
40		/**
41		* @var ProgressBar
42		*/
43		protected $progress = null;
44
45		/**
46		* CerbereConsoleListener constructor.
47		* @param OutputInterface\|null $output
48		*/
49	View Code Duplication	public function __construct(OutputInterface $output = null)
		0 ignored issues – show Duplication introduced 2015-11-24 16:15 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...
50		{
51		if (null === $output) {
52		$output = new ConsoleOutput();
53		}
54
55		$this->output = $output;
56		}
57
58		/**
59		* @return OutputInterface
60		*/
61		public function getOutput()
62		{
63		return $this->output;
64		}
65
66		/**
67		* @param OutputInterface $output
68		*/
69		public function setOutput($output)
70		{
71		$this->output = $output;
72		}
73
74		/**
75		* Returns an array of event names this subscriber wants to listen to.
76		*
77		* The array keys are event names and the value can be:
78		*
79		* * The method name to call (priority defaults to 0)
80		* * An array composed of the method name to call and the priority
81		* * An array of arrays composed of the method names to call and respective
82		* priorities, or 0 if unset
83		*
84		* For instance:
85		*
86		* * array('eventName' => 'methodName')
87		* * array('eventName' => array('methodName', $priority))
88		* * array('eventName' => array(array('methodName1', $priority), array('methodName2'))
89		*
90		* @return array The event names to listen to
91		*/
92		public static function getSubscribedEvents()
93		{
94		return array(
95		CerbereEvents::CERBERE_PRE_ACTION => array('onCerberePreAction', 0),
96		CerbereEvents::CERBERE_DO_ACTION => array('onCerbereDoAction', 0),
97		CerbereEvents::CERBERE_POST_ACTION => array('onCerberePostAction', 0),
98		);
99		}
100
101		/**
102		* @param CerbereDoActionEvent $event
103		*/
104		public function onCerbereDoAction(CerbereDoActionEvent $event)
105		{
106		if (null !== $this->progress) {
107		$this->progress->setMessage($event->getProject()->getName(), 'project');
108		$this->progress->advance();
109		}
110		}
111
112		/**
113		* @param CerberePostActionEvent $event
114		*/
115		public function onCerberePostAction(CerberePostActionEvent $event)
		0 ignored issues – show Unused Code introduced 2015-11-24 16:15 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...
116		{
117		if (null !== $this->progress) {
118		$this->progress->setMessage('Action ended');
119		$this->progress->setMessage('', 'project');
120		$this->progress->finish();
121
122		// Returns and jump new line.
123		$this->output->getErrorOutput()->writeln('');
		0 ignored issues – show Bug introduced 2015-11-24 16:15 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Output\OutputInterface` as the method `getErrorOutput()` does only exist in the following implementations of said interface: `Psy\Output\ShellOutput`, `Symfony\Component\Console\Output\ConsoleOutput`. 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...
124		$this->output->getErrorOutput()->writeln('');
		0 ignored issues – show Bug introduced 2015-11-24 16:15 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Output\OutputInterface` as the method `getErrorOutput()` does only exist in the following implementations of said interface: `Psy\Output\ShellOutput`, `Symfony\Component\Console\Output\ConsoleOutput`. 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...
125		}
126		}
127
128		/**
129		* @param CerberePreActionEvent $event
130		*/
131		public function onCerberePreAction(CerberePreActionEvent $event)
132		{
133		if ($max = count($event->getProjects())) {
134		// Returns and jump new line.
135		$this->output->getErrorOutput()->writeln('');
		0 ignored issues – show Bug introduced 2015-11-24 16:15 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Output\OutputInterface` as the method `getErrorOutput()` does only exist in the following implementations of said interface: `Psy\Output\ShellOutput`, `Symfony\Component\Console\Output\ConsoleOutput`. 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...
136
137		$format = " Project: %project%\n";
138		$format .= ProgressBar::getFormatDefinition('debug');
139
140		$progress = new ProgressBar($this->output, $max);
141		$progress->setFormat($format);
142		$progress->setRedrawFrequency(1);
143		$progress->setMessage('Action starts');
144
145		$this->progress = $progress;
146		}
147		}
148		}
149

smalot / drush-cerbere

CerbereProgressBarListener A last analyzed 2017-03-23 18:27 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

CerbereProgressBarListener A
last analyzed 2017-03-23 18:27 UTC