]> git.immae.eu Git - github/shaarli/Shaarli.git/blobdiff - tests/utils/ReferenceLinkDB.php
add search highlight unit tests
[github/shaarli/Shaarli.git] / tests / utils / ReferenceLinkDB.php
index 1f4b306372e9a8dd4959d9e3636c39220ea01202..1f53dc3cd60337d2c6cbda01616ef88e7fad014b 100644 (file)
@@ -1,27 +1,65 @@
 <?php
+
+use Shaarli\Bookmark\Bookmark;
+use Shaarli\Bookmark\BookmarkArray;
+
 /**
- * Populates a reference datastore to test LinkDB
+ * Populates a reference datastore to test Bookmark
  */
 class ReferenceLinkDB
 {
-    public static $NB_LINKS_TOTAL = 8;
+    public static $NB_LINKS_TOTAL = 11;
 
-    private $_links = array();
+    private $bookmarks = array();
     private $_publicCount = 0;
     private $_privateCount = 0;
 
+    private $isLegacy;
+
     /**
      * Populates the test DB with reference data
+     *
+     * @param bool $isLegacy Use links as array instead of Bookmark object
      */
-    public function __construct()
+    public function __construct($isLegacy = false)
     {
+        $this->isLegacy = $isLegacy;
+        if (! $this->isLegacy) {
+            $this->bookmarks = new BookmarkArray();
+        }
+        $this->addLink(
+            11,
+            'Pined older',
+            '/shaare/PCRizQ',
+            'This is an older pinned link',
+            0,
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20100309_101010'),
+            '',
+            null,
+            'PCRizQ',
+            true
+        );
+
+        $this->addLink(
+            10,
+            'Pined',
+            '/shaare/0gCTjQ',
+            'This is a pinned link',
+            0,
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20121207_152312'),
+            '',
+            null,
+            '0gCTjQ',
+            true
+        );
+
         $this->addLink(
             41,
             'Link title: @website',
-            '?WDWyig',
+            '/shaare/WDWyig',
             'Stallman has a beard and is part of the Free Software Foundation (or not). Seriously, read this. #hashtag',
             0,
-            DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20150310_114651'),
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20150310_114651'),
             'sTuff',
             null,
             'WDWyig'
@@ -30,22 +68,32 @@ class ReferenceLinkDB
         $this->addLink(
             42,
             'Note: I have a big ID but an old date',
-            '?WDWyig',
-            'Used to test links reordering.',
+            '/shaare/WDWyig',
+            'Used to test bookmarks reordering.',
             0,
-            DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20100310_101010'),
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20100310_101010'),
             'ut'
         );
 
+        $this->addLink(
+            9,
+            'PSR-2: Coding Style Guide',
+            'http://www.php-fig.org/psr/psr-2/',
+            'This guide extends and expands on PSR-1, the basic coding standard.',
+            0,
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20121206_152312'),
+            'coding-style standards quality assurance'
+        );
+
         $this->addLink(
             8,
             'Free as in Freedom 2.0 @website',
             'https://static.fsf.org/nosvn/faif-2.0.pdf',
             'Richard Stallman and the Free Software Revolution. Read this. #hashtag',
             0,
-            DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20150310_114633'),
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20150310_114633'),
             'free gnu software stallman -exclude stuff hashtag',
-            DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20160803_093033')
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20160803_093033')
         );
 
         $this->addLink(
@@ -54,9 +102,9 @@ class ReferenceLinkDB
             'http://mediagoblin.org/',
             'A free software media publishing platform #hashtagOther',
             0,
-            DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20130614_184135'),
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20130614_184135'),
             'gnu media web .hidden hashtag',
-            DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20130615_184230'),
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20130615_184230'),
             'IuWvgA'
         );
 
@@ -66,7 +114,7 @@ class ReferenceLinkDB
             'https://dvcs.w3.org/hg/markup-validator/summary',
             'Mercurial repository for the W3C Validator #private',
             1,
-            DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20141125_084734'),
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20141125_084734'),
             'css html w3c web Mercurial'
         );
 
@@ -76,7 +124,7 @@ class ReferenceLinkDB
             'http://ars.userfriendly.org/cartoons/?id=20121206',
             'Naming conventions... #private',
             0,
-            DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20121206_142300'),
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20121206_142300'),
             'dev cartoon web'
         );
 
@@ -86,7 +134,7 @@ class ReferenceLinkDB
             'http://ars.userfriendly.org/cartoons/?id=20010306',
             'Tropical printing',
             0,
-            DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20121206_172539'),
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20121206_172539'),
             'samba cartoon web'
         );
 
