Added test function return type hint (#2)

fuwasegu · web-flow · commit 4044b9bd7778 · 2022-02-01T18:44:43.000-07:00
* add: return void type hint
* add: param type hint
diff --git a/tests/Blocks/BlockElementTest.php b/tests/Blocks/BlockElementTest.php
@@ -12,7 +12,7 @@
  */
 class BlockElementTest extends TestCase
 {
-    public function testCanSetBlockId()
+    public function testCanSetBlockId(): void
     {
         $block = new class () extends BlockElement {
             public function validate(): void
@@ -26,7 +26,7 @@ public function validate(): void
         $this->assertEquals('foo', $block->getBlockId());
     }
 
-    public function testCanSetBlockIdWhenConstructing()
+    public function testCanSetBlockIdWhenConstructing(): void
     {
         $block = new class ('foo') extends BlockElement {
             public function validate(): void
diff --git a/tests/Blocks/DividerTest.php b/tests/Blocks/DividerTest.php
@@ -13,7 +13,7 @@
  */
 class DividerTest extends TestCase
 {
-    public function testThatDividerRendersToJsonCorrectly()
+    public function testThatDividerRendersToJsonCorrectly(): void
     {
         $divider = new Divider();
         $this->assertJsonData([
diff --git a/tests/Blocks/FileTest.php b/tests/Blocks/FileTest.php
@@ -13,7 +13,7 @@
  */
 class FileTest extends TestCase
 {
-    public function testThatFileRendersToJsonCorrectly()
+    public function testThatFileRendersToJsonCorrectly(): void
     {
         $file = new File('id1');
         $file->externalId('foo');
diff --git a/tests/Blocks/HeaderTest.php b/tests/Blocks/HeaderTest.php
@@ -13,7 +13,7 @@
  */
 class HeaderTest extends TestCase
 {
-    public function testThatHeaderRendersToJsonCorrectly()
+    public function testThatHeaderRendersToJsonCorrectly(): void
     {
         $header = new Header('id1');
         $header->text('foo');
diff --git a/tests/ConfigTest.php b/tests/ConfigTest.php
@@ -9,7 +9,7 @@
  */
 class ConfigTest extends TestCase
 {
-    public function testCanSetConfigValuesWithFluentSyntax()
+    public function testCanSetConfigValuesWithFluentSyntax(): void
     {
         $c = Config::new()
             ->setDefaultEmojiSetting(true)
@@ -19,7 +19,7 @@ public function testCanSetConfigValuesWithFluentSyntax()
         $this->assertTrue($c->getDefaultVerbatimSetting());
     }
 
-    public function testCanUseDefaultConfigValues()
+    public function testCanUseDefaultConfigValues(): void
     {
         $c = Config::new();
 
diff --git a/tests/ElementTest.php b/tests/ElementTest.php
@@ -16,7 +16,7 @@
  */
 class ElementTest extends TestCase
 {
-    public function testCanSerializeValidElementToJson()
+    public function testCanSerializeValidElementToJson(): void
     {
         $element = $this->getMockElement();
 
@@ -26,14 +26,14 @@ public function testCanSerializeValidElementToJson()
         ]);
     }
 
-    public function testThrowsErrorElementIsInvalid()
+    public function testThrowsErrorElementIsInvalid(): void
     {
         $this->expectException(Exception::class);
         $element = $this->getMockElement(false);
         $this->jsonEncode($element);
     }
 
-    public function testCanSetParentWithFluidInterfaceAndGetParentBack()
+    public function testCanSetParentWithFluidInterfaceAndGetParentBack(): void
     {
         $parent = $this->getMockElement();
         $element = $this->getMockElement();
@@ -42,14 +42,14 @@ public function testCanSetParentWithFluidInterfaceAndGetParentBack()
         $this->assertSame($parent, $element->getParent());
     }
 
-    public function testCanUseNewAsFactoryForChildClasses()
+    public function testCanUseNewAsFactoryForChildClasses(): void
     {
         $element = Section::new();
         $this->assertEquals(Type::SECTION, $element->getType());
         $this->assertInstanceOf(Section::class, $element);
     }
 
-    public function testCanSetExtraFieldsForArbitraryData()
+    public function testCanSetExtraFieldsForArbitraryData(): void
     {
         $element = $this->getMockElement();
 
@@ -62,7 +62,7 @@ public function testCanSetExtraFieldsForArbitraryData()
         ]);
     }
 
-    public function testCanTapIntoElementForChaining()
+    public function testCanTapIntoElementForChaining(): void
     {
         $element = $this->getMockElement()->tap(function (Element $e) {
             $e->setExtra('fizz', 'buzz');
@@ -76,7 +76,7 @@ public function testCanTapIntoElementForChaining()
         ]);
     }
 
-    public function testCanConditionallyTapIntoElementForChaining()
+    public function testCanConditionallyTapIntoElementForChaining(): void
     {
         $callable = function (Element $e) {
             $e->setExtra('fizz', 'buzz');
@@ -100,8 +100,8 @@ public function testCanConditionallyTapIntoElementForChaining()
     private function getMockElement(bool $valid = true): Element
     {
         return new class ($valid) extends Element {
-            private $text;
-            private $valid;
+            private string $text;
+            private bool $valid;
 
             public function __construct(bool $valid)
             {
@@ -128,7 +128,7 @@ public function toArray(): array
         };
     }
 
-    public function testHydration()
+    public function testHydration(): void
     {
         $beforeJson = <<<JSON
         {
@@ -180,13 +180,13 @@ public function testHydration()
         $this->assertJsonStringEqualsJsonString($beforeJson, $afterJson);
     }
 
-    public function testFromJsonThrowsExceptionOnBadJson()
+    public function testFromJsonThrowsExceptionOnBadJson(): void
     {
         $this->expectException(HydrationException::class);
         Modal::fromJson('{"foo":"Bar",}');
     }
 
-    public function testCanExportToJsonWithPrettyPrint()
+    public function testCanExportToJsonWithPrettyPrint(): void
     {
         $element = $this->getMockElement();
         $json = $element->toJson(true);
diff --git a/tests/FormatterTest.php b/tests/FormatterTest.php
@@ -9,7 +9,7 @@
  */
 class FormatterTest extends TestCase
 {
-    public function testCanDoSimpleTextFormatting()
+    public function testCanDoSimpleTextFormatting(): void
     {
         $f = Formatter::new();
         $this->assertEquals('*hello*', $f->bold('hello'));
@@ -18,7 +18,7 @@ public function testCanDoSimpleTextFormatting()
         $this->assertEquals('`hello`', $f->code('hello'));
     }
 
-    public function testCanDoEntityReferenceFormatting()
+    public function testCanDoEntityReferenceFormatting(): void
     {
         $f = Formatter::new();
         $this->assertEquals('<!channel>', $f->atChannel());
@@ -29,7 +29,7 @@ public function testCanDoEntityReferenceFormatting()
         $this->assertEquals('<!subteam^G01>', $f->userGroup('G01'));
     }
 
-    public function testCanInterpolateAndEscapeText()
+    public function testCanInterpolateAndEscapeText(): void
     {
         $f = Formatter::new();
         $text = $f->escape($f->sub('There is {name} & John.', ['name' => 'Jim']));
diff --git a/tests/Inputs/CheckBoxesTest.php b/tests/Inputs/CheckBoxesTest.php
@@ -15,7 +15,7 @@
  */
 class CheckBoxesTest extends TestCase
 {
-    public function testCheckboxesWithConfirm()
+    public function testCheckboxesWithConfirm(): void
     {
         $input = (new Checkboxes('checkboxes-identifier'))
             ->option('foo', 'foo')
@@ -86,7 +86,7 @@ public function testCheckboxesWithConfirm()
         ], $input);
     }
 
-    public function testTooManyOptions()
+    public function testTooManyOptions(): void
     {
 
         $this->expectException(Exception::class);
@@ -105,7 +105,7 @@ public function testTooManyOptions()
         $input->validate();
     }
 
-    public function testNoOptions()
+    public function testNoOptions(): void
     {
         $this->expectException(Exception::class);
         $input = new Checkboxes();
diff --git a/tests/Inputs/DatePickerTest.php b/tests/Inputs/DatePickerTest.php
@@ -13,7 +13,7 @@
  */
 class DatePickerTest extends TestCase
 {
-    public function testCanConfigureDatePicker()
+    public function testCanConfigureDatePicker(): void
     {
         $input = (new DatePicker())
             ->actionId('my_id')
@@ -31,7 +31,7 @@ public function testCanConfigureDatePicker()
         ], $input);
     }
 
-    public function testMustAdhereToCorrectTimeFormat()
+    public function testMustAdhereToCorrectTimeFormat(): void
     {
         $this->expectException(Exception::class);
         (new DatePicker())->initialDate('nope');
diff --git a/tests/Inputs/InputElementTest.php b/tests/Inputs/InputElementTest.php
@@ -12,7 +12,7 @@
  */
 class InputElementTest extends TestCase
 {
-    public function testCanSetActionId()
+    public function testCanSetActionId(): void
     {
         $input = new class () extends InputElement {
             public function validate(): void
@@ -34,7 +34,7 @@ public function getType(): string
         ], $input);
     }
 
-    public function testCanSetActionIdWhenConstructing()
+    public function testCanSetActionIdWhenConstructing(): void
     {
         $input = new class ('foo') extends InputElement {
             public function validate(): void
diff --git a/tests/Inputs/OverflowMenuTest.php b/tests/Inputs/OverflowMenuTest.php
@@ -15,7 +15,7 @@
  */
 class OverflowMenuTest extends TestCase
 {
-    public function testOverflowMenuWithConfirm()
+    public function testOverflowMenuWithConfirm(): void
     {
         $input = (new OverflowMenu('overflow-identifier'))
             ->option('foo', 'foo')
@@ -71,7 +71,7 @@ public function testOverflowMenuWithConfirm()
         ], $input);
     }
 
-    public function testTooManyOptions()
+    public function testTooManyOptions(): void
     {
         $this->expectException(Exception::class);
         $input = (new OverflowMenu())
@@ -84,7 +84,7 @@ public function testTooManyOptions()
         $input->validate();
     }
 
-    public function testTooFewOptions()
+    public function testTooFewOptions(): void
     {
         $this->expectException(Exception::class);
         $input = (new OverflowMenu())
diff --git a/tests/Inputs/RadioButtonsTest.php b/tests/Inputs/RadioButtonsTest.php
@@ -15,7 +15,7 @@
  */
 class RadioButtonsTest extends TestCase
 {
-    public function testRadioButtonsWithConfirm()
+    public function testRadioButtonsWithConfirm(): void
     {
         $input = (new RadioButtons('radio-buttons-identifier'))
             ->option('foo', 'foo')
@@ -77,7 +77,7 @@ public function testRadioButtonsWithConfirm()
         ], $input);
     }
 
-    public function testTooManyOptions()
+    public function testTooManyOptions(): void
     {
         $this->expectException(Exception::class);
         $input = (new RadioButtons())
@@ -95,14 +95,14 @@ public function testTooManyOptions()
         $input->validate();
     }
 
-    public function testNoOptions()
+    public function testNoOptions(): void
     {
         $this->expectException(Exception::class);
         $input = new RadioButtons();
         $input->validate();
     }
 
-    public function testTooManyInitialOptions()
+    public function testTooManyInitialOptions(): void
     {
         $this->expectException(Exception::class);
         $input = (new RadioButtons())
diff --git a/tests/Inputs/TextInputTest.php b/tests/Inputs/TextInputTest.php
@@ -13,7 +13,7 @@
  */
 class TextInputTest extends TestCase
 {
-    public function testCanConfigureTextInput()
+    public function testCanConfigureTextInput(): void
     {
         $input = (new TextInput())
             ->placeholder('foo')
@@ -40,26 +40,26 @@ public function testCanConfigureTextInput()
         ], $input);
     }
 
-    public function testCannotSetMinLengthLessThanZero()
+    public function testCannotSetMinLengthLessThanZero(): void
     {
         $this->expectException(Exception::class);
         (new TextInput())->minLength(-1);
     }
 
-    public function testCannotSetMaxLengthLessThanOne()
+    public function testCannotSetMaxLengthLessThanOne(): void
     {
         $this->expectException(Exception::class);
         (new TextInput())->maxLength(0);
     }
 
-    public function testCannotSetMaxLengthLessThanMinLength()
+    public function testCannotSetMaxLengthLessThanMinLength(): void
     {
         $this->expectException(Exception::class);
         $input = (new TextInput())->minLength(5)->maxLength(3);
         $input->validate();
     }
 
-    public function testCannotSetMinLengthGreaterThan3000()
+    public function testCannotSetMinLengthGreaterThan3000(): void
     {
         $this->expectException(Exception::class);
         $input = (new TextInput())->minLength(3001);
diff --git a/tests/Inputs/TimePickerTest.php b/tests/Inputs/TimePickerTest.php
@@ -13,7 +13,7 @@
  */
 class TimePickerTest extends TestCase
 {
-    public function testCanConfigureTimePicker()
+    public function testCanConfigureTimePicker(): void
     {
         $input = (new TimePicker())
             ->actionId('my_id')
@@ -31,7 +31,7 @@ public function testCanConfigureTimePicker()
         ], $input);
     }
 
-    public function testMustAdhereToCorrectTimeFormat()
+    public function testMustAdhereToCorrectTimeFormat(): void
     {
         $this->expectException(Exception::class);
         (new TimePicker())->initialTime('nope');
diff --git a/tests/KitTest.php b/tests/KitTest.php
diff --git a/tests/Partials/FilterTest.php b/tests/Partials/FilterTest.php
diff --git a/tests/Partials/OptionListTest.php b/tests/Partials/OptionListTest.php
diff --git a/tests/TestCase.php b/tests/TestCase.php
diff --git a/tests/TypeTest.php b/tests/TypeTest.php
diff --git a/tests/manual/functions.php b/tests/manual/functions.php

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`*/`
`13`	`13`	`class BlockElementTest extends TestCase`
`14`	`14`	`{`
`15`		`- public function testCanSetBlockId()`
	`15`	`+ public function testCanSetBlockId(): void`
`16`	`16`	`{`
`17`	`17`	`$block = new class () extends BlockElement {`
`18`	`18`	`public function validate(): void`
`@@ -26,7 +26,7 @@ public function validate(): void`
`26`	`26`	`$this->assertEquals('foo', $block->getBlockId());`
`27`	`27`	`}`
`28`	`28`
`29`		`- public function testCanSetBlockIdWhenConstructing()`
	`29`	`+ public function testCanSetBlockIdWhenConstructing(): void`
`30`	`30`	`{`
`31`	`31`	`$block = new class ('foo') extends BlockElement {`
`32`	`32`	`public function validate(): void`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`*/`
`14`	`14`	`class DividerTest extends TestCase`
`15`	`15`	`{`
`16`		`- public function testThatDividerRendersToJsonCorrectly()`
	`16`	`+ public function testThatDividerRendersToJsonCorrectly(): void`
`17`	`17`	`{`
`18`	`18`	`$divider = new Divider();`
`19`	`19`	`$this->assertJsonData([`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`*/`
`10`	`10`	`class ConfigTest extends TestCase`
`11`	`11`	`{`
`12`		`- public function testCanSetConfigValuesWithFluentSyntax()`
	`12`	`+ public function testCanSetConfigValuesWithFluentSyntax(): void`
`13`	`13`	`{`
`14`	`14`	`$c = Config::new()`
`15`	`15`	`->setDefaultEmojiSetting(true)`
`@@ -19,7 +19,7 @@ public function testCanSetConfigValuesWithFluentSyntax()`
`19`	`19`	`$this->assertTrue($c->getDefaultVerbatimSetting());`
`20`	`20`	`}`
`21`	`21`
`22`		`- public function testCanUseDefaultConfigValues()`
	`22`	`+ public function testCanUseDefaultConfigValues(): void`
`23`	`23`	`{`
`24`	`24`	`$c = Config::new();`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`*/`
`17`	`17`	`class ElementTest extends TestCase`
`18`	`18`	`{`
`19`		`- public function testCanSerializeValidElementToJson()`
	`19`	`+ public function testCanSerializeValidElementToJson(): void`
`20`	`20`	`{`
`21`	`21`	`$element = $this->getMockElement();`
`22`	`22`
`@@ -26,14 +26,14 @@ public function testCanSerializeValidElementToJson()`
`26`	`26`	`]);`
`27`	`27`	`}`
`28`	`28`
`29`		`- public function testThrowsErrorElementIsInvalid()`
	`29`	`+ public function testThrowsErrorElementIsInvalid(): void`
`30`	`30`	`{`
`31`	`31`	`$this->expectException(Exception::class);`
`32`	`32`	`$element = $this->getMockElement(false);`
`33`	`33`	`$this->jsonEncode($element);`
`34`	`34`	`}`
`35`	`35`
`36`		`- public function testCanSetParentWithFluidInterfaceAndGetParentBack()`
	`36`	`+ public function testCanSetParentWithFluidInterfaceAndGetParentBack(): void`
`37`	`37`	`{`
`38`	`38`	`$parent = $this->getMockElement();`
`39`	`39`	`$element = $this->getMockElement();`
`@@ -42,14 +42,14 @@ public function testCanSetParentWithFluidInterfaceAndGetParentBack()`
`42`	`42`	`$this->assertSame($parent, $element->getParent());`
`43`	`43`	`}`
`44`	`44`
`45`		`- public function testCanUseNewAsFactoryForChildClasses()`
	`45`	`+ public function testCanUseNewAsFactoryForChildClasses(): void`
`46`	`46`	`{`
`47`	`47`	`$element = Section::new();`
`48`	`48`	`$this->assertEquals(Type::SECTION, $element->getType());`
`49`	`49`	`$this->assertInstanceOf(Section::class, $element);`
`50`	`50`	`}`
`51`	`51`
`52`		`- public function testCanSetExtraFieldsForArbitraryData()`
	`52`	`+ public function testCanSetExtraFieldsForArbitraryData(): void`
`53`	`53`	`{`
`54`	`54`	`$element = $this->getMockElement();`
`55`	`55`
`@@ -62,7 +62,7 @@ public function testCanSetExtraFieldsForArbitraryData()`
`62`	`62`	`]);`
`63`	`63`	`}`
`64`	`64`
`65`		`- public function testCanTapIntoElementForChaining()`
	`65`	`+ public function testCanTapIntoElementForChaining(): void`
`66`	`66`	`{`
`67`	`67`	`$element = $this->getMockElement()->tap(function (Element $e) {`
`68`	`68`	`$e->setExtra('fizz', 'buzz');`
`@@ -76,7 +76,7 @@ public function testCanTapIntoElementForChaining()`
`76`	`76`	`]);`
`77`	`77`	`}`
`78`	`78`
`79`		`- public function testCanConditionallyTapIntoElementForChaining()`
	`79`	`+ public function testCanConditionallyTapIntoElementForChaining(): void`
`80`	`80`	`{`
`81`	`81`	`$callable = function (Element $e) {`
`82`	`82`	`$e->setExtra('fizz', 'buzz');`
`@@ -100,8 +100,8 @@ public function testCanConditionallyTapIntoElementForChaining()`
`100`	`100`	`private function getMockElement(bool $valid = true): Element`
`101`	`101`	`{`
`102`	`102`	`return new class ($valid) extends Element {`
`103`		`- private $text;`
`104`		`- private $valid;`
	`103`	`+ private string $text;`
	`104`	`+ private bool $valid;`
`105`	`105`
`106`	`106`	`public function __construct(bool $valid)`
`107`	`107`	`{`
`@@ -128,7 +128,7 @@ public function toArray(): array`
`128`	`128`	`};`
`129`	`129`	`}`
`130`	`130`
`131`		`- public function testHydration()`
	`131`	`+ public function testHydration(): void`
`132`	`132`	`{`
`133`	`133`	`$beforeJson = <<<JSON`
`134`	`134`	`{`
`@@ -180,13 +180,13 @@ public function testHydration()`
`180`	`180`	`$this->assertJsonStringEqualsJsonString($beforeJson, $afterJson);`
`181`	`181`	`}`
`182`	`182`
`183`		`- public function testFromJsonThrowsExceptionOnBadJson()`
	`183`	`+ public function testFromJsonThrowsExceptionOnBadJson(): void`
`184`	`184`	`{`
`185`	`185`	`$this->expectException(HydrationException::class);`
`186`	`186`	`Modal::fromJson('{"foo":"Bar",}');`
`187`	`187`	`}`
`188`	`188`
`189`		`- public function testCanExportToJsonWithPrettyPrint()`
	`189`	`+ public function testCanExportToJsonWithPrettyPrint(): void`
`190`	`190`	`{`
`191`	`191`	`$element = $this->getMockElement();`
`192`	`192`	`$json = $element->toJson(true);`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`*/`
`16`	`16`	`class CheckBoxesTest extends TestCase`
`17`	`17`	`{`
`18`		`- public function testCheckboxesWithConfirm()`
	`18`	`+ public function testCheckboxesWithConfirm(): void`
`19`	`19`	`{`
`20`	`20`	`$input = (new Checkboxes('checkboxes-identifier'))`
`21`	`21`	`->option('foo', 'foo')`
`@@ -86,7 +86,7 @@ public function testCheckboxesWithConfirm()`
`86`	`86`	`], $input);`
`87`	`87`	`}`
`88`	`88`
`89`		`- public function testTooManyOptions()`
	`89`	`+ public function testTooManyOptions(): void`
`90`	`90`	`{`
`91`	`91`
`92`	`92`	`$this->expectException(Exception::class);`
`@@ -105,7 +105,7 @@ public function testTooManyOptions()`
`105`	`105`	`$input->validate();`
`106`	`106`	`}`
`107`	`107`
`108`		`- public function testNoOptions()`
	`108`	`+ public function testNoOptions(): void`
`109`	`109`	`{`
`110`	`110`	`$this->expectException(Exception::class);`
`111`	`111`	`$input = new Checkboxes();`