File Coverage

blib/lib/Filename/Type/Image.pm

Criterion	Covered	Total	%
statement	11	13	84.6
branch	0	2	0.0
condition			n/a
subroutine	4	5	80.0
pod	1	1	100.0
total	16	21	76.1

package Filename::Type::Image;

use 5.010001;
use strict;
use warnings;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-12-21'; # DATE
our $DIST = 'Filename-Type-Image'; # DIST
our $VERSION = '0.006'; # VERSION

use Exporter qw(import);
our @EXPORT_OK = qw(check_image_filename);

our $STR_RE = "djvu|jpeg|jpg2|svgz|tiff|wbmp|webp|art|bmp|cdr|cdt|cpt|cr2|crw|djv|erf|gif|ico|ief|jng|jp2|jpe|jpf|jpg|jpm|jpx|nef|orf|pat|pbm|pcx|pgm|png|pnm|ppm|psd|ras|rgb|svg|tif|xbm|xcf|xpm|xwd"; # STR_RE

our $RE = qr(\.(?:$STR_RE)\z)i;

our %SPEC;

$SPEC{check_image_filename} = {
    v => 1.1,
    summary => 'Check whether filename indicates being an image',
    description => <<'MARKDOWN',


MARKDOWN
    args => {
        filename => {
            schema => 'filename*',
            req => 1,
            pos => 0,
        },
        # XXX recurse?
        #ci => {
        #    summary => 'Whether to match case-insensitively',
        #    schema  => 'bool',
        #    default => 1,
        #},
    },
    result_naked => 1,
    result => {
        schema => ['any*', of=>['bool*', 'hash*']],
        description => <<'MARKDOWN',

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

MARKDOWN
    },
    examples => [
        {
            args => {filename => 'foo.txt'},
            naked_result => 0,
        },
        {
            args => {filename => 'foo.mp4'},
            naked_result => 0,
        },
        {
            args => {filename => 'foo.jpg'},
            naked_result => {},
        },
        {
            args => {filename => 'foo.PNG'},
            naked_result => {},
        },
    ],
};
sub check_image_filename {
    my %args = @_;

    $args{filename} =~ $RE ? {} : 0;
}

1;
# ABSTRACT: Check whether filename indicates being an image

__END__