cs2103-ay1819s2-w13-3 / main

The Infinity Machine - A safe place to store your research materials.

The Infinity Machine

What is it about?

Have you ever faced the problem of not having a place to store all the information you search online or the notes you take? Well, we have! Therefore, through our application, The Infinity Machine, we have created a platform where the storing and retrieving of textual information such as research materials can be done efficiently. It also allows you to apply custom made tags and descriptions for easy categorization, search and retrieval. Other useful functionalities implemented are: - Bibliography generator - Panic/unpanic mode - Restore command - History command and many more!

Target Users

Tech-savvy university students or researchers who love to use the Command line Interface and wish to organize and tag research information or any other data that they may wish to store for a long time, frequently performing basic operations such as adding, editing, deleting and searching an entry.

Site Map

• User Guide

• Developer Guide

• About Us

• Contact Us

Acknowledgements

• AddressBook-Level4 project created by SE-EDU initiative at https://github.com/se-edu/

• Some parts of this sample application were inspired by the excellent Java FX tutorial by Marco Jakob.

• Libraries used: TextFX, Jackson, Guava, JUnit5

Licence : MIT

main's Issues

As a user I can search multiple tags simultaneously

So I don't have to make multiple searches to see information across multiple categories.

make master protected protected branch

As a user I would like to be able to soft-delete sources

so that I will not lose my important data in case I accidentally deleted something.

• Saves sources deleted to Recycle Bin
• Persistent Storage for deleted sources
• Permanent Delete from storage

As a user I can define and write custom commands

So I can extend and customize the functionality of the app.

As a user, I would want the application to greet me

for a more positive user experience.

As a user I would prefer if there is an undo function

So that I can immediately retrieve information lost as a result of a small mistake.

Keeping track of research material

As a researcher, I want to be able to find relevant material I have come across before easily so I do not have to spend time looking for them again

As a user I can rename tags

So I can choose a better tag without having to delete and re-add everything under the old tag.

Enabling panic mode twice loses original database state

As a user I want to be able to search using multiple tags simultaneously, with the results in descending order of the number of matching tags

So I can easily access the most relevant material.

As a user, I want to be able to add or change tags of the information I store

just in case I make a mistake or miss out a tag

Feedback on week 7 project progress

Subject: feedback on week 7 project progress

See v1.1 progress guide for more details of the activities mentioned below.

Team progress

• Team org and repo set up correctly (:heavy_check_mark: well done!)
• PR created from team repo to AB-3 or AB-4 (:heavy_check_mark: well done!)
• Auto-publishing set up for the team repo (:heavy_check_mark: well done!)

• README page:
  • Ui.png has been updated (:heavy_check_mark: well done!)
  • Parts not related to your product are removed (:heavy_check_mark: well done!)
  • se-edu/addressbook-level4 acknowledged (:exclamation: try to do by next milestone)

• User Guide: some content has been updated (:heavy_check_mark: well done!)
• Developer Guide: some content has been updated (:heavy_check_mark: well done!)
• Team repo git tagged as v1.1 (:heavy_check_mark: well done!)

Individual progress of @darrendragonlee

• Used forking workflow:
  • Created PRs link (:heavy_check_mark: well done!)
  • Gave review comments to other PRs (:heavy_check_mark: well done!)

• Merged updates to documents (:heavy_check_mark: well done!)
• darrendragonlee.png uploaded and linked from AboutUs page in png format (change image to png if presently in different format) (:heavy_check_mark: well done!)

Individual progress of @case141

• Used forking workflow:
  • Created PRs link (:heavy_check_mark: well done!)
  • Gave review comments to other PRs (:heavy_check_mark: well done!)

• Merged updates to documents (:heavy_check_mark: well done!)
• case141.png uploaded and linked from AboutUs page in png format (change image to png if presently in different format) (:heavy_check_mark: well done!)

Individual progress of @suriruhani

