Merge pull request AY2425S2-CS2113-T12-2#222 from ShengBin-101/shengbin-PED-fixes

Change book category from string to enum

Author: ShengBin-101

docs/DeveloperGuide.md

@@ -144,6 +144,7 @@ The following UML sequence diagram shows how the `add-book BOOK_TITLE a/AUTHOR c
    If the book does not exist in the inventory:
 
    - A new `Book` object is created using the parsed arguments. The `note` field is optional and defaults to an empty string if not provided.
+   - The `category` string is converted to a `Category` enum using `Category.fromString(...)`.
    - The `condition` string is converted to a `Condition` enum using `Condition.fromString(...)`.
    - The book is added to the `BookList` using `bookList.addBook(...)`.
 
@@ -639,22 +640,23 @@ BookKeeper gives you full control over your collection in a clean, offline-frien
 
 ## Appendix B: User Stories
 
-| Version | As a...       | I want to...                                                           | So that I can                                                       |
-| ------- | ------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------- |
-| `v1.0`  | Librarian     | View inventory, including book count                                   | See my existing books                                               |
-| `v1.0`  | Librarian     | Add new books to the system easily                                     | Update my inventory when acquiring new books                        |
-| `v1.0`  | Librarian     | Remove books when lost or permanently borrowed                         | Maintain an accurate inventory                                      |
-| `v1.0`  | Librarian     | Add book loans, including borrower details and return dates            | Ensure books are returned on time and inform others of availability |
-| `v1.0`  | Librarian     | Delete book loans, including borrower details and return dates         | Maintain accurate loan records                                      |
-| `v1.0`  | Librarian     | View on-going loans                                                    | Keep track of what books are loaned out                             |
-| `v2.0`  | Librarian     | Categorize my inventory                                                | Make searching for books more convenient                            |
-| `v2.0`  | Librarian     | Manage/Update book availability, including borrowed and reserved books | Efficiently allocate books                                          |
-| `v2.0`  | Librarian     | Track book conditions (e.g good, fair, poor)                | Maintain detailed records                                           |
-| `v2.0`  | Librarian     | Add personal notes about individual books                              | Maintain detailed records                                           |
-| `v2.0`  | Librarian     | Edit existing book loans' due dates                                    | Better track by updating book loans                                 |
-| `v2.0`  | Librarian     | Add contact details for borrowers                                      | Easily reach out to borrowers when needed                           |
-| `v2.0`  | Librarian     | Keep track of where available books are in the library                 | Help visitors find books                                            |
+| Version | As a...  | I want to...                                                           | So that I can                                                       |
+|---------| -------- |------------------------------------------------------------------------|---------------------------------------------------------------------|
+| `v1.0`  | Librarian | View inventory, including book count                                   | See my existing books                                               |
+| `v1.0`  | Librarian | Add new books to the system easily                                     | Update my inventory when acquiring new books                        |
+| `v1.0`  | Librarian | Remove books when lost or permanently borrowed                         | Maintain an accurate inventory                                      |
+| `v1.0`  | Librarian | Add book loans, including borrower details and return dates            | Ensure books are returned on time and inform others of availability |
+| `v1.0`  | Librarian | Delete book loans, including borrower details and return dates         | Maintain accurate loan records                                      |
+| `v1.0`  | Librarian | View on-going loans                                                    | Keep track of what books are loaned out                             |
+| `v2.0`  | Librarian | Categorize my inventory                                                | Make searching for books more convenient                            |
+| `v2.0`  | Librarian | Manage/Update book availability, including borrowed and reserved books | Efficiently allocate books                                          |
+| `v2.0`  | Librarian | Track book conditions (e.g good, fair, poor)                           | Maintain detailed records                                           |
+| `v2.0`  | Librarian | Add personal notes about individual books                              | Maintain detailed records                                           |
+| `v2.0`  | Librarian | Edit existing book loans' due dates                                    | Better track by updating book loans                                 |
+| `v2.0`  | Librarian | Add contact details for borrowers                                      | Easily reach out to borrowers when needed                           |
+| `v2.0`  | Librarian | Keep track of where available books are in the library                 | Help visitors find books                                            |
 | `v2.0`  | New Librarian | View a list of available commands                                      | Learn how to use the application                                    |
+| `v2.1`  |Librarian | Update existing personal notes about individual books                  | Maintain accurate records                                           |
 
 ## Appendix C: Non-Functional Requirements
 

docs/UserGuide.md

@@ -1,8 +1,8 @@
-# User Guide (v2.0)
+# User Guide (v2.1)
 
 ## Table of Contents
 
-- [User Guide (v2.0)](#user-guide-v20)
+- [User Guide (v2.1)](#user-guide-v21)
   - [Table of Contents](#table-of-contents)
   - [Introduction](#introduction)
   - [Quick Start](#quick-start)
@@ -44,7 +44,7 @@ BookKeeper is a Command Line Interface (CLI) library manager application for eff
 Welcome to BookKeeper! This guide will help you get started with using the system for managing your library's books and loan records.
 
 1. Ensure that you have Java 17 or above installed.
-2. Download the latest version of `BookKeeper` from [here](https://github.com/AY2425S2-CS2113-T12-2/tp/releases/tag/Release-v2.0).
+2. Download the latest version of `BookKeeper` from [here](https://github.com/AY2425S2-CS2113-T12-2/tp/releases/tag/Release-v2.1).
 3. Copy the file to the folder you want to use as the home folder for BookKeeper.
 4. Open a command prompt/terminal and navigate to the folder where you placed the jar file.
 5. Run the application using: `java -jar BookKeeper.jar`
@@ -63,6 +63,9 @@ Adds a book to the library collection.
 
 Format: `add-book BOOK_TITLE a/AUTHOR cat/CATEGORY cond/CONDITION loc/LOCATION [note/NOTE]`
 
+Notes:
+- Valid categories are: romance, adventure, action, horror, mystery, fiction, nonfiction, scifi, education.
+
 Example:
 
 ```

