Skip to content

Commit

Permalink
Merge pull request #254 from mslevis/owen-codeQuality
Browse files Browse the repository at this point in the history
Code quality
  • Loading branch information
joenzkc authored Nov 8, 2021
2 parents 185aaf9 + 1244184 commit 9b95f39
Show file tree
Hide file tree
Showing 16 changed files with 96 additions and 30 deletions.
6 changes: 6 additions & 0 deletions src/main/java/seedu/address/logic/commands/AddCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
import static seedu.address.logic.parser.CliSyntax.PREFIX_RATING;
import static seedu.address.logic.parser.CliSyntax.PREFIX_TAG;

import java.util.logging.Logger;

import seedu.address.commons.core.LogsCenter;
import seedu.address.logic.commands.exceptions.CommandException;
import seedu.address.model.Model;
import seedu.address.model.studyspot.StudySpot;
Expand Down Expand Up @@ -42,6 +45,8 @@ public class AddCommand extends Command {
public static final String MESSAGE_SUCCESS = "New study spot added: %1$s";
public static final String MESSAGE_DUPLICATE_STUDYSPOT = "This study spot already exists in the study tracker";

private static final Logger logger = LogsCenter.getLogger(AddCommand.class);

private final StudySpot toAdd;

/**
Expand All @@ -54,6 +59,7 @@ public AddCommand(StudySpot studySpot) {

@Override
public CommandResult execute(Model model) throws CommandException {
logger.info("Executing Add Command...");
requireNonNull(model);

if (model.hasStudySpot(toAdd)) {
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/seedu/address/logic/commands/AliasCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
import static seedu.address.logic.parser.CliSyntax.PREFIX_ALIAS;
import static seedu.address.logic.parser.CliSyntax.PREFIX_ALIAS_COMMAND;

import java.util.logging.Logger;
import java.util.stream.Collectors;

import seedu.address.commons.core.LogsCenter;
import seedu.address.model.Model;
import seedu.address.model.alias.Alias;

Expand All @@ -30,6 +32,8 @@ public class AliasCommand extends Command {
public static final String MESSAGE_SUCCESS_SET = "Added alias %1$s";
public static final String MESSAGE_SUCCESS_SHOW = "Here are your aliases:\n%1$s.";

private static final Logger logger = LogsCenter.getLogger(AliasCommand.class);

private final boolean isShowType;
private final Alias alias;

Expand Down Expand Up @@ -60,6 +64,7 @@ public AliasCommand(boolean isShowType, Alias alias) {

@Override
public CommandResult execute(Model model) {
logger.info("Executing Alias Command...");
if (this.isShowType) {
return new CommandResult(String.format(MESSAGE_SUCCESS_SHOW,
model.getUserPrefs().getUserAliases().stream()
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/seedu/address/logic/commands/ClearCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

import static java.util.Objects.requireNonNull;

import java.util.logging.Logger;

import seedu.address.commons.core.LogsCenter;
import seedu.address.model.Model;
import seedu.address.model.StudyTracker;

Expand All @@ -16,8 +19,11 @@ public class ClearCommand extends Command {
+ "Example: " + COMMAND_WORD;
public static final String MESSAGE_SUCCESS = "StudyTracker has been cleared!";

private static final Logger logger = LogsCenter.getLogger(ClearCommand.class);

@Override
public CommandResult execute(Model model) {
logger.info("Executing Clear Command...");
requireNonNull(model);
model.setStudyTracker(new StudyTracker());
return new CommandResult(MESSAGE_SUCCESS);
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/seedu/address/logic/commands/DeleteCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
import static seedu.address.commons.core.Messages.MESSAGE_INVALID_NAME;
import static seedu.address.logic.parser.CliSyntax.PREFIX_DELETE_SPOT;

import java.util.logging.Logger;

import seedu.address.commons.core.LogsCenter;
import seedu.address.logic.commands.exceptions.CommandException;
import seedu.address.model.Model;
import seedu.address.model.studyspot.Name;
Expand All @@ -22,6 +25,8 @@ public class DeleteCommand extends Command {

public static final String MESSAGE_DELETE_STUDYSPOT_SUCCESS = "Deleted study spot: %1$s";

private static final Logger logger = LogsCenter.getLogger(DeleteCommand.class);

private Name name;

public DeleteCommand(Name name) {
Expand All @@ -30,6 +35,7 @@ public DeleteCommand(Name name) {

@Override
public CommandResult execute(Model model) throws CommandException {
logger.info("Executing Delete Command...");
requireNonNull(model);
StudySpot studySpotToDelete = model.findStudySpot(name);
if (studySpotToDelete == null) {
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/seedu/address/logic/commands/EditCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
import java.util.HashSet;
import java.util.Optional;
import java.util.Set;
import java.util.logging.Logger;

import seedu.address.commons.core.LogsCenter;
import seedu.address.commons.util.CollectionUtil;
import seedu.address.logic.commands.exceptions.CommandException;
import seedu.address.model.Model;
Expand Down Expand Up @@ -68,6 +70,8 @@ public class EditCommand extends Command {
public static final String FIELD_TAG = "tag";
public static final String FIELD_AMENITY = "amenity";

private static final Logger logger = LogsCenter.getLogger(EditCommand.class);

private final Name name;
private final EditStudySpotDescriptor editStudySpotDescriptor;

Expand All @@ -85,6 +89,7 @@ public EditCommand(Name name, EditStudySpotDescriptor editStudySpotDescriptor) {

@Override
public CommandResult execute(Model model) throws CommandException {
logger.info("Executing Edit Command...");
requireNonNull(model);

StudySpot studySpotToEdit = model.findStudySpot(name);
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/seedu/address/logic/commands/ExitCommand.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
package seedu.address.logic.commands;

import java.util.logging.Logger;

import seedu.address.commons.core.LogsCenter;
import seedu.address.model.Model;

/**
Expand All @@ -14,8 +17,11 @@ public class ExitCommand extends Command {

public static final String MESSAGE_EXIT_ACKNOWLEDGEMENT = "Exiting StudyTracker as requested ...";

private static final Logger logger = LogsCenter.getLogger(ExitCommand.class);

@Override
public CommandResult execute(Model model) {
logger.info("Executing Exit Command...");
return new CommandResult(MESSAGE_EXIT_ACKNOWLEDGEMENT, false, false, true);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
import static seedu.address.commons.core.Messages.MESSAGE_INVALID_NAME;
import static seedu.address.logic.parser.CliSyntax.PREFIX_NAME;

import java.util.logging.Logger;

import seedu.address.commons.core.LogsCenter;
import seedu.address.logic.commands.exceptions.CommandException;
import seedu.address.model.Model;
import seedu.address.model.studyspot.Name;
Expand All @@ -25,6 +28,8 @@ public class FavouriteCommand extends Command {
public static final String MESSAGE_FAVOURITE_REPEATSTUDYSPOT_FAIL =
"Study spot provided is already a favourite: %1$s";

private static final Logger logger = LogsCenter.getLogger(FavouriteCommand.class);

private final Name name;

public FavouriteCommand(Name name) {
Expand All @@ -33,6 +38,7 @@ public FavouriteCommand(Name name) {

@Override
public CommandResult execute(Model model) throws CommandException {
logger.info("Executing Favourite Command...");
requireNonNull(model);

StudySpot studySpotToFavourite = model.findStudySpot(name);
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/seedu/address/logic/commands/FindCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

import static java.util.Objects.requireNonNull;

import java.util.logging.Logger;

import seedu.address.commons.core.LogsCenter;
import seedu.address.commons.core.Messages;
import seedu.address.model.Model;
import seedu.address.model.studyspot.NameContainsKeywordsPredicate;
Expand All @@ -19,6 +22,8 @@ public class FindCommand extends Command {
+ "Parameters: KEYWORD [MORE_KEYWORDS]...\n"
+ "Example: " + COMMAND_WORD + " com2 library biz ";

private static final Logger logger = LogsCenter.getLogger(AddCommand.class);

private final NameContainsKeywordsPredicate predicate;

public FindCommand(NameContainsKeywordsPredicate predicate) {
Expand All @@ -27,6 +32,7 @@ public FindCommand(NameContainsKeywordsPredicate predicate) {

@Override
public CommandResult execute(Model model) {
logger.info("Executing Find Command...");
requireNonNull(model);
model.updateFilteredStudySpotList(predicate);
return new CommandResult(
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/seedu/address/logic/commands/HelpCommand.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
package seedu.address.logic.commands;

import java.util.logging.Logger;

import seedu.address.commons.core.LogsCenter;
import seedu.address.model.Model;

/**
Expand All @@ -15,8 +18,11 @@ public class HelpCommand extends Command {

public static final String SHOWING_HELP_MESSAGE = "Opened help window.";

private static final Logger logger = LogsCenter.getLogger(HelpCommand.class);

@Override
public CommandResult execute(Model model) {
logger.info("Executing Help Command...");
return new CommandResult(SHOWING_HELP_MESSAGE, false, true, false);
}

Expand Down
5 changes: 5 additions & 0 deletions src/main/java/seedu/address/logic/commands/ListCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@
import java.util.Optional;
import java.util.Set;
import java.util.function.Predicate;
import java.util.logging.Logger;
import java.util.stream.Collectors;

import seedu.address.commons.core.LogsCenter;
import seedu.address.model.Model;
import seedu.address.model.amenity.Amenity;
import seedu.address.model.studyspot.Rating;
Expand Down Expand Up @@ -45,6 +47,8 @@ public class ListCommand extends Command {
public static final String MESSAGE_MISSING_RATING = "Please enter a rating. e.g. r/5";
public static final String MESSAGE_UNKNOWN_FLAGS = "Unknown flags given. Valid flags: -f -t -m -r";

private static final Logger logger = LogsCenter.getLogger(ListCommand.class);

private final Predicate<StudySpot> predicate;
private final boolean isFavFlagPresent;
private final Set<Tag> tags;
Expand All @@ -68,6 +72,7 @@ public ListCommand(Predicate<StudySpot> predicate, boolean isFavFlagPresent, Set

@Override
public CommandResult execute(Model model) {
logger.info("Executing List Command...");
requireNonNull(model);
model.updateFilteredStudySpotList(predicate);
StringBuilder sb = new StringBuilder();
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/seedu/address/logic/commands/LogCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
import static seedu.address.logic.parser.CliSyntax.PREFIX_NAME;

import java.util.Set;
import java.util.logging.Logger;

import seedu.address.commons.core.LogsCenter;
import seedu.address.commons.exceptions.IllegalValueException;
import seedu.address.logic.commands.exceptions.CommandException;
import seedu.address.model.Model;
Expand Down Expand Up @@ -46,6 +48,7 @@ public class LogCommand extends Command {
public static final String FLAG_RESET_ALL = "ra";
public static final String FLAG_OVERRIDE = "o";

private static final Logger logger = LogsCenter.getLogger(LogCommand.class);

private final Name name;
private final StudiedHours studiedHours;
Expand All @@ -72,6 +75,7 @@ public LogCommand(Name name, StudiedHours studiedHours, boolean isResetStudySpot

@Override
public CommandResult execute(Model model) throws CommandException {
logger.info("Executing Log Command...");
requireNonNull(model);

if (isResetAll) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
import static java.util.Objects.requireNonNull;
import static seedu.address.logic.parser.CliSyntax.PREFIX_ALIAS;

import java.util.logging.Logger;

import seedu.address.commons.core.LogsCenter;
import seedu.address.logic.commands.exceptions.CommandException;
import seedu.address.model.Model;
import seedu.address.model.alias.Alias;
Expand All @@ -23,6 +26,8 @@ public class UnaliasCommand extends Command {
public static final String MESSAGE_SUCCESS_UNALIAS = "Removed alias '%1$s'";
public static final String MESSAGE_NOT_FOUND = "Alias '%1$s' was not found in list of aliases.";

private static final Logger logger = LogsCenter.getLogger(UnaliasCommand.class);

private final Alias alias;

/**
Expand All @@ -36,6 +41,7 @@ public UnaliasCommand(Alias alias) {

@Override
public CommandResult execute(Model model) throws CommandException {
logger.info("Executing Unalias Command...");
if (!model.hasAlias(alias)) {
throw new CommandException(String.format(MESSAGE_NOT_FOUND, alias.userAlias));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
import static seedu.address.commons.core.Messages.MESSAGE_INVALID_NAME;
import static seedu.address.logic.parser.CliSyntax.PREFIX_NAME;

import java.util.logging.Logger;

import seedu.address.commons.core.LogsCenter;
import seedu.address.logic.commands.exceptions.CommandException;
import seedu.address.model.Model;
import seedu.address.model.studyspot.Name;
Expand All @@ -25,6 +28,8 @@ public class UnfavouriteCommand extends Command {
public static final String MESSAGE_UNFAVOURITE_REPEATSTUDYSPOT_FAIL =
"Study spot provided is not a favourite: %1$s";

private static final Logger logger = LogsCenter.getLogger(UnfavouriteCommand.class);

private final Name name;

public UnfavouriteCommand(Name name) {
Expand All @@ -33,6 +38,7 @@ public UnfavouriteCommand(Name name) {

@Override
public CommandResult execute(Model model) throws CommandException {
logger.info("Executing Unfavourite Command...");
requireNonNull(model);

StudySpot studySpotToUnfavourite = model.findStudySpot(name);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ public ListCommand parse(String args) throws ParseException {
ArgumentMultimap argMultimap = ArgumentTokenizer.tokenize(args, PREFIX_FLAG, PREFIX_TAG, PREFIX_AMENITY,
PREFIX_RATING);
Predicate<StudySpot> predicate = ParserUtil.parseFlags(argMultimap);

List<String> flagsList = argMultimap.getAllValues(PREFIX_FLAG);

boolean isFavFlagPresent = ParserUtil.isFlagPresent(flagsList, ListCommand.FLAG_FAVOURITES);
Expand All @@ -44,18 +43,14 @@ public ListCommand parse(String args) throws ParseException {
Set<Amenity> amenityList = isAmenityFlagPresent
? ParserUtil.parseAmenities(argMultimap.getAllValues(PREFIX_AMENITY))
: null;

Rating rating = isRatingFlagPresent
? ParserUtil.parseRating(argMultimap.getValue(PREFIX_RATING).get()) : null;
Rating rating = isRatingFlagPresent ? ParserUtil.parseRating(argMultimap.getValue(PREFIX_RATING).get()) : null;

if (isTagFlagPresent && tagList.isEmpty()) {
throw new ParseException(ListCommand.MESSAGE_MISSING_TAGS);
}

if (isAmenityFlagPresent && amenityList.isEmpty()) {
throw new ParseException(ListCommand.MESSAGE_MISSING_AMENITIES);
}

for (String flag : flagsList) {
if (!ListCommand.FLAG_LIST.contains(flag)) {
throw new ParseException(ListCommand.MESSAGE_UNKNOWN_FLAGS);
Expand Down
Loading

0 comments on commit 9b95f39

Please sign in to comment.