Merge 0c2abd5 into 63a00ad

build.gradle

@@ -79,6 +79,8 @@ dependencies {
     testRuntimeOnly group: 'org.testfx', name: 'openjfx-monocle', version: 'jdk-9+181'
     testRuntimeOnly group:'org.junit.vintage', name:'junit-vintage-engine', version: jUnitVersion
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
+    compile 'org.apache.pdfbox:pdfbox:2.0.2'
 }
 
 shadowJar {

src/main/java/seedu/address/logic/commands/ExportCertCommand.java

@@ -0,0 +1,205 @@
+package seedu.address.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.List;
+
+import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.apache.pdfbox.pdmodel.PDPageContentStream;
+import org.apache.pdfbox.pdmodel.font.PDType1Font;
+
+import seedu.address.commons.core.LogsCenter;
+import seedu.address.commons.core.Messages;
+import seedu.address.commons.core.index.Index;
+import seedu.address.logic.CommandHistory;
+import seedu.address.logic.commands.exceptions.CommandException;
+import seedu.address.model.Model;
+import seedu.address.model.event.Date;
+import seedu.address.model.event.Event;
+import seedu.address.model.event.EventId;
+import seedu.address.model.record.Hour;
+import seedu.address.model.record.Record;
+import seedu.address.model.volunteer.Name;
+import seedu.address.model.volunteer.Volunteer;
+import seedu.address.model.volunteer.VolunteerId;
+
+/**
+ * Exports a PDF document with data on a volunteer's involvement with the organisation.
+ */
+public class ExportCertCommand extends Command {
+
+    public static final String COMMAND_WORD = "exportcert";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Exports a PDF certificate for the volunteer at "
+            + "the specified index in the displayed volunteer list.\n"
+            + "Parameters: INDEX (must be a positive integer)\n"
+            + "Example: " + COMMAND_WORD + " 1";
+
+    public static final String MESSAGE_ARGUMENTS = "Index: %1$d";
+    public static final String MESSAGE_EXPORT_CERT_SUCCESS = "Certificate exported for volunteer at %1$d "
+            + "to your Desktop.";
+    public static final String MESSAGE_EXPORT_FAILED = "Certificate export failed, please try again.";
+    public static final String PDF_SAVE_PATH = System.getProperty("user.dir") + "/Volunteer Certs/";
+    public static final String PDF_ALT_SAVE_PATH = System.getProperty("user.home") + "/Desktop/";
+
+    private static final java.util.logging.Logger logger = LogsCenter.getLogger(ExportCertCommand.class);
+
+    private static String currentSavePath = PDF_SAVE_PATH;
+
+    private final Index index;
+
+    /**
+     * @param index of the volunteer in the filtered volunteer list whose certificate is to be generated and exported
+     */
+    public ExportCertCommand(Index index) {
+        requireNonNull(index);
+        this.index = index;
+
+        // Create a folder in user's working directory to export certificates to, if possible
+        File exportDir = new File(currentSavePath);
+        if (!exportDir.exists()) {
+            try {
+                exportDir.mkdir();
+            } catch (SecurityException se) {
+                logger.warning("Couldn't create a relative export path next to jar file. "
+                        + "Defaulting to user's Desktop.");
+                currentSavePath = PDF_ALT_SAVE_PATH;
+            }
+        }
+    }
+
+    public static String getCurrentSavePath() {
+        return currentSavePath;
+    }
+
+    @Override
+    public CommandResult execute(Model model, CommandHistory history) throws CommandException {
+        requireNonNull(model);
+        List<Volunteer> lastShownList = model.getFilteredVolunteerList();
+
+        // Handle case where the index input exceeds or equals the size of the last displayed list
+        if (index.getZeroBased() >= lastShownList.size()) {
+            throw new CommandException(Messages.MESSAGE_INVALID_VOLUNTEER_DISPLAYED_INDEX);
+        }
+
+        // Get the Volunteer object whom the index corresponds to
+        Volunteer selectedVolunteer = lastShownList.get(index.getZeroBased());
+
+        // Try creating and exporting the PDF for the selected volunteer
+        try {
+            createPdf(model, selectedVolunteer);
+        } catch (IOException ioe) {
+            throw new CommandException(MESSAGE_EXPORT_FAILED);
+        }
+
+        // Return a success result
+        return new CommandResult(String.format(MESSAGE_EXPORT_CERT_SUCCESS, index.getOneBased()));
+    }
+
+    /**
+     * Creates and exports a PDF document containing a Volunteer's data
+     * @param volunteer who's data is to be input into the PDF document
+     * @param model from which the volunteer's event records will be accessed
+     */
+    private void createPdf(Model model, Volunteer volunteer) throws IOException {
+        // Retrieve the selected volunteer's attributes
+        VolunteerId volunteerId = volunteer.getVolunteerId();
+        Name volunteerName = volunteer.getName();
+
+        // Retrieve the volunteer's events
+        List<Record> eventRecords = model.getFilteredRecordList().filtered((x) -> x.getVolunteerId()
+                .equals(volunteerId));
+
+        // Create the new document
+        PDDocument doc = new PDDocument();
+
+        // Create a new page and add it to the document
+        PDPage page = new PDPage();
+        doc.addPage(page);
+
+        // Setup a new content stream to write to a page
+        PDPageContentStream contStream = new PDPageContentStream(doc, page);
+
+        // Populate the PDF with necessary details
+        contStream.beginText();
+
+        contStream.setFont(PDType1Font.TIMES_BOLD_ITALIC, 12);
+        contStream.setLeading(14.5f);
+
+        // Title
+        contStream.newLineAtOffset(10, 770);
+        String line1 = "Certificate of Recognition";
+        contStream.showText(line1);
+        contStream.newLine();
+
+        // Date of export
+        contStream.showText(String.valueOf(java.time.LocalDate.now()));
+        contStream.newLine();
+
+        // Name
+        String line2 = "Name: " + volunteerName;
+        contStream.showText(line2);
+        contStream.newLine();
+
+        // ID
+        String line3 = "Volunteer ID: " + volunteerId;
+        contStream.showText(line3);
+        contStream.newLine();
+
+        // Events
+        if (eventRecords.isEmpty()) {
+            String noEventsLine = volunteerName + " has not participated in any events thus far.";
+            contStream.showText(noEventsLine);
+            contStream.newLine();
+        } else {
+            contStream.showText("Events:");
+            contStream.newLine();
+            for (Record r: eventRecords) {
+                // Information from event record
+                Hour eventHours = r.getHour();
+                EventId eventId = r.getEventId();
+
+                // Get the exact corresponding event object and extract information from it
+                Event event = model.getFilteredEventList().filtered((x) -> x.getEventId().equals(eventId)).get(0);
+                seedu.address.model.event.Name eventName = event.getName();
+                Date startDate = event.getStartDate();
+                Date endDate = event.getEndDate();
+
+                String eventEntryLine = eventName + " - " + eventHours + " hours from " + startDate + " to " + endDate;
+
+                contStream.showText(eventEntryLine);
+                contStream.newLine();
+            }
+        }
+
+        // Close the content stream
+        contStream.endText();
+        contStream.close();
+
+        // Save document as <volunteerName>.pdf to the save path
+        doc.save(PDF_SAVE_PATH + volunteerName + ".pdf");
+
+        // Close the document
+        doc.close();
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        // Case: Both same object
+        if (other == this) {
+            return true;
+        }
+
+        // Case: Handle null, not instance of
+        if (!(other instanceof ExportCertCommand)) {
+            return false;
+        }
+
+        // Compare internal fields
+        ExportCertCommand e = (ExportCertCommand) other;
+        return index.equals(e.index);
+    }
+}

src/main/java/seedu/address/logic/parser/AddressBookParser.java

@@ -18,6 +18,7 @@
 import seedu.address.logic.commands.EditEventCommand;
 import seedu.address.logic.commands.EditRecordCommand;
 import seedu.address.logic.commands.ExitCommand;
+import seedu.address.logic.commands.ExportCertCommand;
 import seedu.address.logic.commands.FindCommand;
 import seedu.address.logic.commands.HelpCommand;
 import seedu.address.logic.commands.HistoryCommand;
@@ -112,6 +113,12 @@ public Command parseCommand(String userInput, String contextId) throws ParseExce
             case ListCommand.COMMAND_WORD:
                 return new ListCommand();
 
+            case ManageCommand.COMMAND_WORD:
+                return new ManageCommandParser().parse(arguments);
+
+            case ExportCertCommand.COMMAND_WORD:
+                return new ExportCertCommandParser().parse(arguments);
+
             default:
                 throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
             }

