File Coverage

blib/lib/Filename/Perl/Release.pm

Criterion	Covered	Total	%
statement	20	20	100.0
branch	4	4	100.0
condition			n/a
subroutine	5	5	100.0
pod	1	1	100.0
total	30	30	100.0

package Filename::Perl::Release;

use 5.010001;
use strict;
use warnings;

use Exporter 'import';

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2023-12-16'; # DATE
our $DIST = 'Filename-Perl-Release'; # DIST
our $VERSION = '0.002'; # VERSION

our @EXPORT_OK = qw(check_perl_release_filename);

our %SPEC;

$SPEC{check_perl_release_filename} = {
    v => 1.1,
    summary => 'Check whether filename looks like a perl module release archive, e.g. a CPAN release tarball',
    description => <<'MARKDOWN',


MARKDOWN
    args => {
        filename => {
            schema => 'str*',
            req => 1,
            pos => 0,
        },
    },
    result_naked => 1,
    result => {
        schema => ['any*', of=>['bool*', 'hash*']],
        description => <<'MARKDOWN',

Return false if not detected like a perl module release archive. Otherwise
return a hash of information, which contains these keys: `distribution`,
`module`, `version`.

MARKDOWN
    },
    examples => [
        {
            args => {filename=>'foo.bar'},
        },
        {
            args => {filename=>'qux-quux-0.123.tar.gz'},
        },
    ],
};
sub check_perl_release_filename {
    require Filename::Archive;

    my %args = @_;

    my $filename = $args{filename};

    my $cares = Filename::Archive::check_archive_filename(filename=>$filename, ci=>1);
    return 0 unless $cares;

    $cares->{filename_without_suffix} =~
        /\A
         (\w+(?:-\w+)*)
         -v?(\d+(?:\.\d+){0,}(_\d+|-TRIAL)?)
         \z/ix
             or return 0;
    my ($dist, $ver) = ($1, $2);
    (my $mod = $dist) =~ s/-/::/g;
    {distribution => $dist, module=>$mod, version=>$ver, archive_suffix=>$cares->{archive_suffix}};
}

1;
# ABSTRACT: Check whether filename looks like a perl module release archive, e.g. a CPAN release tarball

__END__