Canonicalize/Rules.pm

filter: Statementstmt 83.3% 10 / 12 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 4 / 4 Podpod n/a totaltotal 87.5% 14 / 16 CC 1 SCAR 0.7
CC
1
Cov
83%
BEGIN
1.3
BEGIN
1.0
BEGIN
1.0
CRAP 1.1
↑ Summary Canonicalize.pm »
1 package Text::Names::Canonicalize::Rules;
2  
3 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 1 ▶use Carp qw(croak);
Subroutine BEGIN: called CC=1 SCAR=0.0
6 0 ▶use YAML::XS qw(LoadFile);
Subroutine BEGIN: called CC=1 SCAR=2.6
7 use File::Spec;
8 use File::Basename qw(dirname);
9  
10 # ----------------------------------------------------------------------
11 # Load a YAML ruleset if available.
12 # YAML files live in:
13 # lib/Text/Names/Canonicalize/Rules/<locale>.yaml
14 # ----------------------------------------------------------------------
15 sub _load_yaml_rules {
16 my ($locale) = @_;
17  
18 # __FILE__ = .../Text/Names/Canonicalize/Rules.pm
19 # YAML lives in .../Text/Names/Canonicalize/Rules/*.yaml
20  
21 my $base = File::Spec->catdir( dirname(__FILE__), 'Rules' );
22 my $file = File::Spec->catfile( $base, "$locale.yaml" );
23  
24 return unless -e $file;
25  
26 my $yaml = eval { LoadFile($file) };
27 croak "Failed to load YAML rules for $locale: $@" if $@;
28  
29 croak "YAML rules for $locale must be a hash" unless ref $yaml eq 'HASH';
30  
31 return $yaml;
32 }
33  
34 # ----------------------------------------------------------------------
35 # Fetch a ruleset:
36 # 1. Try YAML
37 # 2. Fall back to Perl registry
38 # ----------------------------------------------------------------------
39 sub get {
40 my ($class, $locale, $ruleset) = @_;
41 $ruleset ||= 'default';
42  
43 # Built-in YAML (may be undef)
44 my $builtin = _load_yaml_rules($locale);
45 $builtin = _resolve_includes($locale, $ruleset, $builtin) if $builtin;
46  
47 # User override YAML (may be undef)
48 my $user = _load_user_yaml_rules($locale);
49 $user = _resolve_includes($locale, $ruleset, $user) if $user;
50  
51 # Extract rulesets
52 my $builtin_rules = $builtin ? $builtin->{$ruleset} : undef;
53 my $user_rules = $user ? $user->{$ruleset} : undef;
54  
55 croak "Ruleset '$ruleset' not found for locale '$locale'"
56 unless $builtin_rules || $user_rules;
57  
58 # Merge: user overrides built-in
59 my $merged = _merge_rules($builtin_rules || {}, $user_rules || {});
60  
61 return $merged;
62 }
63  
64 sub _user_rules_dir {
65  
66 # If CONFIG_DIR is set, use:
67 # $CONFIG_DIR/text-names-canonicalize/rules
68 if ($ENV{CONFIG_DIR}) {
69 return File::Spec->catdir(
70 $ENV{CONFIG_DIR},
71 'text-names-canonicalize',
72 'rules'
73 );
74 }
75  
76 # Otherwise use:
77 # ~/.config/text-names-canonicalize/rules
78 my $home = $ENV{HOME} or return;
79 return File::Spec->catdir(
80 $home,
81 '.config',
82 'text-names-canonicalize',
83 'rules'
84 );
85 }
86  
87 sub _load_user_yaml_rules {
88 my ($locale) = @_;
89  
90 my $dir = _user_rules_dir() or return;
91 my $file = File::Spec->catfile($dir, "$locale.yaml");
92  
93 return unless -e $file;
94  
95 my $yaml = eval { LoadFile($file) };
96 croak "Failed to load user YAML rules for $locale: $@" if $@;
97  
98 return $yaml;
99 }
100  
101 sub _merge_rules {
102 my ($base, $override) = @_;
103 return $base unless $override;
104  
105 my %merged = (%$base, %$override);
106 return \%merged;
107 }
108  
109 sub _resolve_includes {
110 my ($locale, $ruleset, $yaml, $seen) = @_;
111 return $yaml unless $yaml;
112  
113 $seen ||= {};
114  
115 my $spec = $yaml->{$ruleset}
116 or return $yaml;
117  
118 my @parents;
119 if (exists $spec->{include}) {
120 my $inc = $spec->{include};
121  
122 @parents =
123 ref $inc eq 'ARRAY' ? @$inc :
124 ref $inc eq '' ? ($inc) :
125 croak "Invalid include format in $locale/$ruleset";
126 }
127  
128 delete $spec->{include};
129  
130 for my $parent (@parents) {
131  
132 # CIRCULAR INCLUDE DETECTION
133 croak "Circular include detected: $locale → $parent"
134 if $seen->{$parent};
135  
136 $seen->{$parent} = 1;
137  
138 my $parent_yaml = _load_yaml_rules($parent)
139 or croak "Included locale '$parent' not found";
140  
141 $parent_yaml = _resolve_includes($parent, $ruleset, $parent_yaml, $seen);
142  
143 my $parent_rules = $parent_yaml->{$ruleset}
144 or croak "Included ruleset '$ruleset' not found in '$parent'";
145  
146 $spec = _merge_rules($parent_rules, $spec);
147 }
148  
149 $yaml->{$ruleset} = $spec;
150 return $yaml;
151 }
152  
153 1;
↑ Summary Canonicalize.pm »