Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[CS2103T-W11-3] EatMe #61

Open
wants to merge 109 commits into
base: master
Choose a base branch
from
Open

[CS2103T-W11-3] EatMe #61

wants to merge 109 commits into from

Conversation

dvrylc
Copy link

@dvrylc dvrylc commented Sep 19, 2019 •
edited
Loading

dvrylc and others added 12 commits September 28, 2019 12:00
wallacelim
wallacelim reviewed Oct 2, 2019
View reviewed changes
docs/DeveloperGuide.adoc

|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
|`* *` |digital nomad |tag places with free power + wifi |sit there for extended periods of time
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benefit is not immediately obvious, consider rephrasing? :)

Berttwm
Berttwm reviewed Oct 2, 2019
View reviewed changes
Copy link

@Berttwm Berttwm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall good job. Can consider formatting your use cases using proper ASCII doc syntax for better readability.

docs/DeveloperGuide.adoc Outdated
@@ -12,7 +12,7 @@ ifdef::env-github[]
:note-caption: :information_source:
:warning-caption: :warning:
endif::[]
:repoURL: https://github.com/se-edu/addressbook-level3/tree/master
:repoURL: https://github.com/AY1920S1-CS2103T-W11-3/main/tree/master

By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure you are from Team SE-EDU? It will be cool if you are.

docs/DeveloperGuide.adoc

|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
|`* * *` |foodie |remember places |share this experience with my family and friends
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may be a nice to have, but good job anyways

docs/DeveloperGuide.adoc
3. User requests to mark an eatery as visited in the list
4. EatMe shifts the data over
5. EatMe toggles to the main mode
6. EatMe requests user for whatever information left that is required before saving in the main mode
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great use case, clear and concise.

docs/DeveloperGuide.adoc
+
Use case ends.

*Extensions*
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may want to format the nesting of your 2a. The List is empty, Use case ends..

docs/DeveloperGuide.adoc Outdated
. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
. Main functionalities (CRUD) should work without WiFi.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Useful NFR's, good job

docs/DeveloperGuide.adoc Outdated
Any place that serves food open to the public (ie, restaurants, cafes, roadside, pushcart)

[[category]] Category::
Broadly containts cuisines (self-explanatory) and eating place (ie, a buffet, fusion)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May want to define what "todo" means as developers may need to understand such terms :)

ROHITREDDYBALAM and others added 10 commits October 8, 2019 23:58
@ROHITREDDYBALAM @jakq
remove email field (#57)
f216da2 
* remove email field

* Remove email field
@ROHITREDDYBALAM @dvrylc
Remove phone and email fields (#59)
9d4b904 
* remove email field

* Remove email field

* Remove phone field

* Remove phone attribute
@jakq @JunHongT
Refactor Person to Eatery (#61)
991cf82 
* Refactor Person to Eatery

v1.0 with 3 EditCommandTest failures.

* Removed 2 test cases from EditCommandTest

* Update BetterModelClassDiagram.puml

* Remove Email and Phone class

* Remove Email Phone multiplicity

* Refactor Person to Eatery edit1

*Close issue #55
@wpuffs @dvrylc
Add Category class (#62)
92cb0de 
Closes #53 🚀 

* Remove all instances of address

* Add new command: Remark

* Update UserGuide.adoc

* Update UserGuide.adoc

* Update Ui.png

* Update UserGuide.adoc

* Update Ui.png

* Revert "Update Ui.png"

This reverts commit 09529ff.

* Revert "Update UserGuide.adoc"

This reverts commit 1011cb1.

* Revert "Update Ui.png"

This reverts commit 43aa00b.

* Revert "Update UserGuide.adoc"

This reverts commit c907562.

* Revert "Update UserGuide.adoc"

This reverts commit ea7590c.

* Revert "Merge branch 'tutorial-adding-command'"

This reverts commit 3f671ae, reversing
changes made to 5e1abfd.

* Revert "Remove all instances of address"

This reverts commit 5e1abfd.

* Update UserGuide.adoc

* Update UserGuide.adoc

* Fix coding style violations

* Create test cases (#1)

* Fix coding style violations (#1)

* Fix coding style violations (#2)

* Fix getId() method to return object's id instead of static variable id

* Fix test case that checks category id

* Add Ui.png ~_~
@dvrylc
Fix category location
14c511b
@wpuffs
Merge pull request #67 from dvrylc/fix-category-location
28fb051 
Fix category location
@dvrylc @jakq
Implement 3-column UI (#63)
e296e7b 
* Implement 3-column UI, closes #48

- Shift content block to center column
- Add placeholder right column for news feed
- Refactor basic styles

* Update views for Eatery refactor

* Add category placeholder label
@dvrylc @ROHITREDDYBALAM
Implement basic news feed (#73)
0fc2d12 
* Implement 3-column UI, closes #48

- Shift content block to center column
- Add placeholder right column for news feed
- Refactor basic styles

* Update views for Eatery refactor

* Add category placeholder label

* Implement basic news feed

Includes:
- Basic news feed functionality
- Tests for new models

* Improve code style

- Fix indentation
- Improve variable names
- Remove unnecessary `if` conditions
@wpuffs @jakq
Add Tag class, refactor Add and Edit command (#74)
9cd9854 
* Remove all instances of address

* Add new command: Remark

* Update UserGuide.adoc

* Update UserGuide.adoc

* Update Ui.png

* Update UserGuide.adoc

* Update Ui.png

* Revert "Update Ui.png"

This reverts commit 09529ff.

* Revert "Update UserGuide.adoc"

This reverts commit 1011cb1.

* Revert "Update Ui.png"

This reverts commit 43aa00b.

* Revert "Update UserGuide.adoc"

This reverts commit c907562.

* Revert "Update UserGuide.adoc"

This reverts commit ea7590c.

* Revert "Merge branch 'tutorial-adding-command'"

This reverts commit 3f671ae, reversing
changes made to 5e1abfd.

* Revert "Remove all instances of address"

This reverts commit 5e1abfd.

* Update UserGuide.adoc

* Update UserGuide.adoc

* Add Tag class

* Add tests for Tag class

* Refactor existing classes

* Refactor existing test classes

* Remove trailing whitespaces

* Fix code to refer to Tag class and not Category class

* Fix ParserUtil class and test class

* Change toString() method of AddressBook
@JunHongT @dvrylc
Add mode command (#68)
1e4eb89 
* Add Mode Command

* Fix checkstyle

* Fix minor bug in JsonSerializableAddressBook.java

* Enable delete command for to-do list

* Fix checkstyle

* Fix minor bug in DeleteCommand

* Create ModeCommandTest

* Fix Checkstyle

* Improve code quality

* Fix test cases

* Improve code quality
wpuffs and others added 30 commits November 11, 2019 00:21
@wpuffs @JunHongT
Fix stats bug (#184)
aa3394a 
* Remove all instances of address

* Add new command: Remark

* Update UserGuide.adoc

* Update UserGuide.adoc

* Update Ui.png

* Update UserGuide.adoc

* Update Ui.png

* Revert "Update Ui.png"

This reverts commit 09529ff.

* Revert "Update UserGuide.adoc"

This reverts commit 1011cb1.

* Revert "Update Ui.png"

This reverts commit 43aa00b.

* Revert "Update UserGuide.adoc"

This reverts commit c907562.

* Revert "Update UserGuide.adoc"

This reverts commit ea7590c.

* Revert "Merge branch 'tutorial-adding-command'"

This reverts commit 3f671ae, reversing
changes made to 5e1abfd.

* Revert "Remove all instances of address"

This reverts commit 5e1abfd.

* Update UserGuide.adoc

* Update UserGuide.adoc

* Implement stats command i.e. the statistics feature

* Fix line ending

* Change the logic of how stats command works

* Remove existing stats exceptions and add new ones

* Add stylesheets related to the charts and graphs generated by stats command

* Modify and add new custom charts and graphs

* Fix coding style violations

* Minor changes to exception handling

* Create tests for stats command

* Fix coding style violations

* Create tests for parsing stats command

* Fixed unhandled exception when review is less than 3

* Fix coding style violations

* Rename stats exception classes to follow convention

* Make appropriate changes based on code review

* Attempt to fix wrong line ending

* Fix CRLF line endings

* Optimize compareTo for priority queues

* THIRD attempt at fixing line ending issue

* Edit stats section of user guide to make more sense

* Fix the stats issue where most shows least data and least shows most data

* Fix label

* Remove duplicate variables
@ROHITREDDYBALAM @wpuffs
Add features to DG (#179)
d9efc9b 
* remove email field

* Remove email field

* Remove phone field

* Remove phone attribute

* Remove phone, email from test  case

* Resolve merge conflicts

* Add API key

* make changes to dg

* add features to dg

* fix doc errors

* add review activity diagram

* add Editreview activity diagram

* add review sequence diagram

* add sequence diagrams to dg and allow reviews to closed eateries

* Change address book to eatery list

* add new lines at eof
@wpuffs @ROHITREDDYBALAM
Update developer guide (#185)
eeaee30 
* Remove all instances of address

* Add new command: Remark

* Update UserGuide.adoc

* Update UserGuide.adoc

* Update Ui.png

* Update UserGuide.adoc

* Update Ui.png

* Revert "Update Ui.png"

This reverts commit 09529ff.

* Revert "Update UserGuide.adoc"

This reverts commit 1011cb1.

* Revert "Update Ui.png"

This reverts commit 43aa00b.

* Revert "Update UserGuide.adoc"

This reverts commit c907562.

* Revert "Update UserGuide.adoc"

This reverts commit ea7590c.

* Revert "Merge branch 'tutorial-adding-command'"

This reverts commit 3f671ae, reversing
changes made to 5e1abfd.

* Revert "Remove all instances of address"

This reverts commit 5e1abfd.

* Update UserGuide.adoc

* Update UserGuide.adoc

* Add activity and sequence diagram for Add command

* Change sequence diagram

* Change activity diagram

* Resize activity diagram

* Update DeveloperGuide.adoc

* Update DeveloperGuide.adoc

* Update DeveloperGuide.adoc

* Update DeveloperGuide.adoc

* Update DeveloperGuide.adoc

* Update DeveloperGuide.adoc

* Update DeveloperGuide.adoc

* Update DeveloperGuide.adoc

* Update photos

* Update DeveloperGuide.adoc

Update add command

* Update DeveloperGuide.adoc

* Update DeveloperGuide.adoc

Add stats feature and modify add feature

* Update DeveloperGuide.adoc

* Update DeveloperGuide.adoc

* Update the diagrams

* Update DeveloperGuide.adoc

* Update DeveloperGuide.adoc

* Update general diagrams

* Update DeveloperGuide.adoc

* Edit Storage class diagram

* Update diagrams to follow theme

* Update DeveloperGuide.adoc

Update picture links

* Add newline at EOF

* Update DeveloperGuide.adoc

* Update DeveloperGuide.adoc

* Update Developer guide

* Update developer guide

* Remove "the"

* Update developer guide
@dvrylc @JunHongT
Update command result messages (#190)
a5fdbfc 
* Update command result messages

* Fix test cases for new command result messages
@jakq @wpuffs
Add Reopen and Load feature in the Developer Guide (#187)
923597e 
* Add Reopen and Load feature in the Developer Guide

* Remove unused test file
@ROHITREDDYBALAM @wpuffs
Dg changes (#191)
866b07c 
* remove email field

* Remove email field

* Remove phone field

* Remove phone attribute

* Remove phone, email from test  case

* Resolve merge conflicts

* Add API key

* make changes to dg

* add features to dg

* fix doc errors

* add review activity diagram

* add Editreview activity diagram

* add review sequence diagram

* add sequence diagrams to dg and allow reviews to closed eateries

* Change address book to eatery list

* add new lines at eof

* change ug pictures

* add review use case diagram

* add line at eof
@dvrylc @JunHongT
Refactor addressbook package to eatme (#186)
a66438a 
* Refactor addressbook package to eatme

* Improve refactor

* Fix invalid test filename

* Add more missing stuff
@JunHongT @wpuffs
Update Uml diagram for DG (#194)
47b226a 
* Edit Developer Guide for Mode Command

* Update developer guide

* Update Developer Guide with SaveTodo Command

* Update uml diagram for SaveTodo Command

* Update Developer Guide with SaveTodo Command

* Update diagram for mode and save command

* Update Developer Guide with Mode And SaveTodo

* Fix merge conflict
'

* Update uml diagram for Mode and SaveTodo Command
@JunHongT @wpuffs
Edit user guide (#182)
b705e2d 
* Fix bug for Save Command Ui

* Add restriction for review command

* Change url of help window to EatMe UserGuide

* Update user guide

* Update user guide

* Increase depth of content page

* Edit SaveTodoCommand section

* Update SaveTodo section in User guide

* Update UG

* Update UserGuide.adoc

- Change import command to load command
- Add short description of main and todo mode in "Introduction" section
-  Edit type in "Features" section

* Update UserGuide.adoc

- Attempt to make user guide more logical by reorganising commands
- Attempt to make user guide more consistent

* Remove trailing whitespaces

* Update UserGuide.adoc

* Update UserGuide.adoc
@JunHongT @dvrylc
create PPP [Jun Hong] (#183)
4d5115c 
* Edit Developer Guide for Mode Command

* Update developer guide

* Update Developer Guide with SaveTodo Command

* Update uml diagram for SaveTodo Command

* Update Project Portfolio

* Add images for PPP

* Update PPP

* Fix checkstyle

* Resolving merge conflict

* Resolve merge conflict

* update sequence diagram for savetodo

* Update PPP

* Remove debug statement
@ROHITREDDYBALAM @dvrylc
Fix Review parser bug (#200)
a61381b 
* remove email field

* Remove email field

* Remove phone field

* Remove phone attribute

* Remove phone, email from test  case

* Resolve merge conflicts

* Add API key

* fix review parser bug
@dvrylc @jakq
Update image assets (#197)
59d4221 
* Update UI image

* Update app icon
@dvrylc @JunHongT
Update command result to show added/edited eatery (#201)
be9666e 
* Update command result to show added/edited eatery

* Fix tests for new command result
@JunHongT @dvrylc
Edit save command (#189)
022aa07 
* Edit Developer Guide for Mode Command

* Update developer guide

* Update Developer Guide with SaveTodo Command

* Update uml diagram for SaveTodo Command

* Update Project Portfolio

* Add images for PPP

* Update PPP

* Remove debuggin line

* Resolve merge conflict

* Edit wantToSave value

* Update DeveloperGuide.adoc
@ROHITREDDYBALAM @wpuffs
New ppp (#199)
1318538 
* remove email field

* Remove email field

* Remove phone field

* Remove phone attribute

* Remove phone, email from test  case

* Resolve merge conflicts

* Add API key

* create pp and change edit review seq diagram

* Update UG

* change ppp file name

* Update ug

* Update ug

* Delete pdf
@jakq @wpuffs
Add Kai Qi's PPP (#198)
08f7531 
* Add Kai Qi's PPP

* Update Kai Qi's PPP

* Update Kai Qi's PPP
@dvrylc @wpuffs
Add PPP (#180)
2d7f45e
@JunHongT @ROHITREDDYBALAM
JunHongT PPP (#203)
8c35833 
* Edit Developer Guide for Mode Command

* Update developer guide

* Update Developer Guide with SaveTodo Command

* Update uml diagram for SaveTodo Command

* Update Project Portfolio

* Add images for PPP

* Update PPP

* Fix checkstyle

* Resolving merge conflict

* Resolve merge conflict

* update sequence diagram for savetodo

* Update PPP

* Remove debug statement

* Rename PPP name
@dvrylc @JunHongT
Remove sample feed (#205)
a8803e2
@ROHITREDDYBALAM @dvrylc
Edit review bug (#206)
bf297e6 
* remove email field

* Remove email field

* Remove phone field

* Remove phone attribute

* Remove phone, email from test  case

* Resolve merge conflicts

* Add API key

* fix edit review bug
@JunHongT @dvrylc
resize image for PPP (#207)
a3db035 
* Edit Developer Guide for Mode Command

* Update developer guide

* Update Developer Guide with SaveTodo Command

* Update uml diagram for SaveTodo Command

* Update Project Portfolio

* Add images for PPP

* Update PPP

* Fix checkstyle

* Resolving merge conflict

* Resolve merge conflict

* update sequence diagram for savetodo

* Update PPP

* Remove debug statement

* Rename PPP name

* rename PPP

* resize image
@wpuffs @JunHongT
Reorganise developer guide and add my PPP (#193)
06fd1a3 
* Remove all instances of address

* Add new command: Remark

* Update UserGuide.adoc

* Update UserGuide.adoc

* Update Ui.png

* Update UserGuide.adoc

* Update Ui.png

* Revert "Update Ui.png"

This reverts commit 09529ff.

* Revert "Update UserGuide.adoc"

This reverts commit 1011cb1.

* Revert "Update Ui.png"

This reverts commit 43aa00b.

* Revert "Update UserGuide.adoc"

This reverts commit c907562.

* Revert "Update UserGuide.adoc"

This reverts commit ea7590c.

* Revert "Merge branch 'tutorial-adding-command'"

This reverts commit 3f671ae, reversing
changes made to 5e1abfd.

* Revert "Remove all instances of address"

This reverts commit 5e1abfd.

* Update UserGuide.adoc

* Update UserGuide.adoc

* Implement stats command i.e. the statistics feature

* Fix line ending

* Change the logic of how stats command works

* Remove existing stats exceptions and add new ones

* Add stylesheets related to the charts and graphs generated by stats command

* Modify and add new custom charts and graphs

* Fix coding style violations

* Minor changes to exception handling

* Create tests for stats command

* Fix coding style violations

* Create tests for parsing stats command

* Add my portfolio page

* Edit PPP

* Edit developer guide

* Reorganise commands in developer guide

* Add diagrams

* Remove existing files

* Fix merge conflicts

* Resize images

* Fix images (again)

* Minor edit

* Modify model class diagram

* Update diagram pictures

* Resize diagram and rename ppp document

* Change line ending

* Made changes to PPP

* Update developer guide and my ppp
@dvrylc
Fix review command, improve command result and fix statistics
fecf0c9
@dvrylc
Standardize messages and fix review sort
70a64dc
@dvrylc
Implement error detection for feed addresses
647b8a8
@ROHITREDDYBALAM @dvrylc
Ugchanges (#208)
04c72b8 
* remove email field

* Remove email field

* Remove phone field

* Remove phone attribute

* Remove phone, email from test  case

* Resolve merge conflicts

* Add API key

* change ug
@ROHITREDDYBALAM
Merge pull request #209 from dvrylc/fix-final-bugs
3ebc9f7 
Fix final bugs
@ROHITREDDYBALAM @dvrylc
Ugchanges (#210)
4707c58 
* remove email field

* Remove email field

* Remove phone field

* Remove phone attribute

* Remove phone, email from test  case

* Resolve merge conflicts

* Add API key

* change ug

* change review command message

* fix checkstyle errors

* Update review message
@dvrylc
Update docs
1a7bcb6
@JunHongT
Merge pull request #211 from dvrylc/update-docs
9919cd0 
Update docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Berttwm Berttwm Berttwm left review comments

@wallacelim wallacelim wallacelim left review comments

Assignees
No one assigned
Labels
team.3 tutor.kylase-learning tutorial.CS2103T-W11
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@dvrylc @wallacelim @Berttwm @yewon0303 @nus-se-pr-bot @JunHongT @wpuffs @ROHITREDDYBALAM @jakq