| 1 | # Copyright (c) 2026 Philipp Schafft | ||
| 2 | |||
| 3 | # licensed under Artistic License 2.0 (see LICENSE file) | ||
| 4 | |||
| 5 | # ABSTRACT: module to generate proper famibeib names | ||
| 6 | |||
| 7 | |||
| 8 | package Lingua::famibeib::NameGenerator; | ||
| 9 | |||
| 10 | use v5.16; | ||
| 11 | use strict; | ||
| 12 | use warnings; | ||
| 13 | |||
| 14 | use Carp; | ||
| 15 | use Digest::SHA3; | ||
| 16 | use Lingua::famibeib::Word; | ||
| 17 | |||
| 18 | our $VERSION = v0.08; | ||
| 19 | |||
| 20 | my @_word_mora = qw( | ||
| 21 | ba be bi bo bu | ||
| 22 | fa fe fi fo fu | ||
| 23 | ka ke ki ko ku | ||
| 24 | la le li lo lu | ||
| 25 | ma me mi mo mu | ||
| 26 | sa se si so su | ||
| 27 | ta te ti to tu | ||
| 28 | ); | ||
| 29 | |||
| 30 | my %_static_length_probabilities = ( | ||
| 31 | 1 => 0.01, | ||
| 32 | 2 => 0.10, | ||
| 33 | 3 => 0.80, | ||
| 34 | 4 => 0.40, | ||
| 35 | 5 => 0.10, | ||
| 36 | ); | ||
| 37 | |||
| 38 | my %_static_key_factors = ( | ||
| 39 | (map {$_ => 0.5} qw(species family tribe)), | ||
| 40 | (map {$_ => 1.0} qw(email realname nickname username name user tag)), | ||
| 41 | ); | ||
| 42 | |||
| 43 | |||
| 44 | #@returns Lingua::famibeib::Word | ||
| 45 | sub generate { | ||
| 46 | my ($pkg, %opts) = @_; | ||
| 47 | my $digest = Digest::SHA3->new(384); | ||
| 48 | my $minlen = delete($opts{minlength}) // $opts{length} // 3; | ||
| 49 | my $maxlen = delete($opts{maxlength}) // $opts{length} // 6; | ||
| 50 | my $counter = $opts{counter} // 0; | ||
| 51 | my $retry = $opts{retry}; | ||
| 52 | my $last = $opts{last}; | ||
| 53 | my @rands; | ||
| 54 | my %letters; | ||
| 55 | my %strings; | ||
| 56 | my %mora = map {$_ => 0} @_word_mora; | ||
| 57 | my $length; | ||
| 58 | |||
| 59 | $counter++; | ||
| 60 | $counter = 1/($counter**.5); | ||
| 61 | |||
| 62 | delete $opts{length}; | ||
| 63 | |||
| 64 | if (delete $opts{random}) { | ||
| 65 | my $random = $pkg->_random; | ||
| 66 | $digest->add(sprintf(':random%u*=%s', length($random), $random)); | ||
| 67 | } | ||
| 68 | |||
| 69 | foreach my $key (qw(seed retry counter last sex_or_gender species family tribe email realname nickname username name subjecttype user tag)) { | ||
| 70 | my $v = delete($opts{$key}) // next; | ||
| 71 | my $ref = ref($v) // ''; | ||
| 72 | my $displayname; | ||
| 73 | my $str; | ||
| 74 | |||
| 75 | if ($ref) { | ||
| 76 | if ($v->isa('Data::Identifier') || $v->isa('Data::Identifier::Interface::Simple')) { | ||
| 77 | $str = $v->ise; | ||
| 78 | $displayname = $v->displayname(default => undef, no_defaults => 1); | ||
| 79 | } else { | ||
| 80 | croak 'Unsupported object: '.$v; | ||
| 81 | } | ||
| 82 | } else { | ||
| 83 | $str = $v; | ||
| 84 | $displayname = $v; | ||
| 85 | } | ||
| 86 | |||
| 87 | $str = sprintf(':%s%u%s=%s', $key, length($str), $ref, $str); | ||
| 88 | $digest->add($str); | ||
| 89 | #say $str; | ||
| 90 | |||
| 91 | if (defined(my $factor = $_static_key_factors{$key})) { | ||
| 92 | $factor *= $counter; | ||
| 93 | if (defined($displayname) && length($displayname)) { | ||
| 94 | $displayname =~ s/\@.*\z//; | ||
| 95 | |||
| 96 | $displayname = lc($displayname); | ||
| 97 | |||
| 98 | unless (exists $strings{$factor.'-'.$displayname}) { | ||
| 99 | $strings{$factor.'-'.$displayname} = undef; | ||
| 100 | |||
| 101 | foreach my $c (split //, $displayname) { # we use lc() not fc() as famibeib in normal form is lower-case. | ||
| 102 | $letters{$c} //= 0; | ||
| 103 | $letters{$c} += $factor; | ||
| 104 | } | ||
| 105 | |||
| 106 | foreach my $mora (@_word_mora) { | ||
| 107 | my $c = () = $displayname =~ /\Q$mora/g; | ||
| 108 | $mora{$mora} += $factor*$c; | ||
| 109 | } | ||
| 110 | } | ||
| 111 | } | ||
| 112 | } | ||
| 113 | } | ||
| 114 | |||
| 115 | croak 'Stray options passed' if scalar keys %opts; | ||
| 116 | croak 'Bad length' if $minlen > $maxlen || $minlen < 2 || $maxlen > 9; | ||
| 117 | # Correct given the prefix. | ||
| 118 | $minlen--; | ||
| 119 | $maxlen--; | ||
| 120 | |||
| 121 | @rands = unpack('C*', $digest->digest); | ||
| 122 | #say '[', join(', ', @rands), ']'; | ||
| 123 | |||
| 124 | foreach my $mora (@_word_mora) { | ||
| 125 | my ($x, $y) = $mora =~ /^(.)(.)\z/; | ||
| 126 | |||
| 127 | $mora{$mora} = (((($letters{$x} // 0)**2 + ($letters{$y} // 0)**2)**.25)/2) + sqrt($mora{$mora}/8) + (shift(@rands)/256); | ||
| 128 | } | ||
| 129 | |||
| 130 | { | ||
| 131 | my %lens = map {$_ => (shift(@rands)/256) * ($_static_length_probabilities{$_} // 0.01)} $minlen .. $maxlen; | ||
| 132 | $length = int((sort {$lens{$a} <=> $lens{$b} || $a <=> $b} keys %lens)[-1]); | ||
| 133 | } | ||
| 134 | |||
| 135 | #use Data::Dumper; | ||
| 136 | #warn Dumper(\@rands, \%mora); | ||
| 137 | |||
| 138 | { | ||
| 139 | my $res = 'ta'; | ||
| 140 | |||
| 141 | for (; $length; $length--) { | ||
| 142 | my $m = (sort {$mora{$a} <=> $mora{$b} || $a cmp $b} keys %mora)[-1]; | ||
| 143 | $res .= $m; | ||
| 144 | $mora{$m} *= 0.8; | ||
| 145 | $mora{$m} -= 0.3; | ||
| 146 | } | ||
| 147 | |||
| 148 | #warn Dumper(\@rands, \%mora); | ||
| 149 | $res = Lingua::famibeib::Word->new(string => $res); | ||
| 150 | |||
| 151 | if (defined $last) { | ||
| 152 | $last = Lingua::famibeib::Word->new(from => $last); # enforce a valid word | ||
| 153 | if ($last->eq($res)) { | ||
| 154 | # Same as last, we need to retry: | ||
| 155 | croak 'Double collision error. You broke the universe. Please retry with a new big-bang.' if $retry; | ||
| 156 | return __SUB__->(@_, retry => ($retry // 0) + 1); | ||
| 157 | } | ||
| 158 | } | ||
| 159 | |||
| 160 | return $res; | ||
| 161 | } | ||
| 162 | } | ||
| 163 | |||
| 164 | # ---- Private helpers ---- | ||
| 165 | |||
| 166 | sub _random { | ||
| 167 | state $prefix = sprintf('%s.%s', $$, $^T); | ||
| 168 | state $count = 0; | ||
| 169 | |||
| 170 | return sprintf('%s/%u/%u/%s', $prefix, $count++, time(), rand()); | ||
| 171 | } | ||
| 172 | |||
| 173 | 1; | ||
| 174 | |||
| 175 | __END__ |