Detect function renaming too

Author: emmetog

docs/Ruleset.md

@@ -15,6 +15,7 @@ V070 | MINOR | Function parameter typing removed
 V071 | MINOR | Function parameter default added
 V072 | MAJOR | Function parameter default removed
 V073 | MINOR | Function parameter default value changed
+V160 | PATCH | Function renamed (case only)
 
 # Classes
 

src/PHPSemVerChecker/Analyzer/FunctionAnalyzer.php

@@ -17,6 +17,7 @@
 use PHPSemVerChecker\Operation\FunctionParameterTypingAdded;
 use PHPSemVerChecker\Operation\FunctionParameterTypingRemoved;
 use PHPSemVerChecker\Operation\FunctionRemoved;
+use PHPSemVerChecker\Operation\FunctionRenamedCaseOnly;
 use PHPSemVerChecker\Registry\Registry;
 use PHPSemVerChecker\Report\Report;
 
@@ -35,28 +36,62 @@ public function analyze(Registry $registryBefore, Registry $registryAfter)
 	{
 		$report = new Report();
 
-		$keysBefore = array_keys($registryBefore->data['function']);
-		$keysAfter = array_keys($registryAfter->data['function']);
-		$added = array_diff($keysAfter, $keysBefore);
-		$removed = array_diff($keysBefore, $keysAfter);
-		$toVerify = array_intersect($keysBefore, $keysAfter);
+
+		$functionsBefore = $registryBefore->data['function'];
+		$functionsAfter = $registryAfter->data['function'];
+
+		$functionsBeforeKeyed = [];
+		$filesBeforeKeyed = [];
+		foreach($functionsBefore as $key => $functionBefore)
+		{
+			$functionsBeforeKeyed[strtolower($functionBefore->name)] = $functionBefore;
+			$filesBeforeKeyed[strtolower($functionBefore->name)] = $registryBefore->mapping['function'][$key];
+		}
+
+		$functionsAfterKeyed = [];
+		$filesAfterKeyed = [];
+		foreach($functionsAfter as $key => $functionAfter)
+		{
+			$functionsAfterKeyed[strtolower($functionAfter->name)] = $functionAfter;
+			$filesAfterKeyed[strtolower($functionAfter->name)] = $registryAfter->mapping['function'][$key];
+		}
+
+		$functionNamesBefore = array_keys($functionsBeforeKeyed);
+		$functionNamesAfter = array_keys($functionsAfterKeyed);
+		$added = array_diff($functionNamesAfter, $functionNamesBefore);
+		$removed = array_diff($functionNamesBefore, $functionNamesAfter);
+		$toVerify = array_intersect($functionNamesBefore, $functionNamesAfter);
 
 		foreach ($removed as $key) {
-			$fileBefore = $registryBefore->mapping['function'][$key];
-			$functionBefore = $registryBefore->data['function'][$key];
+			$fileBefore = $filesBeforeKeyed[$key];
+			$functionBefore = $functionsBeforeKeyed[$key];
 
 			$data = new FunctionRemoved($fileBefore, $functionBefore);
 			$report->addFunction($data);
 		}
 
 		foreach ($toVerify as $key) {
-			$fileBefore = $registryBefore->mapping['function'][$key];
-			$functionBefore = $registryBefore->data['function'][$key];
-			$fileAfter = $registryAfter->mapping['function'][$key];
-			$functionAfter = $registryAfter->data['function'][$key];
+			$fileBefore = $filesBeforeKeyed[$key];
+			$functionBefore = $functionsBeforeKeyed[$key];
+			$fileAfter = $filesAfterKeyed[$key];
+			$functionAfter = $functionsAfterKeyed[$key];
 
 			// Leave non-strict comparison here
 			if ($functionBefore != $functionAfter) {
+
+				// Check if the name of the interface has changed case.
+				// If we entered this section then the normalized names (lowercase) were equal.
+				if ($functionBefore->name !== $functionAfter->name) {
+					$report->addFunction(
+						new FunctionRenamedCaseOnly(
+							$fileBefore,
+							$functionBefore,
+							$fileAfter,
+							$functionAfter
+						)
+					);
+				}
+
 				$signatureResult = Signature::analyze($functionBefore->getParams(), $functionAfter->getParams());
 
 				$changes = [

src/PHPSemVerChecker/Configuration/LevelMapping.php

@@ -134,6 +134,7 @@ class LevelMapping
 		'V157' => Level::PATCH,
 		'V158' => Level::PATCH,
 		'V159' => Level::PATCH,
+		'V160' => Level::PATCH,
 	];
 
 	/**

src/PHPSemVerChecker/Operation/FunctionRenamedCaseOnly.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace PHPSemVerChecker\Operation;
+
+class FunctionRenamedCaseOnly extends FunctionOperationDelta
+{
+	/**
+	 * @var string
+	 */
+	protected $code = 'V160';
+	/**
+	 * @var string
+	 */
+	protected $reason = 'Function renamed (case only).';
+}

tests/PHPSemVerChecker/Analyzer/FunctionAnalyzerTest.php

@@ -390,4 +390,31 @@ public function testFunctionImplementationChanged()
 		$this->assertSame('Function implementation changed.', $report['function'][$expectedLevel][0]->getReason());
 		$this->assertSame('tmp', $report['function'][$expectedLevel][0]->getTarget());
 	}
+
+	public function testFunctionCaseChanged()
+	{
+		$before = new Registry();
+		$after = new Registry();
+
+		$before->addFunction(new Function_('somefunctionname', [
+			'stmts' => [
+				new FuncCall('someFunctionCall'),
+			],
+		]));
+
+		$after->addFunction(new Function_('someFunctionName', [
+			'stmts' => [
+				new FuncCall('someFunctionCall'),
+			],
+		]));
+
+		$analyzer = new FunctionAnalyzer();
+		$report = $analyzer->analyze($before, $after);
+
+		$expectedLevel = Level::PATCH;
+		Assert::assertDifference($report, 'function', $expectedLevel);
+		$this->assertSame('V160', $report['function'][$expectedLevel][0]->getCode());
+		$this->assertSame('Function renamed (case only).', $report['function'][$expectedLevel][0]->getReason());
+		$this->assertSame('someFunctionName', $report['function'][$expectedLevel][0]->getTarget());
+	}
 }