rummy 0.2.0

a crate for the card game Rummy
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

#[cfg(test)]
mod tests {
    use crate::cards::deck::DeckConfig;
    use crate::cards::{
        card::Card,
        suit_rank::{Rank, Suit},
    };
    use std::sync::Arc;

    #[test]
    /// Cards have the expected ordering.
    fn normal_ordering_card() {
        let cfg = Arc::new(DeckConfig::new());

        // cards are ordered by rank, then suit
        let card1 = Card {
            rank: Rank::Ace,
            suit: Suit::Clubs,
            deck_config: cfg.clone(),
        };
        let card2 = Card {
            rank: Rank::Ace,
            suit: Suit::Diamonds,
            deck_config: cfg.clone(),
        };
        let card3 = Card {
            rank: Rank::Two,
            suit: Suit::Clubs,
            deck_config: cfg.clone(),
        };

        assert!(card2 > card1);
        assert!(card3 > card2);
    }

    #[test]
    /// If the deck config specifies a custom high rank,
    /// ordering will decrease from that rank onwards.
    ///
    /// For eg, `high_rank = 3` means `3 > 2 > Ace > King > Queen > ...`
    fn custom_ordering_card() {
        let cfg = Arc::new(DeckConfig {
            shuffle_seed: None,
            pack_count: 1,
            high_rank: Some(Rank::Three),
            wildcard_rank: None,
        });

        // Rank::Three should be the highest now
        let card1 = Card {
            rank: Rank::King,
            suit: Suit::Spades,
            deck_config: cfg.clone(),
        };
        let card2 = Card {
            rank: Rank::Two,
            suit: Suit::Spades,
            deck_config: cfg.clone(),
        };
        let card3 = Card {
            rank: Rank::Three,
            suit: Suit::Clubs,
            deck_config: cfg.clone(),
        };

        assert!(card2 > card1);
        assert!(card3 > card2);

        // Suit ordering should remain the same
        let card4 = Card {
            rank: Rank::Three,
            suit: Suit::Spades,
            deck_config: cfg.clone(),
        };
        assert!(card4 > card1);
    }
}