webgui/lib/WGDev/Command/Dist.pm

package WGDev::Command::Dist;
# ABSTRACT: Create a distribution file for WebGUI
use strict;
use warnings;
use 5.008008;

use parent qw(WGDev::Command::Base);

use File::Spec ();

sub config_options {
    return (
        shift->SUPER::config_options, qw(
            buildDir|b=s
            ) );
}

sub needs_config {
    return;
}

sub process {
    my $self = shift;
    my $wgd  = $self->wgd;
    require File::Temp;
    File::Temp->VERSION(0.19); ##no critic (ProhibitMagicNumbers)
    require File::Copy;
    require Cwd;

    my ( $version, $status ) = $wgd->version->module;
    my $build_dir = $self->option('buildDir');
    my $build_root;
    if ($build_dir) {
        $build_root = $build_dir;
        mkdir $build_root;
    }
    if ( $build_root && !-e $build_root ) {
        $build_root = File::Temp->newdir;
    }
    my $build_webgui = File::Spec->catdir( $build_root, 'WebGUI' );
    my $build_docs   = File::Spec->catdir( $build_root, 'api' );
    my $cwd          = Cwd::cwd();

    mkdir $build_webgui;
    $self->export_files($build_webgui);
    my $inst_dir = $build_dir || $cwd;
    if ( !fork ) {
        chdir $build_root;
        exec 'tar', 'czf',
            File::Spec->catfile( $inst_dir,
            "webgui-$version-$status.tar.gz" ),
            'WebGUI';
    }
    wait;

    mkdir $build_docs;
    $self->generate_docs($build_docs);
    if ( !fork ) {
        chdir $build_root;
        exec 'tar', 'czf',
            File::Spec->catfile(
            $inst_dir, "webgui-api-$version-$status.tar.gz"
            ),
            'api';
    }
    wait;
    return 1;
}

sub export_files {
    my $self    = shift;
    my $to_root = shift;
    my $from    = $self->wgd->root;

    if ( -e File::Spec->catdir( $from, '.git' ) ) {
        system 'git', '--git-dir=' . File::Spec->catdir( $from, '.git' ),
            'checkout-index', '-a', '--prefix=' . $to_root . q{/};
    }
    elsif ( -e File::Spec->catdir( $from, '.svn' ) ) {
        system 'svn', 'export', $from, $to_root;
    }
    else {
        system 'cp', '-r', $from, $to_root;
    }

    for my $file (
        [ 'docs', 'previousVersion.sql' ],
        [ 'etc',  '*.conf' ],
        [ 'sbin', 'preload.custom' ],
        [ 'sbin', 'preload.exclude' ] )
    {
        my $file_path = File::Spec->catfile( $to_root, @{$file} );
        for my $file ( glob $file_path ) {
            unlink $file;
        }
    }
    return $to_root;
}

sub generate_docs {
    my $self    = shift;
    my $to_root = shift;
    my $from    = $self->wgd->root;
    require File::Find;
    require File::Path;
    require Pod::Html;
    require File::Temp;
    File::Temp->VERSION(0.19); ##no critic (ProhibitMagicNumbers)
    my $code_dir = File::Spec->catdir( $from, 'lib', 'WebGUI' );
    my $temp_dir = File::Temp->newdir;
    File::Find::find( {
            no_chdir => 1,
            wanted   => sub {
                no warnings 'once';
                my $code_file = $File::Find::name;
                return
                    if -d $code_file;
                my $doc_file = $code_file;
                return
                    if $doc_file =~ /\b\QOperation.pm\E$/msx;
                return
                    if $doc_file !~ s/\Q.pm\E$/.html/msx;
                $doc_file = File::Spec->rel2abs(
                    File::Spec->abs2rel( $doc_file, $code_dir ), $to_root );
                my $directory = File::Spec->catpath(
                    ( File::Spec->splitpath($doc_file) )[ 0, 1 ] );
                File::Path::mkpath($directory);
                Pod::Html::pod2html(
                    '--quiet',
                    '--noindex',
                    '--infile=' . $code_file,
                    '--outfile=' . $doc_file,
                    '--cachedir=' . $temp_dir,
                );
            },
        },
        $code_dir
    );
    return $to_root;
}

1;

=head1 SYNOPSIS

    wgd dist [-c] [-d] [-b /data/builds]

=head1 DESCRIPTION

Generates distribution files containing WebGUI or the WebGUI API.

=head1 OPTIONS

By default, generates both a code and API documentation package.

=over 8

=item C<-c> C<--code>

Generates a code distribution

=item C<-d> C<--documentation>

Generates an API documentation distribution

=item C<-b> C<--buildDir>

Install the directories and tarballs in a different location.  If no build directory
is specified, it will create a temp file.

=back

=method C<export_files ( $directory )>

Exports the WebGUI root directory, excluding common site specific files, to
the specified directory.

=method C<generate_docs ( $directory )>

Generate API documentation for WebGUI using Pod::Html in the specified
directory.

=cut