Merge pull request #44 from IronBiscuit/master

List Inventory

Author: IronBiscuit

docs/AboutUs.md

@@ -3,7 +3,7 @@ layout: page
 title: About Us
 ---
 
-We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg), formed 
+We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg), formed
 to fulfill the team project requirements of [CS2103T](https://nusmods.com/modules/CS2103T/software-engineering)
 
 You can reach us at the email `seer[at]comp.nus.edu.sg`
@@ -64,7 +64,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 <img src="images/howtoosee.png" width="200px">
 
-[[github](https://github.com/howtoosee)] 
+[[github](https://github.com/howtoosee)]
 [[portfolio](team/xihao.md)]
 
 * Role: Developer

docs/DeveloperGuide.md

@@ -264,7 +264,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 ### Use cases
 For all use cases (unless specified otherwise):
 - The **System** is `NUStorage`
-- The **Actor** is `User` 
+- The **Actor** is `User`
 
 
 **Use case: Add an inventory item**
@@ -277,7 +277,7 @@ For all use cases (unless specified otherwise):
 4.  NUStorage adds the item to the list
 
     Use case ends.
-    
+
 **Use case: Remove an inventory item**
 
 **MSS**
@@ -330,7 +330,7 @@ For all use cases (unless specified otherwise):
     * 3a1. NUStorage shows an error message.
 
       Use case resumes at step 2.
-      
+
 **Use case: List finance/inventory records**
 
 **MSS**
@@ -341,7 +341,7 @@ For all use cases (unless specified otherwise):
 * 2a. The list is empty.
 
   Use case ends.
-  
+
 **Use case: Save finance / inventory records**
 
 **MSS**
@@ -356,7 +356,7 @@ For all use cases (unless specified otherwise):
 1. User requests to exit NUStorage
 2. NUStorage saves both finance and inventory records and shows a goodbye message
 3. NUStorage terminates after 1.5 seconds
-  
+
 
 
 ### Non-Functional Requirements
@@ -371,7 +371,7 @@ For all use cases (unless specified otherwise):
 
 * **Mainstream OS**: Windows, Linux, Unix, OS-X
 * **Inventory**: An item that a user wishes to record. An inventory item can refer to any existing object
-* **Finances**: A record that allows a user to monitor his earnings and spending. 
+* **Finances**: A record that allows a user to monitor his earnings and spending.
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -403,7 +403,7 @@ testers are expected to do more *exploratory* testing.
 1. Shutting Down
 
     1. If you would like to save your records prior to shutting down, remember to enter the `save` command
-    
+
     1. Close the app by simply clicking on the close button or enter the `exit` command.
 
 ### Deleting a record
@@ -426,13 +426,13 @@ testers are expected to do more *exploratory* testing.
 1. Adding a financial/inventory record.
 
     1. Prerequisites: None
-    
+
     1. Test case: `add_inventory i/MacBook n/10`<br>
         Expected: An inventory item 'MacBook' is added with the quantity of 10. Details of the added record shown in the status message.
-        
+
     1. Test case: `add_finance op/in amt/1000`
         Expected: A finance record of an increase by $1000.00 is added. Details of the added record shown in status message.
-        
+
     1. Other incorrect add commands to try: `add`, `add_record`, `add_inventory i/MacBook` <br>
         Expected: No record is added. Error details shown in the status message.
 

src/main/java/nustorage/logic/Logic.java

@@ -9,6 +9,7 @@
 import nustorage.logic.parser.exceptions.ParseException;
 import nustorage.model.ReadOnlyAddressBook;
 import nustorage.model.person.Person;
+import nustorage.model.record.InventoryRecord;
 
 /**
  * API of the Logic component
@@ -33,6 +34,8 @@ public interface Logic {
     /** Returns an unmodifiable view of the filtered list of persons */
     ObservableList<Person> getFilteredPersonList();
 
+    ObservableList<InventoryRecord> getFilteredInventory();
+
     /**
      * Returns the user prefs' address book file path.
      */

src/main/java/nustorage/logic/LogicManager.java

@@ -15,6 +15,7 @@
 import nustorage.model.Model;
 import nustorage.model.ReadOnlyAddressBook;
 import nustorage.model.person.Person;
+import nustorage.model.record.InventoryRecord;
 import nustorage.storage.Storage;
 
 /**
@@ -64,6 +65,10 @@ public ObservableList<Person> getFilteredPersonList() {
         return model.getFilteredPersonList();
     }
 
+    public ObservableList<InventoryRecord> getFilteredInventory() {
+        return model.getFilteredInventory();
+    }
+
     @Override
     public Path getAddressBookFilePath() {
         return model.getAddressBookFilePath();

src/main/java/nustorage/logic/commands/AddInventoryCommand.java

@@ -33,7 +33,6 @@ public AddInventoryCommand(InventoryRecord newInventoryRecord, FinanceRecord new
     @Override
     public CommandResult execute(Model model) throws CommandException {
         requireNonNull(model);
-
         model.addInventoryRecord(newInventoryRecord);
         model.addFinanceRecord(newFinanceRecord);
         return new CommandResult(String.format(MESSAGE_SUCCESS, newInventoryRecord));

src/main/java/nustorage/logic/commands/CommandResult.java

@@ -17,6 +17,7 @@ public class CommandResult {
     /** The application should exit. */
     private final boolean exit;
 
+
     /**
      * Constructs a {@code CommandResult} with the specified fields.
      */

src/main/java/nustorage/logic/commands/ListInventoryCommand.java

@@ -0,0 +1,27 @@
+package nustorage.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+import static nustorage.model.Model.PREDICATE_SHOW_ALL_INVENTORY;
+
+import javafx.collections.ObservableList;
+import nustorage.model.Model;
+import nustorage.model.record.InventoryRecord;
+
+/**
+ * Lists all persons in the address book to the user.
+ */
+public class ListInventoryCommand extends Command {
+
+    public static final String COMMAND_WORD = "list_inventory";
+
+    public static final String MESSAGE_SUCCESS = "Listed all inventory items!";
+
+
+    @Override
+    public CommandResult execute(Model model) {
+        requireNonNull(model);
+        model.updateFilteredInventoryList(PREDICATE_SHOW_ALL_INVENTORY);
+        ObservableList<InventoryRecord> inventory = model.getFilteredInventory();
+        return new CommandResult(MESSAGE_SUCCESS);
+    }
+}

src/main/java/nustorage/logic/parser/AddressBookParser.java

@@ -18,6 +18,7 @@
 import nustorage.logic.commands.FindCommand;
 import nustorage.logic.commands.HelpCommand;
 import nustorage.logic.commands.ListCommand;
+import nustorage.logic.commands.ListInventoryCommand;
 import nustorage.logic.commands.ListFinanceRecordsCommand;
 import nustorage.logic.parser.exceptions.ParseException;
 
@@ -47,6 +48,8 @@ public Command parseCommand(String userInput) throws ParseException {
         final String commandWord = matcher.group("commandWord");
         final String arguments = matcher.group("arguments");
         switch (commandWord) {
+        case ListInventoryCommand.COMMAND_WORD:
+            return new ListInventoryCommand();
 
         case AddInventoryCommand.COMMAND_WORD:
             return new AddInventoryCommandParser().parse(arguments);

src/main/java/nustorage/model/Model.java

@@ -18,6 +18,7 @@
 public interface Model {
     /** {@code Predicate} that always evaluate to true */
     Predicate<Person> PREDICATE_SHOW_ALL_PERSONS = unused -> true;
+    Predicate<InventoryRecord> PREDICATE_SHOW_ALL_INVENTORY = unused -> true;
 
     /**
      * Replaces user prefs data with the data in {@code userPrefs}.
@@ -92,9 +93,13 @@ public interface Model {
     /** Returns an unmodifiable view of the filtered person list */
     ObservableList<Person> getFilteredPersonList();
 
+    ObservableList<InventoryRecord> getFilteredInventory();
+
     /**
      * Updates the filter of the filtered person list to filter by the given {@code predicate}.
      * @throws NullPointerException if {@code predicate} is null.
      */
     void updateFilteredPersonList(Predicate<Person> predicate);
+
+    void updateFilteredInventoryList(Predicate<InventoryRecord> predicate);
 }

src/main/java/nustorage/model/ModelManager.java

@@ -31,6 +31,7 @@ public class ModelManager implements Model {
     private final AddressBook addressBook;
     private final UserPrefs userPrefs;
     private final FilteredList<Person> filteredPersons;
+    private final FilteredList<InventoryRecord> filteredInventory;
 
     /**
      * Initializes a ModelManager with the given addressBook and userPrefs.
@@ -42,6 +43,7 @@ public ModelManager(ReadOnlyAddressBook addressBook, ReadOnlyUserPrefs userPrefs
         logger.fine("Initializing with address book: " + addressBook + " and user prefs " + userPrefs);
 
         this.inventory = new Inventory();
+        filteredInventory = new FilteredList<>(this.inventory.asUnmodifiableObservableList());
         this.financeAccount = new FinanceAccount();
         this.addressBook = new AddressBook(addressBook);
         this.userPrefs = new UserPrefs(userPrefs);
@@ -93,6 +95,19 @@ public void addInventoryRecord(InventoryRecord newRecord) {
         inventory.addInventoryRecord(newRecord);
     }
 
+    public ObservableList<InventoryRecord> getFilteredInventory() {
+        return filteredInventory;
+    }
+
+    /**
+     * Applies a predicate to the Inventory and returns those that pass it.
+     * @param predicate the predicate used to filter Inventory
+     */
+    public void updateFilteredInventoryList(Predicate<InventoryRecord> predicate) {
+        requireNonNull(predicate);
+        filteredInventory.setPredicate(predicate);
+    }
+
     //=========== FinanceAccount ================================================================================
 
     @Override
@@ -163,6 +178,7 @@ public void updateFilteredPersonList(Predicate<Person> predicate) {
         filteredPersons.setPredicate(predicate);
     }
 
+
     @Override
     public boolean equals(Object obj) {
         // short circuit if same object