Rename getObject to getInstance (#41)

* test: implement unit tests

* refactor: remove unused getClass function

* test: upgrade phpunit

* test: upgrade phpunit

* ci: improve QA tooling

* docs: update example

* docs: update badges

* tweak: rename object/instance

* tweak: formatting

Author: Greg Bowler

README.md

@@ -8,7 +8,7 @@ Throughout PHP.Gt repositories, wherever an object represents enclosed data, a c
 <a href="https://github.com/PhpGt/TypeSafeGetter/actions" target="_blank">
 	<img src="https://badge.status.php.gt/typesafegetter-build.svg" alt="Build status" />
 </a>
-<a href="https://app.codacy.com/gh/PhpGt/Curl" target="_blank">
+<a href="https://scrutinizer-ci.com/g/PhpGt/TypeSafeGetter" target="_blank">
 	<img src="https://badge.status.php.gt/typesafegetter-quality.svg" alt="Code quality" />
 </a>
 <a href="https://app.codecov.io/gh/PhpGt/TypeSafeGetter" target="_blank">
@@ -29,7 +29,7 @@ The following methods are defined by this interface:
 + `getFloat(string $name):?float`
 + `getBool(string $name):?bool`
 + `getDateTime(string $name):?DateTimeInterface`
-+ `getObject(string $name, class-string<T> $className):?T`
++ `getInstance(string $name, class-string<T> $className):?T`
 
 Common areas you will see this interface used:
 

src/CallbackTypeSafeGetter.php

@@ -21,5 +21,9 @@ public function getDateTime(
 	 * @param callable():<T> $callback
 	 * @return T
 	 */
-	public function getObject(string $name, string $className, callable $callback);
+	public function getInstance(
+		string $name,
+		string $className,
+		callable $callback,
+	);
 }

src/NullableTypeSafeGetter.php

@@ -40,7 +40,7 @@ function(string|int|DateTimeInterface $value) {
 		);
 	}
 
-	public function getObject(string $name, string $className) {
+	public function getInstance(string $name, string $className) {
 		return $this->getNullableType(
 			$name,
 			$className,

src/TypeSafeGetter.php

@@ -17,5 +17,5 @@ public function getDateTime(string $name):?DateTimeInterface;
 	 * @param class-string<T> $className
 	 * @return T
 	 */
-	public function getObject(string $name, string $className);
+	public function getInstance(string $name, string $className);
 }

test/phpunit/TypeSafeGetterTest.php

@@ -114,12 +114,12 @@ public function testGetDateTime_castFromInt():void {
 		self::assertSame($dateString, $dateTime->format("Y-m-d"));
 	}
 
-	public function testGetObject():void {
+	public function testGetInstance():void {
 		$example = new ExampleClass("Just an example");
 		$sut = new TestGetter([
 			"example" => $example
 		]);
-		$object = $sut->getObject("example", ExampleClass::class);
+		$object = $sut->getInstance("example", ExampleClass::class);
 		self::assertSame(
 			$example,
 			$object
@@ -134,26 +134,26 @@ public function testGetObject():void {
 		);
 	}
 
-	public function testGetObject_invalidType():void {
+	public function testGetInstance_invalidType():void {
 		$example = new ExampleClass("Just an example");
 		$sut = new TestGetter([
 			"example" => $example
 		]);
 
 		self::expectException(TypeError::class);
 		self::expectExceptionMessage("Session value must be of type DateTimeInterface, " . ExampleClass::class . " returned");
-		$sut->getObject("example", DateTimeInterface::class);
+		$sut->getInstance("example", DateTimeInterface::class);
 	}
 
-	public function testGetObject_inheritedClass():void {
+	public function testGetInstance_inheritedClass():void {
 		$example = new DateTime("1988-04-05");
 		$sut = new TestGetter([
 			"example" => $example
 		]);
 
 		self::assertSame(
 			$example,
-			$sut->getObject("example", DateTimeInterface::class),
+			$sut->getInstance("example", DateTimeInterface::class),
 		);
 	}
 }