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 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
#![no_std]
//!
//! You can populate [`Petnames`] with your own word lists, but the word lists
//! from upstream [petname](https://github.com/dustinkirkland/petname) are
//! included with the `default-words` feature (enabled by default). See
//! [`Petnames::small`], [`Petnames::medium`], and [`Petnames::large`] to select
//! a particular built-in word list, or use [`Petnames::default`].
//!
//! The other thing you need is a random number generator from [rand][]:
//!
//! ```rust
//! use petname::Generator; // Trait needs to be in scope for `generate`.
//! # #[cfg(feature = "default-rng")]
//! let mut rng = rand::thread_rng();
//! # #[cfg(all(feature = "default-rng", feature = "default-words"))]
//! let name = petname::Petnames::default().generate(&mut rng, 7, ":").expect("no names");
//! ```
//!
//! It may be more convenient to use the default random number generator:
//!
//! ```rust
//! use petname::Generator; // Trait needs to be in scope for `generate_one`.
//! # #[cfg(all(feature = "default-rng", feature = "default-words"))]
//! let name = petname::Petnames::default().generate_one(7, ":").expect("no names");
//! ```
//!
//! There's a [convenience function][petname] that'll do all of this:
//!
//! ```rust
//! # #[cfg(all(feature = "default-rng", feature = "default-words"))]
//! let name = petname::petname(7, ":");
//! ```
//!
//! But the most flexible approach is to create an [`Iterator`] with
//! [`iter`][`Petnames::iter`]:
//!
//! ```rust
//! use petname::Generator; // Trait needs to be in scope for `iter`.
//! # #[cfg(feature = "default-rng")]
//! let mut rng = rand::thread_rng();
//! # #[cfg(feature = "default-words")]
//! let petnames = petname::Petnames::default();
//! # #[cfg(all(feature = "default-rng", feature = "default-words"))]
//! let ten_thousand_names: Vec<String> =
//! petnames.iter(&mut rng, 3, "_").take(10000).collect();
//! ```
//!
//! You can modify the word lists to, for example, only use words beginning with
//! the letter "b":
//!
//! ```rust
//! # use petname::Generator;
//! # #[cfg(feature = "default-words")]
//! let mut petnames = petname::Petnames::default();
//! # #[cfg(feature = "default-words")]
//! petnames.retain(|s| s.starts_with("b"));
//! # #[cfg(all(feature = "default-rng", feature = "default-words"))]
//! let name = petnames.generate_one(3, ".").expect("no names");
//! # #[cfg(all(feature = "default-rng", feature = "default-words"))]
//! assert!(name.starts_with('b'));
//! ```
//!
//! There's another way to generate alliterative petnames which is useful when
//! you you don't need or want each name to be limited to using the same initial
//! letter as the previous generated name. Create the `Petnames` as before, and
//! then convert it into an [`Alliterations`]:
//!
//! ```rust
//! # use petname::Generator;
//! # #[cfg(feature = "default-words")]
//! let mut petnames = petname::Petnames::default();
//! # #[cfg(feature = "default-words")]
//! let mut alliterations: petname::Alliterations = petnames.into();
//! # #[cfg(all(feature = "default-rng", feature = "default-words"))]
//! alliterations.generate_one(3, "/").expect("no names");
//! ```
//!
//! Both [`Petnames`] and [`Alliterations`] implement [`Generator`]; this needs
//! to be in scope in order to generate names. It's [object-safe] so you can use
//! `Petnames` and `Alliterations` as trait objects:
//!
//! [object-safe]:
//! https://doc.rust-lang.org/reference/items/traits.html#object-safety
//!
//! ```rust
//! use petname::Generator;
//! # #[cfg(feature = "default-words")]
//! let generator: &dyn Generator = &petname::Petnames::default();
//! # #[cfg(feature = "default-words")]
//! let generator: &dyn Generator = &petname::Alliterations::default();
//! ```
//!
extern crate alloc;
use alloc::{
borrow::Cow,
boxed::Box,
collections::BTreeMap,
string::{String, ToString},
vec::Vec,
};
use rand::seq::{IteratorRandom, SliceRandom};
/// Convenience function to generate a new petname from default word lists.
#[allow(dead_code)]
#[cfg(all(feature = "default-rng", feature = "default-words"))]
pub fn petname(words: u8, separator: &str) -> Option<String> {
Petnames::default().generate_one(words, separator)
}
/// A word list.
pub type Words<'a> = Cow<'a, [&'a str]>;
#[cfg(feature = "default-words")]
mod words {
include!(concat!(env!("OUT_DIR"), "/words.rs"));
}
/// Trait that defines a generator of petnames.
///
/// There are default implementations of `generate_one` and `iter`, i.e. only
/// `generate` needs to be implemented.
///
pub trait Generator<'a> {
/// Generate a new petname.
///
/// # Examples
///
/// ```rust
/// # use petname::Generator;
/// # #[cfg(all(feature = "default-rng", feature = "default-words"))]
/// let mut rng = rand::thread_rng();
/// # #[cfg(all(feature = "default-rng", feature = "default-words"))]
/// petname::Petnames::default().generate(&mut rng, 7, ":");
/// ```
///
/// # Notes
///
/// This may return fewer words than you request if one or more of the word
/// lists are empty. For example, if there are no adverbs, requesting 3 or
/// more words may still yield only "doubtful-salmon".
///
fn generate(&self, rng: &mut dyn rand::RngCore, words: u8, separator: &str) -> Option<String>;
/// Generate a single new petname.
///
/// This is like `generate` but uses `rand::thread_rng` as the random
/// source. For efficiency use `generate` when creating multiple names, or
/// when you want to use a custom source of randomness.
#[cfg(feature = "default-rng")]
fn generate_one(&self, words: u8, separator: &str) -> Option<String> {
self.generate(&mut rand::thread_rng(), words, separator)
}
/// Iterator yielding petnames.
///
/// # Examples
///
/// ```rust
/// # use petname::Generator;
/// # #[cfg(all(feature = "default-rng", feature = "default-words"))]
/// let mut rng = rand::thread_rng();
/// # #[cfg(all(feature = "default-rng", feature = "default-words"))]
/// let petnames = petname::Petnames::default();
/// # #[cfg(all(feature = "default-rng", feature = "default-words"))]
/// let mut iter = petnames.iter(&mut rng, 4, "_");
/// # #[cfg(all(feature = "default-rng", feature = "default-words"))]
/// println!("name: {}", iter.next().unwrap());
/// ```
fn iter(
&'a self,
rng: &'a mut dyn rand::RngCore,
words: u8,
separator: &str,
) -> Box<dyn Iterator<Item = String> + 'a>
where
Self: Sized,
{
let names = Names { generator: self, rng, words, separator: separator.to_string() };
Box::new(names)
}
}
/// Word lists and the logic to combine them into _petnames_.
///
/// A _petname_ with `n` words will contain, in order:
///
/// * `n - 2` adverbs when `n >= 2`, otherwise 0 adverbs.
/// * 1 adjective when `n >= 2`, otherwise 0 adjectives.
/// * 1 noun when `n >= 1`, otherwise 0 nouns.
///
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Petnames<'a> {
pub adjectives: Words<'a>,
pub adverbs: Words<'a>,
pub nouns: Words<'a>,
}
impl<'a> Petnames<'a> {
/// Constructs a new `Petnames` from the small word lists.
#[cfg(feature = "default-words")]
pub fn small() -> Self {
Self {
adjectives: Cow::from(&words::small::ADJECTIVES[..]),
adverbs: Cow::from(&words::small::ADVERBS[..]),
nouns: Cow::from(&words::small::NOUNS[..]),
}
}
/// Constructs a new `Petnames` from the medium word lists.
#[cfg(feature = "default-words")]
pub fn medium() -> Self {
Self {
adjectives: Cow::from(&words::medium::ADJECTIVES[..]),
adverbs: Cow::from(&words::medium::ADVERBS[..]),
nouns: Cow::from(&words::medium::NOUNS[..]),
}
}
/// Constructs a new `Petnames` from the large word lists.
#[cfg(feature = "default-words")]
pub fn large() -> Self {
Self {
adjectives: Cow::from(&words::large::ADJECTIVES[..]),
adverbs: Cow::from(&words::large::ADVERBS[..]),
nouns: Cow::from(&words::large::NOUNS[..]),
}
}
/// Constructs a new `Petnames` from the given word lists.
///
/// The words are extracted from the given strings by splitting on whitespace.
pub fn new(adjectives: &'a str, adverbs: &'a str, nouns: &'a str) -> Self {
Self {
adjectives: Cow::Owned(adjectives.split_whitespace().collect()),
adverbs: Cow::Owned(adverbs.split_whitespace().collect()),
nouns: Cow::Owned(nouns.split_whitespace().collect()),
}
}
/// Keep words matching a predicate.
///
/// # Examples
///
/// ```rust
/// # use petname::Generator;
/// # #[cfg(feature = "default-words")]
/// let mut petnames = petname::Petnames::default();
/// # #[cfg(feature = "default-words")]
/// petnames.retain(|s| s.starts_with("h"));
/// # #[cfg(all(feature = "default-words", feature = "default-rng"))]
/// assert!(petnames.generate_one(2, ".").unwrap().starts_with('h'));
/// ```
///
/// This is a convenience wrapper that applies the same predicate to the
/// adjectives, adverbs, and nouns lists.
///
pub fn retain<F>(&mut self, mut predicate: F)
where
F: FnMut(&str) -> bool,
{
self.adjectives.to_mut().retain(|word| predicate(word));
self.adverbs.to_mut().retain(|word| predicate(word));
self.nouns.to_mut().retain(|word| predicate(word));
}
/// Calculate the cardinality of this `Petnames`.
///
/// If this is low, names may be repeated by the generator with a higher
/// frequency than your use-case may allow.
///
/// This can saturate. If the total possible combinations of words exceeds
/// `u128::MAX` then this will return `u128::MAX`.
pub fn cardinality(&self, words: u8) -> u128 {
Lists::new(words)
.map(|list| match list {
List::Adverb => self.adverbs.len() as u128,
List::Adjective => self.adjectives.len() as u128,
List::Noun => self.nouns.len() as u128,
})
.reduce(u128::saturating_mul)
.unwrap_or(0u128)
}
}
impl<'a> Generator<'a> for Petnames<'a> {
fn generate(&self, rng: &mut dyn rand::RngCore, words: u8, separator: &str) -> Option<String> {
let name = itertools::intersperse(
Lists::new(words).filter_map(|list| match list {
List::Adverb => self.adverbs.choose(rng).copied(),
List::Adjective => self.adjectives.choose(rng).copied(),
List::Noun => self.nouns.choose(rng).copied(),
}),
separator,
)
.collect::<String>();
if name.is_empty() {
None
} else {
Some(name)
}
}
}
#[cfg(feature = "default-words")]
impl<'a> Default for Petnames<'a> {
/// Constructs a new [`Petnames`] from the default (medium) word lists.
fn default() -> Self {
Self::medium()
}
}
/// Word lists prepared for alliteration.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Alliterations<'a> {
groups: BTreeMap<char, Petnames<'a>>,
}
impl<'a> Alliterations<'a> {
/// Keep only those groups that match a predicate.
pub fn retain<F>(&mut self, predicate: F)
where
F: FnMut(&char, &mut Petnames) -> bool,
{
self.groups.retain(predicate)
}
/// Calculate the cardinality of this `Alliterations`.
///
/// This is the sum of the cardinality of all groups.
///
/// This can saturate. If the total possible combinations of words exceeds
/// `u128::MAX` then this will return `u128::MAX`.
pub fn cardinality(&self, words: u8) -> u128 {
self.groups
.values()
.map(|petnames| petnames.cardinality(words))
.reduce(u128::saturating_add)
.unwrap_or(0u128)
}
}
impl<'a> From<Petnames<'a>> for Alliterations<'a> {
fn from(petnames: Petnames<'a>) -> Self {
let mut adjectives: BTreeMap<char, Vec<&str>> = group_words_by_first_letter(petnames.adjectives);
let mut adverbs: BTreeMap<char, Vec<&str>> = group_words_by_first_letter(petnames.adverbs);
let nouns: BTreeMap<char, Vec<&str>> = group_words_by_first_letter(petnames.nouns);
// We find all adjectives and adverbs that start with the same letter as
// each group of nouns. We start from nouns because it's possible to
// have a petname with length of 1, i.e. a noun. This means that it's
// okay at this point for the adjectives and adverbs lists to be empty.
Alliterations {
groups: nouns.into_iter().fold(BTreeMap::default(), |mut acc, (first_letter, nouns)| {
acc.insert(
first_letter,
Petnames {
adjectives: adjectives.remove(&first_letter).unwrap_or_default().into(),
adverbs: adverbs.remove(&first_letter).unwrap_or_default().into(),
nouns: Cow::from(nouns),
},
);
acc
}),
}
}
}
impl<'a, GROUPS> From<GROUPS> for Alliterations<'a>
where
GROUPS: IntoIterator<Item = (char, Petnames<'a>)>,
{
fn from(groups: GROUPS) -> Self {
Self { groups: groups.into_iter().collect() }
}
}
fn group_words_by_first_letter(words: Words) -> BTreeMap<char, Vec<&str>> {
words.iter().fold(BTreeMap::default(), |mut acc, s| match s.chars().next() {
Some(first_letter) => {
acc.entry(first_letter).or_default().push(s);
acc
}
None => acc,
})
}
impl<'a> Generator<'a> for Alliterations<'a> {
/// Generate a new petname.
///
/// # Examples
///
/// ```rust
/// # use petname::Generator;
/// # #[cfg(all(feature = "default-rng", feature = "default-words"))]
/// let mut rng = rand::thread_rng();
/// # #[cfg(all(feature = "default-rng", feature = "default-words"))]
/// petname::Petnames::default().generate(&mut rng, 7, ":");
/// ```
///
/// # Notes
///
/// This may return fewer words than you request if one or more of the word
/// lists are empty. For example, if there are no adverbs, requesting 3 or
/// more words may still yield only "doubtful-salmon".
///
fn generate(&self, rng: &mut dyn rand::RngCore, words: u8, separator: &str) -> Option<String> {
self.groups.values().choose(rng).and_then(|group| group.generate(rng, words, separator))
}
}
#[cfg(feature = "default-words")]
impl<'a> Default for Alliterations<'a> {
/// Constructs a new [`Alliterations`] from the default [`Petnames`].
fn default() -> Self {
Petnames::default().into()
}
}
/// Enum representing which word list to use.
#[derive(Debug, PartialEq)]
enum List {
Adverb,
Adjective,
Noun,
}
/// Iterator, yielding which word list to use next.
///
/// This yields the appropriate list – [adverbs][List::Adverb],
/// [adjectives][List::Adjective]s, [nouns][List::Nouns] – from which to select
/// a word when constructing a petname of `n` words. For example, if you want 4
/// words in your petname, this will first yield [List::Adverb], then
/// [List::Adverb] again, then [List::Adjective], and lastly [List::Noun].
#[derive(Debug, PartialEq)]
enum Lists {
Adverb(u8),
Adjective,
Noun,
Done,
}
impl Lists {
fn new(words: u8) -> Self {
match words {
0 => Self::Done,
1 => Self::Noun,
2 => Self::Adjective,
n => Self::Adverb(n - 3),
}
}
fn current(&self) -> Option<List> {
match self {
Self::Adjective => Some(List::Adjective),
Self::Adverb(_) => Some(List::Adverb),
Self::Noun => Some(List::Noun),
Self::Done => None,
}
}
fn advance(&mut self) {
*self = match self {
Self::Adverb(0) => Self::Adjective,
Self::Adverb(remaining) => Self::Adverb(*remaining - 1),
Self::Adjective => Self::Noun,
Self::Noun | Self::Done => Self::Done,
}
}
fn remaining(&self) -> usize {
match self {
Self::Adverb(n) => (n + 3) as usize,
Self::Adjective => 2,
Self::Noun => 1,
Self::Done => 0,
}
}
}
impl Iterator for Lists {
type Item = List;
fn next(&mut self) -> Option<Self::Item> {
let current = self.current();
self.advance();
current
}
fn size_hint(&self) -> (usize, Option<usize>) {
let remaining = self.remaining();
(remaining, Some(remaining))
}
}
/// Iterator yielding petnames.
struct Names<'a, GENERATOR>
where
GENERATOR: Generator<'a>,
{
generator: &'a GENERATOR,
rng: &'a mut dyn rand::RngCore,
words: u8,
separator: String,
}
impl<'a, GENERATOR> Iterator for Names<'a, GENERATOR>
where
GENERATOR: Generator<'a>,
{
type Item = String;
fn next(&mut self) -> Option<Self::Item> {
self.generator.generate(self.rng, self.words, &self.separator)
}
}
#[cfg(test)]
mod tests {
#[test]
fn lists_sequences_adverbs_adjectives_then_names() {
let mut lists = super::Lists::new(4);
assert_eq!(super::Lists::Adverb(1), lists);
assert_eq!(Some(super::List::Adverb), lists.next());
assert_eq!(super::Lists::Adverb(0), lists);
assert_eq!(Some(super::List::Adverb), lists.next());
assert_eq!(super::Lists::Adjective, lists);
assert_eq!(Some(super::List::Adjective), lists.next());
assert_eq!(super::Lists::Noun, lists);
assert_eq!(Some(super::List::Noun), lists.next());
assert_eq!(super::Lists::Done, lists);
assert_eq!(None, lists.next());
}
#[test]
fn lists_size_hint() {
let mut lists = super::Lists::new(3);
assert_eq!((3, Some(3)), lists.size_hint());
assert!(lists.next().is_some());
assert_eq!((2, Some(2)), lists.size_hint());
assert!(lists.next().is_some());
assert_eq!((1, Some(1)), lists.size_hint());
assert!(lists.next().is_some());
assert_eq!((0, Some(0)), lists.size_hint());
assert_eq!(None, lists.next());
assert_eq!((0, Some(0)), lists.size_hint());
}
}