NAME

       App::DocKnot::Util - Shared utility functions for other DocKnot modules

SYNOPSIS

           use App::DocKnot::Util qw(
               is_newer latest_tarball print_checked print_fh
           );
           use Path::Tiny qw(path);

           print_checked('some stdout output');
           my @inputs = (path('/input-1'), path('/input-2'));
           if (!is_newer(path('/output'), @inputs)) {
               open(my $fh, '>', '/output');
               print_fh($fh, '/output', 'some stuff');
               close($fh);
           }

           my $latest_ref = latest_tarball(path('/archive'), 'App-Foo');

REQUIREMENTS

       Perl 5.24 or later and the modules List::SomeUtils, Path::Tiny, and Sort::Versions, available from CPAN.

DESCRIPTION

       This module collects utility functions used by other App::DocKnot modules.  It is not really intended for
       use outside of DocKnot, but these functions can be used if desired.

FUNCTIONS

       is_newer(FILE, SOURCE[, SOURCE ...])
           Returns  a  true value if FILE exists and has a last modified time that is newer or equal to the last
           modified times of all SOURCE files, and otherwise returns a false value.  Used primarily to determine
           if a given output file is up-to-date with respect to its source files.  All paths must be  Path::Tiny
           objects.

       latest_tarball(PATH, NAME)
           Returns  data  including a file list for the latest tarballs (by version number) for a given software
           package NAME in the directory PATH (which must be a Path::Tiny object).  Versions are compared  using
           Sort::Versions.  The return valid is a hash with the following keys:

           files
               The list of files found for that version.

           version
               The version number extracted from this set of files.

       print_checked(ARG[, ARG ...])
           The same as print (without a file handle argument), except that it throws a text exception on failure
           as if autodie affected print (which it unfortunately doesn't because print cannot be prototyped).

       print_fh(FH, NAME, DATA[, DATA ...])
           Writes  the concatenation of the DATA elements (interpreted as scalar strings) to the file handle FH.
           NAME should be the name of (or Path::Tiny object for) the file open as FH,  and  is  used  for  error
           reporting.

           This is mostly equivalent to "print {fh}" but throws a text exception in the event of a failure.

AUTHOR

       Russ Allbery <rra@cpan.org>

COPYRIGHT AND LICENSE

       Copyright 1999-2011, 2013, 2021-2022 Russ Allbery <rra@cpan.org>

       Permission  is  hereby  granted,  free  of  charge,  to  any person obtaining a copy of this software and
       associated documentation files (the "Software"), to deal in the Software without  restriction,  including
       without  limitation  the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
       copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to  the
       following conditions:

       The  above  copyright  notice  and  this permission notice shall be included in all copies or substantial
       portions of the Software.

       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR  IMPLIED,  INCLUDING  BUT  NOT
       LIMITED  TO  THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN
       NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  CLAIM,  DAMAGES  OR  OTHER  LIABILITY,
       WHETHER  IN  AN  ACTION  OF  CONTRACT,  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
       SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

SEE ALSO

       App::DocKnot

       This module is part of the App-DocKnot distribution.  The current version of DocKnot  is  available  from
       CPAN, or directly from its web site at <https://www.eyrie.org/~eagle/software/docknot/>.

perl v5.36.0                                       2023-11-19                            App::DocKnot::Util(3pm)