]> BookStack Code Mirror - bookstack/blob - tests/User/UserPreferencesTest.php
Converted md settings to localstorage, added preview resize
[bookstack] / tests / User / UserPreferencesTest.php
1 <?php
2
3 namespace Tests\User;
4
5 use Tests\TestCase;
6
7 class UserPreferencesTest extends TestCase
8 {
9     public function test_interface_shortcuts_updating()
10     {
11         $this->asEditor();
12
13         // View preferences with defaults
14         $resp = $this->get('/preferences/shortcuts');
15         $resp->assertSee('Interface Keyboard Shortcuts');
16
17         $html = $this->withHtml($resp);
18         $html->assertFieldHasValue('enabled', 'false');
19         $html->assertFieldHasValue('shortcut[home_view]', '1');
20
21         // Update preferences
22         $resp = $this->put('/preferences/shortcuts', [
23             'enabled' => 'true',
24             'shortcut' => ['home_view' => 'Ctrl + 1'],
25         ]);
26
27         $resp->assertRedirect('/preferences/shortcuts');
28         $resp->assertSessionHas('success', 'Shortcut preferences have been updated!');
29
30         // View updates to preferences page
31         $resp = $this->get('/preferences/shortcuts');
32         $html = $this->withHtml($resp);
33         $html->assertFieldHasValue('enabled', 'true');
34         $html->assertFieldHasValue('shortcut[home_view]', 'Ctrl + 1');
35     }
36
37     public function test_body_has_shortcuts_component_when_active()
38     {
39         $editor = $this->getEditor();
40         $this->actingAs($editor);
41
42         $this->withHtml($this->get('/'))->assertElementNotExists('body[component="shortcuts"]');
43
44         setting()->putUser($editor, 'ui-shortcuts-enabled', 'true');
45         $this->withHtml($this->get('/'))->assertElementExists('body[component="shortcuts"]');
46     }
47
48     public function test_update_sort_preference()
49     {
50         $editor = $this->getEditor();
51         $this->actingAs($editor);
52
53         $updateRequest = $this->patch('/preferences/change-sort/books', [
54             'sort'  => 'created_at',
55             'order' => 'desc',
56         ]);
57         $updateRequest->assertStatus(302);
58
59         $this->assertDatabaseHas('settings', [
60             'setting_key' => 'user:' . $editor->id . ':books_sort',
61             'value'       => 'created_at',
62         ]);
63         $this->assertDatabaseHas('settings', [
64             'setting_key' => 'user:' . $editor->id . ':books_sort_order',
65             'value'       => 'desc',
66         ]);
67         $this->assertEquals('created_at', setting()->getForCurrentUser('books_sort'));
68         $this->assertEquals('desc', setting()->getForCurrentUser('books_sort_order'));
69     }
70
71     public function test_update_sort_bad_entity_type_handled()
72     {
73         $editor = $this->getEditor();
74         $this->actingAs($editor);
75
76         $updateRequest = $this->patch('/preferences/change-sort/dogs', [
77             'sort'  => 'name',
78             'order' => 'asc',
79         ]);
80         $updateRequest->assertStatus(500);
81
82         $this->assertNotEmpty('name', setting()->getForCurrentUser('bookshelves_sort'));
83         $this->assertNotEmpty('asc', setting()->getForCurrentUser('bookshelves_sort_order'));
84     }
85
86     public function test_update_expansion_preference()
87     {
88         $editor = $this->getEditor();
89         $this->actingAs($editor);
90
91         $updateRequest = $this->patch('/preferences/change-expansion/home-details', ['expand' => 'true']);
92         $updateRequest->assertStatus(204);
93
94         $this->assertDatabaseHas('settings', [
95             'setting_key' => 'user:' . $editor->id . ':section_expansion#home-details',
96             'value'       => 'true',
97         ]);
98         $this->assertEquals(true, setting()->getForCurrentUser('section_expansion#home-details'));
99
100         $invalidKeyRequest = $this->patch('/preferences/change-expansion/my-home-details', ['expand' => 'true']);
101         $invalidKeyRequest->assertStatus(500);
102     }
103
104     public function test_toggle_dark_mode()
105     {
106         $home = $this->actingAs($this->getEditor())->get('/');
107         $home->assertSee('Dark Mode');
108         $this->withHtml($home)->assertElementNotExists('.dark-mode');
109
110         $this->assertEquals(false, setting()->getForCurrentUser('dark-mode-enabled', false));
111         $prefChange = $this->patch('/preferences/toggle-dark-mode');
112         $prefChange->assertRedirect();
113         $this->assertEquals(true, setting()->getForCurrentUser('dark-mode-enabled'));
114
115         $home = $this->actingAs($this->getEditor())->get('/');
116         $this->withHtml($home)->assertElementExists('.dark-mode');
117         $home->assertDontSee('Dark Mode');
118         $home->assertSee('Light Mode');
119     }
120
121     public function test_dark_mode_defaults_to_config_option()
122     {
123         config()->set('setting-defaults.user.dark-mode-enabled', false);
124         $this->assertEquals(false, setting()->getForCurrentUser('dark-mode-enabled'));
125         $home = $this->get('/login');
126         $this->withHtml($home)->assertElementNotExists('.dark-mode');
127
128         config()->set('setting-defaults.user.dark-mode-enabled', true);
129         $this->assertEquals(true, setting()->getForCurrentUser('dark-mode-enabled'));
130         $home = $this->get('/login');
131         $this->withHtml($home)->assertElementExists('.dark-mode');
132     }
133
134     public function test_books_view_type_preferences_when_list()
135     {
136         $editor = $this->getEditor();
137         setting()->putUser($editor, 'books_view_type', 'list');
138
139         $resp = $this->actingAs($editor)->get('/books');
140         $this->withHtml($resp)
141             ->assertElementNotExists('.featured-image-container')
142             ->assertElementExists('.content-wrap .entity-list-item');
143     }
144
145     public function test_books_view_type_preferences_when_grid()
146     {
147         $editor = $this->getEditor();
148         setting()->putUser($editor, 'books_view_type', 'grid');
149
150         $resp = $this->actingAs($editor)->get('/books');
151         $this->withHtml($resp)->assertElementExists('.featured-image-container');
152     }
153
154     public function test_shelf_view_type_change()
155     {
156         $editor = $this->getEditor();
157         $shelf = $this->entities->shelf();
158         setting()->putUser($editor, 'bookshelf_view_type', 'list');
159
160         $resp = $this->actingAs($editor)->get($shelf->getUrl())->assertSee('Grid View');
161         $this->withHtml($resp)
162             ->assertElementNotExists('.featured-image-container')
163             ->assertElementExists('.content-wrap .entity-list-item');
164
165         $req = $this->patch("/preferences/change-view/bookshelf", ['view' => 'grid']);
166         $req->assertRedirect($shelf->getUrl());
167
168         $resp = $this->actingAs($editor)->get($shelf->getUrl())
169             ->assertSee('List View');
170
171         $this->withHtml($resp)
172             ->assertElementExists('.featured-image-container')
173             ->assertElementNotExists('.content-wrap .entity-list-item');
174     }
175
176     public function test_update_code_language_favourite()
177     {
178         $editor = $this->getEditor();
179         $page = $this->entities->page();
180         $this->actingAs($editor);
181
182         $this->patch('/preferences/update-code-language-favourite', ['language' => 'php', 'active' => true]);
183         $this->patch('/preferences/update-code-language-favourite', ['language' => 'javascript', 'active' => true]);
184
185         $resp = $this->get($page->getUrl('/edit'));
186         $resp->assertSee('option:code-editor:favourites="php,javascript"', false);
187
188         $this->patch('/preferences/update-code-language-favourite', ['language' => 'ruby', 'active' => true]);
189         $this->patch('/preferences/update-code-language-favourite', ['language' => 'php', 'active' => false]);
190
191         $resp = $this->get($page->getUrl('/edit'));
192         $resp->assertSee('option:code-editor:favourites="javascript,ruby"', false);
193     }
194 }