Merge pull request #93 from sabbelasichon/task/add-more-rule-tests

Author: sascha-egerer

src/Rule/ContextAspectValidationRule.php

@@ -28,14 +28,22 @@ public function getNodeType(): string
 		return Node\Expr\MethodCall::class;
 	}
 
+	/**
+	 * @param Node\Expr\MethodCall $node
+	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (!$node->name instanceof Node\Identifier) {
 			return [];
 		}
 
 		$methodReflection = $scope->getMethodReflection($scope->getType($node->var), $node->name->toString());
-		if ($methodReflection === null || $methodReflection->getName() !== 'getAspect') {
+
+		if ($methodReflection === null) {
+			return [];
+		}
+
+		if (!in_array($methodReflection->getName(), ['getAspect', 'getPropertyFromAspect'], true)) {
 			return [];
 		}
 

tests/Unit/Rule/ContextAspectValidationRule/ContextAspectValidationRuleTest.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Tests\Unit\Rule\ContextAspectValidationRule;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use SaschaEgerer\PhpstanTypo3\Rule\ContextAspectValidationRule;
+use TYPO3\CMS\Core\Context\DateTimeAspect;
+
+/**
+ * @extends RuleTestCase<ContextAspectValidationRule>
+ */
+final class ContextAspectValidationRuleTest extends RuleTestCase
+{
+
+	public function testRuleWithErrors(): void
+	{
+		$this->analyse(
+			[__DIR__ . '/Fixture/UseContextApiWithUndefinedAspect.php'],
+			[
+				[
+					'There is no aspect "foo" configured so we can\'t figure out the exact type to return when calling TYPO3\CMS\Core\Context\Context::getAspect',
+					13,
+					'You should add custom aspects to the typo3.contextApiGetAspectMapping setting.',
+				],
+				[
+					'There is no aspect "dates" configured so we can\'t figure out the exact type to return when calling TYPO3\CMS\Core\Context\Context::getPropertyFromAspect',
+					16,
+					'You should add custom aspects to the typo3.contextApiGetAspectMapping setting.',
+				],
+			]
+		);
+	}
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [__DIR__ . '/../../../../extension.neon'];
+	}
+
+	public function testRuleWithoutErrors(): void
+	{
+		$this->analyse([__DIR__ . '/Fixture/UseContextApiWithDefinedAspect.php'], []);
+	}
+
+	protected function getRule(): Rule
+	{
+		return new ContextAspectValidationRule([
+			'date' => DateTimeAspect::class,
+		]);
+	}
+
+}

tests/Unit/Rule/ContextAspectValidationRule/Fixture/UseContextApiWithDefinedAspect.php

@@ -0,0 +1,35 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Tests\Unit\Rule\ContextAspectValidationRule\Fixture;
+
+use TYPO3\CMS\Core\Context\Context;
+use TYPO3\CMS\Core\Context\DateTimeAspect;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+final class UseContextApiWithDefinedAspect
+{
+
+	public function someMethod(): void
+	{
+		$dateAspect = GeneralUtility::makeInstance(Context::class)->getAspect('date');
+		$dateAspect->get('bar');
+
+		$class = new class {
+
+			public function getAspect(string $name): \stdClass
+			{
+				return new \stdClass();
+			}
+
+		};
+
+		$myCustomAspect = $class->getAspect('foo');
+		$myCustomAspect->something = 'FooBarBaz';
+
+		$aspectWithoutDefiningName = GeneralUtility::makeInstance(Context::class)->getAspect();
+		$aspectWithoutDefiningName->get('bar');
+
+		GeneralUtility::makeInstance(Context::class)->setAspect('dates', new DateTimeAspect(new \DateTimeImmutable()));
+	}
+
+}

tests/Unit/Rule/ContextAspectValidationRule/Fixture/UseContextApiWithUndefinedAspect.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Tests\Unit\Rule\ContextAspectValidationRule\Fixture;
+
+use TYPO3\CMS\Core\Context\Context;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+final class UseContextApiWithUndefinedAspect
+{
+
+	public function someMethod(): void
+	{
+		$foo = GeneralUtility::makeInstance(Context::class)->getAspect('foo');
+		$foo->get('bar');
+
+		GeneralUtility::makeInstance(Context::class)->getPropertyFromAspect('dates', 'foo');
+	}
+
+}