Any::Template::ProcessDir - Process a directory of templates


Any-Template-ProcessDir documentation Contained in the Any-Template-ProcessDir distribution.

Index


Code Index:

NAME

Top

Any::Template::ProcessDir -- Process a directory of templates

VERSION

Top

version 0.03

SYNOPSIS

Top

    use Any::Template::ProcessDir;

    my $pd = Any::Template::ProcessDir->new(
        source_dir   => '/path/to/source/dir',
        dest_dir     => '/path/to/dest/dir',
        process_text => sub {
            my $template = Any::Template->new( Backend => '...', String => $_[0] );
            $template->process({ ... });
        }
    );
    $pd->process_dir();

    # or

    my $pd = Any::Template::ProcessDir->new(
        source_dir   => '/path/to/source/dir',
        dest_dir     => '/path/to/dest/dir',
        process_text => sub {
            my $file = $_[0];
            # do something with $file, return content
        }
    );
    $pd->process_dir();

DESCRIPTION

Top

Recursively processes a directory of templates, generating a parallel directory of result files. Each file in the source directory may be template-processed, copied, or ignored depending on its pathname.

CONSTRUCTOR

Top

Required parameters:

source_dir

Directory containing the template files.

dest_dir

Directory where you want to generate result files.

Plus one of these:

process_file

A code reference that takes a single argument, the full template filename, and returns the result string. This can use Any::Template or another method altogether.

process_text

A code reference that takes a single argument, the template text, and returns the result string. This can use Any::Template or another method altogether.

Optional parameters:

dir_create_mode

Permissions mode to use when creating destination directories. Defaults to 0775.

file_create_mode

Permissions mode to use when creating destination files. Defaults to 0444 (read-only), so that destination files are not accidentally edited.

ignore_files

Coderef which takes a full pathname and returns true if the file should be ignored. By default, all files will be considered.

readme_filename

Name of a README file to generate in the destination directory - defaults to "README".

template_file_suffix

Suffix of template files in source directory. Defaults to ".src". This will be removed from the destination file name.

Any file in the source directory that does not have this suffix (or ignore_file_suffix) will simply be copied to the destination.

METHODS

Top

process_dir

Process the directory. The destination directory will be removed completely and recreated, to eliminate any old files from previous processing.

SEE ALSO

Top

Any::Template

COPYRIGHT AND LICENSE

Top


Any-Template-ProcessDir documentation Contained in the Any-Template-ProcessDir distribution.

package Any::Template::ProcessDir;
BEGIN {
  $Any::Template::ProcessDir::VERSION = '0.03';
}
use 5.006;
use File::Basename;
use File::Find::Wanted;
use File::Path qw(make_path remove_tree);
use File::Slurp qw(read_file write_file);
use File::Spec::Functions qw(catfile catdir);
use Moose;
use Moose::Util::TypeConstraints;
use Try::Tiny;
use strict;
use warnings;

has 'dest_dir'             => ( is => 'ro', required => 1 );
has 'dir_create_mode'      => ( is => 'ro', isa => 'Int', default => oct(775) );
has 'file_create_mode'     => ( is => 'ro', isa => 'Int', default => oct(444) );
has 'ignore_files'         => ( is => 'ro', isa => 'CodeRef', default => sub { sub { 0 } } );
has 'process_file'         => ( is => 'ro', isa => 'CodeRef', default => sub { \&_default_process_file } );
has 'process_text'         => ( is => 'ro', isa => 'CodeRef', default => sub { \&_default_process_text } );
has 'readme_filename'      => ( is => 'ro', default => 'README' );
has 'source_dir'           => ( is => 'ro', required => 1 );
has 'template_file_suffix' => ( is => 'ro', default => '.src' );

sub process_dir {
    my ($self) = @_;

    my $source_dir = $self->source_dir;
    my $dest_dir   = $self->dest_dir;
    remove_tree($dest_dir);
    die "could not remove '$dest_dir'" if -d $dest_dir;

    my $ignore_files = $self->ignore_files;
    my @source_files =
      find_wanted( sub { -f && !$ignore_files->($_) }, $source_dir );
    my $template_file_suffix = $self->template_file_suffix;

    foreach my $source_file (@source_files) {
        $self->generate_dest_file($source_file);
    }

    $self->generate_readme();
    try { $self->generate_source_symlink() };
}

sub generate_dest_file {
    my ( $self, $source_file ) = @_;

    my $template_file_suffix = $self->template_file_suffix;
    my $template_file_regex =
      defined($template_file_suffix) ? qr/\Q$template_file_suffix\E$/ : qr/.|/;

    substr( ( my $dest_file = $source_file ), 0, length( $self->source_dir ) ) =
      $self->dest_dir;

    my $dest_text;
    if ( $source_file =~ $template_file_regex ) {
        $dest_file =
          substr( $dest_file, 0,
            -1 * length( $self->template_file_suffix || '' ) );
        my $code = $self->process_file;
        $dest_text = $code->( $source_file, $self );
    }
    else {
        $dest_text = read_file($source_file);
    }

    die "$dest_file already exists!" if -f $dest_file;

    make_path( dirname($dest_file) );
    chmod( $self->dir_create_mode(), dirname($dest_file) )
      if defined( $self->dir_create_mode() );

    write_file( $dest_file, $dest_text );
    chmod( $self->file_create_mode(), $dest_file )
      if defined( $self->file_create_mode() );
}

sub _default_process_file {
    my ( $file, $self ) = @_;

    my $code = $self->process_text;
    return $code->( read_file($file), $self );
}

sub _default_process_text {
    my ( $text, $self ) = @_;

    return $text;
}

sub generate_readme {
    my $self = shift;

    my $readme_file = catfile( $self->dest_dir, $self->readme_filename );
    if ( defined($readme_file) ) {
        unlink($readme_file);
        write_file(
            $readme_file,
            "Files in this directory generated from "
              . $self->source_dir . ".\n",
            "Do not edit files here, as they will be overwritten. Edit the source instead!"
        );
    }
}

sub generate_source_symlink {
    my $self = shift;

    # Create symlink from dest dir back to source dir.
    #
    my $source_link = catdir( $self->dest_dir, "source" );
    unlink($source_link) if -e $source_link;
    symlink( $self->source_dir, $source_link );
}

1;




__END__