Nikoms / phpunit-arrange

src/Printer/ArrangeResultPrinter.php

<?php

namespace Nikoms\PhpUnit\Printer;

use Doctrine\Common\Annotations\AnnotationReader;
use Nikoms\PhpUnit\Annotation\Arrange;
use Nikoms\PhpUnit\AnnotationReaderFactory;
use Nikoms\PhpUnit\Listener\ArrangeListener;
use PHPUnit_Framework_Test;

/**
 * Class ArrangeResultPrinter
 * @package Nikoms\PhpUnit\Printer
 */
class ArrangeResultPrinter extends \PHPUnit_Util_TestDox_ResultPrinter_Text
{
    /**
     * @param \PHPUnit_Framework_Test | \PHPUnit_Framework_TestCase $test
     */
    public function startTest(PHPUnit_Framework_Test $test)
    {
        parent::startTest($test);
        if ($this->currentTestMethodPrettified == null || empty(ArrangeListener::$inputs[$test->getName(true)])) {

It seems like you code against a concrete implementation and not the interface PHPUnit_Framework_Test as the method getName() does only exist in the following implementations of said interface: AbstractTest, BankAccountTest, BankAccountWithCustomExtensionTest, BeforeAndAfterTest, BeforeClassAndAfterClassTest, BeforeClassWithOnlyDataProviderTest, ChangeCurrentWorkingDirectoryTest, ClonedDependencyTest, ConcreteTest, ConcreteWithMyCustomExtensionTest, CountTest, CoverageClassExtendedTest, CoverageClassTest, CoverageFunctionParenthesesTest, CoverageFunctionParenthesesWhitespaceTest, CoverageFunctionTest, CoverageMethodOneLineAnnotationTest, CoverageMethodParenthesesTest, CoverageMethodParenthesesWhitespaceTest, CoverageMethodTest, CoverageNamespacedFunctionTest, CoverageNoneTest, CoverageNotPrivateTest, CoverageNotProtectedTest, CoverageNotPublicTest, CoverageNothingTest, CoveragePrivateTest, CoverageProtectedTest, CoveragePublicTest, DataProviderDebugTest, DataProviderFilterTest, DataProviderIncompleteTest, DataProviderSkippedTest, DataProviderTest, DependencyFailureTest, DependencySuccessTest, EmptyTestCaseTest, ExceptionInAssertPostConditionsTest, ExceptionInAssertPreConditionsTest, ExceptionInSetUpTest, ExceptionInTearDownTest, ExceptionInTest, ExceptionMessageRegExpTest, ExceptionMessageTest, ExceptionStackTest, ExceptionTest, Extensions_PhptTestCaseTest, Extensions_RepeatedTestTest, Failure, FailureTest, FatalTest, Foo_Bar_Issue684Test, Framework_AssertTest, Framework_BaseTestListenerTest, Framework_ConstraintTest, Framework_Constraint_IsJsonTest, Framework_Constraint_JsonMatchesTest, Framework_Constraint_JsonMatches_ErrorMessageProviderTest, Framework_SuiteTest, Framework_TestCaseTest, Framework_TestFailureTest, Framework_TestImplementorTest, Framework_TestListenerTest, IgnoreCodeCoverageClassTest, IncompleteTest, InheritanceA, InheritanceB, InheritedTestCase, IniTest, IsolationTest, Issue1021Test, Issue1149Test, Issue1216Test, Issue1265Test, Issue1330Test, Issue1335Test, Issue1337Test, Issue1348Test, Issue1351Test, Issue1374Test, Issue1437Test, Issue1468Test, Issue1471Test, Issue1472Test, Issue1570Test, Issue244Test, Issue322Test, Issue433Test, Issue445Test, Issue498Test, Issue503Test, Issue523Test, Issue578Test, Issue581Test, Issue74Test, Issue765Test, Issue797Test, MultiDependencyTest, My\Space\ExceptionNamespaceTest, NamespaceCoverageClassExtendedTest, NamespaceCoverageClassTest, NamespaceCoverageCoversClassPublicTest, NamespaceCoverageCoversClassTest, NamespaceCoverageMethodTest, NamespaceCoverageNotPrivateTest, NamespaceCoverageNotProtectedTest, NamespaceCoverageNotPublicTest, NamespaceCoveragePrivateTest, NamespaceCoverageProtectedTest, NamespaceCoveragePublicTest, NoArgTestCaseTest, NoTestCases, NotExistingCoveredElementTest, NotPublicTestCase, NotVoidTestCase, NothingTest, OneTest, OneTestCase, OutputTestCase, OverrideTestCase, PHPUnit_Extensions_GroupTestSuite, PHPUnit_Extensions_PhptTestCase, PHPUnit_Extensions_PhptTestSuite, PHPUnit_Framework_IncompleteTestCase, PHPUnit_Framework_SkippedTestCase, PHPUnit_Framework_TestCase, PHPUnit_Framework_TestSuite, PHPUnit_Framework_TestSuite_DataProvider, PHPUnit_Framework_WarningTestCase, PHPUnit_Util_PHPTest, PhpTestCaseProxy, RequirementsClassBeforeClassHookTest, RequirementsTest, Runner_BaseTestRunnerTest, StackTest, StopsOnWarningTest, Success, TemplateMethodsTest, TestError, TestIncomplete, TestSkipped, TestWithTest, ThrowExceptionTestCase, ThrowNoExceptionTestCase, TwoTest, Util_ConfigurationTest, Util_GetoptTest, Util_GlobalStateTest, Util_RegexTest, Util_TestDox_NamePrettifierTest, Util_TestTest, Util_XMLTest, WasRun.

            return;
        }

        $arranges = $this->getArrangeLines($test);

$test of type object<PHPUnit_Framework_Test> is not a sub-type of object<PHPUnit_Framework_TestCase>. It seems like you assume a concrete implementation of the interface PHPUnit_Framework_Test to be always present.

        $arrangeText = $this->getArrangeText($arranges);
        $this->currentTestMethodPrettified = $arrangeText.$this->currentTestMethodPrettified;
    }

