Skip to content

Add question part status to AssignmentProgressDTO #697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: redesign-2024
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions src/main/java/uk/ac/cam/cl/dtg/isaac/api/AssignmentFacade.java
Original file line number Diff line number Diff line change
Expand Up @@ -405,25 +405,29 @@ public Response getAssignmentProgress(@Context final HttpServletRequest request,

// can the user access the data?
if (userSummary.isAuthorisedFullAccess()) {
ArrayList<GameboardItemState> states = Lists.newArrayList();
ArrayList<CompletionState> questionStates = Lists.newArrayList();
ArrayList<List<QuestionPartState>> questionPartStates = Lists.newArrayList();
ArrayList<Integer> correctQuestionParts = Lists.newArrayList();
ArrayList<Integer> incorrectQuestionParts = Lists.newArrayList();
for (GameboardItem questionResult : userGameboardItems.getRight()) {
states.add(questionResult.getState());
questionStates.add(questionResult.getState());
questionPartStates.add(questionResult.getQuestionPartStates());
correctQuestionParts.add(questionResult.getQuestionPartsCorrect());
incorrectQuestionParts.add(questionResult.getQuestionPartsIncorrect());
}
result.add(new AssignmentProgressDTO(
userSummary,
correctQuestionParts,
incorrectQuestionParts,
states
questionStates,
questionPartStates
));
} else {
result.add(new AssignmentProgressDTO(
userSummary,
Collections.emptyList(),
Collections.emptyList(),
Collections.emptyList(),
Collections.emptyList()
));
}
Expand Down Expand Up @@ -1176,4 +1180,4 @@ public Response deleteAssignment(@Context final HttpServletRequest request,
return new SegueErrorResponse(Status.INTERNAL_SERVER_ERROR, "Unknown database error.").toResponse();
}
}
}
}
9 changes: 1 addition & 8 deletions src/main/java/uk/ac/cam/cl/dtg/isaac/api/Constants.java
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,8 @@ public final class Constants {
*/
public static final int GAME_BOARD_TARGET_SIZE = 10;

/**
* GameboardItemState Represents the potential states of a gameboard item.
*/
public enum GameboardItemState {
PERFECT, PASSED, IN_PROGRESS, NOT_ATTEMPTED, FAILED;
}

public enum CompletionState {
ALL_CORRECT, IN_PROGRESS, NOT_ATTEMPTED;
ALL_CORRECT, ALL_ATTEMPTED, ALL_INCORRECT, IN_PROGRESS, NOT_ATTEMPTED;

private static final Set<CompletionState> allStates = Set.of(CompletionState.values());

Expand Down
37 changes: 23 additions & 14 deletions src/main/java/uk/ac/cam/cl/dtg/isaac/api/managers/GameManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -818,7 +818,7 @@ private GameboardDTO augmentGameboardWithQuestionAttemptInformation(final Gamebo
continue;
}

if (!gameboardStarted && !gameItem.getState().equals(Constants.GameboardItemState.NOT_ATTEMPTED)) {
if (!gameboardStarted && !gameItem.getState().equals(CompletionState.NOT_ATTEMPTED)) {
gameboardStarted = true;
gameboardDTO.setStartedQuestion(gameboardStarted);
}
Expand Down Expand Up @@ -1009,7 +1009,7 @@ private List<GameboardItem> getSelectedGameboardQuestions(final GameFilter gameF
// choose the gameboard questions to include.
while (gameboardReadyQuestions.size() < GAME_BOARD_TARGET_SIZE && !selectionOfGameboardQuestions.isEmpty()) {
for (GameboardItem gameboardItem : selectionOfGameboardQuestions) {
GameboardItemState questionState;
CompletionState questionState;
try {
this.augmentGameItemWithAttemptInformation(gameboardItem, usersQuestionAttempts);
questionState = gameboardItem.getState();
Expand All @@ -1019,8 +1019,8 @@ private List<GameboardItem> getSelectedGameboardQuestions(final GameFilter gameF
+ "should only show available content.");
}

if (questionState.equals(GameboardItemState.PASSED)
|| questionState.equals(GameboardItemState.PERFECT)) {
if (questionState.equals(CompletionState.ALL_ATTEMPTED)
|| questionState.equals(CompletionState.ALL_CORRECT)) {
completedQuestions.add(gameboardItem);
} else {
gameboardReadyQuestions.add(gameboardItem);
Expand Down Expand Up @@ -1192,21 +1192,30 @@ private void augmentGameItemWithAttemptInformation(
gameItem.setQuestionPartStates(questionPartStates);
int questionPartsTotal = questionPartsCorrect + questionPartsIncorrect + questionPartsNotAttempted;
gameItem.setQuestionPartsTotal(questionPartsTotal);
float percentCorrect = 100f * questionPartsCorrect / questionPartsTotal;
float percentIncorrect = 100f * questionPartsIncorrect / questionPartsTotal;
// float percentCorrect = 100f * questionPartsCorrect / questionPartsTotal;
// float percentIncorrect = 100f * questionPartsIncorrect / questionPartsTotal;

GameboardItemState state;
CompletionState state;
if (questionPartsCorrect == questionPartsTotal) {
state = GameboardItemState.PERFECT;
state = CompletionState.ALL_CORRECT;
} else if (questionPartsIncorrect == questionPartsTotal) {
state = CompletionState.ALL_INCORRECT;
} else if (questionPartsNotAttempted == questionPartsTotal) {
state = GameboardItemState.NOT_ATTEMPTED;
} else if (percentCorrect >= gameItem.getPassMark()) {
state = GameboardItemState.PASSED;
} else if (percentIncorrect > (100 - gameItem.getPassMark())) {
state = GameboardItemState.FAILED;
state = CompletionState.NOT_ATTEMPTED;
} else if (questionPartsNotAttempted > 0) {
state = CompletionState.IN_PROGRESS;
} else {
state = GameboardItemState.IN_PROGRESS;
state = CompletionState.ALL_ATTEMPTED;
}


// } else if (percentCorrect >= gameItem.getPassMark()) {
// state = GameboardItemState.PASSED;
// } else if (percentIncorrect > (100 - gameItem.getPassMark())) {
// state = GameboardItemState.FAILED;
// } else {
// state = GameboardItemState.IN_PROGRESS;
// }
gameItem.setState(state);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,34 +71,42 @@ private void augmentContentSummaryWithAttemptInformation(
String questionId = contentSummary.getId();
Map<String, ? extends List<? extends LightweightQuestionValidationResponse>> questionAttempts = usersQuestionAttempts.get(questionId);
boolean questionAnsweredCorrectly = false;
boolean attempted = false;
int questionPartsCorrect = 0;
int questionPartsIncorrect = 0;
int questionPartsTotal = contentSummary.getQuestionPartIds().size();
if (questionAttempts != null) {
for (String relatedQuestionPartId : contentSummary.getQuestionPartIds()) {
questionAnsweredCorrectly = false;
List<? extends LightweightQuestionValidationResponse> questionPartAttempts = questionAttempts.get(relatedQuestionPartId);
if (questionPartAttempts != null) {
attempted = true;
for (LightweightQuestionValidationResponse partAttempt : questionPartAttempts) {
questionAnsweredCorrectly = partAttempt.isCorrect();
if (questionAnsweredCorrectly) {
questionPartsCorrect++;
break; // exit on first correct attempt
}
}
}
if (!questionAnsweredCorrectly) {
break; // exit on first false question part
if (!questionAnsweredCorrectly) {
questionPartsIncorrect++;
}
}
}
}
if (attempted) {
if (questionAnsweredCorrectly) {
contentSummary.setState(Constants.CompletionState.ALL_CORRECT);
} else {
contentSummary.setState(Constants.CompletionState.IN_PROGRESS);
}
int questionPartsNotAttempted = questionPartsTotal - (questionPartsCorrect + questionPartsIncorrect);

// TODO: move to common function with GameManagerL1198
CompletionState state;
if (questionPartsCorrect == questionPartsTotal) {
state = CompletionState.ALL_CORRECT;
} else if (questionPartsIncorrect == questionPartsTotal) {
state = CompletionState.ALL_INCORRECT;
} else if (questionPartsNotAttempted == questionPartsTotal) {
state = CompletionState.NOT_ATTEMPTED;
} else if (questionPartsNotAttempted > 0) {
state = CompletionState.IN_PROGRESS;
} else {
contentSummary.setState(Constants.CompletionState.NOT_ATTEMPTED);
state = CompletionState.ALL_ATTEMPTED;
}
contentSummary.setState(state);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ public class AssignmentProgressDTO {
public UserSummaryDTO user;
public List<Integer> correctPartResults;
public List<Integer> incorrectPartResults;
public List<Constants.GameboardItemState> results;
public List<Constants.CompletionState> questionResults;
public List<List<Constants.QuestionPartState>> questionPartResults;

/**
* Complete AssignmentProgressDTO constructor with all dependencies.
Expand All @@ -25,11 +26,12 @@ public class AssignmentProgressDTO {
* @param results
* - Array of results.
*/
public AssignmentProgressDTO(UserSummaryDTO user, List<Integer> correctPartResults, List<Integer> incorrectPartResults, List<Constants.GameboardItemState> results) {
public AssignmentProgressDTO(UserSummaryDTO user, List<Integer> correctPartResults, List<Integer> incorrectPartResults, List<Constants.CompletionState> results, List<List<Constants.QuestionPartState>> partResults) {
this.user = user;
this.correctPartResults = correctPartResults;
this.incorrectPartResults = incorrectPartResults;
this.results = results;
this.questionResults = results;
this.questionPartResults = partResults;
}

public AssignmentProgressDTO() {
Expand Down Expand Up @@ -59,11 +61,20 @@ public void setIncorrectPartResults(List<Integer> incorrectPartResults) {
this.incorrectPartResults = incorrectPartResults;
}

public List<Constants.GameboardItemState> getResults() {
return results;
public List<Constants.CompletionState> getQuestionResults() {
return questionResults;
}

public void setResults(List<Constants.GameboardItemState> results) {
this.results = results;
public void setQuestionResults(List<Constants.CompletionState> questionResults) {
this.questionResults = questionResults;
}


public List<List<Constants.QuestionPartState>> getQuestionPartResults() {
return questionPartResults;
}

public void setQuestionPartResults(List<List<Constants.QuestionPartState>> questionPartResults) {
this.questionPartResults = questionPartResults;
}
}
7 changes: 3 additions & 4 deletions src/main/java/uk/ac/cam/cl/dtg/isaac/dto/GameboardItem.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

import com.google.common.collect.Lists;
import uk.ac.cam.cl.dtg.isaac.api.Constants;
import uk.ac.cam.cl.dtg.isaac.api.Constants.GameboardItemState;
import uk.ac.cam.cl.dtg.isaac.dos.AudienceContext;
import uk.ac.cam.cl.dtg.isaac.dos.GameboardContentDescriptor;

Expand Down Expand Up @@ -46,7 +45,7 @@ public class GameboardItem {
private Integer questionPartsNotAttempted;
private Integer questionPartsTotal;
private Float passMark;
private GameboardItemState state;
private Constants.CompletionState state;
private List<Constants.QuestionPartState> questionPartStates = Lists.newArrayList();

// optional field if we want to use the gameboard item outside the context of a board.
Expand Down Expand Up @@ -346,7 +345,7 @@ public final void setPassMark(final Float passMark) {
*
* @return the state
*/
public final GameboardItemState getState() {
public final Constants.CompletionState getState() {
return state;
}

Expand All @@ -356,7 +355,7 @@ public final GameboardItemState getState() {
* @param state
* the state to set
*/
public final void setState(final GameboardItemState state) {
public final void setState(final Constants.CompletionState state) {
this.state = state;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -703,8 +703,8 @@ public List<UserGameboardProgressSummaryDTO> getGroupProgressSummary(List<Regist
questionPartsNotAttempted += gameboardItem.getQuestionPartsNotAttempted();
questionPartsTotal += gameboardItem.getQuestionPartsTotal();
passMark += gameboardItem.getPassMark();
Constants.GameboardItemState state = gameboardItem.getState();
if (state == Constants.GameboardItemState.PERFECT) {
Constants.CompletionState state = gameboardItem.getState();
if (state == Constants.CompletionState.ALL_CORRECT) {
questionPagesPerfect += 1;
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
import uk.ac.cam.cl.dtg.isaac.dto.AssignmentStatusDTO;
import uk.ac.cam.cl.dtg.isaac.dto.SegueErrorResponse;
import uk.ac.cam.cl.dtg.isaac.dto.UserGroupDTO;
import uk.ac.cam.cl.dtg.isaac.dto.users.UserSummaryDTO;
import uk.ac.cam.cl.dtg.segue.dao.SegueDatabaseException;

import jakarta.servlet.http.Cookie;
Expand All @@ -45,7 +44,6 @@
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collections;
import java.util.Map;

import static org.easymock.EasyMock.replay;
import static org.junit.jupiter.api.Assertions.assertEquals;
Expand Down Expand Up @@ -506,7 +504,7 @@ public void getAssignmentProgressEndpoint_getProgressAsGroupOwner_succeeds() thr
// check the progress response contains the right fields
AssignmentProgressDTO progressDTO = responseData.get(0);
Assertions.assertNotNull(progressDTO.getUser());
Assertions.assertNotNull(progressDTO.getResults());
Assertions.assertNotNull(progressDTO.getQuestionResults());
Assertions.assertNotNull(progressDTO.getCorrectPartResults());
Assertions.assertNotNull(progressDTO.getIncorrectPartResults());
}
Expand Down Expand Up @@ -540,7 +538,7 @@ public void getAssignmentProgressEndpoint_getProgressAsAdditionalManager_succeed
// check the progress response contains the right fields
AssignmentProgressDTO progressDTO = responseData.get(0);
Assertions.assertNotNull(progressDTO.getUser());
Assertions.assertNotNull(progressDTO.getResults());
Assertions.assertNotNull(progressDTO.getQuestionResults());
Assertions.assertNotNull(progressDTO.getCorrectPartResults());
Assertions.assertNotNull(progressDTO.getIncorrectPartResults());
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ public void revokeOwnerAssociation_studentRevokesTeacherConnection_studentNotInM
UserSummaryDTO userSummary = studentResults.getUser();
assert userSummary != null;
if (userSummary.getId() == ALICE_STUDENT_ID) {
List<Constants.GameboardItemState> results = studentResults.getResults();
List<Constants.CompletionState> results = studentResults.getQuestionResults();
assertTrue(results != null && results.isEmpty());
break;
}
Expand Down
Loading