AssertReadme::assertReadme() - Code Metrics - Inspection of "Add Expectation/ReturnObj and PHPUnit/AssertReadme" - hanneskod/readme-tester - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c32bd7...f916e0 )

by Hannes

created 2016-05-01 21:01 UTC

AssertReadme::assertReadme() A

↳ Parent: AssertReadme

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	2

<?php

namespace hanneskod\readmetester\PHPUnit;

use hanneskod\readmetester\ReadmeTester;
use hanneskod\readmetester\Format\FormatFactory;

class AssertReadme
{
    /**
     * @var \PHPUnit_Framework_TestCase
     */
    private $testCase;

    /**
     * @var ReadmeTester
     */
    private $tester;

    /**
     * @var FormatFactory
     */
    private $formatFactory;

    public function __construct(
        \PHPUnit_Framework_TestCase $testCase,
        ReadmeTester $tester = null,
        FormatFactory $formatFactory = null
    ) {
        $this->testCase = $testCase;
        $this->tester = $tester ?: new ReadmeTester;
        $this->formatFactory = $formatFactory ?: new FormatFactory;
    }

    /**
     * Validate code examples in $file
     *
     * @param  \SplFileObject $file
     * @param  string         $formatIdentifier
     * @return void
     */
    public function assertFile(\SplFileObject $file, $formatIdentifier = '')
    {
        $format = $this->formatFactory->createFormat($formatIdentifier ?: $file->getExtension());
        $result = $this->testCase->getTestResultObject();

        foreach ($this->tester->test($file, $format) as $example => $returnObj) {
            $this->testCase->addToAssertionCount(1);
            if ($returnObj->isFailure()) {
                $result->addFailure(
                    $this->testCase,
                    new \PHPUnit_Framework_AssertionFailedError("Example $example: {$returnObj->getMessage()}"),
                    0.0
                );
            }
        }
    }

    public function assertReadme($filename, $formatIdentifier = '')
    {
        return $this->assertFile(new \SplFileObject($filename), $formatIdentifier);
    }
}


1			<?php
2
3			namespace hanneskod\readmetester\PHPUnit;
4
5			use hanneskod\readmetester\ReadmeTester;
6			use hanneskod\readmetester\Format\FormatFactory;
7
8			class AssertReadme
9			{
10			/**
11			* @var \PHPUnit_Framework_TestCase
12			*/
13			private $testCase;
14
15			/**
16			* @var ReadmeTester
17			*/
18			private $tester;
19
20			/**
21			* @var FormatFactory
22			*/
23			private $formatFactory;
24
25			public function __construct(
26			\PHPUnit_Framework_TestCase $testCase,
27			ReadmeTester $tester = null,
28			FormatFactory $formatFactory = null
29			) {
30			$this->testCase = $testCase;
31			$this->tester = $tester ?: new ReadmeTester;
32			$this->formatFactory = $formatFactory ?: new FormatFactory;
33			}
34
35			/**
36			* Validate code examples in $file
37			*
38			* @param \SplFileObject $file
39			* @param string $formatIdentifier
40			* @return void
41			*/
42			public function assertFile(\SplFileObject $file, $formatIdentifier = '')
43			{
44			$format = $this->formatFactory->createFormat($formatIdentifier ?: $file->getExtension());
45			$result = $this->testCase->getTestResultObject();
46
47			foreach ($this->tester->test($file, $format) as $example => $returnObj) {
48			$this->testCase->addToAssertionCount(1);
49			if ($returnObj->isFailure()) {
50			$result->addFailure(
51			$this->testCase,
52			new \PHPUnit_Framework_AssertionFailedError("Example $example: {$returnObj->getMessage()}"),
53			0.0
54			);
55			}
56			}
57			}
58
59			public function assertReadme($filename, $formatIdentifier = '')
60			{
61			return $this->assertFile(new \SplFileObject($filename), $formatIdentifier);
62			}
63			}
64

hanneskod / readme-tester

Push — master ( c32bd7...f916e0 )

AssertReadme::assertReadme() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like