TestTasksTrait::assertOutputEquals() - Code Metrics - Inspection of "Add PHP 7.4 testing and dependency updates." - consolidation/robo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#924)

by Greg

created 2020-02-11 01:23 UTC

TestTasksTrait::assertOutputEquals() A

↳ Parent: TestTasksTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php
namespace Robo\Traits;

use Robo\Robo;
use Robo\TaskAccessor;
use Robo\Collection\CollectionBuilder;
use Symfony\Component\Console\Output\BufferedOutput;
use Symfony\Component\Console\Output\OutputInterface;

trait TestTasksTrait
{
    use TaskAccessor;

    protected $testPrinter;
    protected $capturedOutput;
    protected $logger;

    public function initTestTasksTrait($commandClass = null, $container = null, $input = null)
    {
        if (!$container) {
            $container = Robo::createDefaultContainer();
        }
        $this->capturedOutput = '';
        $this->testPrinter = new BufferedOutput(OutputInterface::VERBOSITY_DEBUG);

        $app = Robo::createDefaultApplication();
        $config = new \Robo\Config();

        \Robo\Robo::configureContainer($container, $app, $config, $input, $this->testPrinter);

        // Set the application dispatcher
        $app->setDispatcher($container->get('eventDispatcher'));
        $this->logger = $container->get('logger');

        // Make a command class if one was not provided
        if (!$commandClass) {
            $commandClass = new \Robo\RoboFileFixture();
            $commandClass->setLogger($this->logger);
        }

        // Configure BuilderAwareTrait
        $builder = CollectionBuilder::create($container, $commandClass);
        $commandClass->setBuilder($builder);
        $this->setBuilder($builder);

        return $container;
    }

    public function capturedOutputStream()
    {
        if (!$this->testPrinter) {
            $this->initTestTasksTrait();
        }
        return $this->testPrinter;
    }

    public function logger()
    {
        return $this->logger;
    }

    protected function accumulate()
    {
        $this->capturedOutput .= $this->capturedOutputStream()->fetch();
        return $this->capturedOutput;
    }

    public function assertOutputContains($value)
    {
        $output = $this->accumulate();
        $output = $this->simplify($output);
        $this->assertContains($value, $output);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function assertOutputNotContains($value)
    {
        $output = $this->accumulate();
        $output = $this->simplify($output);
        $this->assertNotContains($value, $output);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function assertOutputEquals($value)
    {
        $output = $this->accumulate();
        $output = $this->simplify($output);
        $this->assertEquals($value, $output);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Make our output comparisons more platform-agnostic by converting
     * CRLF (Windows) or raw CR (confused output) to a LF (unix/Mac).
     */
    protected function simplify($output)

    {
        $output = str_replace("\r\n", "\n", $output);
        $output = str_replace("\r", "\n", $output);

        return $output;
    }
}


1		<?php
2		namespace Robo\Traits;
3
4		use Robo\Robo;
5		use Robo\TaskAccessor;
6		use Robo\Collection\CollectionBuilder;
7		use Symfony\Component\Console\Output\BufferedOutput;
8		use Symfony\Component\Console\Output\OutputInterface;
9
10		trait TestTasksTrait
11		{
12		use TaskAccessor;
13
14		protected $testPrinter;
15		protected $capturedOutput;
16		protected $logger;
17
18		public function initTestTasksTrait($commandClass = null, $container = null, $input = null)
19		{
20		if (!$container) {
21		$container = Robo::createDefaultContainer();
22		}
23		$this->capturedOutput = '';
24		$this->testPrinter = new BufferedOutput(OutputInterface::VERBOSITY_DEBUG);
25
26		$app = Robo::createDefaultApplication();
27		$config = new \Robo\Config();
		0 ignored issues – show Deprecated Code introduced 2020-02-08 05:06 UTC by Report Bug Copy Issue Report The class `Robo\Config` has been deprecated with message: Use \Robo\Config\Config This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
28		\Robo\Robo::configureContainer($container, $app, $config, $input, $this->testPrinter);
29
30		// Set the application dispatcher
31		$app->setDispatcher($container->get('eventDispatcher'));
32		$this->logger = $container->get('logger');
33
34		// Make a command class if one was not provided
35		if (!$commandClass) {
36		$commandClass = new \Robo\RoboFileFixture();
37		$commandClass->setLogger($this->logger);
38		}
39
40		// Configure BuilderAwareTrait
41		$builder = CollectionBuilder::create($container, $commandClass);
42		$commandClass->setBuilder($builder);
43		$this->setBuilder($builder);
44
45		return $container;
46		}
47
48		public function capturedOutputStream()
49		{
50		if (!$this->testPrinter) {
51		$this->initTestTasksTrait();
52		}
53		return $this->testPrinter;
54		}
55
56		public function logger()
57		{
58		return $this->logger;
59		}
60
61		protected function accumulate()
62		{
63		$this->capturedOutput .= $this->capturedOutputStream()->fetch();
64		return $this->capturedOutput;
65		}
66
67		public function assertOutputContains($value)
68		{
69		$output = $this->accumulate();
70		$output = $this->simplify($output);
71		$this->assertContains($value, $output);
		0 ignored issues – show Bug introduced 2020-02-08 05:06 UTC by Report Bug Copy Issue Report It seems like `assertContains()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
72		}
73
74		public function assertOutputNotContains($value)
75		{
76		$output = $this->accumulate();
77		$output = $this->simplify($output);
78		$this->assertNotContains($value, $output);
		0 ignored issues – show Bug introduced 2020-02-08 05:06 UTC by Report Bug Copy Issue Report It seems like `assertNotContains()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
79		}
80
81		public function assertOutputEquals($value)
82		{
83		$output = $this->accumulate();
84		$output = $this->simplify($output);
85		$this->assertEquals($value, $output);
		0 ignored issues – show Bug introduced 2020-02-08 05:06 UTC by Report Bug Copy Issue Report It seems like `assertEquals()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
86		}
87
88		/**
89		* Make our output comparisons more platform-agnostic by converting
90		* CRLF (Windows) or raw CR (confused output) to a LF (unix/Mac).
91		*/
92	View Code Duplication	protected function simplify($output)
		0 ignored issues – show Duplication introduced 2020-02-08 05:06 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...
93		{
94		$output = str_replace("\r\n", "\n", $output);
95		$output = str_replace("\r", "\n", $output);
96
97		return $output;
98		}
99		}
100

consolidation / robo

Pull Request — master (#924)

TestTasksTrait::assertOutputEquals() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like