178 lines
3.4 KiB
Perl
178 lines
3.4 KiB
Perl
package Server::Toaster::Modules::Base;
|
|
|
|
use 5.006;
|
|
use strict;
|
|
use warnings;
|
|
use Template;
|
|
use Server::Toaster::Defaults;
|
|
use File::ShareDir ':ALL';
|
|
use File::Spec::Functions;
|
|
use Moose;
|
|
|
|
=head1 NAME
|
|
|
|
Server::Toaster::Modules::Apache - Apache helper for Server::Toaster
|
|
|
|
=head1 VERSION
|
|
|
|
Version 0.0.1
|
|
|
|
=cut
|
|
|
|
our $VERSION = '0.0.1';
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
Quick summary of what the module does.
|
|
|
|
Perhaps a little code snippet.
|
|
|
|
use Server::Toaster::Modules::Apache;
|
|
|
|
my $st = Server::Toaster->new();
|
|
|
|
=head1 METHODS
|
|
|
|
=head2 new
|
|
|
|
This initiates the module.
|
|
|
|
dir - The base dir to use. If not spoecified,
|
|
'stoaster' is used.
|
|
|
|
output - The output dir to use. If not specified,
|
|
$dir.'/output' is used.
|
|
|
|
templates - The template dir to use. If not specified,
|
|
$dir.'/templates' is used.
|
|
|
|
$templates and $output will be created as needed, but $dir must
|
|
exist upon module init or it will die.
|
|
|
|
=cut
|
|
|
|
sub new {
|
|
my ( $blank, %opts ) = @_;
|
|
|
|
# set the default dir if non is specified
|
|
if ( !defined( $opts{dir} ) ) {
|
|
$opts{dir} = 'stoaster';
|
|
}
|
|
|
|
# die if the base dir is not a directory or does not exist
|
|
if ( !-d $opts{dir} ) {
|
|
die '"' . $opts{dir} . '" does not exist or is not a directory';
|
|
}
|
|
|
|
# set the default output dir if non is specified
|
|
if ( !defined( $opts{output} ) ) {
|
|
$opts{output} = catdir( $opts{dir}, 'output' );
|
|
}
|
|
|
|
# set the default template dir if non is specified
|
|
if ( !defined( $opts{templates} ) ) {
|
|
$opts{templates} = catdir($opts{dir} , 'templates');
|
|
}
|
|
|
|
# init the object
|
|
my $self = {
|
|
dir => $opts{dir},
|
|
output => $opts{output},
|
|
templates => $opts{templates},
|
|
share => dist_dir('Server-Toaster'),
|
|
};
|
|
bless $self;
|
|
|
|
return $self;
|
|
}
|
|
|
|
=head2 get_files_module
|
|
|
|
Fetches a list of templates a module uses.
|
|
|
|
The returned value is a hash with the keys being the template names
|
|
and the value being the full path to the file.
|
|
|
|
=cut
|
|
|
|
sub get_files {
|
|
my ($self) = @_;
|
|
|
|
my @files=$self->get_files_module;
|
|
|
|
my $share_dir = dist_dir('Server-Toaster');
|
|
|
|
my %to_return;
|
|
foreach my $file (@files) {
|
|
my @split_path=split(/\//, $file);
|
|
$to_return{$file}={
|
|
rel=>catfile(@split_path),
|
|
share=>catfile($share_dir, @split_path),
|
|
};
|
|
|
|
my $use_test=catfile( $self->{templates}, @split_path );
|
|
if (-f $use_test ) {
|
|
$to_return{$file}{use}=$use_test;
|
|
}else {
|
|
$to_return{$file}{use}=$to_return{$file}{share};
|
|
}
|
|
}
|
|
|
|
return %to_return;
|
|
}
|
|
|
|
=head1 AUTHOR
|
|
|
|
Zane C. Bowers-Hadley, C<< <vvelox at vvelox.net> >>
|
|
|
|
=head1 BUGS
|
|
|
|
Please report any bugs or feature requests to C<bug-server-toaster at rt.cpan.org>, or through
|
|
the web interface at L<https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Server-Toaster>. 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 Server::Toaster
|
|
|
|
|
|
You can also look for information at:
|
|
|
|
=over 4
|
|
|
|
=item * RT: CPAN's request tracker (report bugs here)
|
|
|
|
L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=Server-Toaster>
|
|
|
|
=item * CPAN Ratings
|
|
|
|
L<https://cpanratings.perl.org/d/Server-Toaster>
|
|
|
|
=item * Search CPAN
|
|
|
|
L<https://metacpan.org/release/Server-Toaster>
|
|
|
|
=back
|
|
|
|
|
|
=head1 ACKNOWLEDGEMENTS
|
|
|
|
|
|
=head1 LICENSE AND COPYRIGHT
|
|
|
|
This software is Copyright (c) 2021 by Zane C. Bowers-Hadley.
|
|
|
|
This is free software, licensed under:
|
|
|
|
The Artistic License 2.0 (GPL Compatible)
|
|
|
|
|
|
=cut
|
|
|
|
1; # End of Server::Toaster
|