File Coverage

blib/lib/App/perlmv/scriptlet/add_prefix_datestamp.pm

Criterion	Covered	Total	%
statement	11	16	68.7
branch	0	2	0.0
condition	0	6	0.0
subroutine	4	5	80.0
pod			n/a
total	15	29	51.7

package App::perlmv::scriptlet::add_prefix_datestamp;

use 5.010001;
use strict;
use warnings;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2023-08-25'; # DATE
our $DIST = 'App-perlmv-scriptlet-add_prefix_datestamp'; # DIST
our $VERSION = '0.003'; # VERSION

sub main::_parse_date {
    my $date = shift;
    if ($date =~ /^\A(\d{4})-?(\d{2})-?(\d{2})(?:[T ]?(\d{2}):?(\d{2}):?(\d{2}))?\z/) {
        require Time::Local;
        return Time::Local::timelocal_posix($6 // 0, $5 // 0, $4 // 0, $3, $2-1, $1 - 1900);
    } else {
        die "Can't parse date '$date'";
    }
}

our $SCRIPTLET = {
    summary => 'Add datestamp prefix (YYYYMMDD-) to filenames, using files\' modification time as date',
    args => {
        date => {
            summary => "Use this date instead of file's modification time",
            schema => 'date*',
        },
        avoid_duplicate_prefix => {
            summary => 'Avoid adding prefix when filename already has prefix that looks like datestamp (1xxxxxxx- to 2xxxxxxx)',
            schema => 'bool*',
        },
        prefix_regex => {
            summary => 'Specify how existing datestamp prefix should be recognized',
            schema => 're_from_str',
            description => <<'_',

This regex is used to check for the existence of datestamp (if you use the
`avoid_duplicate_prefix` option. The default is `qr/^\d{8}(?:T\d{6})?-/` but if
your existing datestamps are in different syntax you can accommodate them here.

_
        },
        prefix_format => {
            summary => 'Specify datestamp format, in the form of strftime() template',
            schema => 'str*',
            description => <<'_',

The default format is `"%Y%m%d-"` or `"%Y%m%dT%H%M%S-"` if you enable the
`with_time` option. But you can customize it here.

_
        },
        with_time => {
            summary => 'Whether to add time (YYYYMMDD"T"hhmmss instead of just date (YYYYMMDD)',
            schema => 'bool*',
        },
    },
    code => sub {
        package
            App::perlmv::code;

        require POSIX;

        use vars qw($ARGS);

        my $re = $ARGS->{prefix_regex} // qr/\A[12][0-9]{3}(0[1-9]|10|11|12)([0-2][0-9]|30|31)-/;

        if ($ARGS->{avoid_duplicate_prefix} && $_ =~ $re) {
            return $_;
        }
        my @stat = stat($_);
        my $time   = defined $ARGS->{date} ? main::_parse_date($ARGS->{date}) : $stat[9];
        my $format = $ARGS->{prefix_format}  // ($ARGS->{with_time} ? '%Y%m%dT%H%M%S-' : '%Y%m%d-');
        my $prefix = POSIX::strftime($format, localtime($time));

        "$prefix$_";
    },
};

1;

# ABSTRACT: Add datestamp prefix (YYYYMMDD-) to filenames, using files' modification time as date

__END__