Merge pull request #13 from 5am-code/feature/improved-properties

mechelon · web-flow · commit ffa41459f3c8 · 2021-05-23T13:51:57.000+02:00
improve properties and collections
diff --git a/README.md b/README.md
@@ -37,11 +37,9 @@ Head over to the [Documentation](https://5amco.de/docs) of this package.
 ### 🔥 Code Examples to jumpstart your Notion API Project
 
 #### Basic Setup
+
 ```php
 use FiveamCode\LaravelNotionApi\Notion;
-use Illuminate\Support\Collection;
-use FiveamCode\LaravelNotionApi\Query\Sorting;
-use FiveamCode\LaravelNotionApi\Query\Filter;
 
 // Setup basic API connection
 $notion = new Notion();
diff --git a/src/Endpoints/Database.php b/src/Endpoints/Database.php
@@ -7,9 +7,6 @@
 use FiveamCode\LaravelNotionApi\Notion;
 use FiveamCode\LaravelNotionApi\Query\Filter;
 use FiveamCode\LaravelNotionApi\Query\Sorting;
-use FiveamCode\LaravelNotionApi\Query\StartCursor;
-use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use Symfony\Component\VarDumper\Cloner\Data;
 
 class Database extends Endpoint
 {
@@ -29,7 +26,7 @@ public function __construct(string $databaseId, Notion $notion)
         parent::__construct($notion);
     }
 
-    public function query(): Collection
+    public function query(): PageCollection
     {
         $postData = [];
 
@@ -54,8 +51,7 @@ public function query(): Collection
 
             ->json();
 
-        $pageCollection = new PageCollection($response);
-        return $pageCollection->getResults();
+        return new PageCollection($response);
     }
 
     public function filterBy(Collection $filter)
diff --git a/src/Endpoints/Databases.php b/src/Endpoints/Databases.php
@@ -5,8 +5,6 @@
 use FiveamCode\LaravelNotionApi\Entities\Database;
 use FiveamCode\LaravelNotionApi\Entities\Collections\DatabaseCollection;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
-use FiveamCode\LaravelNotionApi\Query\StartCursor;
 use Illuminate\Support\Collection;
 
 
diff --git a/src/Endpoints/Pages.php b/src/Endpoints/Pages.php
@@ -4,7 +4,6 @@
 
 use FiveamCode\LaravelNotionApi\Entities\Page;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
 
 class Pages extends Endpoint implements EndpointInterface
 {
diff --git a/src/Endpoints/Search.php b/src/Endpoints/Search.php
@@ -2,15 +2,10 @@
 
 namespace FiveamCode\LaravelNotionApi\Endpoints;
 
-use FiveamCode\LaravelNotionApi\Entities\Collections\EntityCollection;
-use FiveamCode\LaravelNotionApi\Entities\Collections\PageCollection;
 use Illuminate\Support\Collection;
 use FiveamCode\LaravelNotionApi\Notion;
-use FiveamCode\LaravelNotionApi\Query\Filter;
 use FiveamCode\LaravelNotionApi\Query\Sorting;
-use FiveamCode\LaravelNotionApi\Query\StartCursor;
-use FiveamCode\LaravelNotionApi\Exceptions\WrapperException;
-use Symfony\Component\VarDumper\Cloner\Data;
+use FiveamCode\LaravelNotionApi\Entities\Collections\EntityCollection;
 
 class Search extends Endpoint
 {
@@ -43,7 +38,7 @@ public function query(): EntityCollection
 
         if ($this->searchText !== null)
             $postData['query'] = $this->searchText;
-        
+
         $response = $this
             ->post(
                 $this->url(Endpoint::SEARCH),
diff --git a/src/Endpoints/Users.php b/src/Endpoints/Users.php
@@ -5,8 +5,6 @@
 use FiveamCode\LaravelNotionApi\Entities\User;
 use FiveamCode\LaravelNotionApi\Entities\Collections\UserCollection;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
-use FiveamCode\LaravelNotionApi\Query\StartCursor;
 use Illuminate\Support\Collection;
 
 class Users extends Endpoint implements EndpointInterface
diff --git a/src/Entities/Blocks/Block.php b/src/Entities/Blocks/Block.php
@@ -5,7 +5,6 @@
 use DateTime;
 use FiveamCode\LaravelNotionApi\Entities\Entity;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
 use Illuminate\Support\Arr;
 
 class Block extends Entity
diff --git a/src/Entities/Collections/BlockCollection.php b/src/Entities/Collections/BlockCollection.php
@@ -3,9 +3,6 @@
 namespace FiveamCode\LaravelNotionApi\Entities\Collections;
 
 use FiveamCode\LaravelNotionApi\Entities\Blocks\Block;
-use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
-use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 
 
diff --git a/src/Entities/Collections/DatabaseCollection.php b/src/Entities/Collections/DatabaseCollection.php
@@ -3,9 +3,6 @@
 namespace FiveamCode\LaravelNotionApi\Entities\Collections;
 
 use FiveamCode\LaravelNotionApi\Entities\Database;
-use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
-use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 
 
diff --git a/src/Entities/Collections/PageCollection.php b/src/Entities/Collections/PageCollection.php
@@ -3,9 +3,6 @@
 namespace FiveamCode\LaravelNotionApi\Entities\Collections;
 
 use FiveamCode\LaravelNotionApi\Entities\Page;
-use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
-use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 
 
diff --git a/src/Entities/Collections/UserCollection.php b/src/Entities/Collections/UserCollection.php
@@ -3,9 +3,6 @@
 namespace FiveamCode\LaravelNotionApi\Entities\Collections;
 
 use FiveamCode\LaravelNotionApi\Entities\User;
-use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
-use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 
 
diff --git a/src/Entities/Database.php b/src/Entities/Database.php
@@ -4,7 +4,6 @@
 
 use DateTime;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
 use Illuminate\Support\Arr;
 
 
@@ -14,6 +13,7 @@ class Database extends Entity
     protected string $objectType = "";
     protected array $rawTitle = [];
     protected array $rawProperties = [];
+    protected array $propertyKeys = [];
     protected DateTime $createdTime;
     protected DateTime $lastEditedTime;
 
@@ -56,6 +56,7 @@ private function fillProperties(): void
     {
         if (Arr::exists($this->responseData, 'properties')) {
             $this->rawProperties = $this->responseData['properties'];
+            $this->propertyKeys = array_keys($this->rawProperties);
         }
     }
 
@@ -86,9 +87,9 @@ public function getRawProperties(): array
         return $this->rawProperties;
     }
 
-    public function getPropertyNames(): array
+    public function getPropertyKeys(): array
     {
-        return array_keys($this->rawProperties);
+        return $this->propertyKeys;
     }
 
     public function getCreatedTime(): DateTime
diff --git a/src/Entities/Entity.php b/src/Entities/Entity.php
@@ -4,11 +4,11 @@
 
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
 use FiveamCode\LaravelNotionApi\Exceptions\NotionException;
-use FiveamCode\LaravelNotionApi\Notion;
 use Illuminate\Support\Arr;
 use Carbon\Carbon;
+use JsonSerializable;
 
-class Entity
+class Entity implements JsonSerializable
 {
     private string $id;
     protected array $responseData = [];
@@ -69,6 +69,11 @@ public function getRaw(): array
         return $this->responseData;
     }
 
+    public function jsonSerialize()
+    {
+        return $this->toArray();
+    }
+
     public function toArray(): array {
         return get_object_vars($this);
     }
diff --git a/src/Entities/Page.php b/src/Entities/Page.php
@@ -5,7 +5,6 @@
 use DateTime;
 use FiveamCode\LaravelNotionApi\Entities\Properties\Property;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 
@@ -14,7 +13,8 @@ class Page extends Entity
     protected string $title = "";
     protected string $objectType = "";
     protected array $rawProperties = [];
-    protected Collection $propertyCollection;
+    protected array $propertyMap = [];
+    protected Collection $properties;
     protected DateTime $createdTime;
     protected DateTime $lastEditedTime;
 
@@ -47,17 +47,18 @@ private function fillProperties(): void
     {
         if (Arr::exists($this->responseData, 'properties')) {
             $this->rawProperties = $this->responseData['properties'];
-            $this->propertyCollection = new Collection();
+            $this->properties = new Collection();
             foreach (array_keys($this->rawProperties) as $propertyKey) {
-                $this->propertyCollection->add(Property::fromResponse($propertyKey, $this->rawProperties[$propertyKey]));
+                $property = Property::fromResponse($propertyKey, $this->rawProperties[$propertyKey]);
+                $this->properties->add($property);
+                $this->propertyMap[$propertyKey] = $property;
             }
         }
     }
 
-
     private function fillTitle(): void
     {
-        $titleProperty = $this->propertyCollection->filter(function ($property) {
+        $titleProperty = $this->properties->filter(function ($property) {
             return $property->getType() == "title";
         })->first();
 
@@ -76,19 +77,15 @@ public function getTitle(): string
         return $this->title;
     }
 
-
     public function getProperties(): Collection
     {
-        return $this->propertyCollection;
+        return $this->properties;
     }
 
     public function getProperty(string $propertyName): ?Property
     {
-        $property = $this->propertyCollection->filter(function ($property) use ($propertyName) {
-            return $property->getTitle() == $propertyName;
-        })->first();
-
-        return $property;
+        //TODO:Handle undefined propertyNames (exception/null/?)
+        return $this->propertyMap[$propertyName];
     }
 
     public function getObjectType(): string
diff --git a/src/Entities/Properties/CreatedBy.php b/src/Entities/Properties/CreatedBy.php
@@ -2,15 +2,8 @@
 
 namespace FiveamCode\LaravelNotionApi\Entities\Properties;
 
-use DateTime;
-use FiveamCode\LaravelNotionApi\Entities\Entity;
-use FiveamCode\LaravelNotionApi\Entities\PropertyItems\RichText;
-use FiveamCode\LaravelNotionApi\Entities\PropertyItems\SelectItem;
 use FiveamCode\LaravelNotionApi\Entities\User;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
-use Illuminate\Support\Arr;
-use Illuminate\Support\Collection;
 
 class CreatedBy extends Property
 {
diff --git a/src/Entities/Properties/MultiSelect.php b/src/Entities/Properties/MultiSelect.php
@@ -2,12 +2,8 @@
 
 namespace FiveamCode\LaravelNotionApi\Entities\Properties;
 
-use DateTime;
-use FiveamCode\LaravelNotionApi\Entities\Entity;
 use FiveamCode\LaravelNotionApi\Entities\PropertyItems\SelectItem;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
-use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 
 class MultiSelect extends Property
diff --git a/src/Entities/Properties/Number.php b/src/Entities/Properties/Number.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Properties;
+
+class Number extends Property
+{
+    protected float $number = 0;
+
+    protected function fillFromRaw(): void
+    {
+        parent::fillFromRaw();
+        // if (!is_array($this->rawContent))
+        //     throw HandlingException::instance("The property-type is number, however the raw data-structure does not represent this type (= array of items). Please check the raw response-data.");
+
+        $this->fillNumber();
+    }
+
+    protected function fillNumber(): void
+    {
+        $this->content = $this->rawContent;
+    }
+
+    public function getContent(): float
+    {
+        return $this->content;
+    }
+
+    public function getNumber(): float
+    {
+        return $this->content;
+    }
+}
diff --git a/src/Entities/Properties/Property.php b/src/Entities/Properties/Property.php
@@ -2,10 +2,8 @@
 
 namespace FiveamCode\LaravelNotionApi\Entities\Properties;
 
-use DateTime;
 use FiveamCode\LaravelNotionApi\Entities\Entity;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
 use Illuminate\Support\Arr;
 
 class Property extends Entity
@@ -47,6 +45,7 @@ private function fillContent(): void
     {
         if (Arr::exists($this->responseData, $this->getType())) {
             $this->rawContent = $this->responseData[$this->getType()];
+            $this->content = $this->rawContent;
         }
     }
 
@@ -78,8 +77,12 @@ public static function fromResponse($propertyKey, $rawContent): Property
             return new Select($propertyKey, $rawContent);
         } else if ($rawContent['type'] == 'text') {
             return new Text($propertyKey, $rawContent);
-        } else if($rawContent['type'] == 'created_by'){
+        } else if ($rawContent['type'] == 'created_by') {
             return new CreatedBy($propertyKey, $rawContent);
+        } else if ($rawContent['type'] == 'title') {
+            return new Title($propertyKey, $rawContent);
+        } else if ($rawContent['type'] == 'number') {
+            return new Number($propertyKey, $rawContent);
         }
 
 
diff --git a/src/Entities/Properties/Select.php b/src/Entities/Properties/Select.php
@@ -2,13 +2,8 @@
 
 namespace FiveamCode\LaravelNotionApi\Entities\Properties;
 
-use DateTime;
-use FiveamCode\LaravelNotionApi\Entities\Entity;
 use FiveamCode\LaravelNotionApi\Entities\PropertyItems\SelectItem;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
-use FiveamCode\LaravelNotionApi\Notion;
-use Illuminate\Support\Arr;
-use Illuminate\Support\Collection;
 
 class Select extends Property
 {
diff --git a/src/Entities/Properties/Text.php b/src/Entities/Properties/Text.php
diff --git a/src/Entities/Properties/Title.php b/src/Entities/Properties/Title.php
diff --git a/src/Entities/PropertyItems/RichText.php b/src/Entities/PropertyItems/RichText.php
diff --git a/src/Entities/PropertyItems/SelectItem.php b/src/Entities/PropertyItems/SelectItem.php
diff --git a/src/Entities/User.php b/src/Entities/User.php
diff --git a/src/Query/QueryHelper.php b/src/Query/QueryHelper.php
diff --git a/src/Query/StartCursor.php b/src/Query/StartCursor.php
diff --git a/tests/EndpointPageTest.php b/tests/EndpointPageTest.php
diff --git a/tests/EnpointPagePropertyTest.php b/tests/EnpointPagePropertyTest.php

Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,6 @@`
`7`	`7`	`use FiveamCode\LaravelNotionApi\Notion;`
`8`	`8`	`use FiveamCode\LaravelNotionApi\Query\Filter;`
`9`	`9`	`use FiveamCode\LaravelNotionApi\Query\Sorting;`
`10`		`-use FiveamCode\LaravelNotionApi\Query\StartCursor;`
`11`		`-use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;`
`12`		`-use Symfony\Component\VarDumper\Cloner\Data;`
`13`	`10`
`14`	`11`	`class Database extends Endpoint`
`15`	`12`	`{`
`@@ -29,7 +26,7 @@ public function __construct(string $databaseId, Notion $notion)`
`29`	`26`	`parent::__construct($notion);`
`30`	`27`	`}`
`31`	`28`
`32`		`- public function query(): Collection`
	`29`	`+ public function query(): PageCollection`
`33`	`30`	`{`
`34`	`31`	`$postData = [];`
`35`	`32`
`@@ -54,8 +51,7 @@ public function query(): Collection`
`54`	`51`
`55`	`52`	`->json();`
`56`	`53`
`57`		`- $pageCollection = new PageCollection($response);`
`58`		`- return $pageCollection->getResults();`
	`54`	`+ return new PageCollection($response);`
`59`	`55`	`}`
`60`	`56`
`61`	`57`	`public function filterBy(Collection $filter)`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`
`5`	`5`	`use FiveamCode\LaravelNotionApi\Entities\Page;`
`6`	`6`	`use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;`
`7`		`-use FiveamCode\LaravelNotionApi\Notion;`
`8`	`7`
`9`	`8`	`class Pages extends Endpoint implements EndpointInterface`
`10`	`9`	`{`