view release on metacpan or  search on metacpan

lib/Alien/Ditaa.pm  view on Meta::CPAN

package Alien::Ditaa;
use Moose;
use Method::Signatures::Simple;
use File::ShareDir qw/module_dir/;
use Path::Class qw/dir file/;
use File::Which qw/which/;
use IPC::Run qw/run/;
use namespace::autoclean;

our $VERSION = '0.002';
$VERSION = eval $VERSION;

method get_installed_dir {
    return dir( module_dir('Alien::Ditaa') );
}

method get_jar {
    file( $self->get_installed_dir, 'ditaa0_9.jar' );
}

has last_run_output => (
    is => 'ro',
    writer => '_set_last_run_output',
);

method run_ditaa {
    my $java = which 'java';
    my $out;
    run [$java, '-jar', $self->get_jar, @_], \undef, \$out;
    my $exit = $? >> 8;
    $self->_set_last_run_output($out);
    return $exit;
}

__PACKAGE__->meta->make_immutable;

=head1 NAME

Alien::Ditaa - Use the ditaa text to diagram package in perl

=head1 SYNOPSIS

    use Alien::Ditaa;
    my $ditaa = Alien::Ditaa->new;
    $ditaa->run_ditaa($input_fn, $output_dn, @args);

=head1 DESCRIPTION

Trivial wrapper to run ditaa from perl.

=head1 METHODS

=head2 run_ditaa ($input_fn, $output_fn, [@args])

Runs ditaa on the input file to produce an output png.

See the ditaa documentation for additional arguments you
may want (but probably don't).

Returns the exit status of the java process (i.e. 0 for success)

=head2 last_run_output

The STDOUT of the child java process running ditaa for the last
call to the C<< run_ditaa >> method. This is not normally useful
except as information to help debug the problem when a run
fails.

=head1 SEE ALSO

L<http://ditaa.sourceforge.net>

=head1 INCLUDED SOFTWARE

An unmodified copy of the latest varion of ditaa.jar is included in
this package. The latest version and source code can be obtained
from the URI above.

=head1 AUTHOR

    Tomas Doran (t0m) C< bobtfish@bobtfish.net >

=head1 COPYRIGHT

Copyright 2009 state51 (L<http://www.state51.co.uk>)

=head1 LICENSE

Licensed under the terms of the GNU GPL.

=cut