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;
17 default => 'CatalystX::HelpText::Finder::TemplateToolkit',
19 find_helptext_keys_in_fn => 'find_helptext_keys_in_fn',
23 has help_files_path => (
33 has template_search_dir => (
39 has filename_pattern => (
42 default => '\.(html|tt)$',
45 has help_files_ext => (
53 $self->print_result();
60 builder => '_build_all_keys',
65 [ uniq map { $self->_find_helptext_keys_in_fn($_)->flatten } $self->all_files->flatten ];
68 has keys_to_helptext_exist_map => (
71 builder => '_build_keys_to_helptext_exist_map',
74 does_helptext_exist_for_key => 'get',
78 sub _build_keys_to_helptext_exist_map {
81 map { $_ => $self->_helptext_file_for_key_exists($_) }
82 $self->all_keys->flatten
87 has documented_keys => (
93 [ grep { $self->does_helptext_exist_for_key($_) } $self->all_keys->flatten ];
97 has_documented_keys => 'count',
101 has undocumented_keys => (
102 isa => ArrayRef[Str],
107 [ grep { ! $self->does_helptext_exist_for_key($_) } $self->all_keys->flatten ];
111 has_undocumented_keys => 'count',
116 isa => ArrayRef[Str],
119 builder => '_build_all_files',
122 sub _build_all_files {
124 my $filename_pattern = $self->filename_pattern;
129 my $filename = $File::Find::name;
130 return unless -f $filename;
131 return unless $filename =~ /$filename_pattern/;
132 push @files, $filename;
135 }, $self->template_search_dir->flatten);
139 sub _find_helptext_keys_in_fn {
140 my ($self, $fn) = @_;
141 return $self->find_helptext_keys_in_fn($fn, $self);
144 sub _helptext_file_for_key_exists {
145 my ($self, $key) = @_;
146 my $file = $self->_get_file($key);
147 $file .= "." . $self->help_files_ext if defined($self->help_files_ext);
153 if ($self->has_undocumented_keys) {
154 print "Undocumented help text keys: \n";
155 print " - $_\n" for ($self->undocumented_keys->flatten);
163 __PACKAGE__->meta->make_immutable;
164 __PACKAGE__->new_with_options->run unless caller;
170 CatalystX::HelpText::Script::SearchUndocumentedHelpText
174 search_undocumented_templates.pl
180 =item L<CatalystX::HelpText>
186 Toomas Doran, C<< t0m at state51.co.uk >>
188 Cinxgler Mariaca Minda, C<< cinxgler at ci-info.com >>
192 Copyright Oscar Music and Media 2011.
196 This sofware is free software, and is licensed under the same terms as perl itself.