The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

DBAURAIN / Bio-MUST-Core-0.250380 / lib / Bio / MUST / Core / Utils.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
—
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

              
package Bio::MUST::Core::Utils;
# ABSTRACT: Utility functions for enabling multiple file processing
$Bio::MUST::Core::Utils::VERSION = '0.250380';
use strict;
use warnings;
use autodie;
use File::Basename;
use Path::Class qw(file);
use Test::Files;
use Test::Most;
# TODO: use :filenames in some binaries
use Exporter::Easy (
    OK   => [ qw(secure_outfile :filenames :tests) ],
    TAGS => [
        filenames => [ qw(insert_suffix change_suffix append_suffix) ],
        tests     => [ qw(cmp_store cmp_float) ],
    ],
);
sub secure_outfile {
    my $infile = shift;
    my $suffix = shift;
    return insert_suffix($infile, $suffix) if defined $suffix;
    rename $infile, append_suffix($infile, '.bak') if -e $infile;
    return $infile;
}
sub insert_suffix {
    my $infile = shift;
    my $string = shift;
    my ($filename, $directories, $suffix) = fileparse($infile, qr{\.[^.]*}xms);
    return $directories . $filename . $string . $suffix;
}
sub change_suffix {
    my $infile = shift;
    my $suffix = shift;
    my ($filename, $directories) = fileparse($infile, qr{\.[^.]*}xms);
    return $directories . $filename . $suffix;
}
sub append_suffix {
    my $infile = shift;
    my $suffix = shift;
    my ($filename, $directories) = fileparse($infile);
    return $directories . $filename . $suffix;
}
sub cmp_store {
    my %args = @_;
    my ($obj, $method, $file, $test, $args)
        = @args{ qw(obj method file test args) };
    $args //= {};               # optional hash reference
    # named output file
    my $outfile;
    unless ($method =~ m/\A temp_/xms) {
        $outfile = file('test', "my_$file");
        ( file($outfile) )->remove if -e $outfile;
        $obj->$method($outfile, $args);
    }
    # anonymous temporary file
    $outfile //= $obj->$method($args);
    # compare file contents
    compare_ok($outfile, file('test', $file), "$test: $file");
    return;
}
sub cmp_float {
    my ($got, $expect, $epsilon, $test) = @_;
    # compare got and expect to epsilon precision
    cmp_ok abs($got - $expect), '<', $epsilon, $test;
    return;
}
1;
__END__
=pod
=head1 NAME
Bio::MUST::Core::Utils - Utility functions for enabling multiple file processing
=head1 VERSION
version 0.250380
=head1 SYNOPSIS
    # TODO
=head1 DESCRIPTION
    # TODO
=head1 AUTHOR
Denis BAURAIN <denis.baurain@uliege.be>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2013 by University of Liege / Unit of Eukaryotic Phylogenomics / Denis BAURAIN.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut