3 namespace Tests\Entity;
5 use BookStack\Actions\Tag;
6 use BookStack\Entities\Models\Book;
7 use BookStack\Entities\Models\Entity;
8 use BookStack\Entities\Models\Page;
11 class TagTest extends TestCase
13 protected $defaultTagCount = 20;
16 * Get an instance of a page that has many tags.
18 protected function getEntityWithTags($class, ?array $tags = null): Entity
20 $entity = $class::first();
23 $tags = Tag::factory()->count($this->defaultTagCount)->make();
26 $entity->tags()->saveMany($tags);
31 public function test_tag_name_suggestions()
33 // Create some tags with similar names to test with
35 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'country']));
36 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'color']));
37 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'city']));
38 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'county']));
39 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'planet']));
40 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'plans']));
41 $page = $this->getEntityWithTags(Page::class, $attrs->all());
43 $this->asAdmin()->get('/ajax/tags/suggest/names?search=dog')->assertSimilarJson([]);
44 $this->get('/ajax/tags/suggest/names?search=co')->assertSimilarJson(['color', 'country', 'county']);
45 $this->get('/ajax/tags/suggest/names?search=cou')->assertSimilarJson(['country', 'county']);
46 $this->get('/ajax/tags/suggest/names?search=pla')->assertSimilarJson(['planet', 'plans']);
49 public function test_tag_value_suggestions()
51 // Create some tags with similar values to test with
53 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'country', 'value' => 'cats']));
54 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'color', 'value' => 'cattery']));
55 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'city', 'value' => 'castle']));
56 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'county', 'value' => 'dog']));
57 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'planet', 'value' => 'catapult']));
58 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'plans', 'value' => 'dodgy']));
59 $page = $this->getEntityWithTags(Page::class, $attrs->all());
61 $this->asAdmin()->get('/ajax/tags/suggest/values?search=ora')->assertSimilarJson([]);
62 $this->get('/ajax/tags/suggest/values?search=cat')->assertSimilarJson(['cats', 'cattery', 'catapult']);
63 $this->get('/ajax/tags/suggest/values?search=do')->assertSimilarJson(['dog', 'dodgy']);
64 $this->get('/ajax/tags/suggest/values?search=cas')->assertSimilarJson(['castle']);
67 public function test_entity_permissions_effect_tag_suggestions()
69 // Create some tags with similar names to test with and save to a page
71 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'country']));
72 $attrs = $attrs->merge(Tag::factory()->count(5)->make(['name' => 'color']));
73 $page = $this->getEntityWithTags(Page::class, $attrs->all());
75 $this->asAdmin()->get('/ajax/tags/suggest/names?search=co')->assertSimilarJson(['color', 'country']);
76 $this->asEditor()->get('/ajax/tags/suggest/names?search=co')->assertSimilarJson(['color', 'country']);
78 // Set restricted permission the page
79 $page->restricted = true;
81 $page->rebuildPermissions();
83 $this->asAdmin()->get('/ajax/tags/suggest/names?search=co')->assertSimilarJson(['color', 'country']);
84 $this->asEditor()->get('/ajax/tags/suggest/names?search=co')->assertSimilarJson([]);
87 public function test_tags_shown_on_search_listing()
90 Tag::factory()->make(['name' => 'category', 'value' => 'buckets']),
91 Tag::factory()->make(['name' => 'color', 'value' => 'red']),
94 $page = $this->getEntityWithTags(Page::class, $tags);
95 $resp = $this->asEditor()->get('/search?term=[category]');
96 $resp->assertSee($page->name);
97 $resp->assertElementContains('[href="' . $page->getUrl() . '"]', 'category');
98 $resp->assertElementContains('[href="' . $page->getUrl() . '"]', 'buckets');
99 $resp->assertElementContains('[href="' . $page->getUrl() . '"]', 'color');
100 $resp->assertElementContains('[href="' . $page->getUrl() . '"]', 'red');
103 public function test_tags_index_shows_tag_name_as_expected_with_right_counts()
105 /** @var Page $page */
106 $page = Page::query()->first();
107 $page->tags()->create(['name' => 'Category', 'value' => 'GreatTestContent']);
108 $page->tags()->create(['name' => 'Category', 'value' => 'OtherTestContent']);
110 $resp = $this->asEditor()->get('/tags');
111 $resp->assertSee('Category');
112 $resp->assertElementCount('.tag-item', 1);
113 $resp->assertDontSee('GreatTestContent');
114 $resp->assertDontSee('OtherTestContent');
115 $resp->assertElementContains('a[title="Total tag usages"]', '2');
116 $resp->assertElementContains('a[title="Assigned to Pages"]', '2');
117 $resp->assertElementContains('a[title="Assigned to Books"]', '0');
118 $resp->assertElementContains('a[title="Assigned to Chapters"]', '0');
119 $resp->assertElementContains('a[title="Assigned to Shelves"]', '0');
120 $resp->assertElementContains('a[href$="/tags?name=Category"]', '2 unique values');
122 /** @var Book $book */
123 $book = Book::query()->first();
124 $book->tags()->create(['name' => 'Category', 'value' => 'GreatTestContent']);
125 $resp = $this->asEditor()->get('/tags');
126 $resp->assertElementContains('a[title="Total tag usages"]', '3');
127 $resp->assertElementContains('a[title="Assigned to Books"]', '1');
128 $resp->assertElementContains('a[href$="/tags?name=Category"]', '2 unique values');
131 public function test_tag_index_can_be_searched()
133 /** @var Page $page */
134 $page = Page::query()->first();
135 $page->tags()->create(['name' => 'Category', 'value' => 'GreatTestContent']);
137 $resp = $this->asEditor()->get('/tags?search=cat');
138 $resp->assertElementContains('.tag-item .tag-name', 'Category');
140 $resp = $this->asEditor()->get('/tags?search=content');
141 $resp->assertElementContains('.tag-item .tag-name', 'Category');
142 $resp->assertElementContains('.tag-item .tag-value', 'GreatTestContent');
144 $resp = $this->asEditor()->get('/tags?search=other');
145 $resp->assertElementNotExists('.tag-item .tag-name');
148 public function test_tag_index_can_be_scoped_to_specific_tag_name()
150 /** @var Page $page */
151 $page = Page::query()->first();
152 $page->tags()->create(['name' => 'Category', 'value' => 'GreatTestContent']);
153 $page->tags()->create(['name' => 'Category', 'value' => 'OtherTestContent']);
154 $page->tags()->create(['name' => 'OtherTagName', 'value' => 'OtherValue']);
156 $resp = $this->asEditor()->get('/tags?name=Category');
157 $resp->assertSee('Category');
158 $resp->assertSee('GreatTestContent');
159 $resp->assertSee('OtherTestContent');
160 $resp->assertDontSee('OtherTagName');
161 $resp->assertElementCount('table .tag-item', 2);
162 $resp->assertSee('Active Filter:');
163 $resp->assertElementContains('form[action$="/tags"]', 'Clear Filter');
166 public function test_tags_index_adheres_to_page_permissions()
168 /** @var Page $page */
169 $page = Page::query()->first();
170 $page->tags()->create(['name' => 'SuperCategory', 'value' => 'GreatTestContent']);
172 $resp = $this->asEditor()->get('/tags');
173 $resp->assertSee('SuperCategory');
174 $resp = $this->get('/tags?name=SuperCategory');
175 $resp->assertSee('GreatTestContent');
177 $page->restricted = true;
178 $this->regenEntityPermissions($page);
180 $resp = $this->asEditor()->get('/tags');
181 $resp->assertDontSee('SuperCategory');
182 $resp = $this->get('/tags?name=SuperCategory');
183 $resp->assertDontSee('GreatTestContent');
186 public function test_tag_index_shows_message_on_no_results()
188 /** @var Page $page */
189 $resp = $this->asEditor()->get('/tags?search=testingval');
190 $resp->assertSee('No items available');
191 $resp->assertSee('Tags can be assigned via the page editor sidebar');