Changeset 2213 for trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Cli/Base.pm

Timestamp:

02/21/19 19:50:37 (5 years ago)

Author:

nanardon

Message:

Migrate online help to Pod format

File:

• trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Cli/Base.pm (modified) (4 diffs)

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Cli/Base.pm

@@ -12 +12 @@
 use Text::ParseWords;
 use Getopt::Long;
+use Pod::Select;
+use Pod::Text::Termcap;
+use File::Temp;
 
 =head1 NAME
@@ -146 +149 @@
     $self->add_func('exit', { help => "exit current mode",
             code => sub { return "EXIT" }, });
+
+
+=head2 help
+
+    help [command] - print help about command
+
+=cut
+
     $self->add_func('help', {
-        help => 'help [command] - print help about command',
         completion => sub {
             if (!$_[2]) { return sort keys %{ $_[0]->{funcs} || {}} }
         },
         code => sub {
-            my ($self, $name) = @_;
-            if (!$name) {
-                print $OUT join(', ', sort keys %{ $self->{funcs} || {}}) . "\n";
-            } elsif ($self->{funcs}{$name}{alias}) {
-                print $OUT "$name is an alias for " . join(' ',
-                    @{$self->{funcs}{$name}{alias}}) . "\n";
-            } elsif ($self->{funcs}{$name}{help}) {
-                print $OUT $self->{funcs}{$name}{help} . "\n";
-            } else {
-                print $OUT "No help availlable\n";
-            }
+            my $env = shift;
+
+            $env->Help(@_);
         },
     });
@@ -283 +285 @@
 sub add_func {
     my ($self, $name, $param) = @_;
+    my (undef, $file) = caller(0);
+    $param->{podfile} = $file;
     $self->{funcs}{$name} = $param;
+}
+
+=head2 Help
+
+Display help of given function
+
+=cut
+
+sub Help {
+    my ($self, $name) = @_;
+    if (!$name) {
+        $self->print(join(', ', sort keys %{ $self->{funcs} || {}}) . "\n");
+    } elsif ($self->{funcs}{$name}{alias}) {
+        $self->print("$name is an alias for " . join(' ', @{$self->{funcs}{$name}{alias}}) . "\n");
+    } elsif ($self->{funcs}{$name}{help}) {
+        $self->print($self->{funcs}{$name}{help});
+    } else {
+        my $fh = File::Temp->new();
+        my $parser = Pod::Text::Termcap->new( sentence => 0, width => 78 );
+
+        podselect(
+            {-output => $fh, -sections => ["CLI FUNCTIONS/\Q$name"]},
+            $self->{funcs}{$name}{podfile}
+        );
+        seek($fh, 0, 0);
+        $parser->parse_from_filehandle($fh, $self->Context->Out);
+    }
 }
 
@@ -330 +361 @@
     my ($self, $name, @args) = @_;
     return if (!$name);
-    if (!exists($self->{funcs}{$name})) {
+
+    if (grep { m/^(-h|--help)$/ } @args) {
+        $self->Help($name);
+    } elsif (!exists($self->{funcs}{$name})) {
         $self->print("No command $name found\n");
     } elsif ($self->{funcs}{$name}{alias}) {