package Toader::Render::AutoDoc;
use warnings;
use strict;
use base 'Error::Helper';
use Toader::Render::General;
use Toader::Templates;
use Date::Parse;
use Toader::Render::AutoDoc::Cleanup;
use Toader::pathHelper;
use File::Path qw(make_path);
use Pod::Simple::HTML;
use File::Copy;
use Script::isAperlScript;
=head1 NAME
Toader::Render::AutoDoc - This renders a Toader::AutoDoc object.
=head1 VERSION
Version 0.2.1
=cut
our $VERSION = '0.2.1';
=head1 SYNOPSIS
=head1 METHODS
=head2 new
This initiates the object.
=head3 args hash ref
=head4 obj
This is the L<Toader::AutoDoc> object to render.
=head4 toader
This is the L<Toader> object to use.
=head2 toDir
This is the value used to get from the directory it is being
rendered in back to directory storing stuff for that directory. By
default this is '../'.
my $foo=Toader::Render::AutoDoc->new(\%args);
if($foo->error){
warn('error: '.$foo->error.":".$foo->errorString);
}
=cut
sub new{
my %args;
if(defined($_[1])){
%args= %{$_[1]};
};
my $self={
error=>undef,
errorString=>'',
perror=>undef,
toDir=>'../',
errorExtra=>{
flags=>{
1=>'noObj',
2=>'noToaderObj',
3=>'objPerror',
4=>'toaderObjPerror',
5=>'noDirSet',
6=>'cleanupNewErrored',
7=>'cleanupErrored',
8=>'fileListFailed',
9=>'pathhelperNewErrored',
11=>'noOutputDirSet',
12=>'outputDirDoesNotExist',
13=>'outputPageDirCreationFailed',
14=>'outputFileDirCreationFailed',
15=>'makePathFailed',
16=>'copyFailed',
},
},
};
bless $self;
if ( defined( $args{toDir} ) ){
$self->{toDir}=$args{toDir};
}
#make sure we have a Toader::AutoDoc object.
if ( ! defined( $args{obj} ) ){
$self->{perror}=1;
$self->{error}=1;
$self->{errorString}='Nothing defined for the Toader::AutoDoc object';
$self->warn;
return $self;
}
if ( ref( $args{obj} ) ne 'Toader::AutoDoc' ){
$self->{perror}=1;
$self->{error}=1;
$self->{errorString}='The specified object is not a Toader::AutoDoc object, but a "'.
ref( $args{obj} ).'"';
$self->warn;
return $self;
}
$self->{obj}=$args{obj};
#make sure the object does not have a permanent error set
if( ! $self->{obj}->errorblank ){
$self->{perror}=1;
$self->{error}=3;
$self->{errorString}='The Toader::AutoDoc object has a permanent error set';
$self->warn;
return $self;
}
#make sure a Toader object is given
if ( ! defined( $args{toader} ) ){
$self->{perror}=1;
$self->{error}=2;
$self->{errorString}='Nothing defined for the Toader object';
$self->warn;
return $self;
}
if ( ref( $args{toader} ) ne 'Toader' ){
$self->{perror}=1;
$self->{error}=2;
$self->{errorString}='The specified object is not a Toader object, but a "'.
ref( $args{toader} ).'"';
$self->warn;
return $self;
}
$self->{toader}=$args{toader};
#make sure the object does not have a permanent error set
if( ! $self->{toader}->errorblank ){
$self->{perror}=1;
$self->{error}=4;
$self->{errorString}='The Toader object has a permanent error set';
$self->warn;
return $self;
}
#make sure a directory is set
if( ! defined( $self->{obj}->dirGet ) ){
$self->{perror}=1;
$self->{error}=5;
$self->{errorString}='The Toader::AutoDoc object does not have a directory set';
$self->warn;
return $self;
}
$self->{dir}=$self->{obj}->dirGet;
#initialize this here for simplicity
$self->{t}=Toader::Templates->new({
dir=>$self->{obj}->dirGet,
toader=>$args{toader},
});
#initialize the general object here for simplicity
$self->{g}=Toader::Render::General->new(
{
toader=>$self->{toader},
self=>\$self,
obj=>$self->{obj},
toDir=>$self->{toDir},
}
);
if ( $self->{g}->error ){
$self->{perror}='';
}
#initialize the Toader::pathHelper
$self->{ph}=Toader::pathHelper->new( $self->{dir} );
if ( $self->{ph}->error ){
$self->{perror}=1;
$self->{error}=6;
$self->{errorString}='Failed to initiate pathHelper. error="'.
$self->{ph}->error.'" errorString="'.$self->{ph}->errorString.'"';
$self->warn;
return $self;
}
#gets the r2r for the object
$self->{r2r}=$self->{ph}->relative2root( $self->{dir} );
if ( $self->{ph}->error ){
$self->{perror}=1;
$self->{error}=19;
$self->{errorString}='pathHelper failed to find the relative2root path for "'.
$self->{odir}.'"';
$self->warn;
return $self;
}
return $self;
}
=head2 content
This renders the content to be included in a static page.
my $content=$foo->content;
=cut
sub content{
my $self=$_[0];
if ( ! $self->errorblank ){
return undef;
}
my $content=$self->{t}->fill_in( 'autodocContent',
{
g=>\$self->{g},
toader=>\$self->{toader},
self=>\$self,
obj=>\$self->{obj},
c=>\$self->{toader}->getConfig,
});
if ( $self->{t}->error ){
$self->{error}=8;
$self->{errorString}='Filling in the template failed. error="'.
$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
$self->warn;
return undef;
}
return $content;
}
=head2 render
This renders the object.
No arguments are taken.
=cut
sub render{
my $self=$_[0];
if ( ! $self->errorblank ){
return undef;
}
#makes sure we have a output directory set...
#while we don't care about this for rendering the content, we do need to
#know this for actually fully rendering it
my $output=$self->{toader}->getOutputDir;
if ( ! defined( $output ) ){
$self->{error}=11;
$self->{errorString}='No output directory has been set for the Toader object';
$self->warn;
return undef;
}
#makes sure the output directory exists
if ( ! -d $output ){
$self->{error}=12;
$self->{errorString}='The output directory, "'.$output.'", does not exist';
$self->warn;
return undef;
}
#clean up the old page
my $cleanup=Toader::Render::AutoDoc::Cleanup->new( $self->{toader} );
if ( $cleanup->error ){
$self->{error}=6;
$self->{errorString}='Initialing the cleanup module failed. error="'.
$cleanup->error.'" errorString="'.$cleanup->errorString.'"';
$self->warn;
return undef;
}
$cleanup->cleanup( $self->{obj} );
if ( $cleanup->error ){
$self->{error}=7;
$self->{errorString}='Cleanup failed. error="'.$cleanup->error.
'" errorString="'.$cleanup->errorString.'"';
$self->warn;
return undef;
}
#this renders the content of it
my $content=$self->content;
if ( $self->error ){
$self->warnString('Failed to render the content to include');
return undef;
}
my $page=$self->{t}->fill_in( 'page',
{
toader=>\$self->{toader},
g=>\$self->{g},
self=>\$self,
obj=>\$self->{obj},
c=>\$self->{toader}->getConfig,
content=>$content,
});
if ( $self->{t}->error ){
$self->{error}=8;
$self->{errorString}='Filling in the template failed. error="'.
$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
$self->warn;
return undef;
}
#put together some paths for later use
my $autodocDir=$output.'/'.$self->{r2r}.'/.autodoc/';
my $index=$autodocDir.'/index.html';
my $filesDir=$autodocDir.'/.files';
#make sure the files and entry directory exist
if ( ! -d $autodocDir ){
if ( ! make_path( $autodocDir ) ){
$self->{error}=13;
$self->{errorString}='The output entry directry, "'.$autodocDir.'", could not be created';
$self->warn;
return undef;
}
}
if ( ! -d $filesDir ){
if ( ! make_path( $filesDir ) ){
$self->{error}=14;
$self->{errorString}='The output file directry, "'.$filesDir.'", could not be created';
$self->warn;
return undef;
}
}
#write the index out
my $fh;
if ( ! open( $fh, '>', $index ) ){
$self->{error}=15;
$self->{errorString}='Failed to open the index, "'.$index.'", for writing';
$self->warn;
return undef;
}
print $fh $page;
close( $fh );
#gets a list of documents
my @files=$self->{obj}->findDocs;
if ( $self->{obj}->error ){
$self->{error}=8;
$self->{errorString}='Failed to get a list of the documents';
$self->warn;
return undef;
}
#copy them all over
my $int=0;
while ( defined( $files[$int] ) ){
my $copyFrom=$self->{dir}.'/'.$files[$int];
my $copyTo=$filesDir.'/'.$files[$int];
#append .html for POD docs
my $ispod=0;
my $checker=Script::isAperlScript->new({
any=>1,
env=>1,
});
if ( $copyTo =~ /\.[Pp][Oo][Dd]$/ ){
$ispod='1';
}
if ( $copyTo =~ /\.[Pp][Mm]$/ ){
$ispod='1';
}
if ( $checker->isAperlScript( $copyFrom ) ){
$ispod='1';
}
#make sure the directory exists
my $outputdir=$copyTo;
my $outputdirTest=$copyTo;
$outputdirTest=~s/.*\///;
$outputdir=~s/$outputdirTest$//;
if ( ! -d $outputdir ){
if ( ! make_path( $outputdir ) ){
$self->{error}=15;
$self->{errorString}='make_path for "'.$outputdir.'" failed';
$self->warn;
return undef;
}
}
if ( $ispod ){
#handles it if it is a pod
$copyTo=$copyTo.'.html';
#convert to HTML from POD
my $p2h=Pod::Simple::HTML->new;
$p2h->index(1);
my $html;
$p2h->output_string(\$html);
$p2h->parse_file($copyFrom);
#open the $copyTo and write it out
my $fh;
if ( ! open( $fh, '>', $copyTo ) ){
$self->{error}=16;
$self->{errorString}='Failed to open "'.$copyTo.'"';
$self->warn;
return undef;
}
print $fh $html;
close( $fh );
}else{
#copy it
if ( ! copy( $copyFrom, $copyTo ) ){
$self->{error}=16;
$self->{errorString}='Failed to copy "'.$copyFrom.'" to "'.$copyTo.'"';
$self->warn;
return undef;
}
}
$int++;
}
return 1;
}
=head1 ERROR CODES
=head2 1, noObj
No L<Toader::AutoDoc> object specified.
=head2 2, noToaderObj
No L<Toader> object specified.
=head2 3, objPerror
The L<Toader::AutoDoc> object has a permanent error set.
=head2 4, toaderObjPerror
The L<Toader> object has a permanent error set.
=head2 5, noDirSet
The L<Toader::AutoDoc> object does not have a directory set
=head2 6, cleanupNewErrored
Failed to initialize the cleanup module.
=head2 7, cleanupErrored
Failed to cleanup.
=head2 8, fileListFailed
Failed to get a list of files.
=head2 9, pathhelperNewErrored
Failed to initialize the path helper.
=head2 11, noOutputDirSet
The L<Toader> object does not have a output directory set.
=head2 12, outputDirDoesNotExist
The output directory does not exist.
=head2 13, outputPageDirCreationFailed
The output page directory could not be created.
=head2 14, outputFileDirCreationFailed
The output file directory could not be created.
=head2 15, makePathFailed
make_path failed.
=head2 16, copyFailed
Failed to copy the HTML produced from the POD to where it belongs.
=head1 AUTHOR
Zane C. Bowers-Hadley, C<< <vvelox at vvelox.net> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-toader at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Toader>. I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Toader::Render::AutoDoc
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Toader>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Toader>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Toader>
=item * Search CPAN
L<http://search.cpan.org/dist/Toader/>
=back
=head1 ACKNOWLEDGEMENTS
=head1 LICENSE AND COPYRIGHT
Copyright 2013. Zane C. Bowers-Hadley.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut
1; # End of Toader::Render::AutoDoc