wpsr 0.3.1

Command line program to help solve word puzzles
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
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
use std::collections::VecDeque;

mod edge;
mod shuffle;
mod weighted_word;

use edge::Edge;
use rand::{SeedableRng, seq::SliceRandom};
use rand_chacha::ChaCha20Rng;
pub use shuffle::Shuffle;
use weighted_word::WeightedWord;

use crate::Error;

#[derive(Debug)]
pub struct LettersBoxed {
    letters: Vec<char>,
    words: Vec<String>,
    invalid_pairs: Vec<(char, char)>,
    word_chain: Vec<String>,
    edges: Vec<Edge>,
    max_chain: Option<usize>,
    shuffle_depth: Option<i8>,
}

impl Default for LettersBoxed {
    fn default() -> Self {
        let letters = vec!['o', 'u', 'h', 'i', 'm', 'a', 'g', 'p', 'l', 'r', 'y', 'f'];
        let edges = vec![
            Edge::new('o', 'u', 'h'),
            Edge::new('i', 'm', 'a'),
            Edge::new('g', 'p', 'l'),
            Edge::new('r', 'y', 'f'),
        ];
        Self {
            letters,
            words: Vec::new(),
            invalid_pairs: Vec::new(),
            word_chain: Vec::new(),
            edges,
            max_chain: None,
            shuffle_depth: None,
        }
    }
}

impl LettersBoxed {
    pub fn new(letters: &[char], words: &[String]) -> Self {
        let mut s = Self::default();
        if !letters.is_empty() {
            s.letters = Vec::from(letters);
            s.generate_edges();
        }
        if !words.is_empty() {
            s.words = Vec::from(words);
        }

        s
    }

    pub fn set_max_chain(&mut self, value: usize) -> &mut Self {
        self.max_chain = Some(value);
        self
    }

    pub fn set_shuffle_depth(&mut self, value: i8) -> &mut Self {
        self.shuffle_depth = Some(value);
        self
    }

    #[tracing::instrument(skip(self))]
    pub fn filter_words_with_letters_only(&mut self) -> &mut Self {
        let filtered = self
            .words
            .iter()
            .filter(|word| word.chars().all(|c| self.letters.contains(&c)))
            .map(|w| w.to_string())
            .collect::<Vec<String>>();

        tracing::info!("Filtered to {} words", filtered.len());
        self.words = filtered;
        self
    }

    #[tracing::instrument(skip(self))]
    fn generate_edges(&mut self) -> &mut Self {
        let mut deque = VecDeque::from(self.letters.clone());

        let mut edges = Vec::new();

        while !deque.is_empty() {
            let edge = Edge::new(
                deque.pop_front().unwrap(),
                deque.pop_front().unwrap(),
                deque.pop_front().unwrap(),
            );

            edges.push(edge);
        }

        self.edges = edges;

        self
    }

    #[tracing::instrument(skip(self))]
    fn generate_invalid_pairs(&mut self) -> &mut Self {
        let mut invalid_pairs = Vec::new();
        for edge in self.edges.iter() {
            for pair in edge.pairs() {
                if !self.invalid_pairs.contains(&pair) {
                    invalid_pairs.push(pair);
                }
            }
        }

        tracing::debug!("Generated {} invalid pairs", invalid_pairs.len());
        tracing::trace!("Invalid pairs: {:#?}", invalid_pairs);
        self.invalid_pairs = invalid_pairs;

        self
    }

    #[tracing::instrument(skip(self))]
    pub fn filter_exclude_invalid_pairs(&mut self) -> &mut Self {
        self.generate_invalid_pairs();

        let filtered = self
            .words
            .iter()
            .filter(|word| {
                let chars = word.chars().collect::<Vec<char>>();
                let mut a = chars[0];
                for b in chars.iter().skip(1) {
                    if self.invalid_pairs.contains(&(a, *b))
                        || self.invalid_pairs.contains(&(*b, a))
                    {
                        return false;
                    }
                    a = *b;
                }
                true
            })
            .map(|w| w.to_string())
            .collect::<Vec<String>>();

        tracing::info!("Filtered to {} words", filtered.len());
        self.words = filtered;
        self
    }

