Merge pull request 5am-code#58 from 5am-code/dev

mechelon · web-flow · commit 4ccef63722a0 · 2021-12-28T15:16:34.000+01:00
Dev to Master: v0.6.2
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -10,7 +10,9 @@ jobs:
       fail-fast: false
       matrix:
         php:
+          - '8.1'
           - '8.0'
+          - '7.4'
         laravel:
           - '8.*'
         testbench:
diff --git a/src/Endpoints/Block.php b/src/Endpoints/Block.php
@@ -81,8 +81,12 @@ public function children(): BlockCollection
      *
      * @throws HandlingException
      */
-    public function append(array|BlockEntity $appendices): BlockEntity
+    public function append($appendices): BlockEntity
     {
+        if (! is_array($appendices) && ! $appendices instanceof BlockEntity) {
+            throw new HandlingException('$appendices must be an array or instance of BlockEntity');
+        }
+
         if (! is_array($appendices)) {
             $appendices = [$appendices];
         }
diff --git a/src/Entities/Blocks/Block.php b/src/Entities/Blocks/Block.php
@@ -212,4 +212,11 @@ private static function mapTypeToClass(string $type): string
                 return Block::class;
         }
     }
+
+    protected static function assertValidTextContent($textContent)
+    {
+        if (! is_array($textContent) && ! is_string($textContent)) {
+            throw new HandlingException('$textContent content must be a string or an array.');
+        }
+    }
 }