• Used forking workflow:
  • Created PRs link (:heavy_check_mark: well done!)
  • Gave review comments to other PRs (:heavy_check_mark: well done!)

• Merged updates to documents (:heavy_check_mark: well done!)
• suriruhani.png uploaded and linked from AboutUs page in png format (change image to png if presently in different format) (:heavy_check_mark: well done!)

Individual progress of @fterh

• Used forking workflow:
  • Created PRs link (:heavy_check_mark: well done!)
  • Gave review comments to other PRs (:heavy_check_mark: well done!)

• Merged updates to documents (:exclamation: try to do by next milestone)
• fterh.png uploaded and linked from AboutUs page in png format (change image to png if presently in different format) (:heavy_check_mark: well done!)

Individual progress of @DoItTomorrow

• Used forking workflow:
  • Created PRs link (:heavy_check_mark: well done!)
  • Gave review comments to other PRs (:heavy_check_mark: well done!)

• Merged updates to documents (:exclamation: try to do by next milestone)
• doittomorrow.png uploaded and linked from AboutUs page in png format (change image to png if presently in different format) (:heavy_check_mark: well done!)

Tutor: @ewaldhew

Note: the above observation was done by the CS2103-feedback-bot and covers changes up to 2019-03-06 00:00:00 only. If you think the above observation is incorrect, please let us know by replying in this thread. Please include links to relevant PRs/comments in your response.

As a user who intends to store large amounts of information in this application

I wanted the search feature to give quick results with as little error as possible.

Modify biblio command to generate APA style entry for single source

As a user I want to be able to add aliases for commands

E.g. I want to use "a" as a shortcut for "add"

• Implement command to add alias (e.g. alias <command> <alias>)
• Implement command to remove alias (e.g. alias-rm <alias>)
• Implement command to list all aliases (e.g. alias-ls)
• Initialize aliasManager with default aliases
• Handle duplicate aliases gracefully
• Disallow aliasing alias commands
• Check for null inputs for all methods (and handle gracefully)
• Persistent storage
• Only allow alphabets
• Unit tests
• Integration tests with SourceManagerParser
• Refactor SourceManagerParser metacommand error messages (and add to tests)
• Update help command
• Refactor MetaCommandParsers to take in their own keyword, to display in usage error messages
• Logging
• AliasManager interface (with ConcreteAliasManager implementation) for DIP
• Update user guide (persistence, regex validation)
• Support dependency injection
• Alias-clear command
• Update dev guide (seq diagram, update class diagram, regex)
• Set up tags in adoc documents for cross-references
• More tests (pairwise unit testing, integration tests, make use of dependency injection)

---

Edge case: alias alias a

As a user I want to be able to request for documentation of the available options by typing help for each interface

So that I can learn more about the system as I use it.

As a user I would like to know how many sources I have

so that I can see the total number of materials I currently have.

Further explanation:
Gets the total number of sources that is present in the database.

Find out more at: Pull Request #57

As a user I would like to be able to edit any details that I have entered wrongly

So that I can provide the correct information.

As a user, I want to be able to search for the information via their content

or some keywords, if I am unable to recall their tags

As a user I want to be able to edit all tags of a certain type

So that I can update information without doing them individually.

As a user I would prefer if my console commands are dynamic

So that I can assign personal hotkeys or rename my commands accordingly.

As a user, I want to be able to access and use (and edit?) the text files used to store my tagged data directly

Issue: this is the abstraction we are building for the user, we want to be the interface between the user and this storage on the text files. Required: to maintain the text files in a logical and hierarchical manner (eg double tagging)

Implement New Model for Infinity Machine

Implement new model for the Infinity Machine.

[Outdated/Unused] Planned enhancements to the source model

• Add additional functions to aid usage
• Add checkers to regulate user input and prevent out-of-bounds issues

*The code in this issue has been removed during the major migration of the project in PR#106.

Communications overview

