use BookStack\Entities\Models\Book;
use BookStack\Entities\Models\BookChild;
+use BookStack\Entities\Models\Bookshelf;
use BookStack\Entities\Repos\BookRepo;
use Tests\TestCase;
-use Tests\Uploads\UsesImages;
class BookTest extends TestCase
{
- use UsesImages;
-
public function test_create()
{
$book = Book::factory()->make([
]);
$resp = $this->asEditor()->get('/books');
- $resp->assertElementContains('a[href="' . url('/create-book') . '"]', 'Create New Book');
+ $this->withHtml($resp)->assertElementContains('a[href="' . url('/create-book') . '"]', 'Create New Book');
$resp = $this->get('/create-book');
- $resp->assertElementContains('form[action="' . url('/books') . '"][method="POST"]', 'Save Book');
+ $this->withHtml($resp)->assertElementContains('form[action="' . url('/books') . '"][method="POST"]', 'Save Book');
- $resp = $this->post('/books', $book->only('name', 'description'));
+ $resp = $this->post('/books', $book->only('name', 'description_html'));
$resp->assertRedirect('/books/my-first-book');
$resp = $this->get('/books/my-first-book');
'name' => 'My First Book',
]);
- $this->asEditor()->post('/books', $book->only('name', 'description'));
- $this->asEditor()->post('/books', $book->only('name', 'description'));
+ $this->asEditor()->post('/books', $book->only('name', 'description_html'));
+ $this->asEditor()->post('/books', $book->only('name', 'description_html'));
$books = Book::query()->where('name', '=', $book->name)
->orderBy('id', 'desc')
{
// Cheeky initial update to refresh slug
$this->asEditor()->post('books', [
- 'name' => 'My book with tags',
- 'description' => 'A book with tags',
- 'tags' => [
+ 'name' => 'My book with tags',
+ 'description_html' => '<p>A book with tags</p>',
+ 'tags' => [
[
'name' => 'Category',
'value' => 'Donkey Content',
public function test_update()
{
- /** @var Book $book */
- $book = Book::query()->first();
+ $book = $this->entities->book();
// Cheeky initial update to refresh slug
- $this->asEditor()->put($book->getUrl(), ['name' => $book->name . '5', 'description' => $book->description]);
+ $this->asEditor()->put($book->getUrl(), ['name' => $book->name . '5', 'description_html' => $book->description_html]);
$book->refresh();
$newName = $book->name . ' Updated';
- $newDesc = $book->description . ' with more content';
+ $newDesc = $book->description_html . '<p>with more content</p>';
$resp = $this->get($book->getUrl('/edit'));
$resp->assertSee($book->name);
- $resp->assertSee($book->description);
- $resp->assertElementContains('form[action="' . $book->getUrl() . '"]', 'Save Book');
+ $resp->assertSee($book->description_html);
+ $this->withHtml($resp)->assertElementContains('form[action="' . $book->getUrl() . '"]', 'Save Book');
- $resp = $this->put($book->getUrl(), ['name' => $newName, 'description' => $newDesc]);
+ $resp = $this->put($book->getUrl(), ['name' => $newName, 'description_html' => $newDesc]);
$resp->assertRedirect($book->getUrl() . '-updated');
$resp = $this->get($book->getUrl() . '-updated');
$resp->assertSee($newName);
- $resp->assertSee($newDesc);
+ $resp->assertSee($newDesc, false);
}
public function test_update_sets_tags()
{
- /** @var Book $book */
- $book = Book::query()->first();
+ $book = $this->entities->book();
$this->assertEquals(0, $book->tags()->count());
$this->assertTrue($book->deletions()->count() === 1);
$redirectReq = $this->get($deleteReq->baseResponse->headers->get('location'));
- $redirectReq->assertNotificationContains('Book Successfully Deleted');
+ $this->assertNotificationContains($redirectReq, 'Book Successfully Deleted');
}
public function test_cancel_on_create_page_leads_back_to_books_listing()
{
$resp = $this->asEditor()->get('/create-book');
- $resp->assertElementContains('form a[href="' . url('/books') . '"]', 'Cancel');
+ $this->withHtml($resp)->assertElementContains('form a[href="' . url('/books') . '"]', 'Cancel');
}
public function test_cancel_on_edit_book_page_leads_back_to_book()
{
- /** @var Book $book */
- $book = Book::query()->first();
+ $book = $this->entities->book();
$resp = $this->asEditor()->get($book->getUrl('/edit'));
- $resp->assertElementContains('form a[href="' . $book->getUrl() . '"]', 'Cancel');
+ $this->withHtml($resp)->assertElementContains('form a[href="' . $book->getUrl() . '"]', 'Cancel');
}
public function test_next_previous_navigation_controls_show_within_book_content()
{
- $book = Book::query()->first();
+ $book = $this->entities->book();
$chapter = $book->chapters->first();
$resp = $this->asEditor()->get($chapter->getUrl());
- $resp->assertElementContains('#sibling-navigation', 'Next');
- $resp->assertElementContains('#sibling-navigation', substr($chapter->pages[0]->name, 0, 20));
+ $this->withHtml($resp)->assertElementContains('#sibling-navigation', 'Next');
+ $this->withHtml($resp)->assertElementContains('#sibling-navigation', substr($chapter->pages[0]->name, 0, 20));
$resp = $this->get($chapter->pages[0]->getUrl());
- $resp->assertElementContains('#sibling-navigation', substr($chapter->pages[1]->name, 0, 20));
- $resp->assertElementContains('#sibling-navigation', 'Previous');
- $resp->assertElementContains('#sibling-navigation', substr($chapter->name, 0, 20));
+ $this->withHtml($resp)->assertElementContains('#sibling-navigation', substr($chapter->pages[1]->name, 0, 20));
+ $this->withHtml($resp)->assertElementContains('#sibling-navigation', 'Previous');
+ $this->withHtml($resp)->assertElementContains('#sibling-navigation', substr($chapter->name, 0, 20));
}
public function test_recently_viewed_books_updates_as_expected()
{
- $books = Book::all()->take(2);
+ $books = Book::take(2)->get();
- $this->asAdmin()->get('/books')
- ->assertElementNotContains('#recents', $books[0]->name)
+ $resp = $this->asAdmin()->get('/books');
+ $this->withHtml($resp)->assertElementNotContains('#recents', $books[0]->name)
->assertElementNotContains('#recents', $books[1]->name);
$this->get($books[0]->getUrl());
$this->get($books[1]->getUrl());
- $this->get('/books')
- ->assertElementContains('#recents', $books[0]->name)
+ $resp = $this->get('/books');
+ $this->withHtml($resp)->assertElementContains('#recents', $books[0]->name)
->assertElementContains('#recents', $books[1]->name);
}
public function test_popular_books_updates_upon_visits()
{
- $books = Book::all()->take(2);
+ $books = Book::take(2)->get();
- $this->asAdmin()->get('/books')
- ->assertElementNotContains('#popular', $books[0]->name)
+ $resp = $this->asAdmin()->get('/books');
+ $this->withHtml($resp)->assertElementNotContains('#popular', $books[0]->name)
->assertElementNotContains('#popular', $books[1]->name);
$this->get($books[0]->getUrl());
$this->get($books[1]->getUrl());
$this->get($books[0]->getUrl());
- $this->get('/books')
- ->assertElementContains('#popular .book:nth-child(1)', $books[0]->name)
+ $resp = $this->get('/books');
+ $this->withHtml($resp)->assertElementContains('#popular .book:nth-child(1)', $books[0]->name)
->assertElementContains('#popular .book:nth-child(2)', $books[1]->name);
}
public function test_books_view_shows_view_toggle_option()
{
/** @var Book $book */
- $editor = $this->getEditor();
+ $editor = $this->users->editor();
setting()->putUser($editor, 'books_view_type', 'list');
$resp = $this->actingAs($editor)->get('/books');
- $resp->assertElementContains('form[action$="/settings/users/' . $editor->id . '/switch-books-view"]', 'Grid View');
- $resp->assertElementExists('input[name="view_type"][value="grid"]');
+ $this->withHtml($resp)->assertElementContains('form[action$="/preferences/change-view/books"]', 'Grid View');
+ $this->withHtml($resp)->assertElementExists('button[name="view"][value="grid"]');
- $resp = $this->patch("/settings/users/{$editor->id}/switch-books-view", ['view_type' => 'grid']);
+ $resp = $this->patch("/preferences/change-view/books", ['view' => 'grid']);
$resp->assertRedirect();
$this->assertEquals('grid', setting()->getUser($editor, 'books_view_type'));
$resp = $this->actingAs($editor)->get('/books');
- $resp->assertElementContains('form[action$="/settings/users/' . $editor->id . '/switch-books-view"]', 'List View');
- $resp->assertElementExists('input[name="view_type"][value="list"]');
+ $this->withHtml($resp)->assertElementContains('form[action$="/preferences/change-view/books"]', 'List View');
+ $this->withHtml($resp)->assertElementExists('button[name="view"][value="list"]');
- $resp = $this->patch("/settings/users/{$editor->id}/switch-books-view", ['view_type' => 'list']);
+ $resp = $this->patch("/preferences/change-view/books", ['view_type' => 'list']);
$resp->assertRedirect();
$this->assertEquals('list', setting()->getUser($editor, 'books_view_type'));
}
public function test_slug_multi_byte_url_safe()
{
- $book = $this->newBook([
+ $book = $this->entities->newBook([
'name' => 'информация',
]);
- $this->assertEquals('informaciya', $book->slug);
+ $this->assertEquals('informaciia', $book->slug);
- $book = $this->newBook([
+ $book = $this->entities->newBook([
'name' => '¿Qué?',
]);
public function test_slug_format()
{
- $book = $this->newBook([
+ $book = $this->entities->newBook([
'name' => 'PartA / PartB / PartC',
]);
$this->assertEquals('parta-partb-partc', $book->slug);
}
+ public function test_description_limited_to_specific_html()
+ {
+ $book = $this->entities->book();
+
+ $input = '<h1>Test</h1><p id="abc" href="beans">Content<a href="#cat" target="_blank" data-a="b">a</a><section>Hello</section></p>';
+ $expected = '<p>Content<a href="#cat" target="_blank">a</a></p>';
+
+ $this->asEditor()->put($book->getUrl(), [
+ 'name' => $book->name,
+ 'description_html' => $input
+ ]);
+
+ $book->refresh();
+ $this->assertEquals($expected, $book->description_html);
+ }
+
+ public function test_show_view_displays_description_if_no_description_html_set()
+ {
+ $book = $this->entities->book();
+ $book->description_html = '';
+ $book->description = "My great\ndescription\n\nwith newlines";
+ $book->save();
+
+ $resp = $this->asEditor()->get($book->getUrl());
+ $resp->assertSee("<p>My great<br>\ndescription<br>\n<br>\nwith newlines</p>", false);
+ }
+
public function test_show_view_has_copy_button()
{
- /** @var Book $book */
- $book = Book::query()->first();
+ $book = $this->entities->book();
$resp = $this->asEditor()->get($book->getUrl());
- $resp->assertElementContains("a[href=\"{$book->getUrl('/copy')}\"]", 'Copy');
+ $this->withHtml($resp)->assertElementContains("a[href=\"{$book->getUrl('/copy')}\"]", 'Copy');
}
public function test_copy_view()
{
- /** @var Book $book */
- $book = Book::query()->first();
+ $book = $this->entities->book();
$resp = $this->asEditor()->get($book->getUrl('/copy'));
$resp->assertOk();
$resp->assertSee('Copy Book');
- $resp->assertElementExists("input[name=\"name\"][value=\"{$book->name}\"]");
+ $this->withHtml($resp)->assertElementExists("input[name=\"name\"][value=\"{$book->name}\"]");
}
public function test_copy()
$copy = Book::query()->where('name', '=', 'My copy book')->first();
$resp->assertRedirect($copy->getUrl());
- $this->assertEquals($book->getDirectChildren()->count(), $copy->getDirectChildren()->count());
+ $this->assertEquals($book->getDirectVisibleChildren()->count(), $copy->getDirectVisibleChildren()->count());
+
+ $this->get($copy->getUrl())->assertSee($book->description_html, false);
}
public function test_copy_does_not_copy_non_visible_content()
// Hide child content
/** @var BookChild $page */
- foreach ($book->getDirectChildren() as $child) {
- $child->restricted = true;
- $child->save();
- $this->regenEntityPermissions($child);
+ foreach ($book->getDirectVisibleChildren() as $child) {
+ $this->permissions->setEntityPermissions($child, [], []);
}
$this->asEditor()->post($book->getUrl('/copy'), ['name' => 'My copy book']);
/** @var Book $copy */
$copy = Book::query()->where('name', '=', 'My copy book')->first();
- $this->assertEquals(0, $copy->getDirectChildren()->count());
+ $this->assertEquals(0, $copy->getDirectVisibleChildren()->count());
}
public function test_copy_does_not_copy_pages_or_chapters_if_user_cant_create()
{
/** @var Book $book */
$book = Book::query()->whereHas('chapters')->whereHas('directPages')->whereHas('chapters')->first();
- $viewer = $this->getViewer();
- $this->giveUserPermissions($viewer, ['book-create-all']);
+ $viewer = $this->users->viewer();
+ $this->permissions->grantUserRolePermissions($viewer, ['book-create-all']);
$this->actingAs($viewer)->post($book->getUrl('/copy'), ['name' => 'My copy book']);
/** @var Book $copy */
public function test_copy_clones_cover_image_if_existing()
{
- /** @var Book $book */
- $book = Book::query()->first();
+ $book = $this->entities->book();
$bookRepo = $this->app->make(BookRepo::class);
- $coverImageFile = $this->getTestImage('cover.png');
+ $coverImageFile = $this->files->uploadedImage('cover.png');
$bookRepo->updateCoverImage($book, $coverImageFile);
$this->asEditor()->post($book->getUrl('/copy'), ['name' => 'My copy book']);
-
/** @var Book $copy */
$copy = Book::query()->where('name', '=', 'My copy book')->first();
$this->assertNotNull($copy->cover);
$this->assertNotEquals($book->cover->id, $copy->cover->id);
}
+
+ public function test_copy_adds_book_to_shelves_if_edit_permissions_allows()
+ {
+ /** @var Bookshelf $shelfA */
+ /** @var Bookshelf $shelfB */
+ [$shelfA, $shelfB] = Bookshelf::query()->take(2)->get();
+ $book = $this->entities->book();
+
+ $shelfA->appendBook($book);
+ $shelfB->appendBook($book);
+
+ $viewer = $this->users->viewer();
+ $this->permissions->grantUserRolePermissions($viewer, ['book-update-all', 'book-create-all', 'bookshelf-update-all']);
+ $this->permissions->setEntityPermissions($shelfB);
+
+
+ $this->asEditor()->post($book->getUrl('/copy'), ['name' => 'My copy book']);
+ /** @var Book $copy */
+ $copy = Book::query()->where('name', '=', 'My copy book')->first();
+
+ $this->assertTrue($copy->shelves()->where('id', '=', $shelfA->id)->exists());
+ $this->assertFalse($copy->shelves()->where('id', '=', $shelfB->id)->exists());
+ }
}