Merge pull request #321 from biblioverse/refactor-reading-status

Refactor reading status and reading list into enums

config/packages/biblioverse_typesense.yaml

@@ -56,7 +56,7 @@ biblioverse_typesense:
             type: string
             facet: true
             optional: true
-            entity_attribute: ageCategory
+            entity_attribute: ageCategoryLabel
           user.read:
             name: read
             optional: true
@@ -76,13 +76,7 @@ biblioverse_typesense:
         default_sorting_field: sortable_id
         symbols_to_index: ['+', '#', '@', '_']
         token_separators: [' ', '-', "'"]
-#      finders:
-#        books_autocomplete:
-#          finder_parameters:
-#            query_by: title,serie,extension,authors,tags,summary
-#            limit: 100
-#            num_typos: 2
 
 when@test:
   biblioverse_typesense:
-    auto_update: false
+    auto_update: false

migrations/Version20241218154423.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20241218154423 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Migrate to Enums for readstatus and readinglist';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE book_interaction ADD read_status VARCHAR(255) DEFAULT \'rs-not-started\' NOT NULL, ADD reading_list VARCHAR(255) DEFAULT \'rl-undefined\' NOT NULL');
+
+        $this->addSql('UPDATE book_interaction SET read_status = \'rs-finished\' WHERE finished =1');
+        $this->addSql('UPDATE book_interaction SET read_status = \'rs-started\' WHERE finished =0 and read_pages > 0');
+        $this->addSql('UPDATE book_interaction SET read_status = \'rs-not-started\' WHERE finished =0 and read_pages = 0');
+
+        $this->addSql('UPDATE book_interaction SET reading_list = \'rl-ignored\' WHERE hidden =1');
+        $this->addSql('UPDATE book_interaction SET reading_list = \'rl-to-read\' WHERE hidden =0 and favorite = 1');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE book_interaction DROP read_status, DROP reading_list');
+    }
+}

migrations/Version20241218154713.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20241218154713 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Add interaction rating';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE book_interaction ADD rating INT DEFAULT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE book_interaction DROP rating');
+    }
+}

migrations/Version20250202073734.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20250202073734 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('DELETE FROM book_interaction WHERE book_id is null or user_id is null');
+        $this->addSql('ALTER TABLE book_interaction CHANGE user_id user_id INT NOT NULL, CHANGE book_id book_id INT NOT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE book_interaction CHANGE user_id user_id INT DEFAULT NULL, CHANGE book_id book_id INT DEFAULT NULL');
+    }
+}

phpstan.neon

@@ -10,4 +10,4 @@ parameters:
   #      - '#Asserted type (.*) for (.*) with type (.*) does not narrow down the type.#'
     errorFormat: symplify
     typeAliases:
-        ReadingStateCriteria: "array{'book':int, 'readPages': int|null, 'finished': boolean}"
+        ReadingStateCriteria: "array{'book':int, 'readPages': int|null, 'readStatus': App\\Enum\\ReadStatus}"

src/Controller/AutocompleteGroupController.php

@@ -2,20 +2,21 @@
 
 namespace App\Controller;
 