@@ -96,7 +144,7 @@ class ReferenceLinkDB
             'http://geek-and-poke.com/',
             '',
             1,
-            DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20121206_182539'),
+            DateTime::createFromFormat(Bookmark::LINK_DATE_FORMAT, '20121206_182539'),
             'dev cartoon tag1  tag2   tag3  tag4   '
         );
     }
@@ -104,8 +152,18 @@ class ReferenceLinkDB
     /**
      * Adds a new link
      */
-    protected function addLink($id, $title, $url, $description, $private, $date, $tags, $updated = '', $shorturl = '')
-    {
+    protected function addLink(
+        $id,
+        $title,
+        $url,
+        $description,
+        $private,
+        $date,
+        $tags,
+        $updated = '',
+        $shorturl = '',
+        $pinned = false
+    ) {
         $link = array(
             'id' => $id,
             'title' => $title,
@@ -115,9 +173,15 @@ class ReferenceLinkDB
             'tags' => $tags,
             'created' => $date,
             'updated' => $updated,
-            'shorturl' => $shorturl ? $shorturl : smallHash($date->format(LinkDB::LINK_DATE_FORMAT) . $id),
+            'shorturl' => $shorturl ? $shorturl : smallHash($date->format(Bookmark::LINK_DATE_FORMAT) . $id),
+            'sticky' => $pinned
         );
-        $this->_links[$id] = $link;
+        if (! $this->isLegacy) {
+            $bookmark = new Bookmark();
+            $this->bookmarks[$id] = $bookmark->fromArray($link);
+        } else {
+            $this->bookmarks[$id] = $link;
+        }
 
         if ($private) {
             $this->_privateCount++;
@@ -131,14 +195,41 @@ class ReferenceLinkDB
      */
     public function write($filename)
     {
+        $this->reorder();
         file_put_contents(
             $filename,
-            '<?php /* '.base64_encode(gzdeflate(serialize($this->_links))).' */ ?>'
+            '<?php /* '.base64_encode(gzdeflate(serialize($this->bookmarks))).' */ ?>'
         );
     }
 
     /**
-     * Returns the number of links in the reference data
+     * Reorder links by creation date (newest first).
+     *
+     * @param string $order ASC|DESC
+     */
+    public function reorder($order = 'DESC')
+    {
+        if (! $this->isLegacy) {
+            $this->bookmarks->reorder($order);
+        } else {
+            $order = $order === 'ASC' ? -1 : 1;
+            // backward compatibility: ignore reorder if the the `created` field doesn't exist
+            if (! isset(array_values($this->bookmarks)[0]['created'])) {
+                return;
+            }
+
+            usort($this->bookmarks, function ($a, $b) use ($order) {
+                if (isset($a['sticky']) && isset($b['sticky']) && $a['sticky'] !== $b['sticky']) {
+                    return $a['sticky'] ? -1 : 1;
+                }
+
+                return $a['created'] < $b['created'] ? 1 * $order : -1 * $order;
+            });
+        }
+    }
+
+    /**
+     * Returns the number of bookmarks in the reference data
      */
     public function countLinks()
     {
@@ -146,7 +237,7 @@ class ReferenceLinkDB
     }
 
     /**
-     * Returns the number of public links in the reference data
+     * Returns the number of public bookmarks in the reference data
      */
     public function countPublicLinks()
     {
@@ -154,25 +245,46 @@ class ReferenceLinkDB
     }
 
     /**
-     * Returns the number of private links in the reference data
+     * Returns the number of private bookmarks in the reference data
      */
     public function countPrivateLinks()
     {
         return $this->_privateCount;
     }
 
+    /**
+     * Returns the number of bookmarks without tag
+     */
+    public function countUntaggedLinks()
+    {
+        $cpt = 0;
+        foreach ($this->bookmarks as $link) {
+            if (! $this->isLegacy) {
+                if (empty($link->getTags())) {
+                    ++$cpt;
+                }
+            } else {
+                if (empty($link['tags'])) {
+                    ++$cpt;
+                }
+            }
+        }
+        return $cpt;
+    }
+
     public function getLinks()
     {
-        return $this->_links;
+        $this->reorder();
+        return $this->bookmarks;
     }
 
     /**
      * Setter to override link creation.
      *
-     * @param array $links List of links.
+     * @param array $links List of bookmarks.
      */
     public function setLinks($links)
     {
-        $this->_links = $links;
+        $this->bookmarks = $links;
     }
 }