[CS2113-F14-4] Financer

.github/workflows/gradle.yml

@@ -32,19 +32,3 @@ jobs:
 
       - name: Build and check with Gradle
         run: ./gradlew check
-
-      - name: Perform IO redirection test (*NIX)
-        if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (MacOS)
-        if: always() && runner.os == 'macOS'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (Windows)
-        if: always() && runner.os == 'Windows'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        shell: cmd
-        run: runtest.bat

.gitignore

@@ -15,3 +15,7 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+data/data.txt
+..gitignore.un~
+config/.idea/
+/*.class

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "java.configuration.updateBuildConfiguration": "interactive"
+}

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# Finance Calculator
 
 This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
 

build.gradle

@@ -14,6 +14,7 @@ dependencies {
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.0'
 }
 
+
 test {
     useJUnitPlatform()
 
@@ -29,11 +30,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("financeproject.Main")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("project")
     archiveClassifier.set("")
 }
 
@@ -43,4 +44,7 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }
+
+

compile.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# Define the base directory variables
+SRC_DIR="src"
+BUILD_DIR="build"
+CLASSES_DIR="$BUILD_DIR/classes"
+LIBS_DIR="$BUILD_DIR/libs"
+JAR_NAME="Financer.jar"
+
+
+# Compile the Java files
+find "$SRC_DIR" -name "*.java" ! -path "*/test/*" > sources.txt
+javac -d "$CLASSES_DIR" @sources.txt
+rm sources.txt
+
+# Package the .class files into a .jar file
+cd "$CLASSES_DIR"
+jar cvf "../libs/$JAR_NAME" *
+cd -
+
+echo "Compilation and packaging complete."

data/passwords.txt

@@ -0,0 +1 @@
+Bob|password

docs/AboutUs.md

@@ -2,7 +2,7 @@
 
 Display | Name | Github Profile | Portfolio 
 --------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Dylan | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
 ![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
 ![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
 ![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)

docs/DeveloperGuide.md

@@ -3,36 +3,138 @@
 ## Acknowledgements
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+- [CS2113 Course Website](https://nus-cs2113-ay2324s2.github.io/website/index.html)
 
 ## Design & implementation
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
-
+The financial manager application is designed using an object-oriented approach, focusing on user authentication, transaction management, and user interaction. The core components include:
+
+- **Main Application Loop**: Handles the initialization of the application, including loading data from storage, authenticating the user, and processing user commands until the application exits.
+- **Command Pattern**: User commands are encapsulated as objects, allowing for the addition of new commands with minimal changes to existing code.
+- **Transaction Management**: Separate classes for managing inflows and outflows, with a unified interface for adding, editing, and deleting transactions.
+- **User Authentication**: Ensures that users are authenticated before accessing their financial data, with a mechanism to track and limit failed attempts.
+- **Inactivity Timer**: Automatically logs out users after a period of inactivity, enhancing security.
+- **Storage Management**: Handles the persistent storage of transaction data, allowing users to save and load their financial information.
+- **[Proposed] Security features**: A maximum of three login attempts are inputted, failing which would cause the application to be exited automatically.
+- **[Proposed] Financial transaction visualiser**: When viewing history of transactions, the data will be visualised using bar charts for better user friendliness.
+- **[Proposed] Undo functionality**: Allows users to undo  their last prompt, but only permittable 10 seconds after the last action. 
+
+### View Transaction History feature:
+
+#### Implementation Details:
+
+#### Functionality:
+The View History feature allows users to retrieve a list of their recent transactions, categorized as inflows and outflows. The user can specify the number of transactions they want to view, and the system presents these transactions in reverse chronological order, with the latest transactions displayed first. Each transaction is presented with its description, date, and time of occurrence.
+
+#### Design Considerations:
+- **Data Structure**: The transaction data is stored in an instance of the `TransactionList` class, which is part of the `financialtransactions` package. This list maintains a record of all transactions made by the user, ensuring easy retrieval and manipulation of transaction data.
+- **Categorization**: Transactions are categorized as inflow or outflow based on their type. This categorization enables users to differentiate between different types of financial activities, such as income and expenses.
+- **Formatting**: The transactions are presented in a formatted string, providing clear and concise information to the user. Each transaction includes its description, date, and time.
+
+#### Implementation Details:
+- The `TransactionManager#showLastNTransactions()` method is responsible for retrieving the last N transactions from the Transaction List.
+- The method iterates over the transaction list in reverse order, starting from the latest transaction and moving towards older transactions.
+- Transactions are categorized as inflows or outflows based on their instance type (Inflow or Outflow), and the relevant transactions are added to the output string accordingly.
+- The formatted string containing the transaction details is returned to the user for display.
+
+#### Alternatives Considered:
+During the development of the View Transaction History feature, several alternatives were considered to achieve the desired functionality. These alternatives included:
+
+- Implementing a more complex data structure for storing transaction history, such as a linked list. However, a simple ArrayList-based approach was chosen for its simplicity and efficiency in managing transaction data.
+- Providing additional filtering options, such as filtering transactions by date range or transaction category. While these options could definitely enhance the feature, they were deemed unnecessary for the initial implementation and may be considered for future iterations.
+
+### Save File feature:
+The `Storage#saveFile()` method will be called when the user decides to quit the application, the method will then get a string of all the transactions. This string will then be written to a file whose filename will be the username of the last user.
+
+#### Implementation Details:
+- The method first creates a FileWriter object.
+- It then calls `TransactionManager#toSave()`. 
+  - This method is similar to `toString()`, except that it creates a string that is more storage friendly.
+  - In this method, each transaction is returned as `name|amount|date|category\n`. 
+  - Each transaction is added line by line, after adding all transactions, the string is returned in the toSave() method.
+  - It is important to note that outflows are saved with a `-` in front of the amount. 
+- With the string generated in the `toSave()` method, the FileWriter will write it to the file before closing it.
+
+### Load File feature:
+The `Storage#loadFile()` method will be called after the user as logged in, it will then retrieve the transactions that were written in the past sessions, so that the user can continue using the finance manger.
+
+#### Implementation Details:
+- The method first creates a File object and a Transaction Manager object.
+- If the file exists
+  - The method will read from the file line by line, splitting each line by `|`. A new inflow or outflow object will be created with those values and then added to the Transaction Manager Object.
+- If the file does not exist
+  - An empty transaction manager object will be returned.
+- To differentiate between inflow or outflow, the `-` in front of the amount will be used.
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+The financial manager application is designed for individual users seeking a simple yet powerful tool to manage personal finances, including tracking income and expenses, and viewing transaction history.
+
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+This application simplifies personal financial management by providing an intuitive interface for tracking and analyzing income and expenses. Users can easily add, edit, or delete transactions, view recent transaction history, and ensure their data is securely managed with user authentication and automatic logout features.
+
 
 ## User Stories
 
-|Version| As a ... | I want to ... | So that I can ...|
-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+|Version| As a/an ... | I want to ... | So that ...|
+|-------|-------------|---------------|------------|
+|v1.0|user|receive alerts or notifications when I exceed my budget limits for specific expense categories|I can stay within my financial goals|
+|v1.0|user|generate monthly reports summarizing my income, expenses, and budget performance|I can track my financial progress over time|
+|v1.0|user|edit or delete past transactions|I can correct any errors or update information as needed|
+|v1.0|user|search for specific transactions based on keywords, dates, or categories|I can quickly find the information I need|
+|v1.0|user|add income transactions with details such as amount, date, and category|I can keep track of my earnings|
+|v1.0|user|add expense transactions with details such as amount, date, and category|I can monitor where my money is going|
+|v1.0|user|categorize my transactions|I can organize my finances and have a clearer view of my income and expenses|
+|v1.0|user|add instalment payments into the tracker|I can track finances for big ticket purchases such as furniture/TVs|
+|v1.0|user|Use a customisable interface for my financial goals|I can adjust these financial goals accordingly as time passes|
+|v1.0|user|add payment types such as credit card, debit card or cash|I can be reminded to pay credit card bills each month|
+|v1.0|user|Be confident that my banking information is encrypted and safe from being accessed by others|The private information is not easily leaked to others|
+|v2.0|user|Export my financial reports as a CSV|I can share my expenditure with my peers|
+|v2.0|user|Visualise my transactions in more meaningful diagrams|I can better understand my spending|
 
 ## Non-Functional Requirements
 
-{Give non-functional requirements}
+1. **Security**: User authentication must be secure, with a limit on login attempts to prevent unauthorized access.
+2. **Usability**: The application should be easy to use, with clear instructions and feedback for users.
+3. **Performance**: The application should respond quickly to user inputs, with minimal delays in processing transactions.
+4. **Reliability**: Data storage should be reliable, ensuring that user data is not lost between sessions.
+
 
 ## Glossary
 
-* *glossary item* - Definition
+1. **Inflow** - A financial transaction representing income or money received.
+2. **Outflow** - A financial transaction representing expenses or money spent.
+
 
 ## Instructions for manual testing
 
-{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
+### Login Procedure:
+- Start the application and enter your username and password when prompted.
+- Test incorrect passwords to ensure the application correctly limits login attempts. 
+- [v2.0] If there are three incorrect attempts, the application will automatically exit and the user has to try again.
+
+### Adding Transactions:
+- Use the `add-inflow` and `add-outflow` commands to add new transactions, following the command format provided in the `help` command.
+- Attempt to add transactions with missing or incorrect information to test validation.
+
+### Editing and Deleting Transactions:
+- Use the `edit-inflow` and `edit-outflow` commands to modify existing transactions.
+- Use the `delete-inflow` and `delete-outflow` commands to remove transactions.
+- Try editing or deleting transactions that do not exist to test error handling.
+
+### Viewing Transaction History:
+- Use the `view-history` command to display recent transactions.
+- Test with different numbers of transactions to view.
+- [v2.0] Additional bar charts will be shown to display the different percentage of categories used in the past n transactions.
+
+### Inactivity Timeout:
+- After logging in, do not input any commands for the duration specified by the inactivity timer to test automatic logout.
+- A maximum of 2.5 minutes of inactivity will trigger the application to check with the user whether the user is still active or not. Input `yes` to indicate continued activity, otherwise input `no` to exit. 
+- 30 seconds after the 2.5 min (3 min), the application will automatically exit.
+- Implemented to provide enhanced security, so no third party can access finance transactions. 
+
+### Data Persistence:
+- Exit the application and restart it to ensure that previously entered transactions are still present.