Added testing coverage for tag index

[bookstack] / app / Entities / Tools / TrashCan.php

diff --git a/app/Entities/Tools/TrashCan.php b/app/Entities/Tools/TrashCan.php
index 62d373e97eba0861e45c3beb68f483e13561d3f5..8327c948931b5567e80fc3d6ca5728c82533fa87 100644 (file)
--- a/app/Entities/Tools/TrashCan.php
+++ b/app/Entities/Tools/TrashCan.php
@@ -1,13 +1,15 @@
-<?php namespace BookStack\Entities\Tools;
+<?php
+
+namespace BookStack\Entities\Tools;

 
 

-use BookStack\Entities\Book;
-use BookStack\Entities\Bookshelf;
-use BookStack\Entities\Chapter;
-use BookStack\Entities\Deletion;
-use BookStack\Entities\Entity;

 use BookStack\Entities\EntityProvider;
 use BookStack\Entities\EntityProvider;

-use BookStack\Entities\HasCoverImage;
-use BookStack\Entities\Page;
+use BookStack\Entities\Models\Book;
+use BookStack\Entities\Models\Bookshelf;
+use BookStack\Entities\Models\Chapter;
+use BookStack\Entities\Models\Deletion;
+use BookStack\Entities\Models\Entity;
+use BookStack\Entities\Models\HasCoverImage;
+use BookStack\Entities\Models\Page;

 use BookStack\Exceptions\NotifyException;
 use BookStack\Facades\Activity;
 use BookStack\Uploads\AttachmentService;
 use BookStack\Exceptions\NotifyException;
 use BookStack\Facades\Activity;
 use BookStack\Uploads\AttachmentService;


@@ -17,7 +19,6 @@ use Illuminate\Support\Carbon;
 
 class TrashCan
 {
 
 class TrashCan
 {

-

     /**
      * Send a shelf to the recycle bin.
      */
     /**
      * Send a shelf to the recycle bin.
      */


@@ -29,6 +30,7 @@ class TrashCan
 
     /**
      * Send a book to the recycle bin.
 
     /**
      * Send a book to the recycle bin.

+     *

      * @throws Exception
      */
     public function softDestroyBook(Book $book)
      * @throws Exception
      */
     public function softDestroyBook(Book $book)


@@ -48,6 +50,7 @@ class TrashCan
 
     /**
      * Send a chapter to the recycle bin.
 
     /**
      * Send a chapter to the recycle bin.

+     *

      * @throws Exception
      */
     public function softDestroyChapter(Chapter $chapter, bool $recordDelete = true)
      * @throws Exception
      */
     public function softDestroyChapter(Chapter $chapter, bool $recordDelete = true)


@@ -67,6 +70,7 @@ class TrashCan
 
     /**
      * Send a page to the recycle bin.
 
     /**
      * Send a page to the recycle bin.

+     *

      * @throws Exception
      */
     public function softDestroyPage(Page $page, bool $recordDelete = true)
      * @throws Exception
      */
     public function softDestroyPage(Page $page, bool $recordDelete = true)


@@ -89,18 +93,21 @@ class TrashCan
 
     /**
      * Remove a bookshelf from the system.
 
     /**
      * Remove a bookshelf from the system.

+     *

      * @throws Exception
      */
     protected function destroyShelf(Bookshelf $shelf): int
     {
         $this->destroyCommonRelations($shelf);
         $shelf->forceDelete();
      * @throws Exception
      */
     protected function destroyShelf(Bookshelf $shelf): int
     {
         $this->destroyCommonRelations($shelf);
         $shelf->forceDelete();

+

         return 1;
     }
 
     /**
      * Remove a book from the system.
      * Destroys any child chapters and pages.
         return 1;
     }
 
     /**
      * Remove a book from the system.
      * Destroys any child chapters and pages.

+     *

      * @throws Exception
      */
     protected function destroyBook(Book $book): int
      * @throws Exception
      */
     protected function destroyBook(Book $book): int


@@ -120,12 +127,14 @@ class TrashCan
 
         $this->destroyCommonRelations($book);
         $book->forceDelete();
 
         $this->destroyCommonRelations($book);
         $book->forceDelete();

+

         return $count + 1;
     }
 
     /**
      * Remove a chapter from the system.
      * Destroys all pages within.
         return $count + 1;
     }
 
     /**
      * Remove a chapter from the system.
      * Destroys all pages within.

+     *

      * @throws Exception
      */
     protected function destroyChapter(Chapter $chapter): int
      * @throws Exception
      */
     protected function destroyChapter(Chapter $chapter): int


@@ -141,16 +150,19 @@ class TrashCan
 
         $this->destroyCommonRelations($chapter);
         $chapter->forceDelete();
 
         $this->destroyCommonRelations($chapter);
         $chapter->forceDelete();

+

         return $count + 1;
     }
 
     /**
      * Remove a page from the system.
         return $count + 1;
     }
 
     /**
      * Remove a page from the system.

+     *

      * @throws Exception
      */
     protected function destroyPage(Page $page): int
     {
         $this->destroyCommonRelations($page);
      * @throws Exception
      */
     protected function destroyPage(Page $page): int
     {
         $this->destroyCommonRelations($page);

+        $page->allRevisions()->delete();

 
         // Delete Attached Files
         $attachmentService = app(AttachmentService::class);
 
         // Delete Attached Files
         $attachmentService = app(AttachmentService::class);


@@ -159,6 +171,7 @@ class TrashCan
         }
 
         $page->forceDelete();
         }
 
         $page->forceDelete();

+

         return 1;
     }
 
         return 1;
     }
 


@@ -168,11 +181,10 @@ class TrashCan
      */
     public function getTrashedCounts(): array
     {
      */
     public function getTrashedCounts(): array
     {

-        $provider = app(EntityProvider::class);

         $counts = [];
 
         /** @var Entity $instance */
         $counts = [];
 
         /** @var Entity $instance */

-        foreach ($provider->all() as $key => $instance) {
+        foreach ((new EntityProvider())->all() as $key => $instance) {

             $counts[$key] = $instance->newQuery()->onlyTrashed()->count();
         }
 
             $counts[$key] = $instance->newQuery()->onlyTrashed()->count();
         }
 


@@ -181,6 +193,7 @@ class TrashCan
 
     /**
      * Destroy all items that have pending deletions.
 
     /**
      * Destroy all items that have pending deletions.

+     *

      * @throws Exception
      */
     public function empty(): int
      * @throws Exception
      */
     public function empty(): int


@@ -190,11 +203,13 @@ class TrashCan
         foreach ($deletions as $deletion) {
             $deleteCount += $this->destroyFromDeletion($deletion);
         }
         foreach ($deletions as $deletion) {
             $deleteCount += $this->destroyFromDeletion($deletion);
         }

+

         return $deleteCount;
     }
 
     /**
      * Destroy an element from the given deletion model.
         return $deleteCount;
     }
 
     /**
      * Destroy an element from the given deletion model.

+     *

      * @throws Exception
      */
     public function destroyFromDeletion(Deletion $deletion): int
      * @throws Exception
      */
     public function destroyFromDeletion(Deletion $deletion): int


@@ -207,11 +222,13 @@ class TrashCan
             $count = $this->destroyEntity($deletion->deletable);
         }
         $deletion->delete();
             $count = $this->destroyEntity($deletion->deletable);
         }
         $deletion->delete();

+

         return $count;
     }
 
     /**
      * Restore the content within the given deletion.
         return $count;
     }
 
     /**
      * Restore the content within the given deletion.

+     *

      * @throws Exception
      */
     public function restoreFromDeletion(Deletion $deletion): int
      * @throws Exception
      */
     public function restoreFromDeletion(Deletion $deletion): int


@@ -229,6 +246,7 @@ class TrashCan
         }
 
         $deletion->delete();
         }
 
         $deletion->delete();

+

         return $restoreCount;
     }
 
         return $restoreCount;
     }
 


@@ -236,6 +254,7 @@ class TrashCan
      * Automatically clear old content from the recycle bin
      * depending on the configured lifetime.
      * Returns the total number of deleted elements.
      * Automatically clear old content from the recycle bin
      * depending on the configured lifetime.
      * Returns the total number of deleted elements.

+     *

      * @throws Exception
      */
     public function autoClearOld(): int
      * @throws Exception
      */
     public function autoClearOld(): int


@@ -274,11 +293,11 @@ class TrashCan
             $count++;
         };
 
             $count++;
         };
 

-        if ($entity->isA('chapter') || $entity->isA('book')) {
+        if ($entity instanceof Chapter || $entity instanceof Book) {

             $entity->pages()->withTrashed()->withCount('deletions')->get()->each($restoreAction);
         }
 
             $entity->pages()->withTrashed()->withCount('deletions')->get()->each($restoreAction);
         }
 

-        if ($entity->isA('book')) {
+        if ($entity instanceof Book) {

             $entity->chapters()->withTrashed()->withCount('deletions')->get()->each($restoreAction);
         }
 
             $entity->chapters()->withTrashed()->withCount('deletions')->get()->each($restoreAction);
         }
 


@@ -287,21 +306,25 @@ class TrashCan
 
     /**
      * Destroy the given entity.
 
     /**
      * Destroy the given entity.

+     *
+     * @throws Exception

      */
     protected function destroyEntity(Entity $entity): int
     {
      */
     protected function destroyEntity(Entity $entity): int
     {

-        if ($entity->isA('page')) {
+        if ($entity instanceof Page) {

             return $this->destroyPage($entity);
         }
             return $this->destroyPage($entity);
         }

-        if ($entity->isA('chapter')) {
+        if ($entity instanceof Chapter) {

             return $this->destroyChapter($entity);
         }
             return $this->destroyChapter($entity);
         }

-        if ($entity->isA('book')) {
+        if ($entity instanceof Book) {

             return $this->destroyBook($entity);
         }
             return $this->destroyBook($entity);
         }

-        if ($entity->isA('shelf')) {
+        if ($entity instanceof Bookshelf) {

             return $this->destroyShelf($entity);
         }
             return $this->destroyShelf($entity);
         }

+
+        return 0;

     }
 
     /**
     }
 
     /**


@@ -317,6 +340,7 @@ class TrashCan
         $entity->jointPermissions()->delete();
         $entity->searchTerms()->delete();
         $entity->deletions()->delete();
         $entity->jointPermissions()->delete();
         $entity->searchTerms()->delete();
         $entity->deletions()->delete();

+        $entity->favourites()->delete();

 
         if ($entity instanceof HasCoverImage && $entity->cover) {
             $imageService = app()->make(ImageService::class);
 
         if ($entity instanceof HasCoverImage && $entity->cover) {
             $imageService = app()->make(ImageService::class);