rustmind 0.1.1

A CLI game inspired by the Mastermind® game
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279

use rand::{RngExt, seq::SliceRandom};

use crate::{combination_check_result::CombinationCheckResult, messages::Messages};

/// Describe a single game state
pub struct Game {
    /// Whether or not to prevent duplicates in combination
    prevent_duplicates: bool,
    /// The user current try
    current_try: usize,
    /// The maximum allowed tries
    max_tries: usize,
    /// The number of slots to discover
    total_slots: usize,
    /// The number of available colors
    total_colors: usize,
    /// The correct colors combination
    answer_combination: Vec<usize>,
}

impl Game {
    /// Create a new game
    pub fn new_parameterized(
        prevent_duplicates: bool,
        total_slots: usize,
        total_colors: usize,
        max_tries: usize,
        colors_combination: Vec<usize>,
    ) -> Self {
        let game = Self {
            prevent_duplicates: prevent_duplicates,
            current_try: 0,
            max_tries: max_tries,
            total_slots: total_slots,
            total_colors: total_colors,
            answer_combination: colors_combination,
        };

        game
    }

    pub fn generate_random_colors_combination(
        duplicates_prevented: bool,
        total_slots: usize,
        total_colors: usize,
    ) -> Vec<usize> {
        let mut rng = rand::rng();

        if duplicates_prevented {
            assert!(
                total_slots <= total_colors,
                "{}",
                Messages::slots_exceed_colors_without_duplicates()
            );

            let mut colors: Vec<usize> = (0..total_colors).collect();
            colors.shuffle(&mut rng);
            colors.truncate(total_slots);
            colors
        } else {
            (0..total_slots)
                .map(|_| rng.random_range(0..total_colors))
                .collect()
        }
    }

    pub fn prevent_duplicates(&self) -> bool {
        self.prevent_duplicates
    }

    pub fn current_try(&self) -> usize {
        self.current_try
    }

    pub fn max_tries(&self) -> usize {
        self.max_tries
    }

    pub fn total_slots(&self) -> usize {
        self.total_slots
    }

    pub fn total_colors(&self) -> usize {
        self.total_colors
    }

    pub fn colors_combination(&self) -> Vec<usize> {
        self.answer_combination.clone()
    }

    pub fn inc_current_try(&mut self) {
        self.current_try += 1;
    }

    /// Compute the correct/misplaced slots and check for victory
    pub fn check_combination(&self, combination: &Vec<usize>) -> CombinationCheckResult {
        let mut well_placed: usize = 0;
        let mut misplaced_slots: usize = 0;
        let mut exact_matches = vec![false; self.answer_combination.len()];
        let mut misplaced_matches = vec![false; combination.len()];
        if combination.len() > 0 {
            // Search for exact matches
            for i in 0..combination.len() {
                if combination[i] == self.answer_combination[i] {
                    well_placed += 1;
                    exact_matches[i] = true;
                    misplaced_matches[i] = true;
                }
            }

            // Search for misplaced matches
            for i in 0..combination.len() {
                if misplaced_matches[i] {
                    continue;
                }

                for j in 0..self.answer_combination.len() {
                    if !exact_matches[j] && combination[i] == self.answer_combination[j] {
                        misplaced_slots += 1;
                        exact_matches[j] = true;
                        misplaced_matches[i] = true;
                        break;
                    }
                }
            }
        }

        let is_victory = well_placed == self.total_slots;
        let result: CombinationCheckResult = CombinationCheckResult::new_parameterized(
            is_victory,
            !is_victory && self.current_try == self.max_tries,
            well_placed,
            misplaced_slots,
        );
        result
    }
}

#[cfg(test)]
mod tests {

    use super::*;
    use rstest::rstest;

    #[rstest]
    #[case([1,2,3,4], vec![1,0,0,0], 1)]
    #[case([1,2,3,4], vec![0,2,0,0], 1)]
    #[case([1,2,3,4], vec![0,0,3,0], 1)]
    #[case([1,2,3,4], vec![0,0,0,4], 1)]
    #[case([1,2,3,4], vec![1,2,0,0], 2)]
    #[case([1,2,3,4], vec![0,2,3,0], 2)]
    #[case([1,2,3,4], vec![0,0,3,4], 2)]
    #[case([1,2,3,4], vec![1,0,0,4], 2)]
    #[case([1,2,3,4], vec![1,2,3,0], 3)]
    #[case([1,2,3,4], vec![0,2,3,4], 3)]
    #[case([1,2,3,4], vec![1,0,3,4], 3)]
    #[case([1,2,3,4], vec![1,2,3,4], 4)]
    fn test_check_combination_handles_well_placed(
        #[case] combination: [usize; 4],
        #[case] combination_try: Vec<usize>,
        #[case] expected: usize,
    ) {
        // arrange
        let game = Game::new_parameterized(false, 4, 4, 1, combination.to_vec());

        // act
        let result = game.check_combination(&combination_try);

        // assert
        assert_eq!(result.well_placed(), expected);
    }

