Merge pull request #235 from AY1920S1-CS2103-T16-3/gary/path-package

Rename imagePath package to path and move DirectoryPath inside
AY1920S1-CS2103-T16-3 · Nov 8, 2019 · d2160ca · d2160ca
2 parents 20e8658 + 5a08b36
commit d2160ca
Show file tree

Hide file tree

Showing 48 changed files with 181 additions and 164 deletions.
diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc
@@ -14,7 +14,7 @@ ifdef::env-github[]
 endif::[]
 :repoURL: https://github.com/AY1920S1-CS2103-T16-3/main
 
-By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
+By: `CS2103-T16-3`      Since: `September 2019`      Licence: `MIT`
 
 == Setting up
 

diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml
@@ -46,7 +46,7 @@ Package Tag {
 Class Tag
 }
 
-Package ImagePath {
+Package Path {
 Class ImagePath
 }
 }

diff --git a/docs/diagrams/TemplateClassDiagram.puml b/docs/diagrams/TemplateClassDiagram.puml
@@ -17,7 +17,7 @@ Class Name
 Class UniqueTemplateList
 }
 
-Package ImagePath {
+Package Path {
 Class ImagePath
 }
 }

diff --git a/docs/images/ModelClassDiagram.png b/docs/images/ModelClassDiagram.png
diff --git a/docs/images/TemplateClassDiagram.png b/docs/images/TemplateClassDiagram.png
diff --git a/src/main/java/seedu/weme/commons/util/FileUtil.java b/src/main/java/seedu/weme/commons/util/FileUtil.java
@@ -14,7 +14,7 @@
 
 import javafx.scene.image.Image;
 
