NAME

App::CLI::Extension - for App::CLI extension module

VERSION

0.6

SYNOPSIS

# MyApp.pm
package MyApp;

use strict;
use base qw(App::CLI::Extension);

# extension method
# load App::CLI::Plugin::Foo,  MyApp::Plugin::Bar
__PACKAGE__->load_plugins(qw(Foo +MyApp::Plugin::Bar));

# extension method
__PACKAGE__->config( name => "kurt");

1;

# MyApp/Hello.pm
package MyApp::Hello;

use strict;
use base qw(App::CLI::Command);
use constant options => ("age=i" => "age");

sub run {

    my($self, @args) = @_;
    # config - App::CLI::Extension extension method(App::CLI::Extension::Component::Config)
    print "Hello! my name is " . $self->config->{name} . "\n";
    print "age is " . "$self->{age}\n";
}

# myapp
#!/usr/bin/perl

use strict;
use MyApp;

MyApp->dispatch;

# execute
[kurt@localhost ~] myapp hello --age=27
Hello! my name is kurt
age is 27

DESCRIPTION

The expansion module which added plug in, initial setting mechanism to App::CLI

App::CLI::Extension::Component::* modules is automatic, and it is done require

(It is now Config and Stash is automatic, and it is done require)

METHOD

load_plugins

auto load and require plugin modules

Example

# MyApp.pm
# MyApp::Plugin::GoodMorning and App::CLI::Plugin::Config::YAML::Syck require
__PACKAGE__->load_plugins(qw(+MyApp::Plugin::GoodMorning Config::YAML::Syck));

# MyApp/Plugin/GoodMorning.pm
package MyApp::Plugin::GoodMorning;

use strict;

sub good_morning {

    my $self = shift;
    print "Good monring!\n";
}

# MyApp/Hello.pm
package MyApp::Hello;

use strict;
use base qw(App::CLI::Command);

sub run {

    my($self, @args) = @_;
    $self->good_morning;
}

# myapp
#!/usr/bin/perl

use strict;
use MyApp;

MyApp->dispatch;

# execute
[kurt@localhost ~] myapp hello
Good morning!

config

configuration method

Example

# MyApp.pm
__PACKAGE__->config(
               name           => "kurt",
               favorite_group => "nirvana",
               favorite_song  => ["Lounge Act", "Negative Creep", "Radio Friendly Unit Shifter", "You Know You're Right"]
            );

# MyApp/Hello.pm
package MyApp::Hello;

use strict;
use base qw(App::CLI::Command);

sub run {

    my($self, @args) = @_;
    print "My name is " . $self->config->{name} . "\n";
    print "My favorite group is " . $self->config->{favorite_group} . "\n";
    print "My favorite song is " . join(",", @{$self->config->{favorite_song}});
    print " and Smells Like Teen Spirit\n"
}

# myapp
#!/usr/bin/perl

use strict;
use MyApp;

MyApp->dispatch;

# execute
[kurt@localhost ~] myapp hello
My name is kurt
My favorite group is nirvana
My favorite song is Lounge Act,Negative Creep,Radio Friendly Unit Shifter,You Know You're Right and Smells Like Teen Spirit

COMPONENT METHOD

setup

for component and plugin function

stash

like global variable in Command package

Example:

# MyApp/Hello.pm
package MyApp::Hello;
use strict;
use feature ":5.10.0";
use base qw(App::CLI::Command);
   
sub run {

    my($self, @args) = @_;
    $self->stash->{name} = "kurt";
    say "stash value: " . $self->stash->{name};
}

1;

SEE ALSO

App::CLI Class::Data::Accessor UNIVERSAL::require

AUTHOR

Akira Horimoto

COPYRIGHT AND LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Copyright (C) 2009 Akira Horimoto

cpanm App::CLI::Extension

perl -MCPAN -e shell
install App::CLI::Extension