view release on metacpan or  search on metacpan

lib/App/lcpan/Cmd/sco_mod.pm  view on Meta::CPAN

package App::lcpan::Cmd::sco_mod;

our $DATE = '2017-07-10'; # DATE
our $VERSION = '0.002'; # VERSION

use 5.010001;
use strict;
use warnings;
use Log::ger;

require App::lcpan;

our %SPEC;

$SPEC{handle_cmd} = {
    v => 1.1,
    summary => 'Open module POD on search.cpan.org',
    description => <<'_',

This will open `http://search.cpan.org/perldoc?MODNAME`. `MODNAME` will first be
checked for existence in local index database.

_
    args => {
        %App::lcpan::common_args,
        %App::lcpan::mod_args,
    },
};
sub handle_cmd {
    my %args = @_;
    my $mod = $args{module};

    my $state = App::lcpan::_init(\%args, 'ro');
    my $dbh = $state->{dbh};

    my ($file_id) = $dbh->selectrow_array(
        "SELECT file_id FROM module WHERE name=?", {}, $mod);
    $file_id or return [404, "No such module '$mod'"];

    require Browser::Open;
    my $err = Browser::Open::open_browser("http://search.cpan.org/perldoc?$mod");
    return [500, "Can't open browser"] if $err;
    [200];
}

1;
# ABSTRACT: Open module POD on search.cpan.org

__END__

=pod

=encoding UTF-8

=head1 NAME

App::lcpan::Cmd::sco_mod - Open module POD on search.cpan.org

=head1 VERSION

This document describes version 0.002 of App::lcpan::Cmd::sco_mod (from Perl distribution App-lcpan-CmdBundle-sco), released on 2017-07-10.

=head1 DESCRIPTION

This module handles the L<lcpan> subcommand C<sco-mod>.

=head1 FUNCTIONS


=head2 handle_cmd

Usage:

 handle_cmd(%args) -> [status, msg, result, meta]

Open module POD on search.cpan.org.

This will open CL<http://search.cpan.org/perldoc?MODNAME>. C<MODNAME> will first be
checked for existence in local index database.

This function is not exported.

Arguments ('*' denotes required arguments):

=over 4

=item * B<cpan> => I<dirname>

Location of your local CPAN mirror, e.g. /path/to/cpan.

Defaults to C<~/cpan>.

=item * B<index_name> => I<filename> (default: "index.db")

Filename of index.

=item * B<module>* => I<perl::modname>