-import seedu.weme.model.DirectoryPath;
+import seedu.weme.model.path.DirectoryPath;
 
 
 /**

diff --git a/src/main/java/seedu/weme/logic/commands/createcommand/CreateCommand.java b/src/main/java/seedu/weme/logic/commands/createcommand/CreateCommand.java
@@ -12,9 +12,9 @@
 import seedu.weme.model.Model;
 import seedu.weme.model.ModelContext;
 import seedu.weme.model.ReadOnlyUserPrefs;
-import seedu.weme.model.imagePath.ImagePath;
 import seedu.weme.model.meme.Description;
 import seedu.weme.model.meme.Meme;
+import seedu.weme.model.path.ImagePath;
 import seedu.weme.model.tag.Tag;
 import seedu.weme.model.template.exceptions.MemeCreationException;
 import seedu.weme.model.util.ImageUtil;

diff --git a/src/main/java/seedu/weme/logic/commands/exportcommand/ExportCommand.java b/src/main/java/seedu/weme/logic/commands/exportcommand/ExportCommand.java
@@ -13,8 +13,8 @@
 import seedu.weme.logic.commands.Command;
 import seedu.weme.logic.commands.CommandResult;
 import seedu.weme.logic.commands.exceptions.CommandException;
-import seedu.weme.model.DirectoryPath;
 import seedu.weme.model.Model;
+import seedu.weme.model.path.DirectoryPath;
 
 /**
  * Exports memes from staging area to a specified path.

diff --git a/src/main/java/seedu/weme/logic/commands/importcommand/ImportEditCommand.java b/src/main/java/seedu/weme/logic/commands/importcommand/ImportEditCommand.java
@@ -14,9 +14,9 @@
 import seedu.weme.logic.commands.exceptions.CommandException;
 import seedu.weme.logic.commands.memecommand.MemeEditCommand;
 import seedu.weme.model.Model;
-import seedu.weme.model.imagePath.ImagePath;
 import seedu.weme.model.meme.Description;
 import seedu.weme.model.meme.Meme;
+import seedu.weme.model.path.ImagePath;
 import seedu.weme.model.tag.Tag;
 
 /**
@@ -46,7 +46,7 @@ public class ImportEditCommand extends Command {
     private final MemeEditCommand.EditMemeDescriptor editMemeDescriptor;
 
     /**
-     * @param index of the meme in the filtered meme list to edit
+     * @param index              of the meme in the filtered meme list to edit
      * @param editMemeDescriptor details to edit the meme with
      */
     public ImportEditCommand(Index index, MemeEditCommand.EditMemeDescriptor editMemeDescriptor) {
@@ -57,6 +57,20 @@ public ImportEditCommand(Index index, MemeEditCommand.EditMemeDescriptor editMem
         this.editMemeDescriptor = new MemeEditCommand.EditMemeDescriptor(editMemeDescriptor);
     }
 
+    /**
+     * Creates and returns a {@code Meme} with the details of {@code memeToEdit}
+     * edited with {@code editMemeDescriptor}.
+     */
+    private static Meme createEditedMeme(Meme memeToEdit, MemeEditCommand.EditMemeDescriptor editMemeDescriptor) {
+        assert memeToEdit != null;
+
+        ImagePath updatedPath = editMemeDescriptor.getFilePath().orElse(memeToEdit.getImagePath());
+        Description updatedDescription = editMemeDescriptor.getDescription().orElse(memeToEdit.getDescription());
+        Set<Tag> updatedTags = editMemeDescriptor.getTags().orElse(memeToEdit.getTags());
+
+        return new Meme(updatedPath, updatedDescription, updatedTags);
+    }
+
     @Override
     public CommandResult execute(Model model) throws CommandException {
         requireNonNull(model);
@@ -79,20 +93,6 @@ public CommandResult execute(Model model) throws CommandException {
         return result;
     }
 
-    /**
-     * Creates and returns a {@code Meme} with the details of {@code memeToEdit}
-     * edited with {@code editMemeDescriptor}.
-     */
-    private static Meme createEditedMeme(Meme memeToEdit, MemeEditCommand.EditMemeDescriptor editMemeDescriptor) {
-        assert memeToEdit != null;
-
-        ImagePath updatedPath = editMemeDescriptor.getFilePath().orElse(memeToEdit.getImagePath());
-        Description updatedDescription = editMemeDescriptor.getDescription().orElse(memeToEdit.getDescription());
-        Set<Tag> updatedTags = editMemeDescriptor.getTags().orElse(memeToEdit.getTags());
-
-        return new Meme(updatedPath, updatedDescription, updatedTags);
-    }
-
     @Override
     public boolean equals(Object other) {
         // short circuit if same object

diff --git a/src/main/java/seedu/weme/logic/commands/importcommand/LoadCommand.java b/src/main/java/seedu/weme/logic/commands/importcommand/LoadCommand.java
@@ -11,8 +11,8 @@
 import seedu.weme.logic.commands.Command;
 import seedu.weme.logic.commands.CommandResult;
 import seedu.weme.logic.commands.exceptions.CommandException;
-import seedu.weme.model.DirectoryPath;
 import seedu.weme.model.Model;
+import seedu.weme.model.path.DirectoryPath;
 
 /**
  * Loads memes from a directory to the import context.

diff --git a/src/main/java/seedu/weme/logic/commands/memecommand/MemeArchiveCommand.java b/src/main/java/seedu/weme/logic/commands/memecommand/MemeArchiveCommand.java
@@ -12,9 +12,9 @@
 import seedu.weme.logic.commands.CommandResult;
 import seedu.weme.logic.commands.exceptions.CommandException;
 import seedu.weme.model.Model;
-import seedu.weme.model.imagePath.ImagePath;
 import seedu.weme.model.meme.Description;
 import seedu.weme.model.meme.Meme;
+import seedu.weme.model.path.ImagePath;
 import seedu.weme.model.tag.Tag;
 
 /**

diff --git a/src/main/java/seedu/weme/logic/commands/memecommand/MemeEditCommand.java b/src/main/java/seedu/weme/logic/commands/memecommand/MemeEditCommand.java
@@ -17,9 +17,9 @@
 import seedu.weme.logic.commands.CommandResult;
 import seedu.weme.logic.commands.exceptions.CommandException;
 import seedu.weme.model.Model;
-import seedu.weme.model.imagePath.ImagePath;
 import seedu.weme.model.meme.Description;
 import seedu.weme.model.meme.Meme;
+import seedu.weme.model.path.ImagePath;
 import seedu.weme.model.tag.Tag;
 
 /**
@@ -51,7 +51,7 @@ public class MemeEditCommand extends Command {
     private final EditMemeDescriptor editMemeDescriptor;
 
     /**
-     * @param index of the meme in the filtered meme list to edit
+     * @param index              of the meme in the filtered meme list to edit
      * @param editMemeDescriptor details to edit the meme with
      */
     public MemeEditCommand(Index index, EditMemeDescriptor editMemeDescriptor) {
@@ -62,6 +62,21 @@ public MemeEditCommand(Index index, EditMemeDescriptor editMemeDescriptor) {
         this.editMemeDescriptor = new EditMemeDescriptor(editMemeDescriptor);
     }
 
+    /**
+     * Creates and returns a {@code Meme} with the details of {@code memeToEdit}
+     * edited with {@code editMemeDescriptor}.
+     */
+    private static Meme createEditedMeme(Meme memeToEdit, EditMemeDescriptor editMemeDescriptor) {
+        assert memeToEdit != null;
+
+        ImagePath updatedPath = editMemeDescriptor.getFilePath().orElse(memeToEdit.getImagePath());
+        Description updatedDescription = editMemeDescriptor.getDescription().orElse(memeToEdit.getDescription());
+        Set<Tag> updatedTags = editMemeDescriptor.getTags().orElse(memeToEdit.getTags());
+        boolean isArchived = memeToEdit.isArchived();
+
+        return new Meme(updatedPath, updatedDescription, updatedTags, isArchived);
+    }
+
     @Override
     public CommandResult execute(Model model) throws CommandException {
         requireNonNull(model);
@@ -89,21 +104,6 @@ public CommandResult execute(Model model) throws CommandException {
         return result;
     }
 
-    /**
-     * Creates and returns a {@code Meme} with the details of {@code memeToEdit}
-     * edited with {@code editMemeDescriptor}.
-     */
-    private static Meme createEditedMeme(Meme memeToEdit, EditMemeDescriptor editMemeDescriptor) {
-        assert memeToEdit != null;
-
-        ImagePath updatedPath = editMemeDescriptor.getFilePath().orElse(memeToEdit.getImagePath());
-        Description updatedDescription = editMemeDescriptor.getDescription().orElse(memeToEdit.getDescription());
-        Set<Tag> updatedTags = editMemeDescriptor.getTags().orElse(memeToEdit.getTags());
-        boolean isArchived = memeToEdit.isArchived();
-
-        return new Meme(updatedPath, updatedDescription, updatedTags, isArchived);
-    }
-
     @Override
     public boolean equals(Object other) {
         // short circuit if same object
@@ -131,7 +131,8 @@ public static class EditMemeDescriptor {
         private Description description;
         private Set<Tag> tags;
 
-        public EditMemeDescriptor() {}
+        public EditMemeDescriptor() {
+        }
 
         /**
          * Copy constructor.
@@ -150,28 +151,20 @@ public boolean isAnyFieldEdited() {
             return CollectionUtil.isAnyNonNull(filePath, description, tags);
         }
 
-        public void setFilePath(ImagePath filePath) {
-            this.filePath = filePath;
-        }
-
         public Optional<ImagePath> getFilePath() {
             return Optional.ofNullable(filePath);
         }
 
-        public void setDescription(Description description) {
-            this.description = description;
+        public void setFilePath(ImagePath filePath) {
+            this.filePath = filePath;
         }
 
         public Optional<Description> getDescription() {
             return Optional.ofNullable(description);
         }
 
-        /**
-         * Sets {@code tags} to this object's {@code tags}.
-         * A defensive copy of {@code tags} is used internally.
-         */
-        public void setTags(Set<Tag> tags) {
-            this.tags = (tags != null) ? new HashSet<>(tags) : null;
+        public void setDescription(Description description) {
+            this.description = description;
         }
 
         /**
@@ -183,6 +176,14 @@ public Optional<Set<Tag>> getTags() {
             return (tags != null) ? Optional.of(Collections.unmodifiableSet(tags)) : Optional.empty();
         }
 
+        /**
+         * Sets {@code tags} to this object's {@code tags}.
+         * A defensive copy of {@code tags} is used internally.
+         */
+        public void setTags(Set<Tag> tags) {
+            this.tags = (tags != null) ? new HashSet<>(tags) : null;
+        }
+
         @Override
         public boolean equals(Object other) {
             // short circuit if same object

diff --git a/src/main/java/seedu/weme/logic/commands/memecommand/MemeUnarchiveCommand.java b/src/main/java/seedu/weme/logic/commands/memecommand/MemeUnarchiveCommand.java
@@ -12,9 +12,9 @@
 import seedu.weme.logic.commands.CommandResult;
 import seedu.weme.logic.commands.exceptions.CommandException;
 import seedu.weme.model.Model;
-import seedu.weme.model.imagePath.ImagePath;
 import seedu.weme.model.meme.Description;
 import seedu.weme.model.meme.Meme;
+import seedu.weme.model.path.ImagePath;
 import seedu.weme.model.tag.Tag;
 
 /**

diff --git a/src/main/java/seedu/weme/logic/commands/templatecommand/TemplateArchiveCommand.java b/src/main/java/seedu/weme/logic/commands/templatecommand/TemplateArchiveCommand.java
@@ -11,7 +11,7 @@
 import seedu.weme.logic.commands.CommandResult;
 import seedu.weme.logic.commands.exceptions.CommandException;
 import seedu.weme.model.Model;
-import seedu.weme.model.imagePath.ImagePath;
+import seedu.weme.model.path.ImagePath;
 import seedu.weme.model.template.Name;
 import seedu.weme.model.template.Template;
 

diff --git a/src/main/java/seedu/weme/logic/commands/templatecommand/TemplateUnarchiveCommand.java b/src/main/java/seedu/weme/logic/commands/templatecommand/TemplateUnarchiveCommand.java
@@ -11,7 +11,7 @@
 import seedu.weme.logic.commands.CommandResult;
 import seedu.weme.logic.commands.exceptions.CommandException;
 import seedu.weme.model.Model;
-import seedu.weme.model.imagePath.ImagePath;
+import seedu.weme.model.path.ImagePath;
 import seedu.weme.model.template.Name;
 import seedu.weme.model.template.Template;
 

diff --git a/...n/java/seedu/weme/logic/parser/commandparser/exportcommandparser/ExportCommandParser.java b/...n/java/seedu/weme/logic/parser/commandparser/exportcommandparser/ExportCommandParser.java
@@ -8,7 +8,7 @@
 import seedu.weme.logic.parser.util.ArgumentMultimap;
 import seedu.weme.logic.parser.util.ArgumentTokenizer;
 import seedu.weme.logic.parser.util.ParserUtil;
-import seedu.weme.model.DirectoryPath;
+import seedu.weme.model.path.DirectoryPath;
 
 /**
  * Parses input arguments and creates a new ExportCommand object

diff --git a/...ain/java/seedu/weme/logic/parser/commandparser/importcommandparser/LoadCommandParser.java b/...ain/java/seedu/weme/logic/parser/commandparser/importcommandparser/LoadCommandParser.java
@@ -8,7 +8,7 @@
 import seedu.weme.logic.parser.util.ArgumentMultimap;
 import seedu.weme.logic.parser.util.ArgumentTokenizer;
 import seedu.weme.logic.parser.util.ParserUtil;
-import seedu.weme.model.DirectoryPath;
+import seedu.weme.model.path.DirectoryPath;
 
 /**
  * Parses input arguments and creates a new LoadCommand object

diff --git a/...in/java/seedu/weme/logic/parser/commandparser/memecommandparser/MemeAddCommandParser.java b/...in/java/seedu/weme/logic/parser/commandparser/memecommandparser/MemeAddCommandParser.java
@@ -13,9 +13,9 @@
 import seedu.weme.logic.parser.util.ArgumentMultimap;
 import seedu.weme.logic.parser.util.ArgumentTokenizer;
 import seedu.weme.logic.parser.util.ParserUtil;
-import seedu.weme.model.imagePath.ImagePath;
 import seedu.weme.model.meme.Description;
 import seedu.weme.model.meme.Meme;
+import seedu.weme.model.path.ImagePath;
 import seedu.weme.model.tag.Tag;
 
 /**
@@ -26,6 +26,7 @@ public class MemeAddCommandParser implements Parser<MemeAddCommand> {
     /**
      * Parses the given {@code String} of arguments in the context of the MemeAddCommand
      * and returns an MemeAddCommand object for execution.
+     *
      * @throws ParseException if the user input does not conform the expected format
      */
     public MemeAddCommand parse(String args) throws ParseException {

diff --git a/...seedu/weme/logic/parser/commandparser/templatecommandparser/TemplateAddCommandParser.java b/...seedu/weme/logic/parser/commandparser/templatecommandparser/TemplateAddCommandParser.java
@@ -10,7 +10,7 @@
 import seedu.weme.logic.parser.util.ArgumentMultimap;
 import seedu.weme.logic.parser.util.ArgumentTokenizer;
 import seedu.weme.logic.parser.util.ParserUtil;
-import seedu.weme.model.imagePath.ImagePath;
+import seedu.weme.model.path.ImagePath;
 import seedu.weme.model.template.Name;
 import seedu.weme.model.template.Template;