[CS2113-T18-4] NUScents #18

lckjosh · 2023-10-05T09:30:35Z

Welcome to NUScents, the tailor-made financial tracker for SOC students at NUS. It is optimized for use via a Command Line Interface (CLI) to offer a clutter-free solution for our users to manage and monitor their financial activities.

Implement CalendarCommandParser

irving11119

Overall your code has decent abstraction and follow good OOP principles. However, continue looking into how you can refactor your code to make it more readable and neater!

irving11119 · 2023-10-29T02:49:07Z

src/main/java/seedu/nuscents/parser/Parser.java

+            String date = extractValue("allowance", arguments, DATE_PATTERN, false);
+            String description = extractValue("allowance", arguments, DESC_PATTERN, false);
+            String additionalInformation = extractValue("allowance", arguments, NOTE_PATTERN, true);
+            String category = extractValue("allowance", arguments, CATEGORY_PATTERN, true);
+            AllowanceCategory allowanceCategory = parseAllowanceCategory(category);
+            String format = datePatternValidation(date);
+            SimpleDateFormat formatter = new SimpleDateFormat(format);
+            Date formattedDate = parseDate(date, format, formatter);


Perhaps you could abstract this out into a separate method, especially seeing how its quite similar to the code below.

irving11119 · 2023-10-29T04:59:16Z

src/main/java/seedu/nuscents/storage/Storage.java

+    private static void transactionDecoder(File file, ArrayList<Transaction> transactions)
+            throws FileNotFoundException, ParseException, NuscentsException {
+        Scanner data = new Scanner(file);
+        while (data.hasNext()) {
+            String transactionDetails = data.nextLine();
+            char transactionType = transactionDetails.charAt(0);
+            String[] columns;
+            float amount;
+            Date date;
+            String description = "";
+            String note = "";
+            String category= "";
+            SimpleDateFormat formatter = new SimpleDateFormat("dd MMMM, yyyy");
+            switch (transactionType) {
+            case 'A':
+                columns = transactionDetails.split("\\s*\\|\\s*");
+                amount = Float.parseFloat(columns[1]);
+                date = formatter.parse(columns[2]);
+                description = columns[3];
+                note = "";
+                if (columns.length > 4) {
+                    note = columns[4];
+                }
+                AllowanceCategory allowanceCategory = null;
+                if (columns.length > 5) {
+                    category = columns[5];
+                    allowanceCategory = parseAllowanceCategory(category);
+                }
+                transactions.add(new Allowance(amount, date, description, note, allowanceCategory));
+                break;
+
+            case 'E':
+                columns = transactionDetails.split("\\s*\\|\\s*");
+                amount = Float.parseFloat(columns[1]);
+                date = formatter.parse(columns[2]);
+                description = columns[3];
+                if (columns.length > 4) {
+                    note = columns[4];
+                }
+                ExpenseCategory expenseCategory = null;
+                if (columns.length > 5) {
+                    category = columns[5];
+                    expenseCategory = parseExpenseCategory(category);
+                }
+                transactions.add(new Expense(amount, date, description, note, expenseCategory));
+                break;
+
+            default:
+                break;
+            }
+        }
+    }


This method is a bit length, consider if you can use more abstraction to make it cleaner and shorter!

irving11119 · 2023-10-29T05:19:21Z

src/main/java/seedu/nuscents/Nuscents.java

