Al Newkirk > SweetPea-Cli-0.08 > App::Rad::Plugin::Abbrev

Download:
SweetPea-Cli-0.08.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

App::Rad::Plugin::Abbrev - Abbreviate your App::Rad commands

VERSION ^

Version 0.01

SYNOPSIS ^

myapp.pl:

    use App::Rad qw(Abbrev);
    App::Rad->run;

        sub mycmd { return "Hello!" }

And from the command line:

    > ./myapp.pl m
        Hello!
        > ./myapp.pl my
        Hello!
        > ./myapp.pl myc
        Hello!
        > ./myapp.pl mycm
        Hello!
        > ./myapp.pl mycmd
        Hello!

DESCRIPTION ^

This plugin lets you abbreviate your command names when calling them (as long as there is no ambiguity - see below). This is useful when you have a long command name and not too much patience to type it :)

$c->execute( COMMAND_NAME );

This plugin overrides Rad's execute method. The new one will work exactly like the former, but will expand abbreviated command names whenever they are ambiguous.

Suppose you have:

   sub command  { ... }
   sub command2 { ... }
   sub yet_another_command { ... }

This is the expected behavior:

   $c->execute('yet');     # same as $c->execute('yet_another_command')
   $c->execute('com');     # ambiguous call, so falls to invalid command
   $c->execute('command'); # not ambiguous, as it's a direct hit

$c->get_commands_like( ABBREVIATED_COMMAND_NAME )

This plugin also creates a new method that returns a list of valid commands that expand from the given abbreviation. If no commands match, returns an empty list.

AUTHOR ^

Breno G. de Oliveira, <garu at cpan.org>

ACKNOWLEDGEMENTS ^

Many thanks go to Andre Ramoni for suggesting this plugin, Gabriel Vieira for discussing the API and to Fernando Correa for some internals' discussion as well.

LICENSE AND COPYRIGHT ^

Copyright 2008 Breno G. de Oliveira <garu at cpan.org>. All rights reserved.

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

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: