Merge pull request 5am-code#19 from 5am-code/feature/blocks

johguentner · web-flow · commit 367cd3226bb6 · 2021-08-21T20:44:55.000+02:00
implement notion block types as classes
diff --git a/src/Entities/Blocks/Block.php b/src/Entities/Blocks/Block.php
@@ -28,6 +28,17 @@ class Block extends Entity
      */
     protected array $rawContent;
 
+    /**
+     * @var mixed
+     */
+    protected $content;
+
+
+    /**
+     * @var string
+     */
+    protected string $text = "[warning: unsupported in notion api]";
+
     /**
      * @var DateTime
      */
@@ -54,7 +65,7 @@ protected function setResponseData(array $responseData): void
     /**
      *
      */
-    private function fillFromRaw(): void
+    protected function fillFromRaw(): void
     {
         $this->fillId();
         $this->fillType();
@@ -133,4 +144,61 @@ public function getLastEditedTime(): DateTime
     {
         return $this->lastEditedTime;
     }
+
+    /**
+     * 
+     */
+    public function getContent()
+    {
+        return $this->content;
+    }
+
+    /**
+     * @return string
+     */
+    public function asText() : string
+    {
+        return $this->text;
+    }
+
+    /**
+     * @param $rawContent
+     * @return Block
+     * @throws HandlingException
+     */
+    public static function fromResponse($rawContent): Block
+    {
+        $blockClass = self::mapTypeToClass($rawContent['type']);
+        $block = new $blockClass($rawContent);
+        return $block;
+    }
+
+    /**
+     * Maps the type of a block to the corresponding package class by converting the type name.
+     *
+     * @param string $type
+     * @return string
+     */
+    private static function mapTypeToClass(string $type): string
+    {
+
+        switch ($type) {
+            case 'bulleted_list_item':
+            case 'numbered_list_item':
+            case 'child_page':
+            case 'paragraph':
+            case 'to_do':
+            case 'toggle':
+                $class = str_replace('_', '', ucwords($type, '_'));
+                return "FiveamCode\\LaravelNotionApi\\Entities\\Blocks\\" . $class;
+            case 'heading_1':
+                return HeadingOne::class;
+            case 'heading_2':
+                return HeadingTwo::class;
+            case 'heading_3':
+                return HeadingThree::class;
+            default:
+                return Block::class;
+        }
+    }
 }
