/tests/unit/AnalyserTest.php

<?php declare(strict_types=1);
/*
 * This file is part of PHPLOC.
 *
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace SebastianBergmann\PHPLOC;

use const E_ALL;
use function error_reporting;
use function sprintf;
use PHPUnit\Framework\TestCase;

/**
 * @covers \SebastianBergmann\PHPLOC\Analyser
 */
final class AnalyserTest extends TestCase
{
    /**
     * @var Analyser
     */
    private $analyser;

    protected function setUp(): void
    {
        $this->analyser = new Analyser;
    }

    public function testWithoutTests(): void
    {
        $this->assertEqualsWithDelta(
            [
                'files'                       => 1,
                'loc'                         => 75,
                'lloc'                        => 24,
                'llocClasses'                 => 22,
                'llocFunctions'               => 1,
                'llocGlobal'                  => 1,
                'cloc'                        => 7,
                'ccn'                         => 2,
                'ccnMethods'                  => 2,
                'interfaces'                  => 1,
                'traits'                      => 0,
                'classes'                     => 2,
                'abstractClasses'             => 1,
                'concreteClasses'             => 1,
                'nonFinalClasses'             => 1,
                'finalClasses'                => 0,
                'functions'                   => 2,
                'namedFunctions'              => 1,
                'anonymousFunctions'          => 1,
                'methods'                     => 4,
                'publicMethods'               => 2,
                'nonPublicMethods'            => 2,
                'protectedMethods'            => 1,
                'privateMethods'              => 1,
                'nonStaticMethods'            => 3,
                'staticMethods'               => 1,
                'constants'                   => 2,
                'classConstants'              => 1,
                'publicClassConstants'        => 1,
                'nonPublicClassConstants'     => 0,
                'globalConstants'             => 1,
                'testClasses'                 => 0,
                'testMethods'                 => 0,
                'ccnByLloc'                   => 0.08,
                'llocByNof'                   => 0.5,
                'methodCalls'                 => 6,
                'staticMethodCalls'           => 4,
                'instanceMethodCalls'         => 2,
                'attributeAccesses'           => 6,
                'staticAttributeAccesses'     => 4,
                'instanceAttributeAccesses'   => 2,
                'globalAccesses'              => 4,
                'globalVariableAccesses'      => 2,
                'superGlobalVariableAccesses' => 1,
                'globalConstantAccesses'      => 1,
                'directories'                 => 0,
                'namespaces'                  => 1,
                'ncloc'                       => 68,
                'classCcnMin'                 => 1,
                'classCcnAvg'                 => 1.65,
                'classCcnMax'                 => 3,
                'methodCcnMin'                => 1,
                'methodCcnAvg'                => 1.65,
                'methodCcnMax'                => 2,
                'classLlocMin'                => 0,
                'classLlocAvg'                => 7.3,
                'classLlocMax'                => 22,
                'methodLlocMin'               => 4,
                'methodLlocAvg'               => 5.6,
                'methodLlocMax'               => 7,
                'averageMethodsPerClass'      => 1.33,
                'minimumMethodsPerClass'      => 0,
                'maximumMethodsPerClass'      => 4,
            ],
            $this->analyser->countFiles(
                [__DIR__ . '/../_files/source.php'],
                false
            ),
            0.1
        );
    }

