File Coverage

blib/lib/Filename/Video.pm

Criterion	Covered	Total	%
statement	13	13	100.0
branch	2	2	100.0
condition			n/a
subroutine	5	5	100.0
pod	1	1	100.0
total	21	21	100.0

package Filename::Video;

use 5.010001;
use strict;
use warnings;

use Exporter qw(import);

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-01-12'; # DATE
our $DIST = 'Filename-Video'; # DIST
our $VERSION = '0.006'; # VERSION

our @EXPORT_OK = qw(check_video_filename);

our $STR_RE = "movie|mpeg|webm|3gp|asf|asx|avi|axv|dif|fli|flv|lsf|lsx|mkv|mng|mov|mp4|mpe|mpg|mpv|mxu|ogv|wmv|wmx|wvx|dl|dv|gl|qt|ts|wm"; # STR_RE

our $RE = qr(\A(.+)\.($STR_RE)\z)i;

our %SPEC;

$SPEC{check_video_filename} = {
    v => 1.1,
    summary => 'Check whether filename indicates being a video file',
    description => <<'_',


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

Return false if no archive suffixes detected. Otherwise return a hash of
information.

_
    },
    examples => [
        {
            args => {filename => 'foo.txt'},
            naked_result => 0,
        },
        {
            args => {filename => 'foo.DOC'},
            naked_result => 0,
        },
        {
            args => {filename => 'foo.webm'},
            naked_result => {filename=>'foo.webm', filename_without_suffix=>"foo", suffix=>"webm"},
        },
        {
            args => {filename => 'foo.MP4'},
            naked_result => {filename=>'foo.MP4', filename_without_suffix=>"foo", suffix=>"MP4"},
        },
    ],
};
sub check_video_filename {
    my %args = @_;

    $args{filename} =~ $RE ? {filename=>"$1.$2", filename_without_suffix=>$1, suffix=>$2} : 0;
}

1;
# ABSTRACT: Check whether filename indicates being a video file

__END__