As a user, I would like to be able to have an overview of any recent communications with my contacts at a glance.

As a user I would like my incorrect searches to show me the closest tags to what I have entered

So that I can access my tags without needing to remember all of the tags I have.

As a user I want to have tags be divided into different categories such as content or media

So my material better organized.

As a user I can rename commands

So I can remember them more easily, e.g. "remove" vs "delete".

Modify AB4 User Interface to suit Infinity Machine

• change UI color
• reflect source details when user clicks on source from list
• assign default icon to source
• allow users to choose different types of icons when adding a source
• update UI when users pin something
• allow users to add headings to certain sections of the source #198

As a user I can list all my research

So I can have an overview of everything I have saved.

• The user should also have an option to specify how many of the 'most recent' entries he wants to list, eg. list 20 should list the latest 20 entries

As a user I would like to assign websites links with a tag

So that I can access it easily through searching by keywords.

As a user, I want the result of my search to be displayed neatly

so I am able to read all the chunks of information tagged under the same category and have them be separated from each other so that I am able to use them as per my wish

Feedback on week 8 project progress

Subject: feedback on week 8 project progress

See mid-v1.2 progress guide for more details of the activities mentioned below.
Mid-milestone progress reports are FYI only. They are not graded.

Team progress

Folow up from v1.1

• Auto-publishing set up for the team repo and the website is available at link (:heavy_check_mark: well done!)

• README page:
  • Parts not related to your product are removed (:heavy_check_mark: well done!)
  • se-edu/addressbook-level[3/4] acknowledged (:exclamation: try to do by next milestone)
  • Ui.png has been updated (:heavy_check_mark: well done!)

Recommended progress for the upcoming milestone

• Issue labels^* set up e.g., type.* and priority.* (:heavy_check_mark: well done!)
• All future milestones v1.2, v1.3, v1.4, created (:heavy_check_mark: well done!)
• Issues marked as type.Story e.g., link (:heavy_check_mark: well done!)
• Some issues prioritized using priority.* labels e.g., link (:heavy_check_mark: well done!)

• Milestone v1.2 planned
  • A suitable deadline^** set (:exclamation: try to do by next milestone)
  • Issues allocated to v1.2 e.g., link (:heavy_check_mark: well done!)

• Build passing link (:heavy_check_mark: well done!)

^*Remember to use the format specified, else it will not be picked up by the bot
^**Remember that the deadline is the midnight before your tutorials

Individual progress of @darrendragonlee

Recommended progress for the upcoming milestone

• Merged updates to java/fxml files (:heavy_check_mark: well done!)
• Has issues/PRs assigned for the next milestone (:heavy_check_mark: well done!)

Individual progress of @case141

Recommended progress for the upcoming milestone

• Merged updates to java/fxml files (:heavy_check_mark: well done!)
• Has issues/PRs assigned for the next milestone (:heavy_check_mark: well done!)

Individual progress of @suriruhani

Recommended progress for the upcoming milestone

• Merged updates to java/fxml files (:heavy_check_mark: well done!)
• Has issues/PRs assigned for the next milestone (:heavy_check_mark: well done!)

Individual progress of @fterh

Recommended progress for the upcoming milestone

• Merged updates to java/fxml files (:heavy_check_mark: well done!)
• Has issues/PRs assigned for the next milestone (:heavy_check_mark: well done!)

Individual progress of @DoItTomorrow

Recommended progress for the upcoming milestone

• Merged updates to java/fxml files (:heavy_check_mark: well done!)
• Has issues/PRs assigned for the next milestone (:exclamation: try to do by next milestone)

Tutor: @ewaldhew

Note: the above observation was done by the CS2103-feedback-bot and covers changes up to 2019-03-13 00:00:00 only. If you think the above observation is incorrect, please let us know by replying in this thread. Please include links to relevant PRs/comments in your response.

As a user I would like to be able to view the past history of commands that I have made