    public function testWithTests(): void
    {
        $this->assertEqualsWithDelta(
            [
                'files'                       => 2,
                'loc'                         => 98,
                'lloc'                        => 24,
                'llocClasses'                 => 22,
                'llocFunctions'               => 1,
                'llocGlobal'                  => 1,
                'cloc'                        => 11,
                'ccn'                         => 2,
                'ccnMethods'                  => 2,
                'interfaces'                  => 1,
                'traits'                      => 0,
                'classes'                     => 2,
                'abstractClasses'             => 1,
                'concreteClasses'             => 1,
                'nonFinalClasses'             => 1,
                'finalClasses'                => 0,
                'functions'                   => 2,
                'namedFunctions'              => 1,
                'anonymousFunctions'          => 1,
                'methods'                     => 4,
                'publicMethods'               => 2,
                'nonPublicMethods'            => 2,
                'protectedMethods'            => 1,
                'privateMethods'              => 1,
                'nonStaticMethods'            => 3,
                'staticMethods'               => 1,
                'constants'                   => 2,
                'publicClassConstants'        => 1,
                'nonPublicClassConstants'     => 0,
                'classConstants'              => 1,
                'globalConstants'             => 1,
                'testClasses'                 => 1,
                'testMethods'                 => 2,
                'ccnByLloc'                   => 0.08,
                'llocByNof'                   => 0.5,
                'methodCalls'                 => 6,
                'staticMethodCalls'           => 4,
                'instanceMethodCalls'         => 2,
                'attributeAccesses'           => 6,
                'staticAttributeAccesses'     => 4,
                'instanceAttributeAccesses'   => 2,
                'globalAccesses'              => 4,
                'globalVariableAccesses'      => 2,
                'superGlobalVariableAccesses' => 1,
                'globalConstantAccesses'      => 1,
                'directories'                 => 0,
                'namespaces'                  => 1,
                'ncloc'                       => 87,
                'classCcnMin'                 => 1,
                'classCcnAvg'                 => 1.5,
                'classCcnMax'                 => 3,
                'methodCcnMin'                => 1,
                'methodCcnAvg'                => 1.66,
                'methodCcnMax'                => 2,
                'classLlocMin'                => 0,
                'classLlocAvg'                => 5.5,
                'classLlocMax'                => 22,
                'methodLlocMin'               => 4,
                'methodLlocAvg'               => 5.6,
                'methodLlocMax'               => 7,
                'averageMethodsPerClass'      => 1,
                'minimumMethodsPerClass'      => 0,
                'maximumMethodsPerClass'      => 4,
            ],
            $this->analyser->countFiles(
                [
                    __DIR__ . '/../_files/source.php',
                    __DIR__ . '/../_files/tests.php',
                ],
                true
            ),
            0.1
        );
    }

    public function testFilesThatExtendPHPUnitTestCaseAreCountedAsTests(): void
    {
        $result = $this->analyser->countFiles(
            [
                __DIR__ . '/../_files/tests.php',
            ],
            true
        );

        $this->assertSame(1, $result['testClasses']);
    }

    public function testFilesThatExtendPHPUnitTestCaseAreCountedAsTests2(): void
    {
        $result = $this->analyser->countFiles(
            [
                __DIR__ . '/../_files/tests_old.php',
            ],
            true
        );

        $this->assertSame(1, $result['testClasses']);
    }

    public function testFilesThatIndirectlyExtendPHPUnitTestCaseAreCountedAsTests(): void
    {
        $result = $this->analyser->countFiles(
            [
                __DIR__ . '/../_files/twoTestsThatIndirectlyExtendOldPHPUnitTestCase.php',
            ],
            true
        );

        $this->assertSame(3, $result['testClasses']);
    }

    public function testFilesThatIndirectlyExtendPHPUnitTestCaseAreCountedAsTests2(): void
    {
        $result = $this->analyser->countFiles(
            [
                __DIR__ . '/../_files/twoTestsThatIndirectlyExtendPHPUnitTestCase.php',
            ],
            true
        );

        $this->assertSame(3, $result['testClasses']);
    }

    public function testTraitsAreCountedCorrectly(): void
    {
        $result = $this->analyser->countFiles(
            [
                __DIR__ . '/../_files/trait.php',
            ],
            false
        );

        $this->assertSame(1, $result['traits']);
    }

    /**
     * @ticket 64
     */
    public function testIssue64IsFixed(): void
    {
        $result = $this->analyser->countFiles(
            [
                __DIR__ . '/../_files/issue_62.php',
            ],
            false
        );

        $this->assertSame(1, $result['cloc']);
    }

    /**
     * @ticket 112
     */
    public function testIssue112IsFixed(): void
    {
        $result = $this->analyser->countFiles(
            [
                __DIR__ . '/../_files/issue_112.php',
            ],
            false
        );

        $this->assertSame(5, $result['loc']);
    }

    /**
     * @ticket 126
     * @dataProvider issue126Provider
     */
    public function testIssue126IsFixed($fileNumber, $cloc): void
    {
        $file   = __DIR__ . '/../_files/issue_126/issue_126_' . $fileNumber . '.php';
        $result = $this->analyser->countFiles([$file], false);

        $assertString = sprintf(
            'Failed asserting that %s matches expected %s in issue_126_%d.php',
            $result['cloc'],
            $cloc,
            $fileNumber
        );

        $this->assertSame($cloc, $result['cloc'], $assertString);
    }

    public function issue126Provider()
    {
        // issue_126_X.php => CLOC
        return [
            [1, 1],
            [2, 1],
            [3, 1],
            [4, 2],
            [5, 3],
            [6, 3],
            [7, 3],
        ];
    }

    /**
     * @requires PHP 7
     * @ticket 138
     */
    public function testIssue138IsFixed(): void
    {
        error_reporting(E_ALL);

        $result = $this->analyser->countFiles(
            [
                __DIR__ . '/../_files/issue_138.php',
            ],
            false
        );

        $this->assertSame(1, $result['classes']);
    }

    /**
     * @ticket 139
     */
    public function testIssue139IsFixed(): void
    {
        error_reporting(E_ALL);

        $result = $this->analyser->countFiles(
            [
                __DIR__ . '/../_files/issue_139.php',
            ],
            false
        );

        $this->assertSame(1, $result['anonymousFunctions']);
    }

    public function testDeclareIsNotLogicalLine(): void
    {
        $result = $this->analyser->countFiles([__DIR__ . '/../_files/with_declare.php'], false);

        $this->assertSame(0, $result['llocGlobal']);
    }

    public function testNamespaceIsNotLogicalLine(): void
    {
        $result = $this->analyser->countFiles([__DIR__ . '/../_files/with_namespace.php'], false);

        $this->assertSame(0, $result['llocGlobal']);
    }

    public function testImportIsNotLogicalLine(): void
    {
        $result = $this->analyser->countFiles([__DIR__ . '/../_files/with_import.php'], false);

        $this->assertSame(0, $result['llocGlobal']);
    }

    public function test_it_makes_a_distinction_between_public_and_non_public_class_constants(): void
    {
        $result = $this->analyser->countFiles([__DIR__ . '/../_files/class_constants.php'], false);
        $this->assertSame(2, $result['publicClassConstants']);
        $this->assertSame(3, $result['nonPublicClassConstants']);
        $this->assertSame(5, $result['classConstants']);
        $this->assertSame(5, $result['constants']);
    }

    public function test_it_collects_the_number_of_final_non_final_and_abstract_classes(): void
    {
        $result = $this->analyser->countFiles([__DIR__ . '/../_files/classes.php'], false);
        $this->assertSame(9, $result['classes']);
        $this->assertSame(2, $result['finalClasses']);
        $this->assertSame(3, $result['nonFinalClasses']);
        $this->assertSame(4, $result['abstractClasses']);
    }

    public function test_it_makes_a_distinction_between_protected_and_private_methods(): void
    {
        $result = $this->analyser->countFiles([__DIR__ . '/../_files/methods.php'], false);
        $this->assertSame(2, $result['publicMethods']);
        $this->assertSame(1, $result['protectedMethods']);
        $this->assertSame(3, $result['privateMethods']);
        $this->assertSame(6, $result['methods']);
    }

    public function test_it_provides_average_minimum_and_maximum_number_of_methods_per_class(): void
    {
        $result = $this->analyser->countFiles([__DIR__ . '/../_files/methods_per_class.php'], false);
        $this->assertSame(2, $result['averageMethodsPerClass']);
        $this->assertSame(0, $result['minimumMethodsPerClass']);
        $this->assertSame(4, $result['maximumMethodsPerClass']);
    }

    public function test_use_trait_is_not_counted_as_logical_line(): void
    {
        $result = $this->analyser->countFiles([__DIR__ . '/../_files/class_using_trait.php'], false);
        $this->assertSame(1, $result['lloc']);
        $this->assertSame(1, $result['llocClasses']);
    }
}