From 9b8c0a4560fa1d87cab1529099b1b4677e92e265 Mon Sep 17 00:00:00 2001
From: ArthurHoaro <arthur@hoa.ro>
Date: Wed, 20 Jan 2021 14:45:59 +0100
Subject: Handle pagination through BookmarkService

Handle all search results through SearchResult object.
This is a required step toward implementing a BookmarkService based on SQL database.

Related to #953
---
 tests/bookmark/BookmarkFileServiceTest.php |   8 +-
 tests/bookmark/SearchResultTest.php        | 125 +++++++++++++++++++++++++++++
 2 files changed, 129 insertions(+), 4 deletions(-)
 create mode 100644 tests/bookmark/SearchResultTest.php

(limited to 'tests/bookmark')

diff --git a/tests/bookmark/BookmarkFileServiceTest.php b/tests/bookmark/BookmarkFileServiceTest.php
index f619aff3..d1af3fb0 100644
--- a/tests/bookmark/BookmarkFileServiceTest.php
+++ b/tests/bookmark/BookmarkFileServiceTest.php
@@ -807,7 +807,7 @@ class BookmarkFileServiceTest extends TestCase
         $request = ['searchtags' => $tags];
         $this->assertEquals(
             2,
-            count($this->privateLinkDB->search($request, null, true))
+            count($this->privateLinkDB->search($request, null, true)->getBookmarks())
         );
     }
 
@@ -820,7 +820,7 @@ class BookmarkFileServiceTest extends TestCase
         $request = ['searchtags' => $tags];
         $this->assertEquals(
             2,
-            count($this->privateLinkDB->search($request, null, true))
+            count($this->privateLinkDB->search($request, null, true)->getBookmarks())
         );
     }
 
@@ -834,12 +834,12 @@ class BookmarkFileServiceTest extends TestCase
         $request = ['searchtags' => $tags];
         $this->assertEquals(
             1,
-            count($this->privateLinkDB->search($request, 'all', true))
+            count($this->privateLinkDB->search($request, 'all', true)->getBookmarks())
         );
 
         $this->assertEquals(
             0,
-            count($this->publicLinkDB->search($request, 'public', true))
+            count($this->publicLinkDB->search($request, 'public', true)->getBookmarks())
         );
     }
 