diff --git a/src/Entities/Blocks/BulletedListItem.php b/src/Entities/Blocks/BulletedListItem.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Blocks;
+
+use DateTime;
+use Illuminate\Support\Arr;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+
+/**
+ * Class BulletedListItem
+ * @package FiveamCode\LaravelNotionApi\Entities\Blocks
+ */
+class BulletedListItem extends TextBlock
+{
+}
diff --git a/src/Entities/Blocks/ChildPage.php b/src/Entities/Blocks/ChildPage.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Blocks;
+
+use DateTime;
+use Illuminate\Support\Arr;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+
+/**
+ * Class ChildPage
+ * @package FiveamCode\LaravelNotionApi\Entities\Blocks
+ */
+class ChildPage extends Block
+{
+    /**
+     * 
+     */
+    protected function fillFromRaw(): void
+    {
+        parent::fillFromRaw();
+        $this->fillContent();
+    }
+
+    /**
+     * 
+     */
+    protected function fillContent() : void
+    {
+        $this->content = $this->rawContent['title'];
+        $this->text = $this->getContent();
+    }
+
+    /**
+     * @return string
+     */
+    public function getContent(): string
+    {
+        return $this->content;
+    }
+}
diff --git a/src/Entities/Blocks/HeadingOne.php b/src/Entities/Blocks/HeadingOne.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Blocks;
+
+use DateTime;
+use Illuminate\Support\Arr;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+
+/**
+ * Class HeadingOne
+ * @package FiveamCode\LaravelNotionApi\Entities\Blocks
+ */
+class HeadingOne extends TextBlock
+{
+}
diff --git a/src/Entities/Blocks/HeadingThree.php b/src/Entities/Blocks/HeadingThree.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Blocks;
+
+use DateTime;
+use Illuminate\Support\Arr;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+
+/**
+ * Class HeadingThree
+ * @package FiveamCode\LaravelNotionApi\Entities\Blocks
+ */
+class HeadingThree extends TextBlock
+{
+}
diff --git a/src/Entities/Blocks/HeadingTwo.php b/src/Entities/Blocks/HeadingTwo.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Blocks;
+
+use DateTime;
+use Illuminate\Support\Arr;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+
+/**
+ * Class HeadingTwo
+ * @package FiveamCode\LaravelNotionApi\Entities\Blocks
+ */
+class HeadingTwo extends TextBlock
+{
+}
diff --git a/src/Entities/Blocks/NumberedListItem.php b/src/Entities/Blocks/NumberedListItem.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Blocks;
+
+use DateTime;
+use Illuminate\Support\Arr;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+
+/**
+ * Class NumberedListItem
+ * @package FiveamCode\LaravelNotionApi\Entities\Blocks
+ */
+class NumberedListItem extends TextBlock
+{
+}
diff --git a/src/Entities/Blocks/Paragraph.php b/src/Entities/Blocks/Paragraph.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Blocks;
+
+use DateTime;
+use Illuminate\Support\Arr;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Entities\PropertyItems\RichText;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+
+/**
+ * Class Paragraph
+ * @package FiveamCode\LaravelNotionApi\Entities\Blocks
+ */
+class Paragraph extends TextBlock
+{
+}
diff --git a/src/Entities/Blocks/TextBlock.php b/src/Entities/Blocks/TextBlock.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Blocks;
+
+use DateTime;
+use Illuminate\Support\Arr;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Entities\PropertyItems\RichText;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+
+/**
+ * Class TextBlock
+ * @package FiveamCode\LaravelNotionApi\Entities\Blocks
+ */
+class TextBlock extends Block
+{
+    /**
+     * 
+     */
+    protected function fillFromRaw(): void
+    {
+        parent::fillFromRaw();
+        $this->fillContent();
+    }
+
+    /**
+     * 
+     */
+    protected function fillContent(): void
+    {
+        $this->content = new RichText($this->rawContent['text']);
+        $this->text = $this->getContent()->getPlainText();
+    }
+
+    /**
+     * @return RichText
+     */
+    public function getContent(): RichText
+    {
+        return $this->content;
+    }
+}
diff --git a/src/Entities/Blocks/ToDo.php b/src/Entities/Blocks/ToDo.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Blocks;
+
+use DateTime;
+use Illuminate\Support\Arr;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+
+/**
+ * Class ToDo
+ * @package FiveamCode\LaravelNotionApi\Entities\Blocks
+ */
+class ToDo extends TextBlock
+{
+}
diff --git a/src/Entities/Blocks/Toggle.php b/src/Entities/Blocks/Toggle.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Blocks;
+
+use DateTime;
+use Illuminate\Support\Arr;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+
+/**
+ * Class Toggle
+ * @package FiveamCode\LaravelNotionApi\Entities\Blocks
+ */
+class Toggle extends TextBlock
+{
+}
diff --git a/src/Entities/Collections/BlockCollection.php b/src/Entities/Collections/BlockCollection.php
@@ -12,11 +12,61 @@
  */
 class BlockCollection extends EntityCollection
 {
+    private bool $showUnsupported = false;
+
+    /**
+     * will include unsupported blocks within your collection
+     * unsupported blocks are currently not supported by the Notion API 
+     * they will be ignored (not included) in your collection by default
+     * 
+     * @return BlockCollection
+     */
+    public function withUnsupported(): BlockCollection
+    {
+        $this->showUnsupported = true;
+        return $this;
+    }
+
+    /**
+     * collects all blocks from the raw results (from notion)
+     */
     protected function collectChildren(): void
     {
         $this->collection = new Collection();
-        foreach ($this->rawResults as $blockChild) {
-            $this->collection->add(new Block($blockChild));
+        foreach ($this->rawResults as $blockChildContent) {
+            $this->collection->add(Block::fromResponse($blockChildContent));
+        }
+    }
+
+    /**
+     * returns according blocks as collection
+     * 
+     * @return Collection
+     */
+    public function asCollection(): Collection
+    {
+        $collection = parent::asCollection();
+        if ($this->showUnsupported) {
+            return $collection;
+        } else {
+            return $collection->filter(function ($block) {
+                return $block->getType() !== 'unsupported';
+            });
+        }
+    }
+
+    /**
+     * returns according blocks as collection and will only represent the textual content of the blocks
+     * (this is useful if you only want to work with the blocks content and not with the whole block object)
+     * 
+     * @return Collection
+     */
+    public function asTextCollection(): Collection
+    {
+        $textCollection = new Collection();
+        foreach ($this->asCollection() as $block) {
+            $textCollection->add($block->asText());
         }
+        return $textCollection;
     }
 }
diff --git a/src/Entities/Collections/EntityCollection.php b/src/Entities/Collections/EntityCollection.php
@@ -124,7 +124,7 @@ public function asCollection(): Collection
      */
     public function asJson(): string
     {
-        return $this->collection->map(function (Entity $item) {
+        return $this->asCollection()->map(function (Entity $item) {
             return $item->toArray();
         });
     }
diff --git a/tests/EndpointBlocksTest.php b/tests/EndpointBlocksTest.php
diff --git a/tests/stubs/endpoints/blocks/response_specific_supported_blocks_200.json b/tests/stubs/endpoints/blocks/response_specific_supported_blocks_200.json
