[CS2113T-T10-3] Decodex by rizemon · Pull Request #27 · nus-cs2113-AY2122S1/tp

rizemon · 2021-09-30T02:15:31Z

Decodex is a Command Line Interface (CLI) application for Capture-The-Flag (CTF) players to quickly transform data from one format to another with extreme ease. The intuitive interaction can help speed up a player's performance during CTFs and save time without having to manually code the tedious data transformations.

crabnuggets

This is a really good DG and the quality of the writing/diagrams is very consistently written throughout. Well done!

crabnuggets · 2021-10-27T04:11:00Z

+- [Introduction](#introduction)
+  - [Purpose of This Guide](#purpose-of-this-guide)
+  - [Developer Guide Usage](#developer-guide-usage)


Perhaps it would be good to consider moving the table of contents to the top. Otherwise, it might seem a little queer to have to come across sections that the developer has already read (e.g. Introduction, Purpose of This Guide, Developer Guide Usage) in the table of contents.

crabnuggets · 2021-10-27T04:23:36Z

+
+### UI Component
+
+![UiClass.png](images/dg/UiClass.png)


It is good that only the commonly used methods are listed in the diagram to avoid overloading the reader with information. Once again, a good well-drawn diagram that is very comprehensible.

crabnuggets · 2021-10-27T04:32:02Z

+![CommandClass1.png](images/dg/CommandClass1.png)
+
+![CommandClass2.png](images/dg/CommandClass2.png)


Since there are many derived *Command classes and the association between these classes and the abstract Command class is the same for all of them (i.e., inheritence), maybe it would be better to have one diagram that can generalize and demonstrate the relationship between these classes and the abstract Command class (i.e., just have a general *Command class representation inheriting from the Command class). It was somewhat tedious for the readerto read through both diagrams only to realise that the main takeaway was the inheritence relationship between the classes.

crabnuggets · 2021-10-27T04:33:23Z

+
+The ***Architecture Diagram*** given below shows the high-level design of Decodex.
+
+![architecture.png](images/dg/architecture.png)


This is really clean and comprehensible! The additional note below the diagram aids readers in understanding the interactions between components. Very well done.

crabnuggets · 2021-10-27T04:40:37Z

+
+Below is the class diagram showing the association between the abstract `Module` class and its derived `*Decoder` classes.
+
+![ModuleClass.png](images/dg/ModuleClass.png)


As mentioned, I think it is worth considering simplifying the diagram here as with the Command class.

crabnuggets · 2021-10-27T04:43:33Z

+
+![RecipeClass.png](images/dg/RecipeClass.png)
+
+> :pen: The reason for having `Recipe` objects is to enable users to run multiple modules at one go sequentially.


I like the addition of this note here as it provides developers with an understanding of why certain components of the program are implemented the way they are.

crabnuggets · 2021-10-27T04:46:22Z

+
+Below shows the sequence diagram of the initialisation of Decodex.
+
+![Decodex Initialisation](images/dg/DecodexInitSeq.png)


Very interesting use of colours and highlighting which actually helps with the readability of the diagram. It is also really good that the highlight colour chosen for each component is kept consistent in the later parts as well.

crabnuggets · 2021-10-27T04:48:07Z

+
+#### SelectCommand
+
+![SelectCommand](images/dg/SelectCommand.png)


Choosing to omit specific and probably complex notations for the implementation of the running of certain modules was a really good choice here.

zonglun99

Well written DG with coverage of most if not all classes. Instructions and descriptions are very clear and concise.

zonglun99 · 2021-10-27T04:13:15Z

+| Terminology                 | Definition                                                                                                                                                    |
+| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Data transformation         | The conversion of one data format to another.                                                                                                                 |
+| Application, Program        | Refer to the `Decodex` program. This two terms are used interchangeably in this User Guide.                                                                   |


Do you mean Developer Guide instead of User Guide?

zonglun99 · 2021-10-27T04:34:05Z

+### Terminologies
+
+| Terminology                 | Definition                                                                                                                                                    |
+| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Data transformation         | The conversion of one data format to another.                                                                                                                 |
+| Application, Program        | Refer to the `Decodex` program. This two terms are used interchangeably in this User Guide.                                                                   |
+| Encoding                    | Convert a message into a coded form.                                                                                                                          |
+| Decoding                    | Convert a coded message into an intelligible form                                                                                                             |
+| Base64, Binary, Hexadecimal | Common types of data encoding standards.                                                                                                                      |
+| Console                     | This refers to your command prompt window.                                                                                                                    |
+| Argument                    | The additional information you provide to the program's command.                                                                                              |
+| Module                      | A self-contained set of instructions to process your data into another form.                                                                                  |
+| Recipe                      | Acts as a container for you to select your modules. When multiple modules are selected, this forms a "module chain". By default, you do not have any recipes. |
+
+### Symbols
+
+| Name                 | Definition                                                                                            |
+| -------------------- | ----------------------------------------------------------------------------------------------------- |
+| :bulb:               | Represents a good tip for you.                                                                        |
+| :exclamation:        | Represents something important that you should take note of.                                          |
+| :information_source: | Represents additional information regarding commands/features for you better understand how it works. |
+| :pen:                | Represents our rationale behind the design/implementation.                                            |


Good use of table to define terminologies and different symbols for users' understanding.

zonglun99 · 2021-10-27T04:42:57Z

+
+This group of modules require at least one additional parameter as their encoding and decoding processes are dependent on the provided parameters. The constructors of these modules should receive parameters as required and stored in private variables. These variables will then be used in their respective `run(Data data)` method.
+
+The current implementation of the abstract `Module` class provides a strong foundation top be inherited by much more complex modules, and developed into full-functioning modules for Decodex.


Possible typo here. Do you mean to be instead of top be?

zonglun99 · 2021-10-27T04:58:11Z

+
+![ParserClass.png](images/dg/ParserClass.png)
+
+Below is the class diagram showing the association between the abstract `Command` class and its derived `*Command` classes.


Suggestion: To be consistent with usage of either *command or XYZcommand, I think would be less confusing to stick to just 1, same for RecipeXYZcommand

zonglun99

Well written DG with coverage of most if not all classes. Instructions and descriptions are very clear and concise.

zonglun99 · 2021-10-27T05:02:34Z

+
+The ***Architecture Diagram*** given below shows the high-level design of Decodex.
+
+![architecture.png](images/dg/architecture.png)


Diagram has a typo, I think you meant a file instead of an file.

itsleeqian · 2021-10-28T04:15:11Z

+This developer guide is made for developers who wish to further understand and/or develop **Decodex**.
+This guide includes the setup instructions, design, implementation, testing, product scope, and other sections to give developers a better understanding of the application.
+
+## Table of Contents <!-- omit in toc -->


Slightly odd that Table of Contents comes after Introduction, when the Intro is actually included in the Table of Contents

itsleeqian · 2021-10-28T04:17:56Z

+
+## Design
+
+### Architecture


Architecture section is really clean and understandable. Sufficient details and explanations have been given. Well done.

WeiXuanYap

lgtm :)

WeiXuanYap · 2021-10-29T03:26:29Z

+
+The `Ui` component consists of:
+
+- `Ui`: Manages access to the `Scanner` object that reads user input and also contains all the methods for printing to the user.


Do not need to create bullet point if there is only one point under UI

WeiXuanYap · 2021-10-29T03:30:05Z

+
+Below is a partial class diagram that shows an overview of the `Logic` component.
+
+![LogicComponent(4).png](images/dg/LogicComponent.png)


Based on week 10 DG Tips, it is preferable to use the same diagramming tool.

WeiXuanYap · 2021-10-29T03:43:26Z

+Modules that do not take in any parameters
+
+This group of modules do not require any additional parameters as their encoding and decoding processes are fixed. Hence, the constructors of these modules should not receive any parameters.
+
+Modules that take in at least one parameter
+
+This group of modules require at least one additional parameter as their encoding and decoding processes are dependent on the provided parameters. The constructors of these modules should receive parameters as required and stored in private variables. These variables will then be used in their respective `run(Data data)` method.


Should include a bullet point/bold/underline to show that this is a subsection/elaboration section

Link user to select module examples in command summary. Fixed the TOC linking to one section And also remove one '>'

Added show command and some fixes

…selectCommand

Changes to replace the list of modules to table format

…into TianBoon-BugFix#1 # Conflicts: # src/main/java/decodex/ui/messages/ErrorMessages.java

…selectCommand

Bug fix #1

…selectCommand

Add `recipe deselect` command

Add recipeName clarification

Add explanation on separators in data

Update module description to follow UG

Fix command argument issues

…op logic, to instead run until, a exit command is found, then break.

…Keyword Replace prefix with suffix

Removed the additional loading method for Decodex in Ui component

* Move TOC * Update links to modules * Fix Command Summary

Change list module argument to be optional

Update UG

* Change input examples to inline code blocks * Add note for last test case of creating recipes

Add page breaks to DG

…rguments Fix extraneous arguments for `reset` command

crabnuggets reviewed Oct 27, 2021

View reviewed changes

zonglun99 reviewed Oct 27, 2021

View reviewed changes

itsleeqian reviewed Oct 28, 2021

View reviewed changes

WeiXuanYap reviewed Oct 29, 2021

View reviewed changes

Kair0s3 and others added 25 commits November 1, 2021 18:48

Made changes to link user

2bfe7ea

Link user to select module examples in command summary. Fixed the TOC linking to one section And also remove one '>'

Merge pull request #274 from Kair0s3/TianBoon-ShowCommand

547a96a

Added show command and some fixes

Additional handling for the listing of files.

6b4a7bb

Changed checking to instead be using endswith function.

9cb4652

Update recipe deselect description

196f086

Merge remote-tracking branch 'upstream/master' into aloysius-RecipeDe…

8c244e4

…selectCommand

Update text-ui-test expected

4577d4c

Changes to module list section

e501dab

Changes to replace the list of modules to table format

Merge branch 'master' of https://github.com/AY2122S1-CS2113T-T10-3/tp …

ad6cebf

…into TianBoon-BugFix#1 # Conflicts: # src/main/java/decodex/ui/messages/ErrorMessages.java

Merge remote-tracking branch 'upstream/master' into aloysius-RecipeDe…

d271266

…selectCommand

Changes to instead print error failed to laod files into one line.

4abe298

Merge pull request #251 from Kair0s3/TianBoon-BugFix#1

f3003f5

Bug fix #1

Break complex line down

516e04a

Merge remote-tracking branch 'upstream/master' into aloysius-RecipeDe…

37fba4b

…selectCommand

Merge pull request #275 from arraysius/aloysius-RecipeDeselectCommand

ed973c8

Add `recipe deselect` command

Add recipeName clarification

33428d9

Merge pull request #276 from SeenFang/Sean-FixUGRecipeNameClarity

7c8c031

Add recipeName clarification

Add explanation on separators in data

9ece200

Merge pull request #277 from rizemon/jiaLe-UpdateUGuide

d519028

Add explanation on separators in data

Fix command argument issues

3a037a1

Update module description to follow UG

1cca6ac

Update module list message in text-ui

0e95877

Merge pull request #279 from rizemon/jiaLe-UpdateModuleDescription

fe8c601

Update module description to follow UG

Merge pull request #278 from SeenFang/Sean-FixIssues

4a367d5

Fix command argument issues

Abstracted some parts of the decodex logic and simplfied the while lo…

e635a8d

…op logic, to instead run until, a exit command is found, then break.

Kair0s3 and others added 30 commits November 8, 2021 16:56

Replace prefix with suffix

77286b1

Merge pull request #366 from Kair0s3/TianBoon-ReplacePrefixWithSuffix…

ecfb998

…Keyword Replace prefix with suffix

Removed the additional loading method for Decodex in Ui component.

6ef2817

Changed the terminology UG to DG keyword

c8d1848

Newline at EOF

336ba10

Merge pull request #370 from Kair0s3/TianBoon-FinalDaystination

b1349a3

Removed the additional loading method for Decodex in Ui component

Change list module argument t be optional

0d65640

Update UG

32d0fe4

* Move TOC * Update links to modules * Fix Command Summary

Merge pull request #373 from Kair0s3/TianBoon-FinalDaystination

3466b5c

Change list module argument to be optional

Add missing s

06ae574

Merge pull request #374 from rizemon/jiaLe-UGBugs

e1c61af

Update UG

Trigger github pages build

9468515

Add page breaks to DG

36be91b

Fix missing appendix header and update TOC

0ca1859

Fix long code blocks

ba033e0

* Change input examples to inline code blocks * Add note for last test case of creating recipes

Merge pull request #375 from arraysius/aloysius-DGPageBreak

6e78feb

Add page breaks to DG

Update DG page breaks

ecfdb34

Add page breaks

80c2b8d

Update page breaks

f113fbe

Update UG page breaks

f9ec90d

Fix page break for arraysius.md

3dadec1

Fix broken arraysius.md

22532b4

Fix extraneous arguments for reset command

4cda073

Add code block to run()

e0eb44a

Move exception signatures one line up

367d544

Updated kair0s3 PPP

2a15d18

Fix inputting data examples

85072e3

Move exception signature in test up one line

efcd394

Change "shows" to "indicate"

844d7c7

Merge pull request #376 from arraysius/aloysius-FixResetCommandExtraA…

6d40107

…rguments Fix extraneous arguments for `reset` command

		![CommandClass1.png](images/dg/CommandClass1.png)

		![CommandClass2.png](images/dg/CommandClass2.png)


		The *Architecture Diagram* given below shows the high-level design of Decodex.

		![architecture.png](images/dg/architecture.png)


		Below is the class diagram showing the association between the abstract `Module` class and its derived `*Decoder` classes.

		![ModuleClass.png](images/dg/ModuleClass.png)


		![RecipeClass.png](images/dg/RecipeClass.png)

		> :pen: The reason for having `Recipe` objects is to enable users to run multiple modules at one go sequentially.


		Below shows the sequence diagram of the initialisation of Decodex.

		![Decodex Initialisation](images/dg/DecodexInitSeq.png)


		#### SelectCommand

		![SelectCommand](images/dg/SelectCommand.png)


		This group of modules require at least one additional parameter as their encoding and decoding processes are dependent on the provided parameters. The constructors of these modules should receive parameters as required and stored in private variables. These variables will then be used in their respective `run(Data data)` method.

		The current implementation of the abstract `Module` class provides a strong foundation top be inherited by much more complex modules, and developed into full-functioning modules for Decodex.


		![ParserClass.png](images/dg/ParserClass.png)

		Below is the class diagram showing the association between the abstract `Command` class and its derived `*Command` classes.


		The `Ui` component consists of:

		- `Ui`: Manages access to the `Scanner` object that reads user input and also contains all the methods for printing to the user.


		Below is a partial class diagram that shows an overview of the `Logic` component.

		![LogicComponent(4).png](images/dg/LogicComponent.png)


		### UI Component

		![UiClass.png](images/dg/UiClass.png)

Uh oh!

Conversation

rizemon commented Sep 30, 2021

Uh oh!

crabnuggets left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zonglun99 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zonglun99 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WeiXuanYap left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants