Sorting: Split out test class, added book autosort tests

Just for test view, actual functionality of autosort on change still
needs to be tested.

diff --git a/app/Sorting/BookSorter.php b/app/Sorting/BookSorter.php
index fd99a8d37817155db729b2db9c7d749c78473931..b6fe33b9c3e905c1221ec4616a7ae6e3a147ebdd 100644 (file)
--- a/app/Sorting/BookSorter.php
+++ b/app/Sorting/BookSorter.php
@@ -42,7 +42,7 @@ class BookSorter
         }, $set->getOperations());
 
         $chapters = $book->chapters()
-            ->with('pages:id,name,priority,created_at,updated_at')
+            ->with('pages:id,name,priority,created_at,updated_at,chapter_id')
             ->get(['id', 'name', 'priority', 'created_at', 'updated_at']);
 
         /** @var (Chapter|Book)[] $topItems */

diff --git a/tests/Entity/SortTest.php b/tests/Sorting/BookSortTest.php
similarity index 51%
rename from tests/Entity/SortTest.php
rename to tests/Sorting/BookSortTest.php
index 9a5a2fe175a43ed0a2bbdd614f60b106ebdd9bb4..a726da148985d6094deb10b5d48a44a195f0c94d 100644 (file)
--- a/tests/Entity/SortTest.php
+++ b/tests/Sorting/BookSortTest.php
@@ -1,15 +1,27 @@
 <?php
 
-namespace Tests\Entity;
+namespace Sorting;
 
-use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Chapter;
 use BookStack\Entities\Models\Page;
 use BookStack\Entities\Repos\PageRepo;
+use BookStack\Sorting\SortSet;
 use Tests\TestCase;
 
