Detect interface case name changes as PATCH

Author: emmetog

docs/Ruleset.md

@@ -111,6 +111,7 @@ V077 | MINOR | Interface method parameter default added
 V078 | MAJOR | Interface method parameter default removed
 V079 | MAJOR | Interface method parameter default value changed
 V151 | PATCH | Interface method renamed (case only)
+V153 | PATCH | Interface renamed (case only)
 
 # Trait
 

src/PHPSemVerChecker/Analyzer/InterfaceAnalyzer.php

@@ -4,6 +4,7 @@
 
 use PHPSemVerChecker\Operation\InterfaceAdded;
 use PHPSemVerChecker\Operation\InterfaceRemoved;
+use PHPSemVerChecker\Operation\InterfaceRenamedCaseOnly;
 use PHPSemVerChecker\Registry\Registry;
 use PHPSemVerChecker\Report\Report;
 
@@ -14,39 +15,67 @@ public function analyze(Registry $registryBefore, Registry $registryAfter)
 	{
 		$report = new Report();
 
-		$keysBefore = array_keys($registryBefore->data['interface']);
-		$keysAfter = array_keys($registryAfter->data['interface']);
-		$added = array_diff($keysAfter, $keysBefore);
-		$removed = array_diff($keysBefore, $keysAfter);
-		$toVerify = array_intersect($keysBefore, $keysAfter);
+		$interfacesBefore = $registryBefore->data['interface'];
+		$interfacesAfter = $registryAfter->data['interface'];
+
+		$interfacesBeforeKeyed = [];
+		$mappingsBeforeKeyed = [];
+		foreach($interfacesBefore as $key => $interfaceBefore)
+		{
+			$interfacesBeforeKeyed[strtolower($interfaceBefore->name)] = $interfaceBefore;
+			$mappingsBeforeKeyed[strtolower($interfaceBefore->name)] = $registryBefore->mapping['interface'][$key];
+		}
+
+		$interfacesAfterKeyed = [];
+		$mappingsAfterKeyed = [];
+		foreach($interfacesAfter as $key => $interfaceAfter)
+		{
+			$interfacesAfterKeyed[strtolower($interfaceAfter->name)] = $interfaceAfter;
+			$mappingsAfterKeyed[strtolower($interfaceAfter->name)] = $registryAfter->mapping['interface'][$key];
+		}
+
+
+		$interfaceNamesBefore = array_keys($interfacesBeforeKeyed);
+		$interfaceNamesAfter = array_keys($interfacesAfterKeyed);
+		$added = array_diff($interfaceNamesAfter, $interfaceNamesBefore);
+		$removed = array_diff($interfaceNamesBefore, $interfaceNamesAfter);
+		$toVerify = array_intersect($interfaceNamesBefore, $interfaceNamesAfter);
 
 		foreach ($removed as $key) {
-			$fileBefore = $registryBefore->mapping['interface'][$key];
-			$interfaceBefore = $registryBefore->data['interface'][$key];
+			$fileBefore = $mappingsBeforeKeyed[$key];
+			$interfaceBefore = $interfacesBeforeKeyed[$key];
 
 			$data = new InterfaceRemoved($fileBefore, $interfaceBefore);
 			$report->addInterface($data);
 		}
 
 		foreach ($toVerify as $key) {
-			$fileBefore = $registryBefore->mapping['interface'][$key];
+			$fileBefore = $mappingsBeforeKeyed[$key];
 			/** @var \PhpParser\Node\Stmt\Interface_ $interfaceBefore */
-			$interfaceBefore = $registryBefore->data['interface'][$key];
-			$fileAfter = $registryAfter->mapping['interface'][$key];
+			$interfaceBefore = $interfacesBeforeKeyed[$key];
+			$fileAfter = $mappingsAfterKeyed[$key];
 			/** @var \PhpParser\Node\Stmt\Interface_ $interfaceBefore */
-			$interfaceAfter = $registryAfter->data['interface'][$key];
+			$interfaceAfter = $interfacesAfterKeyed[$key];
 
 			// Leave non-strict comparison here
 			if ($interfaceBefore != $interfaceAfter) {
+
+				// Check if the name of the interface has changed case.
+				if($interfaceBefore->name !== $interfaceAfter->name)
+				{
+					$report->add('interface', new InterfaceRenamedCaseOnly($fileAfter, $interfaceAfter));
+				}
+
 				$analyzer = new ClassMethodAnalyzer('interface', $fileBefore, $fileAfter);
 				$interfaceMethodReport = $analyzer->analyze($interfaceBefore, $interfaceAfter);
 				$report->merge($interfaceMethodReport);
 			}
 		}
 
 		foreach ($added as $key) {
-			$fileAfter = $registryAfter->mapping['interface'][$key];
-			$interfaceAfter = $registryAfter->data['interface'][$key];
+
+			$fileAfter = $mappingsAfterKeyed[$key];
+			$interfaceAfter = $interfacesAfterKeyed[$key];
 
 			$data = new InterfaceAdded($fileAfter, $interfaceAfter);
 			$report->addInterface($data);

src/PHPSemVerChecker/Configuration/LevelMapping.php

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

src/PHPSemVerChecker/Operation/InterfaceRenamedCaseOnly.php

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

tests/PHPSemVerChecker/Analyzer/InterfaceAnalyzerTest.php

@@ -62,4 +62,25 @@ public function testInterfaceAdded()
 		$this->assertSame('Interface was added.', $report[$context][$expectedLevel][0]->getReason());
 		$this->assertSame('tmp', $report[$context][$expectedLevel][0]->getTarget());
 	}
+
+	public function testInterfaceRenamedCaseOnly()
+	{
+		$before = new Registry();
+		$after = new Registry();
+
+		$interfaceBefore = new Interface_('TestInterface');
+		$before->addInterface($interfaceBefore);
+
+		$interfaceAfter = new Interface_('testinterface');
+		$after->addInterface($interfaceAfter);
+
+		$analyzer = new InterfaceAnalyzer();
+		$report = $analyzer->analyze($before, $after);
+
+		$context = 'interface';
+		$expectedLevel = Level::PATCH;
+		Assert::assertDifference($report, $context, $expectedLevel);
+		$this->assertSame('V153', $report[$context][$expectedLevel][0]->getCode());
+		$this->assertSame('Interface was renamed (case only).', $report[$context][$expectedLevel][0]->getReason());
+	}
 }