BookStack Code Mirror - bookstack/blob - tests/Entity/BookDefaultTemplateTest.php

   1 <?php
   2
   3 namespace Tests\Entity;
   4
   5 use BookStack\Entities\Models\Book;
   6 use BookStack\Entities\Models\Page;
   7 use Tests\TestCase;
   8
   9 class BookDefaultTemplateTest extends TestCase
  10 {
  11     public function test_creating_book_with_default_template()
  12     {
  13         $templatePage = $this->entities->templatePage();
  14         $details = [
  15             'name' => 'My book with default template',
  16             'default_template_id' => $templatePage->id,
  17         ];
  18
  19         $this->asEditor()->post('/books', $details);
  20         $this->assertDatabaseHas('books', $details);
  21     }
  22
  23     public function test_updating_book_with_default_template()
  24     {
  25         $book = $this->entities->book();
  26         $templatePage = $this->entities->templatePage();
  27
  28         $this->asEditor()->put("/books/{$book->slug}", ['name' => $book->name, 'default_template_id' => strval($templatePage->id)]);
  29         $this->assertDatabaseHas('books', ['id' => $book->id, 'default_template_id' => $templatePage->id]);
  30
  31         $this->asEditor()->put("/books/{$book->slug}", ['name' => $book->name, 'default_template_id' => '']);
  32         $this->assertDatabaseHas('books', ['id' => $book->id, 'default_template_id' => null]);
  33     }
  34
  35     public function test_default_template_cannot_be_set_if_not_a_template()
  36     {
  37         $book = $this->entities->book();
  38         $page = $this->entities->page();
  39         $this->assertFalse($page->template);
  40
  41         $this->asEditor()->put("/books/{$book->slug}", ['name' => $book->name, 'default_template_id' => $page->id]);
  42         $this->assertDatabaseHas('books', ['id' => $book->id, 'default_template_id' => null]);
  43     }
  44
  45     public function test_default_template_cannot_be_set_if_not_have_access()
  46     {
  47         $book = $this->entities->book();
  48         $templatePage = $this->entities->templatePage();
  49         $this->permissions->disableEntityInheritedPermissions($templatePage);
  50
  51         $this->asEditor()->put("/books/{$book->slug}", ['name' => $book->name, 'default_template_id' => $templatePage->id]);
  52         $this->assertDatabaseHas('books', ['id' => $book->id, 'default_template_id' => null]);
  53     }
  54
  55     public function test_inaccessible_default_template_can_be_set_if_unchanged()
  56     {
  57         $templatePage = $this->entities->templatePage();
  58         $book = $this->bookUsingDefaultTemplate($templatePage);
  59         $this->permissions->disableEntityInheritedPermissions($templatePage);
  60
  61         $this->asEditor()->put("/books/{$book->slug}", ['name' => $book->name, 'default_template_id' => $templatePage->id]);
  62         $this->assertDatabaseHas('books', ['id' => $book->id, 'default_template_id' => $templatePage->id]);
  63     }
  64
  65     public function test_default_page_template_option_shows_on_book_form()
  66     {
  67         $templatePage = $this->entities->templatePage();
  68         $book = $this->bookUsingDefaultTemplate($templatePage);
  69
  70         $resp = $this->asEditor()->get($book->getUrl('/edit'));
  71         $this->withHtml($resp)->assertElementExists('input[name="default_template_id"][value="' . $templatePage->id . '"]');
  72     }
  73
  74     public function test_default_page_template_option_only_shows_template_name_if_visible()
  75     {
  76         $templatePage = $this->entities->templatePage();
  77         $book = $this->bookUsingDefaultTemplate($templatePage);
  78
  79         $resp = $this->asEditor()->get($book->getUrl('/edit'));
  80         $this->withHtml($resp)->assertElementContains('#template-control a.text-page', "#{$templatePage->id}, {$templatePage->name}");
  81
  82         $this->permissions->disableEntityInheritedPermissions($templatePage);
  83
  84         $resp = $this->asEditor()->get($book->getUrl('/edit'));
  85         $this->withHtml($resp)->assertElementNotContains('#template-control a.text-page', "#{$templatePage->id}, {$templatePage->name}");
  86         $this->withHtml($resp)->assertElementContains('#template-control a.text-page', "#{$templatePage->id}");
  87     }
  88
  89     public function test_creating_book_page_uses_default_template()
  90     {
  91         $templatePage = $this->entities->templatePage();
  92         $templatePage->forceFill(['html' => '<p>My template page</p>', 'markdown' => '# My template page'])->save();
  93         $book = $this->bookUsingDefaultTemplate($templatePage);
  94
  95         $this->asEditor()->get($book->getUrl('/create-page'));
  96         $latestPage = $book->pages()
  97             ->where('draft', '=', true)
  98             ->where('template', '=', false)
  99             ->latest()->first();
 100
 101         $this->assertEquals('<p>My template page</p>', $latestPage->html);
 102         $this->assertEquals('# My template page', $latestPage->markdown);
 103     }
 104
 105     public function test_creating_chapter_page_uses_default_template()
 106     {
 107         $templatePage = $this->entities->templatePage();
 108         $templatePage->forceFill(['html' => '<p>My template page in chapter</p>', 'markdown' => '# My template page in chapter'])->save();
 109         $book = $this->bookUsingDefaultTemplate($templatePage);
 110         $chapter = $book->chapters()->first();
 111
 112         $this->asEditor()->get($chapter->getUrl('/create-page'));
 113         $latestPage = $chapter->pages()
 114             ->where('draft', '=', true)
 115             ->where('template', '=', false)
 116             ->latest()->first();
 117
 118         $this->assertEquals('<p>My template page in chapter</p>', $latestPage->html);
 119         $this->assertEquals('# My template page in chapter', $latestPage->markdown);
 120     }
 121
 122     public function test_creating_book_page_as_guest_uses_default_template()
 123     {
 124         $templatePage = $this->entities->templatePage();
 125         $templatePage->forceFill(['html' => '<p>My template page</p>', 'markdown' => '# My template page'])->save();
 126         $book = $this->bookUsingDefaultTemplate($templatePage);
 127         $guest = $this->users->guest();
 128
 129         $this->permissions->makeAppPublic();
 130         $this->permissions->grantUserRolePermissions($guest, ['page-create-all', 'page-update-all']);
 131
 132         $resp = $this->post($book->getUrl('/create-guest-page'), [
 133             'name' => 'My guest page with template'
 134         ]);
 135         $latestPage = $book->pages()
 136             ->where('draft', '=', false)
 137             ->where('template', '=', false)
 138             ->where('created_by', '=', $guest->id)
 139             ->latest()->first();
 140
 141         $this->assertEquals('<p>My template page</p>', $latestPage->html);
 142         $this->assertEquals('# My template page', $latestPage->markdown);
 143     }
 144
 145     public function test_creating_book_page_does_not_use_template_if_not_visible()
 146     {
 147         $templatePage = $this->entities->templatePage();
 148         $templatePage->forceFill(['html' => '<p>My template page</p>', 'markdown' => '# My template page'])->save();
 149         $book = $this->bookUsingDefaultTemplate($templatePage);
 150         $this->permissions->disableEntityInheritedPermissions($templatePage);
 151
 152         $this->asEditor()->get($book->getUrl('/create-page'));
 153         $latestPage = $book->pages()
 154             ->where('draft', '=', true)
 155             ->where('template', '=', false)
 156             ->latest()->first();
 157
 158         $this->assertEquals('', $latestPage->html);
 159         $this->assertEquals('', $latestPage->markdown);
 160     }
 161
 162     public function test_template_page_delete_removes_book_template_usage()
 163     {
 164         $templatePage = $this->entities->templatePage();
 165         $book = $this->bookUsingDefaultTemplate($templatePage);
 166
 167         $book->refresh();
 168         $this->assertEquals($templatePage->id, $book->default_template_id);
 169
 170         $this->asEditor()->delete($templatePage->getUrl());
 171         $this->asAdmin()->post('/settings/recycle-bin/empty');
 172
 173         $book->refresh();
 174         $this->assertEquals(null, $book->default_template_id);
 175     }
 176
 177     protected function bookUsingDefaultTemplate(Page $page): Book
 178     {
 179         $book = $this->entities->book();
 180         $book->default_template_id = $page->id;
 181         $book->save();
 182
 183         return $book;
 184     }
 185 }