ARGV-Struct
view release on metacpan or search on metacpan
{
"abstract" : "Parse complex data structures passed in ARGV",
"author" : [
"Jose Luis Martinez <joseluis.martinez@capside.com>"
],
"dynamic_config" : 0,
"generated_by" : "Dist::Zilla version 6.012, CPAN::Meta::Converter version 2.150010",
"license" : [
"perl_5"
],
"meta-spec" : {
"url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
---
abstract: 'Parse complex data structures passed in ARGV'
author:
- 'Jose Luis Martinez <joseluis.martinez@capside.com>'
build_requires:
Test::Exception: '0'
Test::More: '0'
configure_requires:
ExtUtils::MakeMaker: '0'
dynamic_config: 0
generated_by: 'Dist::Zilla version 6.012, CPAN::Meta::Converter version 2.150010'
license: perl
Makefile.PL view on Meta::CPAN
# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.012.
use strict;
use warnings;
use ExtUtils::MakeMaker;
my %WriteMakefileArgs = (
"ABSTRACT" => "Parse complex data structures passed in ARGV",
"AUTHOR" => "Jose Luis Martinez <joseluis.martinez\@capside.com>",
"CONFIGURE_REQUIRES" => {
"ExtUtils::MakeMaker" => 0
},
"DISTNAME" => "ARGV-Struct",
"EXE_FILES" => [
"bin/argvstruct"
],
"LICENSE" => "perl",
"NAME" => "ARGV::Struct",
# NAME
ARGV::Struct - Parse complex data structures passed in ARGV
# SYNOPSIS
use ARGV::Struct;
my $struct = ARGV::Struct->new->parse;
# DESCRIPTION
Have you ever felt that you need something different than Getopt?
Are you tired of shoehorning Getopt style arguments into your commandline scripts?
Are you trying to express complex datastructures via command line?
then ARGV::Struct is for you!
It's designed so the users of your command line utilities won't hate you when things
get complex.
# THE PAIN
I've had to use some command-line utilities that had to do creative stuff to transmit
deeply nested arguments, or datastructure-like information. Here are some strategies that
I've found over time:
## Complex arguments codified as JSON
JSON is horrible for the command line because you have to escape the quotes. It's a nightmare.
command --complex_arg "{\"key1\":\"value1\",\"key2\":\"value2\"}"
## Arguments encoded via some custom scheme
## Repeating Getopt arguments
Getopt friendly, but too verbose
command --key key1 --value value1 --key key1 --value value 2
# THE DESIGN
The design of this module is aimed at "playing well with the shell". The main purpose is
to let the user transmit complex data structures, while staying compact enough for command line
use.
## Key/Value sets (objects)
On the command line, the user can transmit sets of key/value pairs within curly brackets
command { K_V_PAIR1 K_V_PAIR2 }
The shell is expected to do some work for us, so key/value pairs are separated by spaces
# METHODS
## new(\[argv => ArrayRef\])
Return an instance of the parser. If argv is not specified, @ARGV will be
used.
## parse
return the parsed data structure
# STATUS
This module is quite experimental. I developed it while developing Paws (a
Perl AWS SDK). It has a commandline utility that needs to recollect all the
Attributes and Values for method calls, and lots of times, they get complex.
Since trying to pass params with Getopt was getting ugly as hell, I decided
that it would be better to do things in a different way, and eventually
thought it could be an independent module.
lib/ARGV/Struct.pm view on Meta::CPAN
} else {
die "Expecting { or [";
}
}
1;
#################### main pod documentation begin ###################
=head1 NAME
ARGV::Struct - Parse complex data structures passed in ARGV
=head1 SYNOPSIS
use ARGV::Struct;
my $struct = ARGV::Struct->new->parse;
=head1 DESCRIPTION
Have you ever felt that you need something different than Getopt?
Are you tired of shoehorning Getopt style arguments into your commandline scripts?
Are you trying to express complex datastructures via command line?
then ARGV::Struct is for you!
It's designed so the users of your command line utilities won't hate you when things
get complex.
=head1 THE PAIN
I've had to use some command-line utilities that had to do creative stuff to transmit
deeply nested arguments, or datastructure-like information. Here are some strategies that
I've found over time:
=head2 Complex arguments codified as JSON
JSON is horrible for the command line because you have to escape the quotes. It's a nightmare.
command --complex_arg "{\"key1\":\"value1\",\"key2\":\"value2\"}"
=head2 Arguments encoded via some custom scheme
lib/ARGV/Struct.pm view on Meta::CPAN
=head2 Repeating Getopt arguments
Getopt friendly, but too verbose
command --key key1 --value value1 --key key1 --value value 2
=head1 THE DESIGN
The design of this module is aimed at "playing well with the shell". The main purpose is
to let the user transmit complex data structures, while staying compact enough for command line
use.
=head2 Key/Value sets (objects)
On the command line, the user can transmit sets of key/value pairs within curly brackets
command { K_V_PAIR1 K_V_PAIR2 }
The shell is expected to do some work for us, so key/value pairs are separated by spaces
lib/ARGV/Struct.pm view on Meta::CPAN
=head1 METHODS
=head2 new([argv => ArrayRef])
Return an instance of the parser. If argv is not specified, @ARGV will be
used.
=head2 parse
return the parsed data structure
=head1 STATUS
This module is quite experimental. I developed it while developing Paws (a
Perl AWS SDK). It has a commandline utility that needs to recollect all the
Attributes and Values for method calls, and lots of times, they get complex.
Since trying to pass params with Getopt was getting ugly as hell, I decided
that it would be better to do things in a different way, and eventually
thought it could be an independent module.
( run in 0.395 second using v1.01-cache-2.11-cpan-ec4f86ec37b )