sub data_to_text {
my ($data) = @_;
- return undef if !defined($data);
+ return '' if !defined($data);
if (my $class = ref($data)) {
return to_json($data, { utf8 => 1, canonical => 1 });
# the last column will never be cutoff
# 'default' - optional default value for the column
# formatopts element order defines column order (left to right)
+# $sort_key is either a column name, or integer 1 which simply
+# sorts the output according to the leftmost column not containing
+# any undef. if not specified, we do not change order.
sub print_text_table {
- my ($formatopts, $data) = @_;
+ my ($formatopts, $data, $sort_key) = @_;
my ($formatstring, @keys, @titles, %cutoffs, %defaults);
my $last_col = $formatopts->[$#{$formatopts}];
+ my $autosort = 0;
+ if (defined($sort_key) && ($sort_key eq 1)) {
+ $autosort = 1;
+ $sort_key = undef;
+ }
+
foreach my $col ( @$formatopts ) {
my ($key, $title, $cutoff) = @$col{qw(key title cutoff)};
$title //= $key;
my $titlelen = length($title);
my $longest = $titlelen;
+ my $sortable = $autosort;
foreach my $entry (@$data) {
my $len = length(data_to_text($entry->{$key})) // 0;
$longest = $len if $len > $longest;
+ $sortable = 0 if !defined($entry->{$key});
}
+ $sort_key //= $key if $sortable;
$cutoff = (defined($cutoff) && $cutoff < $longest) ? $cutoff : $longest;
$cutoffs{$key} = $cutoff;
printf $formatstring, @titles;
- foreach my $entry (sort { $a->{$keys[0]} cmp $b->{$keys[0]} } @$data) {
+ if (defined($sort_key)){
+ @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
+ }
+ foreach my $entry (@$data) {
printf $formatstring, map { substr((data_to_text($entry->{$_}) // $defaults{$_}), 0 , $cutoffs{$_}) } @keys;
}
}
-# prints the result of an API GET call returning an array
-# and to have the results key of the API call defined.
+# prints the result of an API GET call returning an array as a table.
+# takes formatting information from the results property of the call
+# if $props_to_print is provided, prints only those columns. otherwise
+# takes all fields of the results property, with a fallback
+# to all fields occuring in items of $data.
sub print_api_list {
- my ($data, $result_schema, $props_to_print) = @_;
+ my ($data, $result_schema, $props_to_print, $sort_key) = @_;
die "can only print object lists\n"
if !($result_schema->{type} eq 'array' && $result_schema->{items}->{type} eq 'object');
if (!defined($props_to_print)) {
$props_to_print = [ sort keys %$returnprops ];
if (!scalar(@$props_to_print)) {
- $props_to_print = [ sort keys %{$data->[0]} ];
+ my $all_props = {};
+ foreach my $obj (@{$data}) {
+ foreach my $key (keys %{$obj}) {
+ $all_props->{ $key } = 1;
+ }
+ }
+ $props_to_print = [ sort keys %{$all_props} ];
}
die "unable to detect list properties\n" if !scalar(@$props_to_print);
}
push @$formatopts, $colopts;
}
- print_text_table($formatopts, $data);
+ print_text_table($formatopts, $data, $sort_key);
}
sub print_api_result {
- my ($format, $data, $result_schema) = @_;
+ my ($format, $data, $result_schema, $props_to_print, $sort_key) = @_;
return if $result_schema->{type} eq 'null';
} elsif ($format eq 'text') {
my $type = $result_schema->{type};
if ($type eq 'object') {
- foreach my $key (sort keys %$data) {
- print $key . ": " . data_to_text($data->{$key}) . "\n";
+ if (defined($props_to_print)) {
+ foreach my $key (@$props_to_print) {
+ print $key . ": " . data_to_text($data->{$key}) . "\n";
+ }
+ } else {
+ foreach my $key (sort keys %$data) {
+ print $key . ": " . data_to_text($data->{$key}) . "\n";
+ }
}
} elsif ($type eq 'array') {
return if !scalar(@$data);
my $item_type = $result_schema->{items}->{type};
if ($item_type eq 'object') {
- print_api_list($data, $result_schema);
+ print_api_list($data, $result_schema, $props_to_print, $sort_key);
} else {
foreach my $entry (@$data) {
print data_to_text($entry) . "\n";