Merge branch 'master' into update-developer-guide

dylankhoo · web-flow · commit a558fb7514c8 · 2025-04-08T04:26:12.000+08:00
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -599,6 +599,23 @@ The following UML sequence diagram shows how the `delete-note BOOK_TITLE` comman
 
    `InputHandler` uses `Formatter` to print a message indicating that the note was successfully deleted
 
+### Search Title
+
+The `search-title` feature allows the user to search for books in the inventory by providing a keyword. The system returns a list of books whose titles contain the specified keyword.
+
+`InputHandler` coordinates with `InputParser`, `BookList`, and `Formatter` classes to implement the feature.
+
+1. User issues command:
+   The user inputs the command in the CLI with the required keyword, e.g., `search-title Gatsby`.
+2. `InputHandler` first calls `InputParser.extractCommandArgs(...)` to split the user input into command arguments.
+3. `InputHandler` checks if the keyword is valid (non-empty). If invalid, an error message is displayed.
+4. InputHandler calls `BookList.findBooksByKeyword(keyword)` to retrieve a list of books whose titles contain the keyword.
+5. `InputHandler` uses `Formatter` to print the list of matching books.
+
+Design Considerations:
+- Case Insensitivity: The search is case-insensitive to improve usability.
+  
+
 ### Save Inventory
 
 The save inventory feature automatically saves the inventory each time the user makes a change.
@@ -682,6 +699,53 @@ The following UML sequence diagram shows the relevant behaviour:
    - A message is printed indicating the number of books loaded.
    - The populated `bookList` is returned.
 
+
+### Save Loans
+
+The save loans feature ensures that all loans are saved to persistent storage whenever there is a change to the `LoanList`. If no existing persistent storage file is detected, it will be created in the default location `./data/bookKeeper_loanList.txt`. The file path can also be customized using the setLoanFilePath() method.
+
+The method `saveLoans(loanList)` is invoked by `InputHandler` after any method call that makes changes to the current loan list.
+
+The following UML sequence diagram shows the relevant behavior:
+
+![saveLoans.png](images/saveLoans.png)
+
+1. Initialization: `InputHandler` invokes `Storage.saveLoans(loanList)`.
+2. Directory Check: A `File` object is created for the directory. If the directory does not exist, it is created using `mkdirs()`.
+3. FileWriter Creation: A new `FileWriter` is created for the file at the path specified by `loanListFilePath`.
+4. Retrieving Loan List: `getLoanList()` is called on the `LoanList` instance passed into `saveLoans(loanList)` to obtain the list of Loan objects.
+5. Writing Each Loan: For each `Loan` in the list, `toFileString()` is called to get a string representation. This string is then written to the file via `FileWriter`.
+6. Closing: After writing all loans, `FileWriter` is closed to complete the writing process.
+
+Error Handling: If an `IOException` occurs during any file operations, an error message is displayed via `Formatter.printBorderedMessage()`.
+
+### Load Loans
+
+The load loans feature loads the loan list from the existing persistent data storage file if it exists. If it does not exist, an empty loan list is used. The file path defaults to `./data/bookKeeper_loanList.txt` but can be customized using the `setLoanFilePath()` method.
+
+The method `loadLoans(bookList)` is called once by `InputHandler` at the start of the program.
+
+The following UML sequence diagram shows the relevant behavior:
+
+![loadLoans.png](images/loadLoans.png)
+
+1. Initialization: 
+
+`InputHandler` invokes `Storage.loadLoans(bookList)`, which initializes an empty `ArrayList<Loan>`.
+
+2. File Existence Check: A `File` object is created for the loan file path.
+- If the file does not exist:
+A message is printed using `Formatter.printBorderedMessage()` indicating no saved loans were found. A new file is created, and an empty `ArrayList<Loan>` is returned.
+
+3. File Reading: If the file exists, a `Scanner` reads the file line by line. Each line is passed to `parseLoanFromString(line, bookList)` to convert it into a Loan object.
+
+4. Loan Validation: If the `Loan` is null, a message is printed indicating the entry was skipped.
+- If valid, duplicates are checked using `loanList.stream().anyMatch(...)`.
+  - If a duplicate is found, a message is printed, and the loan is skipped.
+  - Otherwise, the loan is added to the loanList.
+
+5. Completion: After processing all lines in the file, the `Scanner` is closed. A message is printed indicating the number of loans loaded. The populated `loanList` is returned.
+
 ## Appendix A: Product scope
 
 ### Target user profile