    #[tracing::instrument(skip(self, shuffle))]
    pub fn build_word_chain(&mut self, shuffle: &mut Shuffle) -> Result<(), Error> {
        tracing::info!("Building word chain");
        // Get the first word from the list of words
        let mut rng = ChaCha20Rng::from_rng(&mut rand::rng());
        let all_words = self.words.clone();
        let words_list = all_words.clone();
        let word_chain = Vec::new();
        let unused_letters = String::from_iter(self.letters.clone());
        let shuffle_depth = self.shuffle_depth.unwrap_or(-1);

        let word_chain = get_word(
            all_words,
            words_list,
            word_chain,
            unused_letters,
            &mut rng,
            shuffle,
            self.max_chain,
            shuffle_depth,
        )?;

        self.word_chain = word_chain;
        Ok(())
    }

    #[tracing::instrument(skip(self))]
    pub fn solution_string(&self) -> String {
        self.word_chain.join(" -> ").to_string()
    }

    #[tracing::instrument(skip(self))]
    pub fn chain_length(&self) -> usize {
        self.word_chain.len()
    }
}

#[allow(clippy::too_many_arguments)]
#[tracing::instrument(skip(
    all_words,
    words_list,
    word_chain,
    unused_letters,
    rng,
    shuffle,
    max_chain,
    shuffle_depth
))]
pub fn get_word(
    all_words: Vec<String>,
    mut words_list: Vec<String>,
    mut word_chain: Vec<String>,
    mut unused_letters: String,
    rng: &mut ChaCha20Rng,
    shuffle: &mut Shuffle,
    max_chain: Option<usize>,
    mut shuffle_depth: i8,
) -> Result<Vec<String>, Error> {
    let initial_unused_letters = unused_letters.clone();
    tracing::trace!("Starting word chain: {}", word_chain.join(" -> "));
    tracing::trace!(
        "Shuffle set to: {} and word list length: {}",
        shuffle,
        words_list.len()
    );

    // Shuffle the starting words list to get a random starting word
    if shuffle == &Shuffle::Twice {
        tracing::debug!("Shuffling words list.");
        words_list.shuffle(rng);
    }
    let mut words_list = words_list
        .iter()
        .map(|word| WeightedWord::new(word.clone(), unused_letters.clone()))
        .collect::<Vec<WeightedWord>>();
    words_list.sort_by_key(|ww| ww.weight);
    let words_list = words_list
        .iter()
        .rev()
        .map(|ww| ww.word.to_string())
        .collect::<Vec<String>>();

    // shuffle the top of to the words list to randomize the first word while keeping a good weight
    let mut words = if shuffle != &Shuffle::None && shuffle_depth != 0 {
        tracing::debug!("Shuffling top half of weighted words list.");
        let words_list = shuffle_top_half(words_list, rng);
        VecDeque::from(words_list)
    } else {
        VecDeque::from(words_list)
    };

    // find a word that increases the letters used

    loop {
        tracing::trace!(
            "List of {} words starting with: {:?}",
            words.len(),
            words.front()
        );
        let Some(word) = words.pop_front() else {
            return Err(Error::NoWordFound);
        };

        let letter_count = &unused_letters.len();
        tracing::trace!("Letters unused before check: {}", unused_letters);
        for letter in word.chars() {
            if let Some(idx) = unused_letters.find(letter) {
                unused_letters.remove(idx);
            }
        }
        tracing::trace!("Letters unused after check: {}", unused_letters);

        // if all of the letters are used then we have the final word chain
        if unused_letters.is_empty() {
            word_chain.push(word);
            break;
        }
        tracing::trace!(
            "Still {} letters unused: {}",
            unused_letters.len(),
            unused_letters
        );

        // if the word extends the chain add it to the chain and start again
        if unused_letters.len() < *letter_count {
            if let Some(max_chain) = max_chain {
                if word_chain.len() >= max_chain {
                    return Err(Error::ChainTooLong);
                }
            }
            let mut next_word_chain = word_chain.clone();
            let next_unused_letters = unused_letters.clone();
            let next_all_words = all_words.clone();
            let last_letter = word.chars().last().unwrap();
            let words_list = all_words
                .iter()
                .filter(|w| w.chars().next().unwrap() == last_letter)
                .map(|w| w.to_string())
                .collect::<Vec<String>>();
            if words.is_empty() {
                return Err(Error::NoWordFound);
            }
            next_word_chain.push(word);
            if shuffle_depth > 0 {
                shuffle_depth -= 1;
            }
            match get_word(
                next_all_words,
                words_list,
                next_word_chain,
                next_unused_letters,
                rng,
                shuffle,
                max_chain,
                shuffle_depth,
            ) {
                Ok(chain) => {
                    word_chain = chain;
                    break;
                }
                Err(e) => {
                    tracing::debug!("No word found, resetting");
                    if e == Error::ChainTooLong {
                        return Err(e);
                    }
                    unused_letters = initial_unused_letters.clone();
                    continue;
                }
            };
        }
    }

    tracing::debug!("Current word chain: {}", word_chain.join("-"));

    Ok(word_chain)
}