-class SortTest extends TestCase
+class BookSortTest extends TestCase
 {
+    public function test_book_sort_page_shows()
+    {
+        $bookToSort = $this->entities->book();
+
+        $resp = $this->asAdmin()->get($bookToSort->getUrl());
+        $this->withHtml($resp)->assertElementExists('a[href="' . $bookToSort->getUrl('/sort') . '"]');
+
+        $resp = $this->get($bookToSort->getUrl('/sort'));
+        $resp->assertStatus(200);
+        $resp->assertSee($bookToSort->name);
+    }
+
     public function test_drafts_do_not_show_up()
     {
         $this->asAdmin();
@@ -20,232 +32,10 @@ class SortTest extends TestCase
         $resp = $this->get($book->getUrl());
         $resp->assertSee($draft->name);
 
-        $resp = $this->get($book->getUrl() . '/sort');
+        $resp = $this->get($book->getUrl('/sort'));
         $resp->assertDontSee($draft->name);
     }
 
-    public function test_page_move_into_book()
-    {
-        $page = $this->entities->page();
-        $currentBook = $page->book;
-        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
-
-        $resp = $this->asEditor()->get($page->getUrl('/move'));
-        $resp->assertSee('Move Page');
-
-        $movePageResp = $this->put($page->getUrl('/move'), [
-            'entity_selection' => 'book:' . $newBook->id,
-        ]);
-        $page->refresh();
-
-        $movePageResp->assertRedirect($page->getUrl());
-        $this->assertTrue($page->book->id == $newBook->id, 'Page book is now the new book');
-
-        $newBookResp = $this->get($newBook->getUrl());
-        $newBookResp->assertSee('moved page');
-        $newBookResp->assertSee($page->name);
-    }
-
-    public function test_page_move_into_chapter()
-    {
-        $page = $this->entities->page();
-        $currentBook = $page->book;
-        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
-        $newChapter = $newBook->chapters()->first();
-
-        $movePageResp = $this->actingAs($this->users->editor())->put($page->getUrl('/move'), [
-            'entity_selection' => 'chapter:' . $newChapter->id,
-        ]);
-        $page->refresh();
-
-        $movePageResp->assertRedirect($page->getUrl());
-        $this->assertTrue($page->book->id == $newBook->id, 'Page parent is now the new chapter');
-
-        $newChapterResp = $this->get($newChapter->getUrl());
-        $newChapterResp->assertSee($page->name);
-    }
-
-    public function test_page_move_from_chapter_to_book()
-    {
-        $oldChapter = Chapter::query()->first();
-        $page = $oldChapter->pages()->first();
-        $newBook = Book::query()->where('id', '!=', $oldChapter->book_id)->first();
-
-        $movePageResp = $this->actingAs($this->users->editor())->put($page->getUrl('/move'), [
-            'entity_selection' => 'book:' . $newBook->id,
-        ]);
-        $page->refresh();
-
-        $movePageResp->assertRedirect($page->getUrl());
-        $this->assertTrue($page->book->id == $newBook->id, 'Page parent is now the new book');
-        $this->assertTrue($page->chapter === null, 'Page has no parent chapter');
-
-        $newBookResp = $this->get($newBook->getUrl());
-        $newBookResp->assertSee($page->name);
-    }
-
-    public function test_page_move_requires_create_permissions_on_parent()
-    {
-        $page = $this->entities->page();
-        $currentBook = $page->book;
-        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
-        $editor = $this->users->editor();
-
-        $this->permissions->setEntityPermissions($newBook, ['view', 'update', 'delete'], $editor->roles->all());
-
-        $movePageResp = $this->actingAs($editor)->put($page->getUrl('/move'), [
-            'entity_selection' => 'book:' . $newBook->id,
-        ]);
-        $this->assertPermissionError($movePageResp);
-
-        $this->permissions->setEntityPermissions($newBook, ['view', 'update', 'delete', 'create'], $editor->roles->all());
-        $movePageResp = $this->put($page->getUrl('/move'), [
-            'entity_selection' => 'book:' . $newBook->id,
-        ]);
-
-        $page->refresh();
-        $movePageResp->assertRedirect($page->getUrl());
-
-        $this->assertTrue($page->book->id == $newBook->id, 'Page book is now the new book');
-    }
-
-    public function test_page_move_requires_delete_permissions()
-    {
-        $page = $this->entities->page();
-        $currentBook = $page->book;
-        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
-        $editor = $this->users->editor();
-
-        $this->permissions->setEntityPermissions($newBook, ['view', 'update', 'create', 'delete'], $editor->roles->all());
-        $this->permissions->setEntityPermissions($page, ['view', 'update', 'create'], $editor->roles->all());
-
-        $movePageResp = $this->actingAs($editor)->put($page->getUrl('/move'), [
-            'entity_selection' => 'book:' . $newBook->id,
-        ]);
-        $this->assertPermissionError($movePageResp);
-        $pageView = $this->get($page->getUrl());
-        $pageView->assertDontSee($page->getUrl('/move'));
-
-        $this->permissions->setEntityPermissions($page, ['view', 'update', 'create', 'delete'], $editor->roles->all());
-        $movePageResp = $this->put($page->getUrl('/move'), [
-            'entity_selection' => 'book:' . $newBook->id,
-        ]);
-
-        $page->refresh();
-        $movePageResp->assertRedirect($page->getUrl());
-        $this->assertTrue($page->book->id == $newBook->id, 'Page book is now the new book');
-    }
-
-    public function test_chapter_move()
-    {
-        $chapter = $this->entities->chapter();
-        $currentBook = $chapter->book;
-        $pageToCheck = $chapter->pages->first();
-        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
-
-        $chapterMoveResp = $this->asEditor()->get($chapter->getUrl('/move'));
-        $chapterMoveResp->assertSee('Move Chapter');
-
-        $moveChapterResp = $this->put($chapter->getUrl('/move'), [
-            'entity_selection' => 'book:' . $newBook->id,
-        ]);
-
-        $chapter = Chapter::query()->find($chapter->id);
-        $moveChapterResp->assertRedirect($chapter->getUrl());
-        $this->assertTrue($chapter->book->id === $newBook->id, 'Chapter Book is now the new book');
-
-        $newBookResp = $this->get($newBook->getUrl());
-        $newBookResp->assertSee('moved chapter');
-        $newBookResp->assertSee($chapter->name);
-
-        $pageToCheck = Page::query()->find($pageToCheck->id);
-        $this->assertTrue($pageToCheck->book_id === $newBook->id, 'Chapter child page\'s book id has changed to the new book');
-        $pageCheckResp = $this->get($pageToCheck->getUrl());
-        $pageCheckResp->assertSee($newBook->name);
-    }
-
-    public function test_chapter_move_requires_delete_permissions()
-    {
-        $chapter = $this->entities->chapter();
-        $currentBook = $chapter->book;
-        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
-        $editor = $this->users->editor();
-
-        $this->permissions->setEntityPermissions($newBook, ['view', 'update', 'create', 'delete'], $editor->roles->all());
-        $this->permissions->setEntityPermissions($chapter, ['view', 'update', 'create'], $editor->roles->all());
-
-        $moveChapterResp = $this->actingAs($editor)->put($chapter->getUrl('/move'), [
-            'entity_selection' => 'book:' . $newBook->id,
-        ]);
-        $this->assertPermissionError($moveChapterResp);
-        $pageView = $this->get($chapter->getUrl());
-        $pageView->assertDontSee($chapter->getUrl('/move'));
-
-        $this->permissions->setEntityPermissions($chapter, ['view', 'update', 'create', 'delete'], $editor->roles->all());
-        $moveChapterResp = $this->put($chapter->getUrl('/move'), [
-            'entity_selection' => 'book:' . $newBook->id,
-        ]);
-
-        $chapter = Chapter::query()->find($chapter->id);
-        $moveChapterResp->assertRedirect($chapter->getUrl());
-        $this->assertTrue($chapter->book->id == $newBook->id, 'Page book is now the new book');
-    }
-
-    public function test_chapter_move_requires_create_permissions_in_new_book()
-    {
-        $chapter = $this->entities->chapter();
-        $currentBook = $chapter->book;
-        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
-        $editor = $this->users->editor();
-
-        $this->permissions->setEntityPermissions($newBook, ['view', 'update', 'delete'], [$editor->roles->first()]);
-        $this->permissions->setEntityPermissions($chapter, ['view', 'update', 'create', 'delete'], [$editor->roles->first()]);
-
-        $moveChapterResp = $this->actingAs($editor)->put($chapter->getUrl('/move'), [
-            'entity_selection' => 'book:' . $newBook->id,
-        ]);
-        $this->assertPermissionError($moveChapterResp);
-
-        $this->permissions->setEntityPermissions($newBook, ['view', 'update', 'create', 'delete'], [$editor->roles->first()]);
-        $moveChapterResp = $this->put($chapter->getUrl('/move'), [
-            'entity_selection' => 'book:' . $newBook->id,
-        ]);
-
-        $chapter = Chapter::query()->find($chapter->id);
-        $moveChapterResp->assertRedirect($chapter->getUrl());
-        $this->assertTrue($chapter->book->id == $newBook->id, 'Page book is now the new book');
-    }
-
-    public function test_chapter_move_changes_book_for_deleted_pages_within()
-    {
-        /** @var Chapter $chapter */
-        $chapter = Chapter::query()->whereHas('pages')->first();
-        $currentBook = $chapter->book;
-        $pageToCheck = $chapter->pages->first();
-        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
-
-        $pageToCheck->delete();
-
-        $this->asEditor()->put($chapter->getUrl('/move'), [
-            'entity_selection' => 'book:' . $newBook->id,
-        ]);
-
-        $pageToCheck->refresh();
-        $this->assertEquals($newBook->id, $pageToCheck->book_id);
-    }
-
-    public function test_book_sort_page_shows()
-    {
-        $bookToSort = $this->entities->book();
-
-        $resp = $this->asAdmin()->get($bookToSort->getUrl());
-        $this->withHtml($resp)->assertElementExists('a[href="' . $bookToSort->getUrl('/sort') . '"]');
-
-        $resp = $this->get($bookToSort->getUrl('/sort'));
-        $resp->assertStatus(200);
-        $resp->assertSee($bookToSort->name);
-    }
-
     public function test_book_sort()
     {
         $oldBook = $this->entities->book();
@@ -423,7 +213,7 @@ class SortTest extends TestCase
         $firstPage = $bookToSort->pages[0];
         $firstChapter = $bookToSort->chapters[0];
 
-        $resp = $this->asAdmin()->get($bookToSort->getUrl() . '/sort-item');
+        $resp = $this->asAdmin()->get($bookToSort->getUrl('/sort-item'));
 
         // Ensure book details are returned
         $resp->assertSee($bookToSort->name);
@@ -431,6 +221,53 @@ class SortTest extends TestCase
         $resp->assertSee($firstChapter->name);
     }
 
+    public function test_book_sort_item_shows_auto_sort_status()
+    {
+        $sort = SortSet::factory()->create(['name' => 'My sort']);
+        $book = $this->entities->book();
+
+        $resp = $this->asAdmin()->get($book->getUrl('/sort-item'));
+        $this->withHtml($resp)->assertElementNotExists("span[title='Auto Sort Active: My sort']");
+
+        $book->sort_set_id = $sort->id;
+        $book->save();
+
+        $resp = $this->asAdmin()->get($book->getUrl('/sort-item'));
+        $this->withHtml($resp)->assertElementExists("span[title='Auto Sort Active: My sort']");
+    }
+
+    public function test_auto_sort_options_shown_on_sort_page()
+    {
+        $sort = SortSet::factory()->create();
+        $book = $this->entities->book();
+        $resp = $this->asAdmin()->get($book->getUrl('/sort'));
+
+        $this->withHtml($resp)->assertElementExists('select[name="auto-sort"] option[value="' . $sort->id . '"]');
+    }
+
+    public function test_auto_sort_option_submit_saves_to_book()
+    {
+        $sort = SortSet::factory()->create();
+        $book = $this->entities->book();
+        $bookPage = $book->pages()->first();
+        $bookPage->priority = 10000;
+        $bookPage->save();
+
+        $resp = $this->asAdmin()->put($book->getUrl('/sort'), [
+            'auto-sort' => $sort->id,
+        ]);
+
+        $resp->assertRedirect($book->getUrl());
+        $book->refresh();
+        $bookPage->refresh();
+
+        $this->assertEquals($sort->id, $book->sort_set_id);
+        $this->assertNotEquals(10000, $bookPage->priority);
+
+        $resp = $this->get($book->getUrl('/sort'));
+        $this->withHtml($resp)->assertElementExists('select[name="auto-sort"] option[value="' . $sort->id . '"][selected]');
+    }
+
     public function test_pages_in_book_show_sorted_by_priority()
     {
         $book = $this->entities->bookHasChaptersAndPages();

diff --git a/tests/Sorting/MoveTest.php b/tests/Sorting/MoveTest.php
new file mode 100644 (file)
index 0000000..edae1f3
--- /dev/null
+++ b/tests/Sorting/MoveTest.php
@@ -0,0 +1,221 @@
+<?php
+
+namespace Sorting;
+
+use BookStack\Entities\Models\Book;
+use BookStack\Entities\Models\Chapter;
+use BookStack\Entities\Models\Page;
+use Tests\TestCase;
+
+class MoveTest extends TestCase
+{
+    public function test_page_move_into_book()
+    {
+        $page = $this->entities->page();
+        $currentBook = $page->book;
+        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
+
+        $resp = $this->asEditor()->get($page->getUrl('/move'));
+        $resp->assertSee('Move Page');
+
+        $movePageResp = $this->put($page->getUrl('/move'), [
+            'entity_selection' => 'book:' . $newBook->id,
+        ]);
+        $page->refresh();
+
+        $movePageResp->assertRedirect($page->getUrl());
+        $this->assertTrue($page->book->id == $newBook->id, 'Page book is now the new book');
+
+        $newBookResp = $this->get($newBook->getUrl());
+        $newBookResp->assertSee('moved page');
+        $newBookResp->assertSee($page->name);
+    }
+
+    public function test_page_move_into_chapter()
+    {
+        $page = $this->entities->page();
+        $currentBook = $page->book;
+        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
+        $newChapter = $newBook->chapters()->first();
+
+        $movePageResp = $this->actingAs($this->users->editor())->put($page->getUrl('/move'), [
+            'entity_selection' => 'chapter:' . $newChapter->id,
+        ]);
+        $page->refresh();
+
+        $movePageResp->assertRedirect($page->getUrl());
+        $this->assertTrue($page->book->id == $newBook->id, 'Page parent is now the new chapter');
+
+        $newChapterResp = $this->get($newChapter->getUrl());
+        $newChapterResp->assertSee($page->name);
+    }
+
+    public function test_page_move_from_chapter_to_book()
+    {
+        $oldChapter = Chapter::query()->first();
+        $page = $oldChapter->pages()->first();
+        $newBook = Book::query()->where('id', '!=', $oldChapter->book_id)->first();
+
+        $movePageResp = $this->actingAs($this->users->editor())->put($page->getUrl('/move'), [
+            'entity_selection' => 'book:' . $newBook->id,
+        ]);
+        $page->refresh();
+
+        $movePageResp->assertRedirect($page->getUrl());
+        $this->assertTrue($page->book->id == $newBook->id, 'Page parent is now the new book');
+        $this->assertTrue($page->chapter === null, 'Page has no parent chapter');
+
+        $newBookResp = $this->get($newBook->getUrl());
+        $newBookResp->assertSee($page->name);
+    }
+
+    public function test_page_move_requires_create_permissions_on_parent()
+    {
+        $page = $this->entities->page();
+        $currentBook = $page->book;
+        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
+        $editor = $this->users->editor();
+
+        $this->permissions->setEntityPermissions($newBook, ['view', 'update', 'delete'], $editor->roles->all());
+
+        $movePageResp = $this->actingAs($editor)->put($page->getUrl('/move'), [
+            'entity_selection' => 'book:' . $newBook->id,
+        ]);
+        $this->assertPermissionError($movePageResp);
+
+        $this->permissions->setEntityPermissions($newBook, ['view', 'update', 'delete', 'create'], $editor->roles->all());
+        $movePageResp = $this->put($page->getUrl('/move'), [
+            'entity_selection' => 'book:' . $newBook->id,
+        ]);
+
+        $page->refresh();
+        $movePageResp->assertRedirect($page->getUrl());
+
+        $this->assertTrue($page->book->id == $newBook->id, 'Page book is now the new book');
+    }
+
+    public function test_page_move_requires_delete_permissions()
+    {
+        $page = $this->entities->page();
+        $currentBook = $page->book;
+        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
+        $editor = $this->users->editor();
+
+        $this->permissions->setEntityPermissions($newBook, ['view', 'update', 'create', 'delete'], $editor->roles->all());
+        $this->permissions->setEntityPermissions($page, ['view', 'update', 'create'], $editor->roles->all());
+
+        $movePageResp = $this->actingAs($editor)->put($page->getUrl('/move'), [
+            'entity_selection' => 'book:' . $newBook->id,
+        ]);
+        $this->assertPermissionError($movePageResp);
+        $pageView = $this->get($page->getUrl());
+        $pageView->assertDontSee($page->getUrl('/move'));
+
+        $this->permissions->setEntityPermissions($page, ['view', 'update', 'create', 'delete'], $editor->roles->all());
+        $movePageResp = $this->put($page->getUrl('/move'), [
+            'entity_selection' => 'book:' . $newBook->id,
+        ]);
+
+        $page->refresh();
+        $movePageResp->assertRedirect($page->getUrl());
+        $this->assertTrue($page->book->id == $newBook->id, 'Page book is now the new book');
+    }
+
+    public function test_chapter_move()
+    {
+        $chapter = $this->entities->chapter();
+        $currentBook = $chapter->book;
+        $pageToCheck = $chapter->pages->first();
+        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
+
+        $chapterMoveResp = $this->asEditor()->get($chapter->getUrl('/move'));
+        $chapterMoveResp->assertSee('Move Chapter');
+
+        $moveChapterResp = $this->put($chapter->getUrl('/move'), [
+            'entity_selection' => 'book:' . $newBook->id,
+        ]);
+
+        $chapter = Chapter::query()->find($chapter->id);
+        $moveChapterResp->assertRedirect($chapter->getUrl());
+        $this->assertTrue($chapter->book->id === $newBook->id, 'Chapter Book is now the new book');
+
+        $newBookResp = $this->get($newBook->getUrl());
+        $newBookResp->assertSee('moved chapter');
+        $newBookResp->assertSee($chapter->name);
+
+        $pageToCheck = Page::query()->find($pageToCheck->id);
+        $this->assertTrue($pageToCheck->book_id === $newBook->id, 'Chapter child page\'s book id has changed to the new book');
+        $pageCheckResp = $this->get($pageToCheck->getUrl());
+        $pageCheckResp->assertSee($newBook->name);
+    }
+
+    public function test_chapter_move_requires_delete_permissions()
+    {
+        $chapter = $this->entities->chapter();
+        $currentBook = $chapter->book;
+        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
+        $editor = $this->users->editor();
+
+        $this->permissions->setEntityPermissions($newBook, ['view', 'update', 'create', 'delete'], $editor->roles->all());
+        $this->permissions->setEntityPermissions($chapter, ['view', 'update', 'create'], $editor->roles->all());
+
+        $moveChapterResp = $this->actingAs($editor)->put($chapter->getUrl('/move'), [
+            'entity_selection' => 'book:' . $newBook->id,
+        ]);
+        $this->assertPermissionError($moveChapterResp);
+        $pageView = $this->get($chapter->getUrl());
+        $pageView->assertDontSee($chapter->getUrl('/move'));
+
+        $this->permissions->setEntityPermissions($chapter, ['view', 'update', 'create', 'delete'], $editor->roles->all());
+        $moveChapterResp = $this->put($chapter->getUrl('/move'), [
+            'entity_selection' => 'book:' . $newBook->id,
+        ]);
+
+        $chapter = Chapter::query()->find($chapter->id);
+        $moveChapterResp->assertRedirect($chapter->getUrl());
+        $this->assertTrue($chapter->book->id == $newBook->id, 'Page book is now the new book');
+    }
+
+    public function test_chapter_move_requires_create_permissions_in_new_book()
+    {
+        $chapter = $this->entities->chapter();
+        $currentBook = $chapter->book;
+        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
+        $editor = $this->users->editor();
+
+        $this->permissions->setEntityPermissions($newBook, ['view', 'update', 'delete'], [$editor->roles->first()]);
+        $this->permissions->setEntityPermissions($chapter, ['view', 'update', 'create', 'delete'], [$editor->roles->first()]);
+
+        $moveChapterResp = $this->actingAs($editor)->put($chapter->getUrl('/move'), [
+            'entity_selection' => 'book:' . $newBook->id,
+        ]);
+        $this->assertPermissionError($moveChapterResp);
+
+        $this->permissions->setEntityPermissions($newBook, ['view', 'update', 'create', 'delete'], [$editor->roles->first()]);
+        $moveChapterResp = $this->put($chapter->getUrl('/move'), [
+            'entity_selection' => 'book:' . $newBook->id,
+        ]);
+
+        $chapter = Chapter::query()->find($chapter->id);
+        $moveChapterResp->assertRedirect($chapter->getUrl());
+        $this->assertTrue($chapter->book->id == $newBook->id, 'Page book is now the new book');
+    }
+
+    public function test_chapter_move_changes_book_for_deleted_pages_within()
+    {
+        /** @var Chapter $chapter */
+        $chapter = Chapter::query()->whereHas('pages')->first();
+        $currentBook = $chapter->book;
+        $pageToCheck = $chapter->pages->first();
+        $newBook = Book::query()->where('id', '!=', $currentBook->id)->first();
+
+        $pageToCheck->delete();
+
+        $this->asEditor()->put($chapter->getUrl('/move'), [
+            'entity_selection' => 'book:' . $newBook->id,
+        ]);
+
+        $pageToCheck->refresh();
+        $this->assertEquals($newBook->id, $pageToCheck->book_id);
+    }
+}