docs/diagrams/classDiagram.puml

@@ -25,7 +25,6 @@ class LoanList {
 class Book {
     - title : String
     - author : String
-    - category : String
     - onLoan : boolean
     - location : String
     - note : String
@@ -46,6 +45,18 @@ enum Condition <<enumeration>> {
     POOR
 }
 
+enum Category <<enumeration>> {
+    ROMANCE
+    ADVENTURE
+    ACTION
+    HORROR
+    MYSTERY
+    FICTION
+    NONFICTION
+    SCIFI
+    EDUCATION
+}
+
 class Storage {
     - FOLDER_PATH: String
     - INVENTORY_FILE_NAME: String
@@ -87,6 +98,7 @@ InputHandler ..> Storage
 InputHandler ..> InputParser
 BookKeeper ..> InputHandler
 Book -> "1" Condition
+Book -> "1" Category
 Loan --> "1" Book
 Storage ..> BookList
 Storage ..> LoanList

src/main/java/bookkeeper/list/BookList.java

@@ -2,6 +2,7 @@
 
 import bookkeeper.model.Book;
 import bookkeeper.ui.Formatter;
+import bookkeeper.model.Category;
 
 import java.util.ArrayList;
 
@@ -47,12 +48,19 @@ public ArrayList<Book> findBooksByKeyword(String keyword) {
         return filteredBookList;
     }
 
-    public ArrayList<Book> findBooksByCategory(String category){
+    public ArrayList<Book> findBooksByCategory(String category) {
         ArrayList<Book> filteredBookList = new ArrayList<>();
-        for (Book book : bookList) {
-            if (book.getCategory().equalsIgnoreCase(category)) {
-                filteredBookList.add(book);
+        try {
+            // Normalize the input category string to a Category enum
+            Category targetCategory = Category.fromString(category);
+            for (Book book : bookList) {
+                if (book.getCategory() == targetCategory) { // Compare using the enum value
+                    filteredBookList.add(book);
+                }
             }
+        } catch (IllegalArgumentException e) {
+            // Handle invalid category input (optional)
+            Formatter.printBorderedMessage("Invalid category: " + category);
         }
         return filteredBookList;
     }

src/main/java/bookkeeper/model/Book.java

@@ -3,7 +3,7 @@
 public class Book {
     private String title;
     private String author;
-    private String category;
+    private Category category;
     private Condition condition;
     private boolean onLoan;
     private String location;
@@ -13,7 +13,7 @@ public class Book {
     public Book(String title, String author, String category, String condition, String location, String note) {
         this.title = title;
         this.author = author;
-        this.category = category;
+        this.category = Category.fromString(category);
         this.condition = Condition.fromString(condition);
         this.note = note;
         this.location = location;
@@ -33,7 +33,7 @@ public String getAuthor() {
         return author;
     }
 
-    public String getCategory() {
+    public Category getCategory() {
         return category;
     }
 
@@ -62,7 +62,7 @@ public void setCondition(String condition){
     }
 
     public void setCategory(String category){
-        this.category = category;
+        this.category = Category.fromString(category);
     }
 
     public void setAuthor(String author){
@@ -84,7 +84,7 @@ public void setLocation(String location) {
     public String toFileString() {
         String title = getTitle();
         String author = getAuthor();
-        String category = getCategory();
+        Category category = getCategory();
         Condition condition = getCondition();
         boolean onLoan = isOnLoan();
         String location = getLocation();

src/main/java/bookkeeper/model/Category.java

@@ -0,0 +1,32 @@
+package bookkeeper.model;
+
+public enum Category {
+    ROMANCE, ADVENTURE, ACTION, HORROR, MYSTERY, FICTION, NONFICTION, SCIFI, EDUCATION;
+
+    public static Category fromString(String category) {
+        switch (category.toLowerCase()) {
+        case "romance":
+            return ROMANCE;
+        case "adventure":
+            return ADVENTURE;
+        case "action":
+            return ACTION;
+        case "horror":
+            return HORROR;
+        case "mystery":
+            return MYSTERY;
+        case "fiction":
+            return FICTION;
+        case "non-fiction":
+        case "nonfiction":
+            return NONFICTION;
+        case "scifi":
+            return SCIFI;
+        case "education":
+            return EDUCATION;
+        default:
+            throw new IllegalArgumentException("Invalid category: " + category + "\nValid categories are: " +
+                    "romance, adventure, action, horror, mystery, fiction, nonfiction, scifi, education");
+        }
+    }
+}

src/main/java/bookkeeper/storage/Storage.java

@@ -112,7 +112,6 @@ public static ArrayList<Book> loadInventory() {
 
                 // Skip invalid book entries
                 if (book == null) {
-                    Formatter.printBorderedMessage("Invalid book entry skipped: " + line);
                     continue;
                 }
 
@@ -159,7 +158,6 @@ public static ArrayList<Loan> loadLoans(BookList bookList) {
 
                 // Skip invalid loans
                 if (loan == null) {
-                    Formatter.printBorderedMessage("Invalid loan entry skipped: " + line);
                     continue;
                 }
 
@@ -200,8 +198,17 @@ private static Book parseBookFromString(String line) {
         String location = parts[5].trim();
         String note = (parts.length == 7) ? parts[6].trim() : "";
 
+        Book book;
         // Normalize case for title, author, and category
-        return new Book(title, author, category, condition, location, note);
+        try { 
+            book = new Book(title, author, category, condition, location, note);
+        }
+        catch (IllegalArgumentException e) {
+            // Handle invalid book creation
+            Formatter.printBorderedMessage("Invalid book entry skipped: " + line + "\nReason: " + e.getMessage());
+            return null; // Skip this book
+        }
+        return book;
     }
 
     private static Loan parseLoanFromString(String line, BookList bookList) {

src/test/java/bookkeeper/BookListTest.java

@@ -9,6 +9,7 @@
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.util.ArrayList;
 
@@ -74,14 +75,17 @@ void testFindBooksByKeyword() {
 
     @Test
     void testFindBooksByCategory() {
+        Book book4 = new Book("Book Four", "Author Four", "nonfiction", "Good", "Shelf 4");
         bookList.addBook(book1);
         bookList.addBook(book2);
         bookList.addBook(book3);
+        bookList.addBook(book4);
 
         ArrayList<Book> foundBooks = bookList.findBooksByCategory("Non-Fiction");
         assertEquals(foundBooks.get(0), book2);
         assertEquals(foundBooks.get(1), book3);
         assertNotEquals(foundBooks.get(0), book1);
         assertNotEquals(foundBooks.get(1), book1);
+        assertTrue(foundBooks.contains(book4));
     }
 }