Feature/refactor can modify vote to validator service #334
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| package org.rulez.demokracia.pdengine.choice; | ||
|
|
||
| import org.rulez.demokracia.pdengine.dataobjects.VoteAdminInfo; | ||
| import org.rulez.demokracia.pdengine.vote.Vote; | ||
| import org.springframework.stereotype.Service; | ||
|
|
||
| @Service | ||
| public interface ChoiceModificationValidatorService { | ||
|
|
||
| void validateModification( | ||
| VoteAdminInfo voteAdminInfo, Vote vote, Choice choice | ||
| ); | ||
|
|
||
| void validateDeletion(VoteAdminInfo voteAdminInfo, Vote vote, Choice choice); | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| package org.rulez.demokracia.pdengine.choice; | ||
|
|
||
| import org.rulez.demokracia.pdengine.authentication.AuthenticatedUserService; | ||
| import org.rulez.demokracia.pdengine.dataobjects.VoteAdminInfo; | ||
| import org.rulez.demokracia.pdengine.exception.ReportedException; | ||
| import org.rulez.demokracia.pdengine.vote.Vote; | ||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.stereotype.Service; | ||
|
|
||
| @Service | ||
| public class ChoiceModificationValidatorServiceImpl | ||
| implements ChoiceModificationValidatorService { | ||
|
|
||
| private static final String MODIFICATION = "modification"; | ||
| private static final String DELETION = "deletion"; | ||
| private static final String CAN_ADDIN_IS_FALSE_MESSAGE = | ||
| "Choice %s disallowed: adminKey is user, but canAddin is false"; | ||
| private static final String DIFFERENT_USER_MESSAGE = | ||
| "Choice %s disallowed: adminKey is user, and the choice was added by a different user"; | ||
| @Autowired | ||
| private AuthenticatedUserService authenticationService; | ||
|
|
||
| @Override | ||
| public void validateModification( | ||
| final VoteAdminInfo voteAdminInfo, final Vote vote, final Choice choice | ||
| ) { | ||
| validate(voteAdminInfo, vote, choice, MODIFICATION); | ||
| } | ||
|
|
||
| @Override | ||
| public void validateDeletion( | ||
| final VoteAdminInfo voteAdminInfo, final Vote vote, final Choice choice | ||
| ) { | ||
| validate(voteAdminInfo, vote, choice, DELETION); | ||
| } | ||
|
|
||
| private void validate( | ||
| final VoteAdminInfo voteAdminInfo, | ||
| final Vote vote, | ||
| final Choice choice, | ||
| final String operation | ||
| ) { | ||
| if (voteAdminInfo.isUserAdminKey()) { | ||
| validateAddinability(vote, operation); | ||
| validateMatchingUser(choice, operation); | ||
| } | ||
| } | ||
|
|
||
| private void | ||
| validateMatchingUser(final Choice choice, final String operation) { | ||
| if (!choice.getUserName().equals(getUserName())) | ||
| throw new ReportedException( | ||
| String.format(DIFFERENT_USER_MESSAGE, operation) | ||
| ); | ||
| } | ||
|
|
||
| private void validateAddinability(final Vote vote, final String operation) { | ||
| if (!vote.getParameters().isAddinable()) | ||
| throw new ReportedException( | ||
| String.format(CAN_ADDIN_IS_FALSE_MESSAGE, operation) | ||
| ); | ||
| } | ||
|
|
||
| private String getUserName() { | ||
| return authenticationService.getAuthenticatedUserName(); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| package org.rulez.demokracia.pdengine.choice; | ||
|
|
||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.mockito.junit.MockitoJUnitRunner; | ||
| import org.rulez.demokracia.pdengine.annotations.TestedBehaviour; | ||
| import org.rulez.demokracia.pdengine.annotations.TestedFeature; | ||
| import org.rulez.demokracia.pdengine.annotations.TestedOperation; | ||
|
|
||
| @TestedFeature("Manage votes") | ||
| @TestedOperation("delete choice") | ||
| @RunWith(MockitoJUnitRunner.class) | ||
| public class ChoiceDeleteValidatorServiceTest extends ChoiceValidatorBaseTest { | ||
|
|
||
| @Test | ||
| @TestedBehaviour( | ||
| "if 'user' is used as adminKey, then the user must be the one who added the choice and canAddIn be true" | ||
| ) | ||
| public void userAdmin_cannot_delete_choice_if_canAddin_is_false() { | ||
| assertFalseCanAddinCauseException( | ||
| () -> underTest.validateDeletion(getUserAdminInfo(), vote, choice) | ||
| ); | ||
| } | ||
|
|
||
| @TestedBehaviour("modifies the string of the choice") | ||
| @Test | ||
| public void proper_voteId_choiceId_and_adminKey_does_modify_choice() { | ||
| assertNotThrows( | ||
| () -> { | ||
| underTest.validateDeletion(getAdminInfo(), vote, choice); | ||
| } | ||
| ); | ||
| } | ||
|
|
||
| @TestedBehaviour( | ||
| "if 'user' is used as adminKey, then the user must be the one who added the choice and canAddIn be true" | ||
| ) | ||
| @Test | ||
| public void | ||
| userAdmin_cannot_modify_choice_if_it_is_not_added_by_other_user() { | ||
| assertDifferentUserCauseException( | ||
| () -> underTest.validateDeletion(getUserAdminInfo(), vote, choice) | ||
| ); | ||
| } | ||
|
|
||
| @TestedBehaviour( | ||
| "if 'user' is used as adminKey, then the user must be the one who added the choice and canAddIn be true" | ||
| ) | ||
| @Test | ||
| public void | ||
| userAdmin_can_modify_the_choice_if_canAddin_is_true_and_he_is_the_choice_creator() { | ||
| assertNoExceptionWithCorrectParameters( | ||
| () -> underTest.validateDeletion(getUserAdminInfo(), vote, choice2) | ||
| ); | ||
| } | ||
|
|
||
| @Override | ||
| protected String getOperation() { | ||
| return "deletion"; | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aren't those strings are constants in the production code?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They are. If you mean, we should use constants of the production code, I suggest to forget it.
Let's imagine the situation, when someone accidentally removes some words from this string or an unlucky regex overwrites it. We wouldn't realize it, since we compare this constant to itself.