/ 
Dev-Util-v2.19.12
/ Dev::Util

NAME

Dev::Util - Utilities useful in the development of perl programs

VERSION

Version v2.19.12

SYNOPSIS

This module provides a standard set of tools to use for oft needed functionality.

Consistent feature setup is achieved. Standard constants are defined. OS identification and external executables are accessible. Quick backups can be made. File and directory attributes are discovered. Lock files are created.

The sub-modules provide this and other utility functionality.

SUB-MODULES

The sub-modules provide the functionality described below. For more details see perldoc <Sub-module_Name>.

Dev::Util

Dev::Util provides a loader for sub-modules where a leading :: denotes a package to load.

use Dev::Util qw( ::File ::OS );

This is equivalent to:

use Dev::Util::File qw(:all);
use Dev::Util::OS   qw(:all);

Dev::Util::Syntax

Provide consistent feature setup. Put all of the "use" setup cmds in one place. Then import them into other modules. Changes are made in one place, yet apply to all of the programs that use Dev::Util::Syntax

Use this in other modules:

package My::Module::Example;

use Dev::Util::Syntax;

# Rest of Code...

This is equivalent to:

package My::Module::Example;

use feature :5.18;
use utf8;
use strict;
use warnings;
use autodie;
use open qw(:std :utf8);
use version;
use Readonly;
use Carp;
use English qw( -no_match_vars );

# Rest of Code...

Note: use Dev::Util::Syntax automatically adds use strict and use warnings to the program.

Dev::Util::Syntax

Dev::Util::Const

Defines named constants as Readonly, based on best practices.

$EMPTY_STR = q{};
$SPACE = q{ };
$SINGLE_QUOTE = q{'};
$DOUBLE_QUOTE = q{"};
$COMMA = q{,};

Dev::Util::Const

Dev::Util::OS

OS discovery and functions to execute and collect data from external programs.

use Dev::Util::OS;

my $OS = get_os();
my $hostname = get_hostname();
my $system_is_linux = is_linux();
my @seq = ipc_run_c( { cmd => 'seq 1 10', } );

Dev::Util::OS

Dev::Util::File

Provides functions to assist working with files and dirs, menus and prompts.

use Dev::Util::File;

my $fexists     = file_exists('/path/to/somefile');
my $canwritef   = file_writable('/path/to/somefile');
my $isplainfile = file_is_plain('/path/to/somefile');
my $issymlink   = file_is_symbolic_link('/path/to/somefile');
my $canreadd    = dir_readable('/path/to/somedir');
my $slash_added_dir = dir_suffix_slash('/dir/path/no/slash');
my $td = mk_temp_dir();

Dev::Util::File

Dev::Util::Query

Provides functions to ask the user for input.

banner( "Hello World", $outputFH );
display_menu( $msg, \@items );
my $action = yes_no_prompt( { text    => "Rename Files?", default => 1, });

Dev::Util::Query

Dev::Util::Backup

The backup function will make a copy of a file or dir with the date of the file appended. Directories are backed up by tar and gz.

my $backup_file = backup('myfile');
my $backup_dir  = backup('mydir/');

Dev::Util::Backup

Dev::Util::Sem

Module to do Semaphore locking

use Dev::Util::Sem;

my $sem = Sem->new('mylock.sem');
...
$sem->unlock;

Dev::Util::Sem

EXAMPLES

Example programs that demonstrate how the Dev::Util modules can be used are in the examples dir.

SEE ALSO

Dev::Util::Backup, Dev::Util::Const, Dev::Util::File, Dev::Util::OS, Dev::Util::Query Dev::Util::Syntax, Dev::Util::Sem,

AUTHOR

Matt Martini, <matt.martini at imaginarywave.com>

BUGS

Please report any bugs or feature requests to bug-dev-util at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dev-Util. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

INSTALLATION

To install this module, see INSTALL.md

TLDR; run the following commands:

perl Makefile.PL
make
make test
make install

SUPPORT AND DOCUMENTATION

You can find documentation for this module with the perldoc command.

perldoc Dev::Util

You can also look for information at:

HISTORY

This module was originally developed under the name MERM::Base.

TEMPLATE

module-starter \
    --module=Dev::Util \
    --module=Dev::Util::Backup \
    --module=Dev::Util::Const \
    --module=Dev::Util::File \
    --module=Dev::Util::OS \
    --module=Dev::Util::Query \
    --module=Dev::Util::Sem \
    --module=Dev::Util::Syntax \
    --builder=ExtUtils::MakeMaker \
    --author='Matt Martini' \
    --email=matt@imaginarywave.com \
    --ignore=git \
    --license=gpl3 \
    --genlicense \
    --minperl=5.018 \
    --verbose

ACKNOWLEDGMENTS

LICENSE AND COPYRIGHT

This software is Copyright © 2024-2025 by Matt Martini.

This is free software, licensed under:

The GNU General Public License, Version 3, June 2007