external-repos/forge
1
0
Fork 0
mirror of https://github.com/Card-Forge/forge.git synced 2025-11-19 12:18:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Heavy refactoring of DeckRecognizer to introduce cardList parsing, allowed sections, and revised TokenTypes

Browse Source 
This commit includes a substantial change//integration into main body of DeckRecognizer API.
First off, the types of tokens emitted by recognised as now increased, leaving place to newly specialised WARNING messages, as well as tokens for cards in invalid set or sections. Moreover, a new token for UNSUPPORTED_DECK_SECTION has been introduced, which works in pair with the new extra addition of allowed Deck sections.
This new list of allowed sections is also used whenever a new DeckSection token is created (constructor) so that if the section is not currently supported, an UNSUPPORTED_DECK_SECTION token is emitted instead.

Similarly, the card recognition step has been updated so that now deck validation mechanism has been integrated at the token level. In other words, everytime each card token is now matched to the most correct section, regardless of what's been specified in card list.

Last but not least, DeckRecognizer now includes the method to parse the whole card list (and not just a single line) to better encapsulate all the logics.
Added control to include Banned and Restricted cards, as well as a newly regExp to specify Mana colour tokens using MANA symbols placeholders (e.g. {G} for green).

Tests for new features have been added and internal documentation improved, and old ones updated with new tokens and APIs.

Signed-off-by: leriomaggio <valeriomaggio@gmail.com>
This commit is contained in:
leriomaggio
2021-10-06 17:07:29 +01:00
parent 65001478b7
commit c5ac93a12e
1 changed files with 210 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

210
forge-gui-desktop/src/test/java/forge/deck/DeckRecognizerTest.java
View File