diff --git a/src/Entities/Blocks/BulletedListItem.php b/src/Entities/Blocks/BulletedListItem.php
@@ -7,8 +7,10 @@
  */
 class BulletedListItem extends TextBlock
 {
-    public static function create(array|string $textContent): BulletedListItem
+    public static function create($textContent): BulletedListItem
     {
+        self::assertValidTextContent($textContent);
+
         $bulletedListItem = new BulletedListItem();
         TextBlock::createTextBlock($bulletedListItem, $textContent);
 
diff --git a/src/Entities/Blocks/HeadingOne.php b/src/Entities/Blocks/HeadingOne.php
@@ -7,8 +7,10 @@
  */
 class HeadingOne extends TextBlock
 {
-    public static function create(array|string $textContent): HeadingOne
+    public static function create($textContent): HeadingOne
     {
+        self::assertValidTextContent($textContent);
+
         $headingOne = new HeadingOne();
         TextBlock::createTextBlock($headingOne, $textContent);
 
diff --git a/src/Entities/Blocks/HeadingThree.php b/src/Entities/Blocks/HeadingThree.php
@@ -7,8 +7,10 @@
  */
 class HeadingThree extends TextBlock
 {
-    public static function create(array|string $textContent): HeadingThree
+    public static function create($textContent): HeadingThree
     {
+        self::assertValidTextContent($textContent);
+
         $headingThree = new HeadingThree();
         HeadingThree::createTextBlock($headingThree, $textContent);
 
diff --git a/src/Entities/Blocks/HeadingTwo.php b/src/Entities/Blocks/HeadingTwo.php
@@ -7,8 +7,10 @@
  */
 class HeadingTwo extends TextBlock
 {
-    public static function create(array|string $textContent): HeadingTwo
+    public static function create($textContent): HeadingTwo
     {
+        self::assertValidTextContent($textContent);
+
         $headingTwo = new HeadingTwo();
         HeadingTwo::createTextBlock($headingTwo, $textContent);
 
diff --git a/src/Entities/Blocks/NumberedListItem.php b/src/Entities/Blocks/NumberedListItem.php
@@ -7,8 +7,10 @@
  */
 class NumberedListItem extends TextBlock
 {
-    public static function create(array|string $textContent): NumberedListItem
+    public static function create($textContent): NumberedListItem
     {
+        self::assertValidTextContent($textContent);
+
         $numberedListItem = new NumberedListItem();
         TextBlock::createTextBlock($numberedListItem, $textContent);
 
diff --git a/src/Entities/Blocks/Paragraph.php b/src/Entities/Blocks/Paragraph.php
@@ -7,8 +7,10 @@
  */
 class Paragraph extends TextBlock
 {
-    public static function create(array|string $textContent): Paragraph
+    public static function create($textContent): Paragraph
     {
+        self::assertValidTextContent($textContent);
+
         $paragraph = new Paragraph();
         TextBlock::createTextBlock($paragraph, $textContent);
 
diff --git a/src/Entities/Blocks/TextBlock.php b/src/Entities/Blocks/TextBlock.php
@@ -10,8 +10,10 @@
  */
 class TextBlock extends Block implements Modifiable
 {
-    protected static function createTextBlock(TextBlock $textBlock, array|string $textContent): TextBlock
+    protected static function createTextBlock(TextBlock $textBlock, $textContent): TextBlock
     {
+        self::assertValidTextContent($textContent);
+
         if (is_string($textContent)) {
             $textContent = [$textContent];
         }
diff --git a/src/Entities/Blocks/ToDo.php b/src/Entities/Blocks/ToDo.php
@@ -7,8 +7,10 @@
  */
 class ToDo extends TextBlock
 {
-    public static function create(array|string $textContent): ToDo
+    public static function create($textContent): ToDo
     {
+        self::assertValidTextContent($textContent);
+
         $toDo = new ToDo();
         TextBlock::createTextBlock($toDo, $textContent);
 
diff --git a/src/Entities/Blocks/Toggle.php b/src/Entities/Blocks/Toggle.php
@@ -7,8 +7,10 @@
  */
 class Toggle extends TextBlock
 {
-    public static function create(array|string $textContent): Toggle
+    public static function create($textContent): Toggle
     {
+        self::assertValidTextContent($textContent);
+
         $toggle = new Toggle();
         TextBlock::createTextBlock($toggle, $textContent);
 
diff --git a/src/Entities/Properties/Select.php b/src/Entities/Properties/Select.php
@@ -5,7 +5,7 @@
 use FiveamCode\LaravelNotionApi\Entities\Contracts\Modifiable;
 use FiveamCode\LaravelNotionApi\Entities\PropertyItems\SelectItem;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Support\Collection;
 
 /**
  * Class Select.
diff --git a/src/Query/Filters/Filter.php b/src/Query/Filters/Filter.php
@@ -75,8 +75,12 @@ public static function textFilter(string $property, string $comparisonOperator,
      *
      * @throws HandlingException
      */
-    public static function numberFilter(string $property, string $comparisonOperator, float|int $number): Filter
+    public static function numberFilter(string $property, string $comparisonOperator, $number): Filter
     {
+        if (! is_numeric($number)) {
+            throw new HandlingException('The number must be numeric.');
+        }
+
         self::isValidComparisonOperatorFor('number', $comparisonOperator);
 
         return new Filter($property, 'number', [$comparisonOperator => $number]);
diff --git a/tests/EndpointBlocksTest.php b/tests/EndpointBlocksTest.php
@@ -18,6 +18,7 @@
 use FiveamCode\LaravelNotionApi\Entities\Blocks\Video;
 use FiveamCode\LaravelNotionApi\Entities\Collections\BlockCollection;
 use FiveamCode\LaravelNotionApi\Exceptions\NotionException;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
 use Illuminate\Support\Facades\Http;
 use Notion;
 
@@ -292,6 +293,35 @@ public function it_returns_parent_block_in_which_new_blocks_have_been_successful
         $this->assertInstanceOf(Block::class, $parentBlock);
     }
 
+    /**
+     * @dataProvider classProvider
+     */
+    public function classProvider(): array
+    {
+        return [
+            [BulletedListItem::class],
+            [HeadingOne::class],
+            [HeadingTwo::class],
+            [HeadingThree::class],
+            [NumberedListItem::class],
+            [Paragraph::class],
+            [ToDo::class],
+            [Toggle::class],
+        ];
+    }
+
+    /**
+     * @test
+     * @dataProvider classProvider
+     *
+     * @param $entityClass
+     */
+    public function it_throws_an_handling_exception_for_wrong_type($entityClass)
+    {
+        $this->expectException(HandlingException::class);
+        $paragraph = $entityClass::create(new \stdClass());
+    }
+
     /** @test */
     public function it_retrieves_a_single_block()
     {
diff --git a/tests/NotionApiTest.php b/tests/NotionApiTest.php
@@ -36,8 +36,12 @@ protected function getPackageAliases($app): array
         ];
     }
 
-    protected function assertContainsInstanceOf(string $class, Collection|array $haystack): bool
+    protected function assertContainsInstanceOf(string $class, $haystack): bool
     {
+        if (! is_array($haystack) && ! ($haystack instanceof Collection)) {
+            throw new \InvalidArgumentException('$haystack must be an array or a Collection');
+        }
+
         foreach ($haystack as $item) {
             if (get_class($item) === $class) {
                 return true;

Original file line number	Diff line number	Diff line change
`@@ -81,8 +81,12 @@ public function children(): BlockCollection`
`81`	`81`	`*`
`82`	`82`	`* @throws HandlingException`
`83`	`83`	`*/`
`84`		`- public function append(array\|BlockEntity $appendices): BlockEntity`
	`84`	`+ public function append($appendices): BlockEntity`
`85`	`85`	`{`
	`86`	`+ if (! is_array($appendices) && ! $appendices instanceof BlockEntity) {`
	`87`	`+ throw new HandlingException('$appendices must be an array or instance of BlockEntity');`
	`88`	`+ }`
	`89`	`+`
`86`	`90`	`if (! is_array($appendices)) {`
`87`	`91`	`$appendices = [$appendices];`
`88`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -212,4 +212,11 @@ private static function mapTypeToClass(string $type): string`
`212`	`212`	`return Block::class;`
`213`	`213`	`}`
`214`	`214`	`}`
	`215`	`+`
	`216`	`+ protected static function assertValidTextContent($textContent)`
	`217`	`+ {`
	`218`	`+ if (! is_array($textContent) && ! is_string($textContent)) {`
	`219`	`+ throw new HandlingException('$textContent content must be a string or an array.');`
	`220`	`+ }`
	`221`	`+ }`
`215`	`222`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,10 @@`
`7`	`7`	`*/`
`8`	`8`	`class BulletedListItem extends TextBlock`
`9`	`9`	`{`
`10`		`- public static function create(array\|string $textContent): BulletedListItem`
	`10`	`+ public static function create($textContent): BulletedListItem`
`11`	`11`	`{`
	`12`	`+ self::assertValidTextContent($textContent);`
	`13`	`+`
`12`	`14`	`$bulletedListItem = new BulletedListItem();`
`13`	`15`	`TextBlock::createTextBlock($bulletedListItem, $textContent);`
`14`	`16`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,10 @@`
`7`	`7`	`*/`
`8`	`8`	`class HeadingOne extends TextBlock`
`9`	`9`	`{`
`10`		`- public static function create(array\|string $textContent): HeadingOne`
	`10`	`+ public static function create($textContent): HeadingOne`
`11`	`11`	`{`
	`12`	`+ self::assertValidTextContent($textContent);`
	`13`	`+`
`12`	`14`	`$headingOne = new HeadingOne();`
`13`	`15`	`TextBlock::createTextBlock($headingOne, $textContent);`
`14`	`16`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,10 @@`
`7`	`7`	`*/`
`8`	`8`	`class HeadingThree extends TextBlock`
`9`	`9`	`{`
`10`		`- public static function create(array\|string $textContent): HeadingThree`
	`10`	`+ public static function create($textContent): HeadingThree`
`11`	`11`	`{`
	`12`	`+ self::assertValidTextContent($textContent);`
	`13`	`+`
`12`	`14`	`$headingThree = new HeadingThree();`
`13`	`15`	`HeadingThree::createTextBlock($headingThree, $textContent);`
`14`	`16`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,10 @@`
`7`	`7`	`*/`
`8`	`8`	`class HeadingTwo extends TextBlock`
`9`	`9`	`{`
`10`		`- public static function create(array\|string $textContent): HeadingTwo`
	`10`	`+ public static function create($textContent): HeadingTwo`
`11`	`11`	`{`
	`12`	`+ self::assertValidTextContent($textContent);`
	`13`	`+`
`12`	`14`	`$headingTwo = new HeadingTwo();`
`13`	`15`	`HeadingTwo::createTextBlock($headingTwo, $textContent);`
`14`	`16`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,10 @@`
`7`	`7`	`*/`
`8`	`8`	`class NumberedListItem extends TextBlock`
`9`	`9`	`{`
`10`		`- public static function create(array\|string $textContent): NumberedListItem`
	`10`	`+ public static function create($textContent): NumberedListItem`
`11`	`11`	`{`
	`12`	`+ self::assertValidTextContent($textContent);`
	`13`	`+`
`12`	`14`	`$numberedListItem = new NumberedListItem();`
`13`	`15`	`TextBlock::createTextBlock($numberedListItem, $textContent);`
`14`	`16`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,10 @@`
`7`	`7`	`*/`
`8`	`8`	`class Paragraph extends TextBlock`
`9`	`9`	`{`
`10`		`- public static function create(array\|string $textContent): Paragraph`
	`10`	`+ public static function create($textContent): Paragraph`
`11`	`11`	`{`
	`12`	`+ self::assertValidTextContent($textContent);`
	`13`	`+`
`12`	`14`	`$paragraph = new Paragraph();`
`13`	`15`	`TextBlock::createTextBlock($paragraph, $textContent);`
`14`	`16`
Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,10 @@`
`10`	`10`	`*/`
`11`	`11`	`class TextBlock extends Block implements Modifiable`
`12`	`12`	`{`
`13`		`- protected static function createTextBlock(TextBlock $textBlock, array\|string $textContent): TextBlock`
	`13`	`+ protected static function createTextBlock(TextBlock $textBlock, $textContent): TextBlock`
`14`	`14`	`{`
	`15`	`+ self::assertValidTextContent($textContent);`
	`16`	`+`
`15`	`17`	`if (is_string($textContent)) {`
`16`	`18`	`$textContent = [$textContent];`
`17`	`19`	`}`