src/main/java/seedu/address/logic/parser/ExportCertCommandParser.java

@@ -0,0 +1,35 @@
+package seedu.address.logic.parser;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+
+import seedu.address.commons.core.index.Index;
+import seedu.address.logic.commands.ExportCertCommand;
+import seedu.address.logic.parser.exceptions.ParseException;
+
+/**
+ * Parses input arguments and creates a new {@code ExportCertCommand} object
+ */
+public class ExportCertCommandParser implements Parser<ExportCertCommand> {
+
+    /**
+     * Parses the given {@code String} of arguments in the context of the {@code ExportCertCommand}
+     * and returns a {@code ExportCertCommand} object for execution.
+     * @param userInput as a {@code String}
+     * @return ExportCertCommand object
+     * @throws ParseException if the user input does not abide by the expected format
+     */
+    public ExportCertCommand parse(String userInput) throws ParseException {
+        requireNonNull(userInput);
+
+        Index index;
+        try {
+            index = ParserUtil.parseIndex(userInput);
+        } catch (ParseException pe) {
+            throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT,
+                    ExportCertCommand.MESSAGE_USAGE), pe);
+        }
+
+        return new ExportCertCommand(index);
+    }
+}

src/test/java/seedu/address/logic/commands/CommandTestUtil.java

@@ -11,6 +11,7 @@
 import static seedu.address.logic.parser.CliSyntax.PREFIX_SWITCH;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_TAG;
 
+import java.io.File;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -181,4 +182,26 @@ public static void deleteFirstVolunteer(Model model) {
         model.commitAddressBook();
     }
 
+    /**
+     * Executes the given {@code command}, confirms that <br>
+     * - the result message matches {@code expectedMessage} <br>
+     * - the {@code actualCommandHistory} remains unchanged <br>
+     * - a file with the {@code volunteer}'s name exists.
+     */
+    public static void assertExportCommandSuccess(Command command, Model model, CommandHistory actualCommandHistory,
+                                            String expectedMessage, Volunteer volunteer) {
+        CommandHistory expectedCommandHistory = new CommandHistory(actualCommandHistory);
+        try {
+            CommandResult result = command.execute(model, actualCommandHistory);
+            assertEquals(expectedMessage, result.feedbackToUser);
+            assertEquals(expectedCommandHistory, actualCommandHistory);
+
+            // For now we just check if the exported file exists
+            File file = new File(ExportCertCommand.getCurrentSavePath() + volunteer.getName() + ".pdf");
+            assertTrue(file.exists());
+        } catch (CommandException ce) {
+            throw new AssertionError("Execution of command should not fail.", ce);
+        }
+    }
+
 }