diff --git a/tests/bookmark/SearchResultTest.php b/tests/bookmark/SearchResultTest.php
new file mode 100644
index 00000000..12854c1f
--- /dev/null
+++ b/tests/bookmark/SearchResultTest.php
@@ -0,0 +1,125 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shaarli\Bookmark;
+
+use Shaarli\TestCase;
+
+/**
+ * Test SearchResult class.
+ */
+class SearchResultTest extends TestCase
+{
+    /** Create a SearchResult without any pagination parameter. */
+    public function testResultNoParameters(): void
+    {
+        $searchResult = SearchResult::getSearchResult($data = ['a', 'b', 'c', 'd', 'e', 'f']);
+
+        static::assertSame($data, $searchResult->getBookmarks());
+        static::assertSame(6, $searchResult->getResultCount());
+        static::assertSame(6, $searchResult->getTotalCount());
+        static::assertSame(null, $searchResult->getLimit());
+        static::assertSame(0, $searchResult->getOffset());
+        static::assertSame(1, $searchResult->getPage());
+        static::assertSame(1, $searchResult->getLastPage());
+        static::assertTrue($searchResult->isFirstPage());
+        static::assertTrue($searchResult->isLastPage());
+    }
+
+    /** Create a SearchResult with only an offset parameter */
+    public function testResultWithOffset(): void
+    {
+        $searchResult = SearchResult::getSearchResult(['a', 'b', 'c', 'd', 'e', 'f'], 2);
+
+        static::assertSame([2 => 'c', 3 => 'd', 4 => 'e', 5 => 'f'], $searchResult->getBookmarks());
+        static::assertSame(4, $searchResult->getResultCount());
+        static::assertSame(6, $searchResult->getTotalCount());
+        static::assertSame(null, $searchResult->getLimit());
+        static::assertSame(2, $searchResult->getOffset());
+        static::assertSame(2, $searchResult->getPage());
+        static::assertSame(2, $searchResult->getLastPage());
+        static::assertFalse($searchResult->isFirstPage());
+        static::assertTrue($searchResult->isLastPage());
+    }
+
+    /** Create a SearchResult with only a limit parameter */
+    public function testResultWithLimit(): void
+    {
+        $searchResult = SearchResult::getSearchResult(['a', 'b', 'c', 'd', 'e', 'f'], 0, 2);
+
+        static::assertSame([0 => 'a', 1 => 'b'], $searchResult->getBookmarks());
+        static::assertSame(2, $searchResult->getResultCount());
+        static::assertSame(6, $searchResult->getTotalCount());
+        static::assertSame(2, $searchResult->getLimit());
+        static::assertSame(0, $searchResult->getOffset());
+        static::assertSame(1, $searchResult->getPage());
+        static::assertSame(3, $searchResult->getLastPage());
+        static::assertTrue($searchResult->isFirstPage());
+        static::assertFalse($searchResult->isLastPage());
+    }
+
+    /** Create a SearchResult with offset and limit parameters */
+    public function testResultWithLimitAndOffset(): void
+    {
+        $searchResult = SearchResult::getSearchResult(['a', 'b', 'c', 'd', 'e', 'f'], 2, 2);
+
+        static::assertSame([2 => 'c', 3 => 'd'], $searchResult->getBookmarks());
+        static::assertSame(2, $searchResult->getResultCount());
+        static::assertSame(6, $searchResult->getTotalCount());
+        static::assertSame(2, $searchResult->getLimit());
+        static::assertSame(2, $searchResult->getOffset());
+        static::assertSame(2, $searchResult->getPage());
+        static::assertSame(3, $searchResult->getLastPage());
+        static::assertFalse($searchResult->isFirstPage());
+        static::assertFalse($searchResult->isLastPage());
+    }
+
+    /** Create a SearchResult with offset and limit parameters displaying the last page */
+    public function testResultWithLimitAndOffsetLastPage(): void
+    {
+        $searchResult = SearchResult::getSearchResult(['a', 'b', 'c', 'd', 'e', 'f'], 4, 2);
+
+        static::assertSame([4 => 'e', 5 => 'f'], $searchResult->getBookmarks());
+        static::assertSame(2, $searchResult->getResultCount());
+        static::assertSame(6, $searchResult->getTotalCount());
+        static::assertSame(2, $searchResult->getLimit());
+        static::assertSame(4, $searchResult->getOffset());
+        static::assertSame(3, $searchResult->getPage());
+        static::assertSame(3, $searchResult->getLastPage());
+        static::assertFalse($searchResult->isFirstPage());
+        static::assertTrue($searchResult->isLastPage());
+    }
+
+    /** Create a SearchResult with offset and limit parameters out of bound (display the last page) */
+    public function testResultWithLimitAndOffsetOutOfBounds(): void
+    {
+        $searchResult = SearchResult::getSearchResult(['a', 'b', 'c', 'd', 'e', 'f'], 12, 2);
+
+        static::assertSame([4 => 'e', 5 => 'f'], $searchResult->getBookmarks());
+        static::assertSame(2, $searchResult->getResultCount());
+        static::assertSame(6, $searchResult->getTotalCount());
+        static::assertSame(2, $searchResult->getLimit());
+        static::assertSame(-2, $searchResult->getOffset());
+        static::assertSame(3, $searchResult->getPage());
+        static::assertSame(3, $searchResult->getLastPage());
+        static::assertFalse($searchResult->isFirstPage());
+        static::assertTrue($searchResult->isLastPage());
+    }
+
+    /** Create a SearchResult with offset and limit parameters out of bound (no result) */
+    public function testResultWithLimitAndOffsetOutOfBoundsNoResult(): void
+    {
+        $searchResult = SearchResult::getSearchResult(['a', 'b', 'c', 'd', 'e', 'f'], 12, 2, true);
+
+        static::assertSame([], $searchResult->getBookmarks());
+        static::assertSame(0, $searchResult->getResultCount());
+        static::assertSame(6, $searchResult->getTotalCount());
+        static::assertSame(2, $searchResult->getLimit());
+        static::assertSame(12, $searchResult->getOffset());
+        static::assertSame(7, $searchResult->getPage());
+        static::assertSame(3, $searchResult->getLastPage());
+        static::assertFalse($searchResult->isFirstPage());
+        static::assertFalse($searchResult->isLastPage());
+    }
+}
-- 
cgit v1.2.3