nus-cs2113-AY2122S1 · rizemon · Nov 1, 2021 · Nov 1, 2021 · Nov 1, 2021 · Nov 1, 2021
diff --git a/.gitignore b/.gitignore
@@ -13,5 +13,12 @@ src/main/resources/docs/
 *.iml
 bin/
 
+# Recipe files
+/recipe/*
+
+# Input, Output files
+/input/*
+/output/*
+
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
diff --git a/build.gradle b/build.gradle
@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "decodex.Decodex"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "decodex"
     archiveClassifier = null
 }
 
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -2,8 +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) | 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)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+<img src="https://avatars.githubusercontent.com/u/26685970?v=4" width="100"/> | Tan Jia Le | [Github](https://github.com/rizemon) | [Portfolio](docs/team/johndoe.md)
+<img src="https://avatars.githubusercontent.com/u/16810847?v=4" width="100"/> | Aloysius Lee | [Github](https://github.com/arraysius) | [Portfolio](docs/team/johndoe.md)
+<img src="https://media.discordapp.net/attachments/285692337357586432/892962858546114560/photo_2021-05-07_15-04-25.jpg?text=BreadDog" width="100"/> | Sean Phang | [Github](https://github.com/SeenFang) | [Portfolio](docs/team/johndoe.md)
+<img src="https://avatars.githubusercontent.com/u/50107219?v=4" width="100"/> | Sim Tian Boon | [Github](https://github.com/Kair0s3) | [Portfolio](docs/team/johndoe.md)
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem 'jemoji', '~> 0.12.0'
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
-# Duke
+# Decodex
 
-{Give product intro here}
+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.
 
 Useful links:
 * [User Guide](UserGuide.md)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,3 @@
+theme: jekyll-theme-cayman
+gems:
+  - jemoji
diff --git a/docs/images/carbon(1).png b/docs/images/carbon(1).png
diff --git a/docs/images/carbon(10).png b/docs/images/carbon(10).png
diff --git a/docs/images/carbon(17).png b/docs/images/carbon(17).png
diff --git a/docs/images/carbon(23).png b/docs/images/carbon(23).png
diff --git a/docs/images/carbon(5).png b/docs/images/carbon(5).png
diff --git a/docs/images/carbon(6).png b/docs/images/carbon(6).png
diff --git a/docs/images/carbon(8).png b/docs/images/carbon(8).png
diff --git a/docs/images/carbon(9).png b/docs/images/carbon(9).png
diff --git a/docs/images/dg/CommandClass1.png b/docs/images/dg/CommandClass1.png
diff --git a/docs/images/dg/CommandClass2.png b/docs/images/dg/CommandClass2.png
diff --git a/docs/images/dg/DataClass.png b/docs/images/dg/DataClass.png
diff --git a/docs/images/dg/DataComponent.png b/docs/images/dg/DataComponent.png
diff --git a/docs/images/dg/DecodexInitSeq.png b/docs/images/dg/DecodexInitSeq.png
diff --git a/docs/images/dg/DecodexMainSeq.png b/docs/images/dg/DecodexMainSeq.png
diff --git a/docs/images/dg/ExitCommand.png b/docs/images/dg/ExitCommand.png
diff --git a/docs/images/dg/InputCommand.png b/docs/images/dg/InputCommand.png
diff --git a/docs/images/dg/ListCommand.png b/docs/images/dg/ListCommand.png
diff --git a/docs/images/dg/LogicComponent.png b/docs/images/dg/LogicComponent.png
diff --git a/docs/images/dg/ModuleClass.png b/docs/images/dg/ModuleClass.png
diff --git a/docs/images/dg/ModuleComponent.png b/docs/images/dg/ModuleComponent.png
diff --git a/docs/images/dg/ModuleManagerClass.png b/docs/images/dg/ModuleManagerClass.png
diff --git a/docs/images/dg/ParserBasicSeq.png b/docs/images/dg/ParserBasicSeq.png
diff --git a/docs/images/dg/ParserClass.png b/docs/images/dg/ParserClass.png
diff --git a/docs/images/dg/ParserRecipeSeq.png b/docs/images/dg/ParserRecipeSeq.png
diff --git a/docs/images/dg/RecipeClass.png b/docs/images/dg/RecipeClass.png
diff --git a/docs/images/dg/RecipeComponent.png b/docs/images/dg/RecipeComponent.png
diff --git a/docs/images/dg/RecipeDeleteCommand.png b/docs/images/dg/RecipeDeleteCommand.png
diff --git a/docs/images/dg/RecipeListCommand.png b/docs/images/dg/RecipeListCommand.png
diff --git a/docs/images/dg/RecipeNewCommand.png b/docs/images/dg/RecipeNewCommand.png
diff --git a/docs/images/dg/RecipePopCommand.png b/docs/images/dg/RecipePopCommand.png
diff --git a/docs/images/dg/RecipePushCommand.png b/docs/images/dg/RecipePushCommand.png
diff --git a/docs/images/dg/RecipeResetCommand.png b/docs/images/dg/RecipeResetCommand.png
diff --git a/docs/images/dg/RecipeSelectCommand.png b/docs/images/dg/RecipeSelectCommand.png
diff --git a/docs/images/dg/ResetCommand.png b/docs/images/dg/ResetCommand.png
diff --git a/docs/images/dg/SelectCommand.png b/docs/images/dg/SelectCommand.png
diff --git a/docs/images/dg/SelectCommandModule.png b/docs/images/dg/SelectCommandModule.png
diff --git a/docs/images/dg/SelectCommandRecipe.png b/docs/images/dg/SelectCommandRecipe.png
diff --git a/docs/images/dg/StorageClass.png b/docs/images/dg/StorageClass.png
diff --git a/docs/images/dg/UiClass.png b/docs/images/dg/UiClass.png
diff --git a/docs/images/dg/architecture.png b/docs/images/dg/architecture.png
diff --git a/docs/images/recipeDelete.png b/docs/images/recipeDelete.png
diff --git a/docs/images/recipeList.png b/docs/images/recipeList.png
diff --git a/docs/images/recipeNew.png b/docs/images/recipeNew.png
diff --git a/docs/images/recipePop.png b/docs/images/recipePop.png
diff --git a/docs/images/recipePush.png b/docs/images/recipePush.png
diff --git a/docs/images/recipeReset.png b/docs/images/recipeReset.png
diff --git a/docs/images/recipeSelect.png b/docs/images/recipeSelect.png
diff --git a/docs/images/ug/ListCommandExample.png b/docs/images/ug/ListCommandExample.png
diff --git a/docs/images/ug/SelectCommandExample.png b/docs/images/ug/SelectCommandExample.png
diff --git a/docs/images/ug/inputCommandExample.png b/docs/images/ug/inputCommandExample.png
diff --git a/src/main/java/decodex/Decodex.java b/src/main/java/decodex/Decodex.java
@@ -0,0 +1,97 @@
+package decodex;
+
+import decodex.commands.Command;
+import decodex.commands.ExitCommand;
+import decodex.data.DataManager;
+import decodex.data.exception.CommandException;
+import decodex.data.exception.DataManagerException;
+import decodex.data.exception.ModuleException;
+import decodex.data.exception.ModuleManagerException;
+import decodex.data.exception.ParserException;
+import decodex.data.exception.RecipeException;
+import decodex.data.exception.RecipeManagerException;
+import decodex.modules.ModuleManager;
+import decodex.parser.Parser;
+import decodex.recipes.RecipeManager;
+import decodex.storage.Storage;
+import decodex.ui.Ui;
+import java.io.IOException;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+public class Decodex {
+
+    public static Logger logger = Logger.getLogger(Decodex.class.getName());
+
+
+    /**
+     * Necessary objects to be initialized for Decodex to work properly.
+     */
+    private static DataManager dataManager;
+    private static ModuleManager moduleManager;
+    private static RecipeManager recipeManager;
+    private static Parser parser;
+    private static Ui ui;
+    private static Storage storage;
+
+    public Decodex() {
+        initDecodex();
+    }
+
+    /**
+     * Initializes the necessary Objects for Decodex.
+     */
+    private void initDecodex() {
+        logger.setLevel(Level.INFO);
+        dataManager = new DataManager();
+        moduleManager = new ModuleManager();
+        parser = new Parser();
+        ui = new Ui();
+        storage = new Storage();
+        recipeManager = new RecipeManager(storage);
+        try {
+            loadSavedRecipes();
+        } catch (IOException err) {
+            ui.printError(err);
+        }
+
+    }
+
+    /**
+     * Decodex entry-point for the java.decodex.Decodex application.
+     */
+    public static void main(String[] args) {
+        new Decodex().run();
+    }
+
+    public void run() {
+        ui.printGreeting();
+
+        Command command = null;
+
+        do {
+            String editingRecipeName;
+            try {
+                editingRecipeName = recipeManager.getEditingRecipe().getName();
+            } catch (RecipeManagerException e) {
+                editingRecipeName = null;
+            }
+            ui.printPromptHeader(editingRecipeName);
+            String userInput = ui.readInput();
+            logger.fine("User input: " + userInput);
+            try {
+                command = parser.parseCommand(userInput);
+                assert command != null : "Command should not be null";
+                command.run(dataManager, moduleManager, ui, recipeManager);
+            } catch (ParserException | CommandException | ModuleManagerException | DataManagerException
+                    | ModuleException | RecipeException | RecipeManagerException | IOException err) {
+                ui.printError(err);
+                logger.fine(err.getMessage());
+            }
+        } while (!(command instanceof ExitCommand));
+    }
+
+    private void loadSavedRecipes() throws IOException {
+        storage.loadRecipesFromDirectory(moduleManager, recipeManager, ui);
+    }
+}
diff --git a/src/main/java/decodex/commands/Command.java b/src/main/java/decodex/commands/Command.java
@@ -0,0 +1,26 @@
+package decodex.commands;
+
+import decodex.data.DataManager;
+import decodex.data.exception.CommandException;
+import decodex.data.exception.DataManagerException;
+import decodex.data.exception.ModuleException;
+import decodex.data.exception.RecipeException;
+import decodex.data.exception.RecipeManagerException;
+import decodex.data.exception.ModuleManagerException;
+import decodex.modules.ModuleManager;
+import decodex.recipes.RecipeManager;
+import decodex.ui.Ui;
+import java.io.IOException;
+
+/**
+ * Command serves as a foundation for other commands to be built upon.
+ */
+public abstract class Command {
+
+    public Command() {
+    }
+
+    public abstract void run(DataManager dataManager, ModuleManager moduleManager, Ui ui, RecipeManager recipeManager)
+            throws CommandException, ModuleManagerException, DataManagerException, ModuleException, RecipeException,
+            RecipeManagerException, IOException;
+}
diff --git a/src/main/java/decodex/commands/ExitCommand.java b/src/main/java/decodex/commands/ExitCommand.java
@@ -0,0 +1,22 @@
+package decodex.commands;
+
+import decodex.data.DataManager;
+import decodex.modules.ModuleManager;
+import decodex.recipes.RecipeManager;
+import decodex.ui.Ui;
+
+public class ExitCommand extends Command {
+
+    public static final String COMMAND_WORD = "exit";
+    public static final String COMMAND_HELP_MESSAGE = "Exit the program\n"
+            + "Syntax: exit";
+
+    public ExitCommand() {
+        super();
+    }
+
+    @Override
+    public void run(DataManager dataManager, ModuleManager moduleManager, Ui ui, RecipeManager recipeManager) {
+        ui.printGoodbye();
+    }
+}
diff --git a/src/main/java/decodex/commands/HelpCommand.java b/src/main/java/decodex/commands/HelpCommand.java
@@ -0,0 +1,48 @@
+package decodex.commands;
+
+import decodex.commands.recipe.RecipeDeleteCommand;
+import decodex.commands.recipe.RecipeListCommand;
+import decodex.commands.recipe.RecipeNewCommand;
+import decodex.commands.recipe.RecipePopCommand;
+import decodex.commands.recipe.RecipePushCommand;
+import decodex.commands.recipe.RecipeResetCommand;
+import decodex.commands.recipe.RecipeSelectCommand;
+import decodex.data.DataManager;
+import decodex.modules.ModuleManager;
+import decodex.recipes.RecipeManager;
+import decodex.ui.Ui;
+
+// @@author rizemon
+public class HelpCommand extends Command {
+
+    public static final String COMMAND_WORD = "help";
+    public static final String COMMAND_HELP_MESSAGE = "Shows list of available commands\n"
+            + "Syntax: help";
+
+    private static final String[] BASIC_COMMAND_HELP_MESSAGES = {
+        HelpCommand.COMMAND_HELP_MESSAGE,
+        ExitCommand.COMMAND_HELP_MESSAGE,
+        InputCommand.COMMAND_HELP_MESSAGE,
+        ListCommand.COMMAND_HELP_MESSAGE,
+        SelectCommand.COMMAND_HELP_MESSAGE
+    };
+
+    private static final String[] RECIPE_COMMAND_HELP_MESSAGES = {
+        RecipeNewCommand.COMMAND_HELP_MESSAGE,
+        RecipeListCommand.COMMAND_HELP_MESSAGE,
+        RecipeSelectCommand.COMMAND_HELP_MESSAGE,
+        RecipePushCommand.COMMAND_HELP_MESSAGE,
+        RecipePopCommand.COMMAND_HELP_MESSAGE,
+        RecipeResetCommand.COMMAND_HELP_MESSAGE,
+        RecipeDeleteCommand.COMMAND_HELP_MESSAGE,
+    };
+
+    public HelpCommand() {
+        super();
+    }
+
+    @Override
+    public void run(DataManager dataManager, ModuleManager moduleManager, Ui ui, RecipeManager recipeManager) {
+        ui.printCommandHelp(BASIC_COMMAND_HELP_MESSAGES, RECIPE_COMMAND_HELP_MESSAGES);
+    }
+}
diff --git a/src/main/java/decodex/commands/InputCommand.java b/src/main/java/decodex/commands/InputCommand.java
@@ -0,0 +1,37 @@
+package decodex.commands;
+
+import decodex.data.Data;
+import decodex.data.DataManager;
+import decodex.data.exception.CommandException;
+import decodex.modules.ModuleManager;
+import decodex.recipes.RecipeManager;
+import decodex.ui.Ui;
+import decodex.ui.messages.ErrorMessages;
+
+// @@author rizemon
+public class InputCommand extends Command {
+
+    public static final String COMMAND_WORD = "input";
+    public static final String COMMAND_HELP_MESSAGE = "Input of data\n"
+            + "Syntax: input <data>";
+
+    private final String dataString;
+
+    public InputCommand(String dataString) {
+        super();
+        this.dataString = dataString;
+    }
+
+    @Override
+    public void run(DataManager dataManager, ModuleManager moduleManager, Ui ui, RecipeManager recipeManager)
+            throws CommandException {
+        if (dataString.isEmpty()) {
+            throw new CommandException(ErrorMessages.MISSING_ARGUMENT);
+        }
+
+        Data userData = new Data(dataString);
+        dataManager.setOriginalData(userData);
+
+        ui.printInput(dataString);
+    }
+}
diff --git a/src/main/java/decodex/commands/ListCommand.java b/src/main/java/decodex/commands/ListCommand.java
@@ -0,0 +1,95 @@
+package decodex.commands;
+
+import decodex.data.DataManager;
+import decodex.data.exception.CommandException;
+import decodex.modules.ModuleManager;
+import decodex.recipes.RecipeManager;
+import decodex.ui.Ui;
+import decodex.ui.messages.ErrorMessages;
+
+public class ListCommand extends Command {
+
+    public static final String COMMAND_WORD = "list";
+    public static final String COMMAND_HELP_MESSAGE = "List available modules and recipes\n"
+            + "Syntax: list {category}\n"
+            + "Acceptable values of category: modules, recipes";
+
+    public static final String LIST_CATEGORY_MODULES = "modules";
+    public static final String LIST_CATEGORY_RECIPE = "recipes";
+    private static final int MODULE_NAME_INDEX = 0;
+    private static final int MODULE_DESCRIPTION_INDEX = 1;
+
+    private final String listCategory;
+
+    public ListCommand(String listCategory) {
+        super();
+        this.listCategory = listCategory;
+    }
+
+    @Override
+    public void run(DataManager dataManager, ModuleManager moduleManager, Ui ui, RecipeManager recipeManager)
+            throws CommandException {
+        boolean isPrintModuleList = listCategory == null || listCategory.equals(LIST_CATEGORY_MODULES);
+        boolean isPrintRecipeList = listCategory == null || listCategory.equals(LIST_CATEGORY_RECIPE);
+
+        if (isPrintModuleList) {
+            ui.printModuleList(getModuleList(moduleManager));
+        }
+        if (isPrintRecipeList) {
+            ui.printRecipeList(getRecipeList(recipeManager));
+        }
+        if (!isPrintModuleList && !isPrintRecipeList) {
+            throw new CommandException(ErrorMessages.INVALID_LIST_CATEGORY);
+        }
+    }
+
+    /**
+     * Prepares the list of supported modules.
+     *
+     * @param moduleManager The ModuleManager to retrieve supported modules.
+     * @return A formatted String of modules.
+     */
+    private String getModuleList(ModuleManager moduleManager) {
+        String[][] modules = moduleManager.getModules();
+        assert modules.length > 0 : "Number of modules should be greater than 0";
+
+        StringBuilder moduleListString = new StringBuilder();
+        int maxNameWidth = 0;
+
+        // Find number of characters of the longest module name
+        for (String[] module : modules) {
+            String moduleName = module[MODULE_NAME_INDEX];
+            if (moduleName.length() > maxNameWidth) {
+                maxNameWidth = moduleName.length();
+            }
+        }
+
+        // Prepare and format list of modules
+        for (String[] module : modules) {
+            String moduleName = module[MODULE_NAME_INDEX];
+            String moduleDescription = module[MODULE_DESCRIPTION_INDEX];
+            moduleListString.append(String.format("  %-" + maxNameWidth + "s - %s\n", moduleName, moduleDescription));
+        }
+
+        return moduleListString.toString();
+    }
+
+    /**
+     * Prepares the list of available recipes.
+     *
+     * @param recipeManager The RecipeManager to retrieve available recipes.
+     * @return A formatted String of recipes.
+     */
+    private String getRecipeList(RecipeManager recipeManager) {
+        String[] recipeNames = recipeManager.getRecipeNames();
+
+        StringBuilder recipeListString = new StringBuilder();
+
+        // Prepare and format list of recipes
+        for (String recipeName : recipeNames) {
+            recipeListString.append(String.format("  %s\n", recipeName));
+        }
+
+        return recipeListString.toString();
+    }
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		source "https://rubygems.org"

		gem 'jemoji', '~> 0.12.0'