    /**
     * @param array $arranges
     * @return string
     */
    private function getArrangeText(array $arranges)
    {
        $arrangeText = '';
        $tab = '     ';
        if (!empty($arranges)) {
            $arrangeText = 'When '
                .implode(PHP_EOL.$tab.'And ', $arranges)
                .PHP_EOL
                .$tab
                .'Then ';

            return $arrangeText;
        }

        return $arrangeText;
    }

    /**
     * @param \PHPUnit_Framework_TestCase $test
     * @return array
     */
    private function getArrangeLines(\PHPUnit_Framework_TestCase $test)
    {
        $arranges = [];
        $annotationReader = AnnotationReaderFactory::getAnnotationReader();

        foreach (ArrangeListener::$inputs[$test->getName(true)] as $i => $arrangeMethods) {
            foreach ($arrangeMethods as $arrangeMethod => $arguments) {
                try {
                    $describe = $this->getArrangeDescription($test, $annotationReader, $arrangeMethod);
                    $arranges[] = $this->getArrangeLine($describe, $arguments);
                } catch (\DomainException $ex) {
                    continue;
                }
            }
        }

        return $arranges;
    }

    /**
     * @param PHPUnit_Framework_Test $test
     * @param AnnotationReader $annotationReader
     * @param string $arrangeMethod
     * @return string
     */
    private function getArrangeDescription(
        PHPUnit_Framework_Test $test,
        AnnotationReader $annotationReader,
        $arrangeMethod
    ) {
        $arrangeMethodAnnotation = $annotationReader->getMethodAnnotation(
            new \ReflectionMethod($test, $arrangeMethod),
            Arrange::class
        );
        if ($arrangeMethodAnnotation === null) {
            throw new \DomainException('The arrange method does not have an annotation itself');
        }

        return $arrangeMethodAnnotation->getMethods()['describe'];
    }

    /**
     * @param string $describe
     * @param array $arguments
     * @return array
     */
    private function getArrangeLine($describe, array $arguments)
    {
        return call_user_func_array(
            'sprintf',
            array_merge(
                [$describe],
                $this->getArgumentsAsString($arguments)
            )
        )
        .',';
    }

    /**
     * @param array $arguments
     * @return array
     */
    private function getArgumentsAsString(array $arguments)
    {
        return array_map(
            function ($argument) {
                if (is_object($argument)) {
                    $fullClassName = get_class($argument);

                    return 'the '.strtolower(substr($fullClassName, strrpos($fullClassName, '\\') + 1));
                }

                return $argument;
            },
            $arguments
        );
    }
}