3 namespace Shaarli\Bookmark
;
5 use PHPUnit\Framework\TestCase
;
6 use Shaarli\Bookmark\Exception\InvalidBookmarkException
;
11 class BookmarkTest
extends TestCase
14 * Test fromArray() with a link with full data
16 public function testFromArrayFull()
21 'url' => 'https://domain.tld/oof.html?param=value#anchor',
22 'title' => 'This is an array link',
23 'description' => 'HTML desc<br><p>hi!</p>',
24 'thumbnail' => 'https://domain.tld/pic.png',
26 'created' => new \
DateTime('-1 minute'),
27 'tags' => ['tag1', 'tag2', 'chair'],
28 'updated' => new \
DateTime(),
32 $bookmark = (new Bookmark())->fromArray($data);
33 $this->assertEquals($data['id'], $bookmark->getId());
34 $this->assertEquals($data['shorturl'], $bookmark->getShortUrl());
35 $this->assertEquals($data['url'], $bookmark->getUrl());
36 $this->assertEquals($data['title'], $bookmark->getTitle());
37 $this->assertEquals($data['description'], $bookmark->getDescription());
38 $this->assertEquals($data['thumbnail'], $bookmark->getThumbnail());
39 $this->assertEquals($data['sticky'], $bookmark->isSticky());
40 $this->assertEquals($data['created'], $bookmark->getCreated());
41 $this->assertEquals($data['tags'], $bookmark->getTags());
42 $this->assertEquals('tag1 tag2 chair', $bookmark->getTagsString());
43 $this->assertEquals($data['updated'], $bookmark->getUpdated());
44 $this->assertEquals($data['private'], $bookmark->isPrivate());
45 $this->assertFalse($bookmark->isNote());
49 * Test fromArray() with a link with minimal data.
50 * Note that I use null values everywhere but this should not happen in the real world.
52 public function testFromArrayMinimal()
59 'description' => null,
65 $bookmark = (new Bookmark())->fromArray($data);
66 $this->assertNull($bookmark->getId());
67 $this->assertNull($bookmark->getShortUrl());
68 $this->assertNull($bookmark->getUrl());
69 $this->assertNull($bookmark->getTitle());
70 $this->assertEquals('', $bookmark->getDescription());
71 $this->assertNull($bookmark->getCreated());
72 $this->assertEquals([], $bookmark->getTags());
73 $this->assertEquals('', $bookmark->getTagsString());
74 $this->assertNull($bookmark->getUpdated());
75 $this->assertFalse($bookmark->getThumbnail());
76 $this->assertFalse($bookmark->isSticky());
77 $this->assertFalse($bookmark->isPrivate());
78 $this->assertTrue($bookmark->isNote());
82 * Test validate() with a valid minimal bookmark
84 public function testValidateValidFullBookmark()
86 $bookmark = new Bookmark();
88 $bookmark->setShortUrl('abc');
89 $bookmark->setCreated($date = \DateTime
::createFromFormat('Ymd_His', '20190514_200102'));
90 $bookmark->setUpdated($dateUp = \DateTime
::createFromFormat('Ymd_His', '20190514_210203'));
91 $bookmark->setUrl($url = 'https://domain.tld/oof.html?param=value#anchor');
92 $bookmark->setTitle($title = 'This is an array link');
93 $bookmark->setDescription($desc = 'HTML desc<br><p>hi!</p>');
94 $bookmark->setTags($tags = ['tag1', 'tag2', 'chair']);
95 $bookmark->setThumbnail($thumb = 'https://domain.tld/pic.png');
96 $bookmark->setPrivate(true);
97 $bookmark->validate();
99 $this->assertEquals(2, $bookmark->getId());
100 $this->assertEquals('abc', $bookmark->getShortUrl());
101 $this->assertEquals($date, $bookmark->getCreated());
102 $this->assertEquals($dateUp, $bookmark->getUpdated());
103 $this->assertEquals($url, $bookmark->getUrl());
104 $this->assertEquals($title, $bookmark->getTitle());
105 $this->assertEquals($desc, $bookmark->getDescription());
106 $this->assertEquals($tags, $bookmark->getTags());
107 $this->assertEquals(implode(' ', $tags), $bookmark->getTagsString());
108 $this->assertEquals($thumb, $bookmark->getThumbnail());
109 $this->assertTrue($bookmark->isPrivate());
110 $this->assertFalse($bookmark->isNote());
114 * Test validate() with a valid minimal bookmark
116 public function testValidateValidMinimalBookmark()
118 $bookmark = new Bookmark();
120 $bookmark->setShortUrl('abc');
121 $bookmark->setCreated($date = \DateTime
::createFromFormat('Ymd_His', '20190514_200102'));
122 $bookmark->validate();
124 $this->assertEquals(1, $bookmark->getId());
125 $this->assertEquals('abc', $bookmark->getShortUrl());
126 $this->assertEquals($date, $bookmark->getCreated());
127 $this->assertEquals('/shaare/abc', $bookmark->getUrl());
128 $this->assertEquals('/shaare/abc', $bookmark->getTitle());
129 $this->assertEquals('', $bookmark->getDescription());
130 $this->assertEquals([], $bookmark->getTags());
131 $this->assertEquals('', $bookmark->getTagsString());
132 $this->assertFalse($bookmark->getThumbnail());
133 $this->assertFalse($bookmark->isPrivate());
134 $this->assertTrue($bookmark->isNote());
135 $this->assertNull($bookmark->getUpdated());
139 * Test validate() with a a bookmark without ID.
141 public function testValidateNotValidNoId()
143 $bookmark = new Bookmark();
144 $bookmark->setShortUrl('abc');
145 $bookmark->setCreated(\DateTime
::createFromFormat('Ymd_His', '20190514_200102'));
148 $bookmark->validate();
149 } catch (InvalidBookmarkException
$e) {
152 $this->assertNotNull($exception);
153 $this->assertContains('- ID: '. PHP_EOL
, $exception->getMessage());
157 * Test validate() with a a bookmark with a non integer ID.
159 public function testValidateNotValidStringId()
161 $bookmark = new Bookmark();
162 $bookmark->setId('str');
163 $bookmark->setShortUrl('abc');
164 $bookmark->setCreated(\DateTime
::createFromFormat('Ymd_His', '20190514_200102'));
167 $bookmark->validate();
168 } catch (InvalidBookmarkException
$e) {
171 $this->assertNotNull($exception);
172 $this->assertContains('- ID: str'. PHP_EOL
, $exception->getMessage());
176 * Test validate() with a a bookmark without short url.
178 public function testValidateNotValidNoShortUrl()
180 $bookmark = new Bookmark();
182 $bookmark->setCreated(\DateTime
::createFromFormat('Ymd_His', '20190514_200102'));
183 $bookmark->setShortUrl(null);
186 $bookmark->validate();
187 } catch (InvalidBookmarkException
$e) {
190 $this->assertNotNull($exception);
191 $this->assertContains('- ShortUrl: '. PHP_EOL
, $exception->getMessage());
195 * Test validate() with a a bookmark without created datetime.
197 public function testValidateNotValidNoCreated()
199 $bookmark = new Bookmark();
201 $bookmark->setShortUrl('abc');
202 $bookmark->setCreated(null);
205 $bookmark->validate();
206 } catch (InvalidBookmarkException
$e) {
209 $this->assertNotNull($exception);
210 $this->assertContains('- Created: '. PHP_EOL
, $exception->getMessage());
214 * Test validate() with a a bookmark with a bad created datetime.
216 public function testValidateNotValidBadCreated()
218 $bookmark = new Bookmark();
220 $bookmark->setShortUrl('abc');
221 $bookmark->setCreated('hi!');
224 $bookmark->validate();
225 } catch (InvalidBookmarkException
$e) {
228 $this->assertNotNull($exception);
229 $this->assertContains('- Created: Not a DateTime object'. PHP_EOL
, $exception->getMessage());
233 * Test setId() and make sure that default fields are generated.
235 public function testSetIdEmptyGeneratedFields()
237 $bookmark = new Bookmark();
240 $this->assertEquals(2, $bookmark->getId());
241 $this->assertRegExp('/[\w\-]{6}/', $bookmark->getShortUrl());
242 $this->assertTrue(new \
DateTime('5 seconds ago') < $bookmark->getCreated());
246 * Test setId() and with generated fields already set.
248 public function testSetIdSetGeneratedFields()
250 $bookmark = new Bookmark();
251 $bookmark->setShortUrl('abc');
252 $bookmark->setCreated($date = \DateTime
::createFromFormat('Ymd_His', '20190514_200102'));
255 $this->assertEquals(2, $bookmark->getId());
256 $this->assertEquals('abc', $bookmark->getShortUrl());
257 $this->assertEquals($date, $bookmark->getCreated());
261 * Test setUrl() and make sure it accepts custom protocols
263 public function testGetUrlWithValidProtocols()
265 $bookmark = new Bookmark();
266 $bookmark->setUrl($url = 'myprotocol://helloworld', ['myprotocol']);
267 $this->assertEquals($url, $bookmark->getUrl());
269 $bookmark->setUrl($url = 'https://helloworld.tld', ['myprotocol']);
270 $this->assertEquals($url, $bookmark->getUrl());
274 * Test setUrl() and make sure it accepts custom protocols
276 public function testGetUrlWithNotValidProtocols()
278 $bookmark = new Bookmark();
279 $bookmark->setUrl('myprotocol://helloworld', []);
280 $this->assertEquals('http://helloworld', $bookmark->getUrl());
282 $bookmark->setUrl($url = 'https://helloworld.tld', []);
283 $this->assertEquals($url, $bookmark->getUrl());
287 * Test setTagsString() with exotic data
289 public function testSetTagsString()
291 $bookmark = new Bookmark();
293 $str = 'tag1 tag2 tag3.tag3-2, tag4 , -tag5 ';
294 $bookmark->setTagsString($str);
308 * Test setTags() with exotic data
310 public function testSetTags()
312 $bookmark = new Bookmark();
322 $bookmark->setTags($array);
338 public function testRenameTag()
340 $bookmark = new Bookmark();
341 $bookmark->setTags(['tag1', 'tag2', 'chair']);
342 $bookmark->renameTag('chair', 'table');
343 $this->assertEquals(['tag1', 'tag2', 'table'], $bookmark->getTags());
344 $bookmark->renameTag('tag1', 'tag42');
345 $this->assertEquals(['tag42', 'tag2', 'table'], $bookmark->getTags());
346 $bookmark->renameTag('tag42', 'tag43');
347 $this->assertEquals(['tag43', 'tag2', 'table'], $bookmark->getTags());
348 $bookmark->renameTag('table', 'desk');
349 $this->assertEquals(['tag43', 'tag2', 'desk'], $bookmark->getTags());
353 * Test renameTag() with a tag that is not present in the bookmark
355 public function testRenameTagNotExists()
357 $bookmark = new Bookmark();
358 $bookmark->setTags(['tag1', 'tag2', 'chair']);
359 $bookmark->renameTag('nope', 'table');
360 $this->assertEquals(['tag1', 'tag2', 'chair'], $bookmark->getTags());
366 public function testDeleteTag()
368 $bookmark = new Bookmark();
369 $bookmark->setTags(['tag1', 'tag2', 'chair']);
370 $bookmark->deleteTag('chair');
371 $this->assertEquals(['tag1', 'tag2'], $bookmark->getTags());
372 $bookmark->deleteTag('tag1');
373 $this->assertEquals(['tag2'], $bookmark->getTags());
374 $bookmark->deleteTag('tag2');
375 $this->assertEquals([], $bookmark->getTags());
379 * Test deleteTag() with a tag that is not present in the bookmark
381 public function testDeleteTagNotExists()
383 $bookmark = new Bookmark();
384 $bookmark->setTags(['tag1', 'tag2', 'chair']);
385 $bookmark->deleteTag('nope');
386 $this->assertEquals(['tag1', 'tag2', 'chair'], $bookmark->getTags());