1 package CatalystX::HelpText::Script::SearchUndocumentedHelpText;
4 use MooseX::Types::Path::Class qw/ Dir /;
5 use MooseX::Types::Moose qw/Str Undef HashRef ArrayRef Bool/;
8 use Getopt::Long::Descriptive; # Force GLD as we override bits..
9 use MooseX::Types::LoadableClass qw/ LoadableClass /;
11 use List::MoreUtils qw/ uniq /;
12 use namespace::autoclean;
14 has help_files_path => (
24 has template_search_dir => (
30 has filename_pattern => (
33 default => '\.(html|tt)$',
36 has help_files_ext => (
44 $self->print_result();
51 builder => '_build_all_keys',
56 [ uniq map { $self->_find_helptext_keys_in_fn($_)->flatten } $self->all_files->flatten ];
59 has keys_to_helptext_exist_map => (
62 builder => '_build_keys_to_helptext_exist_map',
65 does_helptext_exist_for_key => 'get',
69 sub _build_keys_to_helptext_exist_map {
72 map { $_ => $self->_helptext_file_for_key_exists($_) }
73 $self->all_keys->flatten
78 has documented_keys => (
84 [ grep { $self->does_helptext_exist_for_key($_) } $self->all_keys->flatten ];
88 has_documented_keys => 'count',
92 has undocumented_keys => (
98 [ grep { ! $self->does_helptext_exist_for_key($_) } $self->all_keys->flatten ];
102 has_undocumented_keys => 'count',
107 isa => ArrayRef[Str],
110 builder => '_build_all_files',
113 sub _build_all_files {
115 my $filename_pattern = $self->filename_pattern;
120 my $filename = $File::Find::name;
121 return unless -f $filename;
122 return unless $filename =~ /$filename_pattern/;
123 push @files, $filename;
126 }, $self->template_search_dir->flatten);
130 sub _find_helptext_keys_in_fn {
131 my ($self, $fn) = @_;
132 my $dir = $self->template_search_dir;
134 my $t = Template->new({
135 INCLUDE_PATH => [ $self->template_search_dir ],
139 $t->process($fn, { help_text => sub { push @keys, shift } }, \$out);
140 return [ uniq @keys ];
143 sub _helptext_file_for_key_exists {
144 my ($self, $key) = @_;
145 my $file = $self->_get_file($key);
146 $file .= "." . $self->help_files_ext if defined($self->help_files_ext);
152 if ($self->has_undocumented_keys) {
153 print "Undocumented help text keys: \n";
154 print " - $_\n" for ($self->undocumented_keys->flatten);
162 __PACKAGE__->meta->make_immutable;
163 __PACKAGE__->new_with_options->run unless caller;
169 CatalystX::HelpText::Script::SearchUndocumentedHelpText
173 search_undocumented_templates.pl
179 =item L<CatalystX::HelpText>
185 Toomas Doran, C<< t0m at state51.co.uk >>
187 Cinxgler Mariaca Minda, C<< cinxgler at ci-info.com >>
191 Copyright Oscar Music and Media 2011.
195 This sofware is free software, and is licensed under the same terms as perl itself.