+                ui.showException(e);
+            } catch (IOException | ParseException e) {
+                Ui.showLine();
+                System.out.println("Something went wrong: " + e.getMessage());


Perhaps printing of error message here can also go into your UI class for good SLAP.

irving11119 · 2023-10-29T05:28:37Z

src/main/java/seedu/nuscents/data/TransactionList.java

+
+        if (isFound) {
+            Ui.showFilterMessage(filteredTransactions, category);
+            System.out.println("Filtered transactions in the category " + category + ":");


Perhaps your system output here can be moved to the UI class? This ensures each class has follows Single Responsibility Principle e.g. printing to the console is handled solely by the UI class.

irving11119 · 2023-10-29T05:31:43Z

src/main/java/seedu/nuscents/ui/Messages.java

@@ -0,0 +1,43 @@
+package seedu.nuscents.ui;
+
+public class Messages {


Good use of a class to store your constant messages to be printed

Update UserGuide.md with quick start and command summary

Update User Guide with all current features.

Update developer guide with architecture diagram and minor fixes

Add hmac verification for storage file

Update UG to include categories for filter command and storage file FAQs

yingx9

Overall a nice DG with great and understandable sequence diagrams, only minor formatting mistakes

yingx9 · 2023-11-01T03:06:35Z

docs/DeveloperGuide.md

+| Version | As a ...           | I want to ...                                             | So that I can ...                                        |
+|---------|--------------------|-----------------------------------------------------------|----------------------------------------------------------|


I think your table formatting is broken in the github.io site

yingx9 · 2023-11-01T03:13:06Z

docs/DeveloperGuide.md

+
+The following sequence diagram shows how the add transaction operation works:
+
+<img src="images/AddTransactionSequenceDiagram.png" width="600" />


Maybe you can omit the classes and User at the bottom because it might not be necessary to repeat them again? Same for the other sequence diagrams

yingx9 · 2023-11-01T03:17:32Z

docs/DeveloperGuide.md

+The following sequence diagram shows how the add transaction operation works:
+<img src="images/ViewSequenceDiagram.png" width="600" />


The sentence says "how the add transaction operation works" but the sequence diagram is about the ViewCommand. Maybe that's an error?

yingx9 · 2023-11-01T03:19:35Z

docs/DeveloperGuide.md

+1. Parser
+
+The Parser class identifies the "view" command and extracts the taskIndex (transaction index) from the user's input.
+
+2. ViewCommand
+
+The ViewCommand object is created by the Parser. It encapsulates the user's request to view a specific transaction. This object is passed to the Nuscents class for execution.
+
+3. Nuscents
+
+In the Nuscents class, the execute() method of the ViewCommand is called, and the taskIndex is extracted from the command. It then calls the viewTransaction(taskIndex) method on the TransactionList.


The numbering is broken in the github.io site

DavinciDelta · 2023-11-01T03:22:45Z

docs/DeveloperGuide.md

+
+The following sequence diagram shows how the add transaction operation works:
+
+<img src="images/AddTransactionSequenceDiagram.png" width="600" />


I think it is bit hard to read the words in the red boxes...

DavinciDelta · 2023-11-01T03:23:48Z

docs/DeveloperGuide.md

+
+The following sequence diagram shows how the add transaction operation works:
+
+<img src="images/AddTransactionSequenceDiagram.png" width="600" />


Is the classes at the bottom required? I think it makes it confusing

DavinciDelta · 2023-11-01T03:27:49Z

docs/DeveloperGuide.md

+and modifications.
+
+The following sequence diagram shows how the add transaction operation works:
+<img src="images/ViewSequenceDiagram.png" width="600" />


Is a new ViewCommand created each time parseCommand is called?

DavinciDelta · 2023-11-01T03:30:08Z

docs/DeveloperGuide.md

+
+The following sequence diagram shows how the add transaction operation works:
+
+<img src="images/AddTransactionSequenceDiagram.png" width="600" />


so when a parseCommand is called, a new addCommand and expense class is created? Should it not have the constructor method?

Fix user guide

Fix numbering typo in UserGuide.md

Fix table format

Fix table format to ensure correct format in deployment

Fix spaces between columns

BenedictChannn · 2023-11-01T04:25:32Z

docs/DeveloperGuide.md

+
+Given below is the example usage scenario and how the list transaction mechanism behaves at each step.
+
+Step 1. The user launches the application. The `TransactionList` will be initialized with the transactions stored in 


Would it be good to extract this file storage and retrieval out to a section on its own to explain how it works?

BenedictChannn · 2023-11-01T04:29:02Z

docs/DeveloperGuide.md

+
+### `helpCommand` Usage Scenario
+
+1. **Step 1**: The user launches the application. The initial screen appears.


Not sure if "1. Step 1" is necessary. would using "Step 1" suffice?

BenedictChannn · 2023-11-01T04:30:54Z

docs/DeveloperGuide.md

-|--------|----------|---------------|------------------|
-|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 ... | I want to ...                                             | So that I can ...


The formatting for the User Stories seems to be broken on the page

Fix table borders in UG

Add Imgaes For AboutUs.md

…master Update

Include more class diagrams

Update Implementation: list transactions feature

Update UG FAQ and PPP

Fix reposense link

Update PPP for spaceman03

Fix github pages formatting issue

Add note in UserGuide.md

Add table of contents to DG

Fix format in DG list implementation steps, add instructions for manual testing

PPP bug fix: formatting issues

Update README.md

bug fix: update links in README.md

Brian030601 added a commit to Brian030601/tp that referenced this pull request Oct 18, 2023

Merge pull request nus-cs2113-AY2324S1#18 from Brian030601/master

a74ef39

Implement CalendarCommandParser

irving11119 reviewed Oct 29, 2023

View reviewed changes

spaceman03 and others added 13 commits October 30, 2023 21:14

Merge pull request #59 from spaceman03/user-guide-v2.0

433c956

Update UserGuide.md with quick start and command summary

Update User Guide with all current features.

b08bd05

Update User Guide with all current features.

5e86029

Delete src/main/java/seedu/nuscents/commands/EditCommand.java

f203697

Merge pull request #61 from aaronxujiachen/branch-editCommand

e41204b

Update User Guide with all current features.

Add hmac verification for storage file

086e5d1

Fix IO redirection test

04eceaa

Update sequence diagram for add transaction

1939358

Update DeveloperGuide.md with Architecture Diagram

e7a0b5c

Merge pull request #65 from spaceman03/developer-guide

fc57001

Update developer guide with architecture diagram and minor fixes

Merge pull request #64 from lckjosh/add-hmac-storage-file

7cfff4d

Add hmac verification for storage file

Update UG to include categories for filter command and storage file FAQs

c8fee8b

Merge pull request #66 from lckjosh/update-ug

9143964

Update UG to include categories for filter command and storage file FAQs

yingx9 reviewed Nov 1, 2023

View reviewed changes

Fix user guide

8f5d725

DavinciDelta reviewed Nov 1, 2023

View reviewed changes

spaceman03 and others added 9 commits November 1, 2023 11:38

Merge pull request #67 from spaceman03/user-guide-v2.0

03a733d

Fix user guide

Fix numbering typo in UserGuide.md

0ac3807

Merge pull request #68 from spaceman03/user-guide-v2.0

b2b9221

Fix numbering typo in UserGuide.md

Fix table format

3a610ba

Merge pull request #69 from spaceman03/developer-guide

1712229

Fix table format

Fix table format to ensure correct format in deployment

c8ec792

Merge pull request #70 from spaceman03/developer-guide

f64a00c

Fix table format to ensure correct format in deployment

Fix spaces between columns

d4d5bd7

Merge pull request #71 from spaceman03/developer-guide

d59c914

Fix spaces between columns

BenedictChannn reviewed Nov 1, 2023

View reviewed changes

lckjosh and others added 2 commits November 1, 2023 12:56

Fix table borders in UG

43e39ec

Merge pull request #72 from lckjosh/fix-ug-table

4083372

Fix table borders in UG

Merge pull request #182 from aaronxujiachen/branch-editCommand

5621d8d

Add Imgaes For AboutUs.md

Brian030601 pushed a commit to Brian030601/tp that referenced this pull request Nov 13, 2023

Merge pull request nus-cs2113-AY2324S1#18 from AY2324S1-CS2113-F11-3/…

3bfbf08

…master Update

lckjosh and others added 28 commits November 14, 2023 00:42

Include more class diagrams

5eb5f1f

Merge pull request #183 from lckjosh/master

1014962

Include more class diagrams

Update Implementation: list transactions feature

5415645

Merge pull request #184 from lckjosh/master

1cdcbec

Update Implementation: list transactions feature

Update UG FAQ

931af49

Update lckjosh PPP

c2bbc9e

Merge pull request #185 from lckjosh/master

c48cf61

Update UG FAQ and PPP

Fix reposense link

c090933

Merge pull request #186 from lckjosh/master

d2e8614

Fix reposense link

Update PPP for spaceman03

4097dd6

Merge pull request #188 from spaceman03/project-portfolio-page

2fc7844

Update PPP for spaceman03

Fix github pages formatting issue

b4448e7

Merge pull request #189 from spaceman03/developer-guide

a7c0630

Fix github pages formatting issue

Add note in UserGuide.md

2163420

Merge pull request #190 from spaceman03/user-guide-v2.1

52c5e6b

Add note in UserGuide.md

Fix format in DG list implementation steps

572f4ee

Add table of contents

f0b1051

Merge pull request #192 from spaceman03/developer-guide

bb42563

Add table of contents to DG

Add instructions for manual testing

16af0ab

Merge branch 'master' into master

3e2eacc

bug fix: formatting issues

b616848

Merge pull request #191 from lckjosh/master

971be5b

Fix format in DG list implementation steps, add instructions for manual testing

Update lckjosh.md

177dcb4

Merge pull request #193 from spaceman03/project-portfolio-page

c398bde

PPP bug fix: formatting issues

Update README.md

102143c

Merge pull request #194 from spaceman03/user-guide-v2.1

4393e16

Update README.md

bug fix: update links

fb57711

Merge pull request #195 from spaceman03/user-guide-v2.1

8bbf98f

bug fix: update links in README.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2113-T18-4] NUScents #18

[CS2113-T18-4] NUScents #18

lckjosh commented Oct 5, 2023

irving11119 left a comment

irving11119 Oct 29, 2023

irving11119 Oct 29, 2023

irving11119 Oct 29, 2023

irving11119 Oct 29, 2023

irving11119 Oct 29, 2023

yingx9 left a comment

yingx9 Nov 1, 2023

yingx9 Nov 1, 2023

yingx9 Nov 1, 2023

yingx9 Nov 1, 2023

DavinciDelta Nov 1, 2023

DavinciDelta Nov 1, 2023

DavinciDelta Nov 1, 2023

DavinciDelta Nov 1, 2023

BenedictChannn Nov 1, 2023

BenedictChannn Nov 1, 2023

BenedictChannn Nov 1, 2023

		@@ -0,0 +1,43 @@
		package seedu.nuscents.ui;

		public class Messages {

		\| Version \| As a ... \| I want to ... \| So that I can ... \|
		\|---------\|--------------------\|-----------------------------------------------------------\|----------------------------------------------------------\|


		The following sequence diagram shows how the add transaction operation works:

		<img src="images/AddTransactionSequenceDiagram.png" width="600" />

		The following sequence diagram shows how the add transaction operation works:
		<img src="images/ViewSequenceDiagram.png" width="600" />


		Given below is the example usage scenario and how the list transaction mechanism behaves at each step.

		Step 1. The user launches the application. The `TransactionList` will be initialized with the transactions stored in


		### `helpCommand` Usage Scenario

		1. Step 1: The user launches the application. The initial screen appears.

[CS2113-T18-4] NUScents #18

Are you sure you want to change the base?

[CS2113-T18-4] NUScents #18

Conversation

lckjosh commented Oct 5, 2023

irving11119 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yingx9 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment