Detect case only name changes for Classes

Author: emmetog

docs/Ruleset.md

@@ -71,6 +71,7 @@ V097 | MAJOR | Class public method parameter default value changed
 V098 | MAJOR | Class protected method parameter default value changed
 V099 | PATCH | Class private method parameter default value changed
 V150 | PATCH | Class public/protected/private method renamed (case only)
+V154 | PATCH | Class renamed (case only)
 VXXX | MAJOR | *Final class public method parameter added*
 VXXX | MAJOR | *Final class protected method parameter added*
 VXXX | PATCH | *Final class private method parameter added*

src/PHPSemVerChecker/Analyzer/ClassAnalyzer.php

@@ -4,6 +4,7 @@
 
 use PHPSemVerChecker\Operation\ClassAdded;
 use PHPSemVerChecker\Operation\ClassRemoved;
+use PHPSemVerChecker\Operation\ClassRenamedCaseOnly;
 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['class']);
-		$keysAfter = array_keys($registryAfter->data['class']);
-		$added = array_diff($keysAfter, $keysBefore);
-		$removed = array_diff($keysBefore, $keysAfter);
-		$toVerify = array_intersect($keysBefore, $keysAfter);
+		$classesBefore = $registryBefore->data['class'];
+		$classesAfter = $registryAfter->data['class'];
+
+		$classesBeforeKeyed = [];
+		$mappingsBeforeKeyed = [];
+		foreach($classesBefore as $key => $classBefore)
+		{
+			$classesBeforeKeyed[strtolower($classBefore->name)] = $classBefore;
+			$mappingsBeforeKeyed[strtolower($classBefore->name)] = $registryBefore->mapping['class'][$key];
+		}
+
+		$classesAfterKeyed = [];
+		$mappingsAfterKeyed = [];
+		foreach($classesAfter as $key => $classAfter)
+		{
+			$classesAfterKeyed[strtolower($classAfter->name)] = $classAfter;
+			$mappingsAfterKeyed[strtolower($classAfter->name)] = $registryAfter->mapping['class'][$key];
+		}
+
+		$classNamesBefore = array_keys($classesBeforeKeyed);
+		$classNamesAfter = array_keys($classesAfterKeyed);
+		$added = array_diff($classNamesAfter, $classNamesBefore);
+		$removed = array_diff($classNamesBefore, $classNamesAfter);
+		$toVerify = array_intersect($classNamesBefore, $classNamesAfter);
 
 		foreach ($removed as $key) {
-			$fileBefore = $registryBefore->mapping['class'][$key];
-			$classBefore = $registryBefore->data['class'][$key];
+			$fileBefore = $mappingsBeforeKeyed[$key];
+			$classBefore = $classesBeforeKeyed[$key];
 
 			$data = new ClassRemoved($fileBefore, $classBefore);
 			$report->addClass($data);
 		}
 
 		foreach ($toVerify as $key) {
-			$fileBefore = $registryBefore->mapping['class'][$key];
+			$fileBefore = $mappingsBeforeKeyed[$key];
 			/** @var \PhpParser\Node\Stmt\Class_ $classBefore */
-			$classBefore = $registryBefore->data['class'][$key];
-			$fileAfter = $registryAfter->mapping['class'][$key];
+			$classBefore = $classesBeforeKeyed[$key];
+			$fileAfter = $mappingsAfterKeyed[$key];
 			/** @var \PhpParser\Node\Stmt\Class_ $classBefore */
-			$classAfter = $registryAfter->data['class'][$key];
+			$classAfter = $classesAfterKeyed[$key];
 
 			// Leave non-strict comparison here
 			if ($classBefore != $classAfter) {
+
+				// Check for case change of class name
+				if(
+					$classBefore->name !== $classAfter->name
+					&& strtolower($classBefore->name) === strtolower($classAfter->name)
+				) {
+					$report->add($this->context, new ClassRenamedCaseOnly($fileAfter, $classAfter));
+				}
+
 				$analyzers = [
 					new ClassMethodAnalyzer('class', $fileBefore, $fileAfter),
 					new PropertyAnalyzer('class', $fileBefore, $fileAfter),
@@ -51,8 +80,8 @@ public function analyze(Registry $registryBefore, Registry $registryAfter)
 		}
 
 		foreach ($added as $key) {
-			$fileAfter = $registryAfter->mapping['class'][$key];
-			$classAfter = $registryAfter->data['class'][$key];
+			$fileAfter = $mappingsAfterKeyed[$key];
+			$classAfter = $classesAfterKeyed[$key];
 
 			$data = new ClassAdded($fileAfter, $classAfter);
 			$report->addClass($data);

src/PHPSemVerChecker/Configuration/LevelMapping.php

@@ -125,6 +125,7 @@ class LevelMapping
 		'V151' => Level::PATCH,
 		'V152' => Level::PATCH,
 		'V153' => Level::PATCH,
+		'V154' => Level::PATCH,
 	];
 
 	public static function getLevelForCode($code)

src/PHPSemVerChecker/Operation/ClassRenamedCaseOnly.php

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

tests/PHPSemVerChecker/Analyzer/ClassAnalyzerTest.php

@@ -62,4 +62,23 @@ public function testClassRemoved()
 		$this->assertSame('Class was removed.', $report[$context][$expectedLevel][0]->getReason());
 		$this->assertSame('tmp', $report[$context][$expectedLevel][0]->getTarget());
 	}
+
+	public function testClassRenamedCaseOnly()
+	{
+		$before = new Registry();
+		$after = new Registry();
+
+		$before->addClass(new Class_('TestCLASS'));
+		$after->addClass(new Class_('TestClass'));
+
+		$analyzer = new ClassAnalyzer();
+		$report = $analyzer->analyze($before, $after);
+
+		$context = 'class';
+		$expectedLevel = Level::PATCH;
+		Assert::assertDifference($report, $context, $expectedLevel);
+		$this->assertSame('V154', $report[$context][$expectedLevel][0]->getCode());
+		$this->assertSame('Class was renamed (case only).', $report[$context][$expectedLevel][0]->getReason());
+		$this->assertSame('TestClass', $report[$context][$expectedLevel][0]->getTarget());
+	}
 }