    #[rstest]
    #[case([1,1,2,2], vec![1,0,0,0], 1)]
    #[case([1,1,2,2], vec![0,1,0,0], 1)]
    #[case([1,1,2,2], vec![1,1,0,0], 2)]
    #[case([1,1,2,2], vec![0,0,2,0], 1)]
    #[case([1,1,2,2], vec![0,0,0,2], 1)]
    #[case([1,1,2,2], vec![0,0,2,2], 2)]
    #[case([1,1,1,2], vec![1,0,0,0], 1)]
    #[case([1,1,1,2], vec![0,1,0,0], 1)]
    #[case([1,1,1,2], vec![0,0,1,0], 1)]
    #[case([1,1,1,2], vec![1,1,1,0], 3)]
    #[case([1,2,2,2], vec![0,0,0,2], 1)]
    #[case([1,2,2,2], vec![0,0,2,2], 2)]
    #[case([1,2,2,2], vec![0,2,2,2], 3)]
    #[case([1,1,1,1], vec![1,1,1,1], 4)]
    fn test_check_combination_handles_well_placed_duplicates(
        #[case] combination: [usize; 4],
        #[case] combination_try: Vec<usize>,
        #[case] expected: usize,
    ) {
        // arrange
        let game = Game::new_parameterized(false, 4, 4, 1, combination.to_vec());

        // act
        let result = game.check_combination(&combination_try);

        // assert
        assert_eq!(result.well_placed(), expected);
    }

    #[rstest]
    #[case([1,2,3,4], vec![4,0,0,0], 1)]
    #[case([1,2,3,4], vec![0,1,0,0], 1)]
    #[case([1,2,3,4], vec![0,0,2,0], 1)]
    #[case([1,2,3,4], vec![0,0,0,3], 1)]
    #[case([1,2,3,4], vec![4,1,0,0], 2)]
    #[case([1,2,3,4], vec![0,1,2,0], 2)]
    #[case([1,2,3,4], vec![0,0,2,3], 2)]
    #[case([1,2,3,4], vec![4,0,0,3], 2)]
    #[case([1,2,3,4], vec![4,1,2,0], 3)]
    #[case([1,2,3,4], vec![0,1,2,3], 3)]
    #[case([1,2,3,4], vec![4,0,2,3], 3)]
    #[case([1,2,3,4], vec![1,2,3,4], 0)]
    fn test_check_combination_handles_misplaced(
        #[case] combination: [usize; 4],
        #[case] combination_try: Vec<usize>,
        #[case] expected: usize,
    ) {
        // arrange
        let game = Game::new_parameterized(false, 4, 4, 1, combination.to_vec());

        // act
        let result = game.check_combination(&combination_try);

        // assert
        assert_eq!(result.misplaced(), expected);
    }

    #[rstest]
    #[case([1,1,2,2], vec![2,0,0,0], 1)]
    #[case([1,1,2,2], vec![0,2,0,0], 1)]
    #[case([1,1,2,2], vec![2,2,0,0], 2)]
    #[case([1,1,2,2], vec![0,0,1,0], 1)]
    #[case([1,1,2,2], vec![0,0,0,1], 1)]
    #[case([1,1,2,2], vec![0,0,1,1], 2)]
    fn test_check_combination_handles_misplaced_duplicates(
        #[case] combination: [usize; 4],
        #[case] combination_try: Vec<usize>,
        #[case] expected: usize,
    ) {
        // arrange
        let game = Game::new_parameterized(false, 4, 4, 1, combination.to_vec());

        // act
        let result = game.check_combination(&combination_try);

        // assert
        assert_eq!(result.misplaced(), expected);
    }

    #[rstest]
    #[case([1,2,3,4], vec![4,4,0,0], 1)]
    #[case([1,2,3,4], vec![0,1,1,0], 1)]
    #[case([1,2,3,4], vec![0,0,2,2], 1)]
    #[case([1,2,3,4], vec![3,0,0,3], 1)]
    #[case([1,2,3,4], vec![4,1,4,1], 2)]
    #[case([1,2,3,4], vec![2,1,2,1], 2)]
    #[case([1,2,3,4], vec![2,3,2,3], 2)]
    #[case([1,2,3,4], vec![4,3,4,3], 2)]
    #[case([1,2,3,4], vec![4,1,2,1], 3)]
    #[case([1,2,3,4], vec![3,1,2,3], 3)]
    #[case([1,2,3,4], vec![4,3,2,3], 3)]
    fn test_check_combination_handles_misplaced_proposed_duplicates(
        #[case] combination: [usize; 4],
        #[case] combination_try: Vec<usize>,
        #[case] expected: usize,
    ) {
        // arrange
        let game = Game::new_parameterized(false, 4, 4, 1, combination.to_vec());

        // act
        let result = game.check_combination(&combination_try);

        // assert
        assert_eq!(result.misplaced(), expected);
    }
}