1 package MooseX::Getopt::Basic;
2 # ABSTRACT: MooseX::Getopt::Basic - role to implement the Getopt::Long functionality
6 use MooseX::Getopt::OptionTypeMap;
7 use MooseX::Getopt::Meta::Attribute;
8 use MooseX::Getopt::Meta::Attribute::NoGetopt;
11 use Getopt::Long 2.37 ();
13 has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
14 has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
16 sub new_with_options {
17 my ($class, @params) = @_;
20 if($class->meta->does_role('MooseX::ConfigFromFile')) {
23 # just get the configfile arg now; the rest of the args will be
26 my $opt_parser = Getopt::Long::Parser->new( config => [ qw( no_auto_help pass_through ) ] );
27 $opt_parser->getoptions( "configfile=s" => \$configfile );
29 if(!defined $configfile) {
30 my $cfmeta = $class->meta->find_attribute_by_name('configfile');
31 $configfile = $cfmeta->default if $cfmeta->has_default;
32 if (ref $configfile eq 'CODE') {
33 # not sure theres a lot you can do with the class and may break some assumptions
35 $configfile = &$configfile($class);
37 if (defined $configfile) {
38 $config_from_file = eval {
39 $class->get_config_from_file($configfile);
42 die $@ unless $@ =~ /Specified configfile '\Q$configfile\E' does not exist/;
47 $config_from_file = $class->get_config_from_file($configfile);
51 my $constructor_params = ( @params == 1 ? $params[0] : {@params} );
53 Carp::croak("Single parameters to new_with_options() must be a HASH ref")
54 unless ref($constructor_params) eq 'HASH';
56 my %processed = $class->_parse_argv(
58 $class->_attrs_to_options( $config_from_file )
60 params => $constructor_params,
63 my $params = $config_from_file ? { %$config_from_file, %{$processed{params}} } : $processed{params};
65 # did the user request usage information?
66 if ( $processed{usage} and $params->{help_flag} )
68 $class->_getopt_full_usage($processed{usage});
72 ARGV => $processed{argv_copy},
73 extra_argv => $processed{argv},
74 ( $processed{usage} ? ( usage => $processed{usage} ) : () ),
75 %$constructor_params, # explicit params to ->new
76 %$params, # params from CLI
80 sub _getopt_spec { shift->_traditional_spec(@_); }
83 my ( $class, %params ) = @_;
85 local @ARGV = @{ $params{params}{argv} || \@ARGV };
87 my ( $opt_spec, $name_to_init_arg ) = $class->_getopt_spec(%params);
89 # Get a clean copy of the original @ARGV
90 my $argv_copy = [ @ARGV ];
93 my ( $parsed_options, $usage ) = eval {
94 local $SIG{__WARN__} = sub { push @warnings, @_ };
96 return $class->_getopt_get_options(\%params, $opt_spec);
99 $class->_getopt_spec_warnings(@warnings) if @warnings;
100 $class->_getopt_spec_exception(\@warnings, $@) if $@;
102 # Get a copy of the Getopt::Long-mangled @ARGV
103 my $argv_mangled = [ @ARGV ];
105 my %constructor_args = (
107 $name_to_init_arg->{$_} => $parsed_options->{$_}
108 } keys %$parsed_options,
112 params => \%constructor_args,
113 argv_copy => $argv_copy,
114 argv => $argv_mangled,
115 ( defined($usage) ? ( usage => $usage ) : () ),
119 sub _getopt_get_options {
120 my ($class, $params, $opt_spec) = @_;
122 Getopt::Long::GetOptions(\%options, @$opt_spec);
123 return ( \%options, undef );
126 sub _getopt_spec_warnings { }
128 sub _getopt_spec_exception {
129 my ($self, $warnings, $exception) = @_;
130 die @$warnings, $exception;
133 sub _getopt_full_usage {
134 my ($self, $usage) = @_;
139 return "usage: %c %o";
142 sub _traditional_spec {
143 my ( $class, %params ) = @_;
145 my ( @options, %name_to_init_arg, %options );
147 foreach my $opt ( @{ $params{options} } ) {
148 push @options, $opt->{opt_string};
150 my $identifier = $opt->{name};
151 $identifier =~ s/\W/_/g; # Getopt::Long does this to all option names
153 $name_to_init_arg{$identifier} = $opt->{init_arg};
156 return ( \@options, \%name_to_init_arg );
159 sub _compute_getopt_attrs {
162 $_->does("MooseX::Getopt::Meta::Attribute::Trait")
166 !$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt')
167 } $class->meta->get_all_attributes
170 sub _get_cmd_flags_for_attr {
171 my ( $class, $attr ) = @_;
173 my $flag = $attr->name;
177 if ($attr->does('MooseX::Getopt::Meta::Attribute::Trait')) {
178 $flag = $attr->cmd_flag if $attr->has_cmd_flag;
179 @aliases = @{ $attr->cmd_aliases } if $attr->has_cmd_aliases;
182 return ( $flag, @aliases );
185 sub _attrs_to_options {
187 my $config_from_file = shift || {};
191 foreach my $attr ($class->_compute_getopt_attrs) {
192 my ( $flag, @aliases ) = $class->_get_cmd_flags_for_attr($attr);
194 my $opt_string = join(q{|}, $flag, @aliases);
196 if ($attr->name eq 'configfile') {
199 elsif ($attr->has_type_constraint) {
200 my $type = $attr->type_constraint;
201 if (MooseX::Getopt::OptionTypeMap->has_option_type($type)) {
202 $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type)
208 init_arg => $attr->init_arg,
209 opt_string => $opt_string,
210 required => $attr->is_required && !$attr->has_default && !$attr->has_builder && !exists $config_from_file->{$attr->name},
212 # this "feature" was breaking because
213 # Getopt::Long::Descriptive would return
214 # the default value as if it was a command
215 # line flag, which would then override the
216 # one passed into a constructor.
217 # See 100_gld_default_bug.t for an example
219 #( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ),
220 ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ),
236 with 'MooseX::Getopt::Basic';
238 has 'out' => (is => 'rw', isa => 'Str', required => 1);
239 has 'in' => (is => 'rw', isa => 'Str', required => 1);
241 # ... rest of the class here
248 my $app = My::App->new_with_options();
249 # ... rest of the script here
251 ## on the command line
252 % perl my_app_script.pl --in file.input --out file.dump
256 This is like L<MooseX::Getopt> and can be used instead except that it
257 doesn't make use of L<Getopt::Long::Descriptive> (or "GLD" for short).
259 =method new_with_options
261 See L<MooseX::Getopt/new_with_options>.