fn shuffle_top_half(mut words: Vec<String>, rng: &mut ChaCha20Rng) -> Vec<String> {
    let half_len = words.len() / 2;
    let mut top_half = words.drain(..half_len).collect::<Vec<String>>();
    let bottom_half = words.iter().map(|w| w.to_string()).collect::<Vec<String>>();
    top_half.shuffle(rng);
    top_half.extend(bottom_half);
    top_half
}

#[cfg(test)]
mod tests {
    use std::vec;

    use super::*;
    #[test]
    fn test_filter_words_with_letters_only() {
        let letters = vec!['o', 'u', 'h', 'i', 'd', 'a', 'g', 'e', 'l', 'r', 'y', 'w'];
        let words = vec![
            "hello".to_string(),
            "world".to_string(),
            "foo".to_string(),
            "bar".to_string(),
            "baz".to_string(),
        ];

        let mut letters_boxed = LettersBoxed::new(&letters, &words);
        letters_boxed.filter_words_with_letters_only();
        assert_eq!(letters_boxed.words.len(), 2);
        assert_eq!(letters_boxed.words[0], "hello".to_string());
        assert_eq!(letters_boxed.words[1], "world".to_string());
    }

    #[test]
    fn test_filter_words_with_invalid_pairs() {
        let letters = vec!['o', 'u', 'm', 'i', 'd', 'a', 'g', 'e', 'l', 'r', 'y', 'w'];
        let words = vec![
            "embolden".to_string(),
            "world".to_string(),
            "foo".to_string(),
            "dire".to_string(),
            "glow".to_string(),
            "game".to_string(),
            "quux".to_string(),
            "corse".to_string(),
            "gaunt".to_string(),
            "grape".to_string(),
            "waldo".to_string(),
            "fred".to_string(),
        ];

        let mut letters_boxed = LettersBoxed::new(&letters, &words);

        println!("{:#?}", letters_boxed.edges);

        letters_boxed.filter_words_with_letters_only();
        println!("{:#?}", letters_boxed.words);

        letters_boxed.filter_exclude_invalid_pairs();
        println!("{:#?}", letters_boxed.words);

        assert_eq!(letters_boxed.words.len(), 3);
        assert_eq!(letters_boxed.words[0], "world".to_string());
        assert_eq!(letters_boxed.words[1], "game".to_string());
        assert_eq!(letters_boxed.words[2], "waldo".to_string());
    }

    #[test]
    fn test_shuffle_top_half() {
        let words = vec![
            "hello".to_string(),
            "world".to_string(),
            "foo".to_string(),
            "bar".to_string(),
            "baz".to_string(),
        ];
        println!("before: {words:?}");
        let mut rng = ChaCha20Rng::seed_from_u64(1);
        let shuffled = shuffle_top_half(words, &mut rng);
        println!("after: {shuffled:?}");
        assert_eq!(shuffled.len(), 5);
        assert_eq!(shuffled[0], "world".to_string());
        assert_eq!(shuffled[1], "hello".to_string());
        assert_eq!(shuffled[2], "foo".to_string());
        assert_eq!(shuffled[3], "bar".to_string());
        assert_eq!(shuffled[4], "baz".to_string());
    }
}