MooseX::App::Cmd::Command - Base class for L<MooseX::Getopt> based L<App::Cmd::Command>s.

MooseX-App-Cmd documentation Contained in the MooseX-App-Cmd distribution.

Index

Code Index:

NAME

Top

MooseX::App::Cmd::Command - Base class for MooseX::Getopt based App::Cmd::Commands.

SYNOPSIS

Top

    use Moose;

    extends qw(MooseX::App::Cmd::Command);

    # no need to set opt_spec
    # see MooseX::Getopt for documentation on how to specify options
    has option_field => (
        isa => "Str",
        is  => "rw",
        required => 1,
    );

    sub execute {
        my ( $self, $opts, $args ) = @_;

        print $self->option_field; # also available in $opts->{option_field}
    }

DESCRIPTION

Top

This is a replacement base class for App::Cmd::Command classes that includes MooseX::Getopt and the glue to combine the two.

METHODS

Top

_process_args

Replaces App::Cmd::Command's argument processing in in favour of MooseX::Getopt based processing.

TODO

Top

Full support for Getopt::Long::Descriptive's abilities is not yet written.

This entails taking apart the attributes and getting at the descriptions.

This might actually be added upstream to MooseX::Getopt, so until we decide here's a functional but not very helpful (to the user) version anyway.

MooseX-App-Cmd documentation Contained in the MooseX-App-Cmd distribution. 
#!/usr/bin/perl

package MooseX::App::Cmd::Command;
use Moose;

with qw/MooseX::Getopt/;

extends qw(Moose::Object App::Cmd::Command);

with qw(MooseX::Getopt);

use Getopt::Long::Descriptive ();

has usage => (
    metaclass => "NoGetopt",
    isa => "Object",
    is  => "ro",
    required => 1,
);

has app => (
    metaclass => "NoGetopt",
    isa => "MooseX::App::Cmd",
    is  => "ro",
    required => 1,
);

sub _process_args {
    my ( $class, $args, @params ) = @_;
    local @ARGV = @$args;

    my $config_from_file;
    if($class->meta->does_role('MooseX::ConfigFromFile')) {
        local @ARGV = @ARGV;

        my $configfile;
        my $opt_parser = Getopt::Long::Parser->new( config => [ qw( pass_through
 ) ] );
        $opt_parser->getoptions( "configfile=s" => \$configfile );        if(!defined $configfile) {
            my $cfmeta = $class->meta->find_attribute_by_name('configfile');
            $configfile = $cfmeta->default if $cfmeta->has_default;
        }

        if(defined $configfile) {
            $config_from_file = $class->get_config_from_file($configfile);
        }
    }

    my %processed = $class->_parse_argv(
        params => { argv => \@ARGV },
        options => [ $class->_attrs_to_options( $config_from_file ) ],
    );

    return (
        $processed{params},
        $processed{argv},
        usage => $processed{usage},
        # params from CLI are also fields in MooseX::Getopt
        %{ $config_from_file ?
            { %$config_from_file, %{$processed{params}} } :
            $processed{params} },
    );
}

sub _usage_format {
    my $class = shift;
    $class->usage_desc();
}

__PACKAGE__;

__END__