Enhancing existing attributes

  package CommonRole;

  use Moo::Role;

  has attr => (is => "ro", ...);

  sub common_logic { ... }

  1;

  package Suitable::Cmd::CLI;

  use Moo;
  use MooX::Cmd;
  use MooX::Options;

  with "CommonRole";

  option '+attr' => (format => 's', repeatable => 1);

  sub execute { shift->common_logic }

  1;

  package Suitable::Web::Request::Handler;

  use Moo;

  with "CommonRole";

  sub all_suits { shift->common_logic }

  1;

  package Suitable::Web;

  use Dancer2;
  use Suitable::Web::Request::Handler;

  set serializer => "JSON";

  get '/suits' => sub {
      $my $reqh = Suitable::Web::Request::Handler->new( attr => config->{suit_attr} );
      $reqh->all_suits;
  };

  dance;

  1;

Of course there more ways to to it, Jedi or Catalyst shall be fine, either.

Rename negativable into negatable

Replace Locale::TextDomain by MooX::Locale::Passthrough

So introduce MooX::Locale::Passthrough to allow any vendor to add reasonable localization, eg. by composing MooX::Locale::TextDomain::OO into it's solution and initialize the localization in a reasonable way.

Make lazy loaded features optional

autosplit

This feature allowes one to split option arguments at a defined character and always return an array (implicit flag "repeatable").

  option "search_path" => ( is => "ro", required => 1, autosplit => ":", format => "s" );
    

However, this feature requires following modules are provided:

json format

This feature allowes one to invoke a script like

  $ my-tool --json-attr '{ "gem": "sapphire", "color": "blue" }'
    

It might be a reasonable enhancement to handles.

Handling JSON formatted arguments requires any of those modules are loded:

Decouple autorange and autosplit

  $ my-tool --range 1..5

is all they desire, autosplit will enabled only when the dependencies of autosplit are fulfilled.

new_with_options

  myTool --str=ko

  t->new_with_options()->str # ko
  t->new_with_options(str => 'ok')->str #ok

option

See "OPTION PARAMETERS" for the documentation.

options_usage | --help

  my $t = t->new_with_options();
  my $exit_code = 1;
  my $pre_message = "str is not valid";
  $t->options_usage($exit_code, $pre_message);

This method is also automatically fired if the command option "--help" is passed.

  myTool --help

options_man | --man

  my $t = t->new_with_options();
  $t->options_man();

This is automatically fired if the command option "--man" is passed.

  myTool --man

options_short_usage | --usage

  my $t = t->new_with_options();
  $t->options_short_usage($exit_code);

This is automatically fired if the command option "--usage" is passed.

  myTool --usage

flavour

  use MooX::Options flavour => [qw( pass_through )];

Any flavour is passed to Getopt::Long as a configuration, check the doc to see what is possible.

protect_argv

  use MooX::Options protect_argv => 0;

skip_options

  use MooX::Options skip_options => [qw/multi/];

prefer_commandline

This parameter will give the command line an higher priority.

  use MooX::Options prefer_commandline => 1;

with_config_from_file

myTool :

  use MooX::Options with_config_from_file => 1;

In /etc/myTool.json

  {"test" : 1}

with_locale_textdomain_oo

No further action is taken, no language is chosen - everything keep in control.

Please read Locale::TextDomain::OO carefully how to enable the desired translation setup accordingly.

spacer

The default char is " ".

  use MooX::Options space => '+'

Then the "spacer_before" and "spacer_after" will use it for "man" and "help" message.

  option 'x' => (is => 'ro', spacer_before => 1, spacer_after => 1);

doc | documentation

long_doc

See also Man parameters to get more examples how to build a nice man page.

required

format

• i : integer
• i@: array of integer
• s : string
• s@: array of string
• f : float value

By default, it's a boolean value.

Take a look of available formats with Getopt::Long::Descriptive.

You need to understand that everything is explicit here. If you use Moose and your attribute has "isa => 'Array[Int]'", that will not imply the format "i@".

format json : special format support

  option 'hash' => (is => 'ro', json => 1);

You can also use the json format

  option 'hash' => (is => 'ro', format => "json");

  myTool --hash='{"a":1,"b":2}' # hash = { a => 1, b => 2 }

negatable

  option 'verbose' => (is => 'ro', negatable => 1);

  myTool --verbose    # verbose = 1
  myTool --no-verbose # verbose = 0

The former name of this flag, negativable, is discouraged - since it's not a word.

repeatable

I advise to add a default value to your attribute to always have an array. Otherwise the default value will be an undefined value.

  option foo => (is => 'rw', format => 's@', default => sub { [] });

  myTool --foo="abc" --foo="def" # foo = ["abc", "def"]

autosplit

  option test => (is => 'ro', format => 'i@', default => sub {[]}, autosplit => ',');
  
  myTool --test=1 --test=2 # test = (1, 2)
  myTool --test=1,2,3      # test = (1, 2, 3)

It will also handle quoted params with the autosplit.

  option testStr => (is => 'ro', format => 's@', default => sub {[]}, autosplit => ',');

  myTool --testStr='a,b,"c,d",e,f' # testStr ("a", "b", "c,d", "e", "f")

autorange

  option test => (is => 'ro', format => 'i@', default => sub {[]}, autorange => 1);
  
  myTool --test=1 --test=2 # test = (1, 2)
  myTool --test=1,2,3      # test = (1, 2, 3)
  myTool --test=1,2,3..6   # test = (1, 2, 3, 4, 5, 6)

It will also handle quoted params like "autosplit", and will not rangify them.

  option testStr => (is => 'ro', format => 's@', default => sub {[]}, autorange => 1);

  myTool --testStr='1,2,"3,a,4",5' # testStr (1, 2, "3,a,4", 5)

"autosplit" will be set to ',' if undefined. You may set "autosplit" to a different delimiter than ',' for your group separation, but the range operator '..' cannot be changed.

  option testStr => (is => 'ro', format => 's@', default => sub {[]}, autorange => 1, autosplit => '-');

  myTool --testStr='1-2-3-5..7' # testStr (1, 2, 3, 5, 6, 7)

short

  option 'verbose' => (is => 'ro', short => 'v');

  myTool --verbose # verbose = 1
  myTool -v        # verbose = 1

  option 'account_id' => (is => 'ro', format => 'i', short => 'a|id');

  myTool --account_id=1
  myTool -a=1
  myTool --id=1

You can also use a shorter option without attribute :

  option 'account_id' => (is => 'ro', format => 'i');

  myTool --acc=1
  myTool --account=1

order

  option 'at_the_end' => (is => 'ro', order => 999);

hidden

  option 'debug' => (is => 'ro', doc => 'hidden');

Or

  option 'debug' => (is => 'ro', hidden => 1);

spacer_before, spacer_after

  option 'myoption' => (is => 'ro', spacer_before => 1, spacer_after => 1);

MooX::Options and Mo

Since some required features ("with", "around") isn't provided by Mo, Class::Method::Modifiers must be loaded by any "Mo" class using "MooX::Options", Role::Tiny::With is needed to inject the MooX::Options::Role and finally in the target package the private accessors to options_config and options_data are missing.

Concluding a reasonable support for Mo based classes is beyond the goal of this module. It's neither forbidden nor actively prevented, but won't be covered by any test nor actively supported.

If someome wants contribute guides how to use "MooX::Options" together with "Mo" or provide patches to solve this limitation - any support will granted.

THANKS

•

sschober

For implementation and German translation.