-use App\Entity\User;
+use App\Enum\AgeCategory;
 use App\Repository\BookRepository;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 /**
  * @phpstan-type GroupType array{ item:string, slug:string, bookCount:int, booksFinished:int, lastBookIndex:int }
  */
 class AutocompleteGroupController extends AbstractController
 {
     #[Route('/autocomplete/group/{type}', name: 'app_autocomplete_group')]
-    public function index(Request $request, BookRepository $bookRepository, string $type): Response
+    public function index(Request $request, BookRepository $bookRepository, string $type, TranslatorInterface $translator): Response
     {
         $query = $request->get('query');
         if (!is_string($query)) {
@@ -25,8 +26,8 @@ public function index(Request $request, BookRepository $bookRepository, string $
         $json = ['results' => []];
 
         if ($type === 'ageCategory') {
-            foreach (User::AGE_CATEGORIES as $ageCategory => $ageCategoryId) {
-                $json['results'][] = ['value' => $ageCategoryId, 'text' => $ageCategory];
+            foreach (AgeCategory::cases() as $ageCategory) {
+                $json['results'][] = ['value' => $ageCategory->value, 'text' => $translator->trans(AgeCategory::getLabel($ageCategory))];
             }
 
             return new JsonResponse($json);

src/Controller/BookController.php

@@ -5,6 +5,7 @@
 use App\Entity\Book;
 use App\Entity\BookInteraction;
 use App\Entity\User;
+use App\Enum\ReadStatus;
 use App\Repository\BookRepository;
 use App\Repository\ShelfRepository;
 use App\Security\Voter\BookVoter;
@@ -199,15 +200,18 @@ public function read(
 
         $page = (int) max(1, $page);
 
-        if (!$interaction->isFinished() && $interaction->getReadPages() < $page) {
+        if ($interaction->getReadStatus() !== ReadStatus::Finished && $interaction->getReadPages() < $page) {
             $interaction->setReadPages($page);
         }
         $manager->persist($interaction);
         $manager->flush();
 
-        if (!$interaction->isFinished() && $page === $book->getPageNumber()) {
-            $interaction->setFinished(true);
-            $interaction->setFinishedDate(new \DateTime());
+        if ($interaction->getReadStatus() !== ReadStatus::Finished && $page === $book->getPageNumber()) {
+            $interaction->setReadStatus(ReadStatus::Finished);
+
+            // TODO Add next unread in serie to reading list?
+
+            $interaction->setFinishedDate(new \DateTimeImmutable());
             $this->addFlash('success', 'Book finished! Congratulations!');
             $manager->flush();
 
@@ -390,9 +394,9 @@ public function relocate(Request $request, Book $book, BookFileSystemManagerInte
             $book = $fileSystemManager->renameFiles($book);
             $entityManager->persist($book);
             $entityManager->flush();
-            $this->addFlash('success', 'Files relocated');
+            $this->addFlash('success', 'Book relocated.');
         } catch (\Exception $e) {
-            $this->addFlash('danger', 'Error while relocating files: '.$e->getMessage());
+            $this->addFlash('danger', 'Error during relocation: '.$e->getMessage());
         }
 
         return $this->redirect($request->headers->get('referer') ?? '/');

src/Controller/DefaultController.php

@@ -2,6 +2,7 @@
 
 namespace App\Controller;
 
+use App\Enum\ReadStatus;
 use App\Repository\BookInteractionRepository;
 use App\Repository\BookRepository;
 use App\Service\BookFileSystemManagerInterface;
@@ -61,7 +62,7 @@ public function readingList(BookInteractionRepository $bookInteractionRepository
             'finished' => [],
         ];
         foreach ($readList as $bookInteraction) {
-            if ($bookInteraction->isFinished()) {
+            if ($bookInteraction->getReadStatus() === ReadStatus::Finished) {
                 $statuses['finished'][] = $bookInteraction->getBook();
             } else {
                 $statuses['unread'][] = $bookInteraction->getBook();

src/Controller/GroupController.php

@@ -45,8 +45,8 @@ public function groups(Request $request, string $type, string $letter = 'a'): Re
         }
 
         $group = match ($search) {
-            '' => array_filter($group, static fn (mixed $item) => str_contains(strtolower($item['item']), strtolower($search))),
-            default => array_filter($group, static fn (mixed $item) => str_starts_with(strtolower($item['item']), $letter)),
+            default => array_filter($group, static fn (mixed $item) => str_contains(strtolower($item['item']), strtolower($search))),
+            '' => array_filter($group, static fn (mixed $item) => str_starts_with(strtolower($item['item']), $letter)),
         };
 
         return $this->render('group/index.html.twig', [

src/Controller/OPDS/OpdsController.php

@@ -151,9 +151,6 @@ public function readinglist(BookInteractionRepository $bookInteractionRepository
 
         $feeds = [];
         foreach ($books as $bookInteraction) {
-            if ($bookInteraction->getBook() === null) {
-                continue;
-            }
             $feeds[] = $this->opds->convertBookToOpdsEntry($bookInteraction->getBook());
         }
         $opds->feeds($feeds);

src/Controller/SerieController.php

@@ -13,7 +13,7 @@
 #[Route('/series')]
 class SerieController extends AbstractController
 {
-    #[Route('/{name}', name: 'app_serie_detail')]
+    #[Route('/{name}', name: 'app_serie_detail', requirements: ['name' => '.+'])]
     public function detail(string $name, BookRepository $bookRepository, BookInteractionService $bookInteractionService, ShelfRepository $shelfRepository): Response
     {
         $books = $bookRepository->findBySerie($name);

src/Controller/UserController.php

@@ -27,7 +27,6 @@ public function index(UserRepository $userRepository): Response
     {
         return $this->render('user/index.html.twig', [
             'users' => $userRepository->findAll(),
-            'age_categories' => array_flip(User::AGE_CATEGORIES),
         ]);
     }
 

src/DataFixtures/BookFixture.php

@@ -3,6 +3,7 @@
 namespace App\DataFixtures;
 
 use App\Entity\Book;
+use App\Enum\AgeCategory;
 use Doctrine\Bundle\FixturesBundle\Fixture;
 use Doctrine\Common\DataFixtures\DependentFixtureInterface;
 use Doctrine\Persistence\ObjectManager;
@@ -91,7 +92,7 @@ public function load(ObjectManager $manager): void
             }
 
             if (array_key_exists('ageCategory', $bookData)) {
-                $book->setAgeCategory($bookData['ageCategory']);
+                $book->setAgeCategory(AgeCategory::tryFrom($bookData['ageCategory']));
             }
 
             if (array_key_exists('tags', $bookData)) {

src/DataFixtures/UserFixture.php

@@ -3,6 +3,7 @@
 namespace App\DataFixtures;
 
 use App\Entity\User;
+use App\Enum\AgeCategory;
 use Doctrine\Bundle\FixturesBundle\Fixture;
 use Doctrine\Persistence\ObjectManager;
 use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
@@ -43,7 +44,7 @@ public function load(ObjectManager $manager): void
         $user->setUsername(self::CHILD_USERNAME);
         $user->setBirthday(new \DateTimeImmutable('1990-01-01'));
         $user->setLanguage('en');
-        $user->setMaxAgeCategory(1);
+        $user->setMaxAgeCategory(AgeCategory::TenPlus);
         $user->setPassword($this->passwordHasher->hashPassword($user, self::CHILD_PASSWORD));
         $user->setRoles(['ROLE_USER']);
 

src/Entity/Book.php

@@ -2,6 +2,9 @@
 
 namespace App\Entity;
 
+use App\Enum\AgeCategory;
+use App\Enum\ReadingList;
+use App\Enum\ReadStatus;
 use App\Repository\BookRepository;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
@@ -109,8 +112,8 @@ class Book
     #[ORM\ManyToMany(targetEntity: Shelf::class, mappedBy: 'books', cascade: ['persist'])]
     private Collection $shelves;
 
-    #[ORM\Column(nullable: true)]
-    private ?int $ageCategory = null;
+    #[ORM\Column(enumType: AgeCategory::class, nullable: true)]
+    private ?AgeCategory $ageCategory = null;
 
     /**
      * @var Collection<int, KoboSyncedBook>
@@ -432,10 +435,7 @@ public function addBookInteraction(BookInteraction $bookInteraction): static
 
     public function removeBookInteraction(BookInteraction $bookInteraction): static
     {
-        // set the owning side to null (unless already changed)
-        if ($this->bookInteractions->removeElement($bookInteraction) && $bookInteraction->getBook() === $this) {
-            $bookInteraction->setBook(null);
-        }
+        $this->bookInteractions->removeElement($bookInteraction);
 
         return $this;
     }
@@ -504,18 +504,23 @@ public function removeShelf(Shelf $shelf): static
         return $this;
     }
 
-    public function getAgeCategory(): ?int
+    public function getAgeCategory(): ?AgeCategory
     {
         return $this->ageCategory;
     }
 
-    public function setAgeCategory(?int $ageCategory): static
+    public function setAgeCategory(?AgeCategory $ageCategory): static
     {
         $this->ageCategory = $ageCategory;
 
         return $this;
     }
 
+    public function getAgeCategoryLabel(): ?string
+    {
+        return $this->ageCategory?->label() ?? 'enum.agecategories.notset';
+    }
+
     public function getUuid(): string
     {
         if ($this->uuid === null) {
@@ -598,17 +603,15 @@ public function getUsers(): object
 
         foreach ($this->getBookInteractions() as $interaction) {
             $user = $interaction->getUser();
-            if ($user === null) {
-                continue;
-            }
+
             $userId = $user->getId();
-            if ($interaction->isFinished()) {
+            if ($interaction->getReadStatus() === ReadStatus::Finished) {
                 $return['read'][] = $userId;
             }
-            if ($interaction->isFavorite()) {
+            if ($interaction->getReadingList() === ReadingList::ToRead) {
                 $return['favorite'][] = $userId;
             }
-            if ($interaction->isHidden()) {
+            if ($interaction->getReadingList() === ReadingList::Ignored) {
                 $return['hidden'][] = $userId;
             }
         }