@@ -2208,6 +2208,10 @@ public class DeckRecognizerTest extends ForgeCardMockTestCase {
assertEquals(cardToken.getTokenSection(), DeckSection.Sideboard);
}
/*=================================
* TEST BANNED
* ================================ */
/*===============
* TEST TOKEN-KEY
* ============== */
@@ -2542,4 +2546,210 @@ public class DeckRecognizerTest extends ForgeCardMockTestCase {
assertEquals(token.getType(), TokenType.COMMENT);
assertEquals(token.getText(), "### General line as comment");
}
// === Parsing Card List ===
@Test void testParsingCardListNoConstraint(){
String[] cardList = new String[]{
"//Sideboard", // decksection
"2x Counterspell FEM", // unknonw card
"4x Incinerate|ICE", // known card to side
"Gibberish to ignore", // ignored
"#Comment to report" // comment token
};
DeckRecognizer recognizer = new DeckRecognizer();
List<Token> tokens = recognizer.parseCardList(cardList);
assertNotNull(tokens);
assertEquals(tokens.size(), 5);
Token deckSectionToken = tokens.get(0);
assertEquals(deckSectionToken.getType(), TokenType.DECK_SECTION_NAME);
assertNull(deckSectionToken.getTokenSection());
assertEquals(deckSectionToken.getText(), DeckSection.Sideboard.name());
Token unknownCardToken = tokens.get(1);
assertEquals(unknownCardToken.getType(), TokenType.UNKNOWN_CARD);
Token unknownText = tokens.get(3);
assertEquals(unknownText.getType(), TokenType.UNKNOWN_TEXT);
Token cardToken = tokens.get(2);
assertTrue(cardToken.isCardToken());
assertNotNull(cardToken.getCard());
assertEquals(cardToken.getQuantity(), 4);
assertEquals(cardToken.getCard().getName(), "Incinerate");
assertEquals(cardToken.getCard().getEdition(), "ICE");
assertEquals(cardToken.getType(), TokenType.LEGAL_CARD);
// This is because of the previous DeckSection token
assertEquals(cardToken.getTokenSection(), DeckSection.Sideboard);
Token commentToken = tokens.get(4);
assertEquals(commentToken.getType(), TokenType.COMMENT);
}
@Test void testParseCardListWithAllowedSectionsRaisesUnsupportedCardsAndSection(){
String[] cardList = new String[]{
"//Sideboard", // decksection - unsupported section
"All in Good Time", // Schemes - unsupported card
"4x Incinerate|ICE", // known card to main
};
DeckRecognizer recognizer = new DeckRecognizer();
recognizer.setAllowedDeckSections(Arrays.asList(DeckSection.Main, DeckSection.Commander));
List<Token> tokens = recognizer.parseCardList(cardList);
assertNotNull(tokens);
assertEquals(tokens.size(), 4);
Token deckSectionToken = tokens.get(0);
assertFalse(deckSectionToken.isDeckSection());
assertEquals(deckSectionToken.getType(), TokenType.UNSUPPORTED_DECK_SECTION);
assertNull(deckSectionToken.getTokenSection());
Token unsupportedCard = tokens.get(1);
assertEquals(unsupportedCard.getType(), TokenType.UNSUPPORTED_CARD);
deckSectionToken = tokens.get(2);
assertTrue(deckSectionToken.isDeckSection());
assertEquals(deckSectionToken.getText(), DeckSection.Main.name());
Token cardToken = tokens.get(3);
assertTrue(cardToken.isCardToken());
assertNotNull(cardToken.getCard());
assertEquals(cardToken.getQuantity(), 4);
assertEquals(cardToken.getCard().getName(), "Incinerate");
assertEquals(cardToken.getCard().getEdition(), "ICE");
assertEquals(cardToken.getType(), TokenType.LEGAL_CARD);
assertEquals(cardToken.getTokenSection(), DeckSection.Main);
}
@Test void testCardListWithDeckNameHasDeckNameOnTop(){
String[] cardList = new String[]{
"//Sideboard", // decksection
"Name: Test deck", // goes on top
"4x Incinerate|ICE", // known card to side
};
DeckRecognizer recognizer = new DeckRecognizer();
List<Token> tokens = recognizer.parseCardList(cardList);
assertNotNull(tokens);
assertEquals(tokens.size(), 3);
Token deckNameToken = tokens.get(0);
assertEquals(deckNameToken.getType(), TokenType.DECK_NAME);
assertEquals(deckNameToken.getText(), "Test deck");
Token deckSectionToken = tokens.get(1);
assertTrue(deckSectionToken.isDeckSection());
assertEquals(deckSectionToken.getType(), TokenType.DECK_SECTION_NAME);
assertEquals(deckSectionToken.getText(), DeckSection.Sideboard.name());
Token cardToken = tokens.get(2);
assertTrue(cardToken.isCardToken());
assertNotNull(cardToken.getCard());
assertEquals(cardToken.getQuantity(), 4);
assertEquals(cardToken.getCard().getName(), "Incinerate");
assertEquals(cardToken.getCard().getEdition(), "ICE");
assertEquals(cardToken.getType(), TokenType.LEGAL_CARD);
assertEquals(cardToken.getTokenSection(), DeckSection.Sideboard);
}
@Test void testCardsInDifferentSectionsWillAddAlsoDeckSectionPlaceholders(){
String[] cardList = new String[]{
"2x Counterspell | TMP", // card legal in Main (+placeholder)
"SB:4x Incinerate|ICE", // card legal in Side (+ placeholder)
"2x Fireball 5ED" // card legal in Side
};
DeckRecognizer recognizer = new DeckRecognizer();
List<Token> tokens = recognizer.parseCardList(cardList);
assertNotNull(tokens);
assertEquals(tokens.size(), 5);
Token deckSectionToken = tokens.get(0);
assertEquals(deckSectionToken.getType(), TokenType.DECK_SECTION_NAME);
assertTrue(deckSectionToken.isDeckSection());
assertEquals(deckSectionToken.getText(), DeckSection.Main.name());
Token cardToken = tokens.get(1);
assertTrue(cardToken.isCardToken());
assertNotNull(cardToken.getCard());
assertEquals(cardToken.getQuantity(), 2);
assertEquals(cardToken.getCard().getName(), "Counterspell");
assertEquals(cardToken.getCard().getEdition(), "TMP");
assertEquals(cardToken.getType(), TokenType.LEGAL_CARD);
assertEquals(cardToken.getTokenSection(), DeckSection.Main);
deckSectionToken = tokens.get(2);
assertEquals(deckSectionToken.getType(), TokenType.DECK_SECTION_NAME);
assertTrue(deckSectionToken.isDeckSection());
assertEquals(deckSectionToken.getText(), DeckSection.Sideboard.name());
cardToken = tokens.get(3);
assertTrue(cardToken.isCardToken());
assertNotNull(cardToken.getCard());
assertEquals(cardToken.getQuantity(), 4);
assertEquals(cardToken.getCard().getName(), "Incinerate");
assertEquals(cardToken.getCard().getEdition(), "ICE");
assertEquals(cardToken.getType(), TokenType.LEGAL_CARD);
assertEquals(cardToken.getTokenSection(), DeckSection.Sideboard);
cardToken = tokens.get(4);
assertTrue(cardToken.isCardToken());
assertNotNull(cardToken.getCard());
assertEquals(cardToken.getQuantity(), 2);
assertEquals(cardToken.getCard().getName(), "Fireball");
assertEquals(cardToken.getCard().getEdition(), "5ED");
assertEquals(cardToken.getType(), TokenType.LEGAL_CARD);
assertEquals(cardToken.getTokenSection(), DeckSection.Sideboard);
}
@Test void testDeckSectionValidationForTokensAddPlaceholderAndRestoresMainSection(){
String[] cardList = new String[]{
"2x Counterspell | TMP", // card legal in Main (+placeholder)
"All in Good Time", // card legal in Schemes (+ placeholder)
"2x Fireball 5ED" // card legal in Main (+ placeholder as section changes again)
};
DeckRecognizer recognizer = new DeckRecognizer();
List<Token> tokens = recognizer.parseCardList(cardList);
assertNotNull(tokens);
assertEquals(tokens.size(), 6);
Token deckSectionToken = tokens.get(0);
assertEquals(deckSectionToken.getType(), TokenType.DECK_SECTION_NAME);
assertTrue(deckSectionToken.isDeckSection());
assertEquals(deckSectionToken.getText(), DeckSection.Main.name());
Token cardToken = tokens.get(1);
assertTrue(cardToken.isCardToken());
assertNotNull(cardToken.getCard());
assertEquals(cardToken.getQuantity(), 2);
assertEquals(cardToken.getCard().getName(), "Counterspell");
assertEquals(cardToken.getCard().getEdition(), "TMP");
assertEquals(cardToken.getType(), TokenType.LEGAL_CARD);
assertEquals(cardToken.getTokenSection(), DeckSection.Main);
deckSectionToken = tokens.get(2);
assertEquals(deckSectionToken.getType(), TokenType.DECK_SECTION_NAME);
assertTrue(deckSectionToken.isDeckSection());
assertEquals(deckSectionToken.getText(), DeckSection.Schemes.name());
cardToken = tokens.get(3);
assertTrue(cardToken.isCardToken());
assertNotNull(cardToken.getCard());
assertEquals(cardToken.getQuantity(), 1);
assertEquals(cardToken.getCard().getName(), "All in Good Time");
assertEquals(cardToken.getType(), TokenType.LEGAL_CARD);
assertEquals(cardToken.getTokenSection(), DeckSection.Schemes);
deckSectionToken = tokens.get(4);
assertEquals(deckSectionToken.getType(), TokenType.DECK_SECTION_NAME);
assertTrue(deckSectionToken.isDeckSection());
assertEquals(deckSectionToken.getText(), DeckSection.Main.name());
cardToken = tokens.get(5);
assertTrue(cardToken.isCardToken());
assertNotNull(cardToken.getCard());
assertEquals(cardToken.getQuantity(), 2);
assertEquals(cardToken.getCard().getName(), "Fireball");
assertEquals(cardToken.getCard().getEdition(), "5ED");
assertEquals(cardToken.getType(), TokenType.LEGAL_CARD);
assertEquals(cardToken.getTokenSection(), DeckSection.Main);
}
}