Detect case only name change for Traits

Author: emmetog

src/PHPSemVerChecker/Analyzer/InterfaceAnalyzer.php

@@ -34,7 +34,6 @@ public function analyze(Registry $registryBefore, Registry $registryAfter)
 			$mappingsAfterKeyed[strtolower($interfaceAfter->name)] = $registryAfter->mapping['interface'][$key];
 		}
 
-
 		$interfaceNamesBefore = array_keys($interfacesBeforeKeyed);
 		$interfaceNamesAfter = array_keys($interfacesAfterKeyed);
 		$added = array_diff($interfaceNamesAfter, $interfaceNamesBefore);

src/PHPSemVerChecker/Analyzer/TraitAnalyzer.php

@@ -4,6 +4,7 @@
 
 use PHPSemVerChecker\Operation\TraitAdded;
 use PHPSemVerChecker\Operation\TraitRemoved;
+use PHPSemVerChecker\Operation\TraitRenamedCaseOnly;
 use PHPSemVerChecker\Registry\Registry;
 use PHPSemVerChecker\Report\Report;
 
@@ -14,30 +15,58 @@ public function analyze(Registry $registryBefore, Registry $registryAfter)
 	{
 		$report = new Report();
 
-		$keysBefore = array_keys($registryBefore->data['trait']);
-		$keysAfter = array_keys($registryAfter->data['trait']);
-		$added = array_diff($keysAfter, $keysBefore);
-		$removed = array_diff($keysBefore, $keysAfter);
-		$toVerify = array_intersect($keysBefore, $keysAfter);
+		$traitsBefore = $registryBefore->data['trait'];
+		$traitsAfter = $registryAfter->data['trait'];
+
+		$traitsBeforeKeyed = [];
+		$mappingsBeforeKeyed = [];
+		foreach($traitsBefore as $key => $traitBefore)
+		{
+			$traitsBeforeKeyed[strtolower($traitBefore->name)] = $traitBefore;
+			$mappingsBeforeKeyed[strtolower($traitBefore->name)] = $registryBefore->mapping['trait'][$key];
+		}
+
+		$traitsAfterKeyed = [];
+		$mappingsAfterKeyed = [];
+		foreach($traitsAfter as $key => $traitAfter)
+		{
+			$traitsAfterKeyed[strtolower($traitAfter->name)] = $traitAfter;
+			$mappingsAfterKeyed[strtolower($traitAfter->name)] = $registryAfter->mapping['trait'][$key];
+		}
+
+		$traitNamesBefore = array_keys($traitsBeforeKeyed);
+		$traitNamesAfter = array_keys($traitsAfterKeyed);
+		$added = array_diff($traitNamesAfter, $traitNamesBefore);
+		$removed = array_diff($traitNamesBefore, $traitNamesAfter);
+		$toVerify = array_intersect($traitNamesBefore, $traitNamesAfter);
 
 		foreach ($removed as $key) {
-			$fileBefore = $registryBefore->mapping['trait'][$key];
-			$traitBefore = $registryBefore->data['trait'][$key];
+			$fileBefore = $mappingsBeforeKeyed[$key];
+			$traitBefore = $traitsBeforeKeyed[$key];
 
 			$data = new TraitRemoved($fileBefore, $traitBefore);
 			$report->addTrait($data);
 		}
 
 		foreach ($toVerify as $key) {
-			$fileBefore = $registryBefore->mapping['trait'][$key];
+			$fileBefore = $mappingsBeforeKeyed[$key];
 			/** @var \PhpParser\Node\Stmt\Class_ $traitBefore */
-			$traitBefore = $registryBefore->data['trait'][$key];
-			$fileAfter = $registryAfter->mapping['trait'][$key];
+			$traitBefore = $traitsBeforeKeyed[$key];
+			$fileAfter = $mappingsAfterKeyed[$key];
 			/** @var \PhpParser\Node\Stmt\Class_ $traitBefore */
-			$traitAfter = $registryAfter->data['trait'][$key];
+			$traitAfter = $traitsAfterKeyed[$key];
 
 			// Leave non-strict comparison here
 			if ($traitBefore != $traitAfter) {
+
+				// Check for name case change.
+				if(
+					$traitBefore->name !== $traitAfter->name
+					&& strtolower($traitBefore->name) === strtolower($traitAfter->name)
+				) {
+					$report->add($this->context, new TraitRenamedCaseOnly($fileAfter, $traitAfter));
+				}
+
 				$analyzers = [
 					new ClassMethodAnalyzer('trait', $fileBefore, $fileAfter),
 					new PropertyAnalyzer('trait', $fileBefore, $fileAfter),
@@ -51,8 +80,8 @@ public function analyze(Registry $registryBefore, Registry $registryAfter)
 		}
 
 		foreach ($added as $key) {
-			$fileAfter = $registryAfter->mapping['trait'][$key];
-			$traitAfter = $registryAfter->data['trait'][$key];
+			$fileAfter = $mappingsAfterKeyed[$key];
+			$traitAfter = $traitsAfter[$key];
 
 			$data = new TraitAdded($fileAfter, $traitAfter);
 			$report->addTrait($data);

src/PHPSemVerChecker/Operation/TraitRenamedCaseOnly.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace PHPSemVerChecker\Operation;
+
+use PhpParser\Node\Stmt\Trait_;
+use PHPSemVerChecker\Node\Statement\Trait_ as PTrait;
+
+class TraitRenamedCaseOnly extends Operation {
+	/**
+	 * @var string
+	 */
+	protected $code = 'V152';
+	/**
+	 * @var string
+	 */
+	protected $reason = 'Trait was renamed (case only).';
+	/**
+	 * @var string
+	 */
+	protected $fileAfter;
+	/**
+	 * @var \PhpParser\Node\Stmt\Trait_
+	 */
+	protected $traitAfter;
+
+	/**
+	 * @param string                      $fileAfter
+	 * @param \PhpParser\Node\Stmt\Trait_ $traitAfter
+	 */
+	public function __construct($fileAfter, Trait_ $traitAfter)
+	{
+		$this->fileAfter = $fileAfter;
+		$this->traitAfter = $traitAfter;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLocation()
+	{
+		return $this->fileAfter;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getLine()
+	{
+		return $this->traitAfter->getLine();
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getTarget()
+	{
+		return PTrait::getFullyQualifiedName($this->traitAfter);
+	}
+}

tests/PHPSemVerChecker/Analyzer/TraitAnalyzerTest.php

@@ -62,4 +62,23 @@ public function testTraitAdded()
 		$this->assertSame('Trait was added.', $report[$context][$expectedLevel][0]->getReason());
 		$this->assertSame('tmp', $report[$context][$expectedLevel][0]->getTarget());
 	}
+
+	public function testTraitRenamedCaseOnly()
+	{
+		$before = new Registry();
+		$after = new Registry();
+
+		$before->addTrait(new Trait_('testTRAIT'));
+		$after->addTrait(new Trait_('testtrait'));
+
+		$analyzer = new TraitAnalyzer();
+		$report = $analyzer->analyze($before, $after);
+
+		$context = 'trait';
+		$expectedLevel = Level::PATCH;
+		Assert::assertDifference($report, $context, $expectedLevel);
+		$this->assertSame('V152', $report[$context][$expectedLevel][0]->getCode());
+		$this->assertSame('Trait was renamed (case only).', $report[$context][$expectedLevel][0]->getReason());
+		$this->assertSame('testtrait', $report[$context][$expectedLevel][0]->getTarget());
+	}
 }