MouseX::Getopt::Meta::Attribute::Trait - Optional meta attribute trait for custom option names

MouseX-Getopt documentation Contained in the MouseX-Getopt distribution.

Index

Code Index:

NAME

Top

MouseX::Getopt::Meta::Attribute::Trait - Optional meta attribute trait for custom option names

SYNOPSIS

Top

  package App;
  use Mouse;

  with 'MouseX::Getopt';

  has 'data' => (
      traits    => [ 'Getopt' ],
      is        => 'ro',
      isa       => 'Str',
      default   => 'file.dat',

      # tells MouseX::Getopt to use --somedata as the
      # command line flag instead of the normal
      # autogenerated one (--data)
      cmd_flag  => 'somedata',

      # tells MouseX::Getopt to also allow --moosedata,
      # -m, and -d as aliases for this same option on
      # the commandline.
      cmd_aliases => [qw/ moosedata m d /],

      # Or, you can use a plain scalar for a single alias:
      cmd_aliases => 'm',
  );

DESCRIPTION

Top

This is a custom attribute metaclass trait which can be used to specify a the specific command line flag to use instead of the default one which MouseX::Getopt will create for you.

METHODS

Top

cmd_flag

Changes the commandline flag to be this value, instead of the default, which is the same as the attribute name.

cmd_aliases

Adds more aliases for this commandline flag, useful for short options and such.

has_cmd_flag

has_cmd_aliases

AUTHORS

Top

COPYRIGHT AND LICENSE

Top

This software is copyright (c) 2010 by Infinity Interactive, Inc.

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

MouseX-Getopt documentation Contained in the MouseX-Getopt distribution. 
package MouseX::Getopt::Meta::Attribute::Trait;
BEGIN {
  $MouseX::Getopt::Meta::Attribute::Trait::AUTHORITY = 'cpan:STEVAN';
}
BEGIN {
  $MouseX::Getopt::Meta::Attribute::Trait::VERSION = '0.33';
}
# ABSTRACT: Optional meta attribute trait for custom option names

use Mouse::Role;
use Mouse::Util::TypeConstraints;

has 'cmd_flag' => (
    is        => 'rw',
    isa       => 'Str',
    predicate => 'has_cmd_flag',
);

# This subtype is to support scalar -> arrayref coercion
#  without polluting the built-in types
subtype '_MouseX_Getopt_CmdAliases' => as 'ArrayRef';

coerce '_MouseX_Getopt_CmdAliases'
    => from 'Str'
        => via { [$_] };

has 'cmd_aliases' => (
    is        => 'rw',
    isa       => '_MouseX_Getopt_CmdAliases',
    predicate => 'has_cmd_aliases',
    coerce    => 1,
);

no Mouse::Util::TypeConstraints;
no Mouse::Role;

# register this as a metaclass alias ...
package # stop confusing PAUSE
    Mouse::Meta::Attribute::Custom::Trait::Getopt;
BEGIN {
  $Mouse::Meta::Attribute::Custom::Trait::Getopt::AUTHORITY = 'cpan:STEVAN';
}
BEGIN {
  $Mouse::Meta::Attribute::Custom::Trait::Getopt::VERSION = '0.33';
}
sub register_implementation { 'MouseX::Getopt::Meta::Attribute::Trait' }

1;


__END__