diff --git a/docs/diagrams/loadInventory.puml b/docs/diagrams/loadInventory.puml
@@ -4,6 +4,7 @@ participant Storage as ":Storage"
 participant File as ":File"
 participant Formatter as ":Formatter"
 participant Scanner as ":Scanner"
+participant Book as ":Book"
 
 
 InputHandler -> Storage: loadInventory()
diff --git a/docs/diagrams/loadLoans.puml b/docs/diagrams/loadLoans.puml
@@ -0,0 +1,108 @@
+@startuml
+participant InputHandler as ":InputHandler"
+participant Storage as ":Storage"
+participant File as ":File"
+participant Formatter as ":Formatter"
+participant Scanner as ":Scanner"
+participant loan as ":Loan"
+
+
+InputHandler -> Storage: loadInventory()
+activate Storage
+
+' Create a new empty loanList
+create loanList as ":loanList"
+Storage -> loanList: new ArrayList<loan>()
+activate loanList
+loanList --> Storage: loanList
+deactivate loanList
+
+' Create File object for LOAN_LIST_FILE_PATH
+Create File
+Storage -> File: new File(LOAN_LIST_FILE_PATH)
+activate File
+File --> Storage: file
+deactivate File
+
+opt !file.exists()
+    Storage -> Formatter: printBorderedMessage("No saved loans found...")
+    activate Formatter
+
+    Formatter --> Storage
+    deactivate Formatter
+    
+    Storage --> InputHandler: empty loanList
+    end
+    ' Open the file using a Scanner
+    create Scanner
+    Storage -> Scanner: new Scanner(file)
+    activate Scanner
+    Scanner --> Storage: scanner
+    deactivate Scanner
+
+    loop scanner.hasNextLine()
+        Storage -> Scanner: nextLine()
+        activate Scanner
+
+        Scanner --> Storage: line
+        deactivate Scanner
+
+        Storage -> Storage: parseloanFromString(line)
+        activate Storage
+        alt line has invalid format
+            note over File
+            returns null if the line has invalid format
+            end note
+        else else
+            create loan
+            Storage -> loan: create loan with arguments provided in line
+            activate loan
+            loan --> Storage: loan
+            deactivate loan
+        end
+        Storage --> Storage: loan
+        deactivate Storage
+
+        opt loan != null
+            ' Check for duplicate loan
+            Storage -> loanList: Check for duplicate loan objects using stream
+            activate loanList
+            loanList --> Storage: isDuplicate
+            deactivate loanList
+            alt isDuplicate
+                ' loan already exists, skip adding it
+                Storage -> Formatter: printBorderedMessage("Duplicate loan found...")
+                activate Formatter
+                Formatter --> Storage
+                deactivate Formatter
+                
+            else else
+                ' Add loan to loanList
+                Storage -> loanList: add(loan)
+                activate loanList
+                loanList --> Storage
+                deactivate loanList
+            end 
+        end
+    end
+
+    
+
+    Storage -> Scanner: close()
+    activate Scanner
+    Scanner --> Storage
+    deactivate Scanner
+    destroy Scanner
+    ' Print message with number of loans loaded
+    Storage -> Formatter: printBorderedMessage("Loaded...")
+    activate Formatter
+    Formatter --> Storage
+    deactivate Formatter
+    
+
+    Storage --> InputHandler: loanList
+    destroy File
+    deactivate Storage
+
+deactivate Storage
+@enduml
diff --git a/docs/diagrams/saveLoans.puml b/docs/diagrams/saveLoans.puml
@@ -0,0 +1,68 @@
+@startuml
+
+participant InputHandler as ":InputHandler"
+participant Storage as ":Storage"
+participant LoanList as ":LoanList"
+participant File as ":File"
+participant FileWriter as ":FileWriter"
+participant Loan as ":Loan"
+participant Formatter as ":Formatter"
+
+activate InputHandler
+
+InputHandler -> Storage: saveLoans(loanList)
+activate Storage
+
+' Check if directory exists
+Storage -> File ** : new File(FOLDER_PATH)
+activate File
+File --> Storage: directory
+deactivate File
+opt Directory does not exist
+    Storage -> File: mkdirs()
+    activate File
+    File --> Storage: 
+    deactivate File
+end
+
+deactivate File
+
+' Create FileWriter for LOAN_LIST_FILE_PATH
+Storage -> FileWriter ** : new FileWriter(LOAN_LIST_FILE_PATH)
+activate FileWriter
+
+FileWriter --> Storage: fileWriter
+deactivate FileWriter
+
+' Retrieve list of Loans from LoanList
+Storage -> LoanList: getLoanList()
+activate LoanList
+LoanList --> Storage: List<Loan>
+deactivate LoanList
+
+' Loop through each Loan and write its file string
+loop for each Loan in LoanList
+    Storage -> Loan: toFileString()
+    activate Loan
+    Loan --> Storage: fileString
+    deactivate Loan
+    Storage -> FileWriter: write(fileString + lineSeparator)
+    activate FileWriter
+    FileWriter --> Storage:
+    deactivate FileWriter
+end
+
+' Close the FileWriter
+Storage -> FileWriter: close()
+activate FileWriter
+
+FileWriter --> Storage
+deactivate FileWriter 
+
+destroy FileWriter
+Storage --> InputHandler 
+deactivate Storage
+
+destroy File
+
+@enduml
diff --git a/docs/images/loadLoans.png b/docs/images/loadLoans.png
diff --git a/docs/images/saveLoans.png b/docs/images/saveLoans.png
diff --git a/src/main/java/bookkeeper/exceptions/ErrorMessages.java b/src/main/java/bookkeeper/exceptions/ErrorMessages.java
@@ -78,7 +78,7 @@ public final class ErrorMessages {
     public static final String INVALID_FORMAT_DELETE_NOTE = "Invalid format for delete-note.\n" +
             "Expected format: delete-note BOOK_TITLE";
 
-    public static final String INVALID_FORMAT_SEARCH_BOOK = "Invalid format for search-title.\n" +
+    public static final String INVALID_FORMAT_SEARCH_TITLE = "Invalid format for search-title.\n" +
             "Expected format: search-title KEYWORD";
 
     public static final String INVALID_FORMAT_LIST_CATEGORY = "Invalid format for list-category.\n" +
diff --git a/src/main/java/bookkeeper/list/BookList.java b/src/main/java/bookkeeper/list/BookList.java
@@ -27,15 +27,6 @@ public void addBook(Book book) {
         bookList.add(book);
     }
 
-    public Book findBookByTitle(String title) {
-        for (Book book : bookList) {
-            if (book.getTitle().equalsIgnoreCase(title)) { // Use equalsIgnoreCase for case-insensitive comparison
-                return book;
-            }
-        }
-        return null;
-    }
-
     public Book searchBook(String title) {
         for (Book book : bookList) {
             if (book.getTitle().equals(title)) { 
diff --git a/src/main/java/bookkeeper/logic/InputHandler.java b/src/main/java/bookkeeper/logic/InputHandler.java
@@ -78,7 +78,7 @@ public void askInput() {
                         updateBook(commandArgs);
                         break;
                     case "search-title":
-                        searchBook(commandArgs);
+                        searchTitle(commandArgs);
                         break;
                     case "list-category":
                         listCategory(commandArgs);
@@ -172,7 +172,7 @@ private void addLoan(String[] commandArgs) throws IncorrectFormatException, Book
         }
         try {
             String[] loanArgs = InputParser.extractAddLoanArgs(commandArgs[1]);
-            Book loanedBook = bookList.findBookByTitle(loanArgs[0]);
+            Book loanedBook = bookList.searchBook(loanArgs[0]);
             if (loanedBook == null) {
                 Formatter.printBorderedMessage("Book not found in inventory: " + loanArgs[0]);
             } else if (loanedBook.isOnLoan()) {
@@ -205,7 +205,7 @@ private void deleteNote(String[] commandArgs) throws IncorrectFormatException, B
 
         String bookTitle = commandArgs[1].trim();
 
-        Book book = bookList.findBookByTitle(bookTitle);
+        Book book = bookList.searchBook(bookTitle);
         if (book == null) {
             throw new BookNotFoundException("Book not found in inventory: " + bookTitle);
         }
@@ -236,7 +236,7 @@ private void addBook(String[] commandArgs) throws IncorrectFormatException, Ille
         String bookTitle = bookArgs[0]; //Already trimmed whitespaces in extractAddBookArgs
 
         // Check if book already exists in the inventory
-        if (bookList.findBookByTitle(bookTitle) != null) {
+        if (bookList.searchBook(bookTitle) != null) {
             Formatter.printBorderedMessage("Book already exists in inventory: " + bookTitle);
             return;
         }
@@ -268,7 +268,7 @@ private void removeBook(String[] commandArgs) throws IncorrectFormatException, B
             throw new IncorrectFormatException(ErrorMessages.INVALID_FORMAT_REMOVE_BOOK);
         }
         String bookTitle = commandArgs[1].trim();
-        Book toRemove = bookList.findBookByTitle(bookTitle);
+        Book toRemove = bookList.searchBook(bookTitle);
 
         if (toRemove == null) {
             Formatter.printBorderedMessage("Book not found in inventory: " + bookTitle);
@@ -295,7 +295,7 @@ private void deleteLoan(String[] commandArgs) throws IncorrectFormatException, B
         }
         try {
             String bookTitle = commandArgs[1];
-            Book loanedBook = bookList.findBookByTitle(bookTitle);
+            Book loanedBook = bookList.searchBook(bookTitle);
             Loan loan = loanList.findLoan(loanedBook);
             if (loanedBook == null) {
                 Formatter.printBorderedMessage("Book not found in inventory: " + bookTitle);
@@ -322,9 +322,9 @@ private void deleteLoan(String[] commandArgs) throws IncorrectFormatException, B
      * @param commandArgs The parsed command arguments
      * @throws IncorrectFormatException If the input format is invalid
      */
-    private void searchBook(String[] commandArgs) throws IncorrectFormatException {
+    private void searchTitle(String[] commandArgs) throws IncorrectFormatException {
         if (commandArgs.length < 2) {
-            throw new IncorrectFormatException(ErrorMessages.INVALID_FORMAT_SEARCH_BOOK);
+            throw new IncorrectFormatException(ErrorMessages.INVALID_FORMAT_SEARCH_TITLE);
         }
 
         String keyword = commandArgs[1].trim();
@@ -417,12 +417,12 @@ private void updateTitle(String[] commandArgs) throws IncorrectFormatException,
             throw new IncorrectFormatException(ErrorMessages.INVALID_FORMAT_SAME_TITLE);
         }
 
-        if(bookList.findBookByTitle(newTitle) != null) {
+        if(bookList.searchBook(newTitle) != null) {
             throw new IncorrectFormatException(ErrorMessages.INVALID_FORMAT_DUPLICATE_TITLE);
         }
 
         // Check if book already exists in the inventory
-        Book book = bookList.findBookByTitle(oldTitle);
+        Book book = bookList.searchBook(oldTitle);
         if (book == null) {
             throw new BookNotFoundException("Book not found in inventory: " + oldTitle);
         }
@@ -449,7 +449,7 @@ private void editLoan(String[] commandArgs) throws IncorrectFormatException, Boo
         String email = editLoanArgs[4];
 
         // Check if book already exists in the inventory
-        Book book = bookList.findBookByTitle(bookTitle);
+        Book book = bookList.searchBook(bookTitle);
         Loan loan = loanList.findLoan(book);
 
         if (book == null) {
diff --git a/src/main/java/bookkeeper/storage/Storage.java b/src/main/java/bookkeeper/storage/Storage.java
@@ -117,7 +117,7 @@ public static ArrayList<Book> loadInventory() {
 
                 // Skip duplicate books
                 boolean isDuplicate = bookList.stream()
-                        .anyMatch(existingBook -> existingBook.getTitle().equalsIgnoreCase(book.getTitle()));
+                        .anyMatch(existingBook -> existingBook.getTitle().equals(book.getTitle()));
                 if (isDuplicate) {
                     Formatter.printBorderedMessage("Duplicate book found and skipped: " + book.getTitle());
                     continue;
@@ -225,7 +225,7 @@ private static Loan parseLoanFromString(String line, BookList bookList) {
         String email = parts[4].trim();
 
         // Find the book in the inventory
-        Book loanedBook = bookList.findBookByTitle(title);
+        Book loanedBook = bookList.searchBook(title);
         if (loanedBook == null) {
             Formatter.printBorderedMessage("Invalid loan: Book not found in inventory - " + title);
             return null; // Skip this loan
diff --git a/src/test/java/bookkeeper/BookListTest.java b/src/test/java/bookkeeper/BookListTest.java