So that I can recall what I have done in the past.

As a user I would like to have an Easteregg mode

so that I can have fun reading jokes when I use the application.

Feedback on week 6 project progress

Subject: feedback on week 6 project progress

See v1.1 progress guide for more details of the activities mentioned below.

Team progress

• Team org and repo set up with the correct names (:heavy_check_mark: well done!)
• PR created from team repo to AB-3 or AB-4 (:heavy_check_mark: well done!)

Individual progress of @darrendragonlee

• Used forking workflow:
  • Team repo forked to your GitHub account (:heavy_check_mark: well done!)
  • PRs created to update Java code (:heavy_check_mark: well done!)
  • PRs created to update documents (:heavy_check_mark: well done!)

Individual progress of @case141

• Used forking workflow:
  • Team repo forked to your GitHub account (:heavy_check_mark: well done!)
  • PRs created to update Java code (:heavy_check_mark: well done!)
  • PRs created to update documents (:heavy_check_mark: well done!)

Individual progress of @suriruhani

• Used forking workflow:
  • Team repo forked to your GitHub account (:heavy_check_mark: well done!)
  • PRs created to update Java code (:exclamation: try to do by next milestone)
  • PRs created to update documents (:heavy_check_mark: well done!)

Individual progress of @fterh

• Used forking workflow:
  • Team repo forked to your GitHub account (:exclamation: try to do by next milestone)
  • PRs created to update Java code (:exclamation: try to do by next milestone)
  • PRs created to update documents (:exclamation: try to do by next milestone)

Individual progress of @DoItTomorrow

• Used forking workflow:
  • Team repo forked to your GitHub account (:exclamation: try to do by next milestone)
  • PRs created to update Java code (:exclamation: try to do by next milestone)
  • PRs created to update documents (:exclamation: try to do by next milestone)

Tutor: @ewaldhew

Note: the above observation was done by the CS2103-feedback-bot and covers changes up to 2019-02-20 00:00:00 only. If you think the above observation is incorrect, please let us know by replying in this thread. Please include links to relevant PRs/comments in your response.

As a user I can have a breakdown of all my tags and their count

So I can have an overview of my research

As a user I would like to be able to remove research materials that are outdated or no longer relevant

So that I can declutter the application and make viewing and searching easier.

As a user I want to be able to find all material of the same type I have come across before, such as research papers or websites

So as to more easily access the material that I need.

As user I would like to be able to customise my word colour

So that I can make the application more interesting.

As a user I would like to be able to search for research materials

So that I can easily retrieve the information using various categories and have it displayed in an indexed fashion with all details displayed.

• search the sources by title (and their combination)
• search the sources by a combination of tags, title, details, sources, and types (CONJUNCTION)
• search the sources by a combination of tags, title, details, sources, and types (DISJUNCTION)
• search the sources by a combination of tags, title, details, sources, and types (NEGATION)
• make the search be able to match parts of words
• make the search be able to match closely related words

As a user I would like to have ascii art for the application

So that the application looks nicer and more interesting.

As a user I would like to have a panic button

so that I can hide sensitive information all at once

Search by tags/categories

As a user, I would like to be able to search by the tags/categories of any particular information so that I can find the same type of material that I need.

As a user I would like to hide sensitive data

so that I can prevent unwanted attention

As a user I want to be able to be able to see a list of existing tags and amount of material associated with each tag

So I don't create unneeded tags and to get an overview of what is already available.

As a user I would like a "do you mean" prompt when assigning tags

So that I will not have duplicate tags meaning the same thing like "data structures" or "Datastructures" or "DataStructure".

Write tests for "source" package

That includes the Source class, and its composite classes (e.g. Title, Type, Detail).

As a user I can see a chronological list of my research information

So I know which one was added first

As a user, I want the CLI commands to be easy to use and remember

so that I can use the application efficiently without having to refer to the command descriptions again and again.