/ 
File-Fu-v0.0.4
River stage one • 4 direct dependents • 4 total dependents
/ File::Fu

NAME

File::Fu - file and directory objects

SYNOPSIS

The directory constructor:

my $dir = File::Fu->dir("bar");
print "$dir\n"; # 'dir/'

my $file = $dir + 'bar.txt';
print "$file\n"; # 'foo/bar.txt'

my $d2 = $dir % 'baz'; # 'barbaz/'
my $d3 = $dir / 'bat'; # 'bar/bat/'

my $file2 = $dir / 'bat' + 'foo.txt'; # 'bar/bat/foo.txt'

The file constructor:

my $file = File::Fu->file("foo");
$file->e and warn "$file exists";
$file->l and warn "$file is a link";
warn "file is in ", $file->dir;

ABOUT

This class provides the toplevel interface to File::Fu directory and file objects, with operator overloading which allows precise path composition and support for most builtin methods, as well as creation of temporary files/directories, finding files, and more.

The interface and style are quite different than the perl builtins or File::Spec. The syntax is concise. Errors are thrown with croak(), so you never need to check a return code.

Constructors

The actual objects are in the 'Dir' and 'File' sub-namespaces.

dir

my $dir = File::Fu->dir($path);

See "new" in File::Fu::Dir

file

my $file = File::Fu->file($path);

See "new" in File::Fu::File

Class Constants

tmp

Your system's '/tmp/' directory (or equivalent of that.)

my $dir = File::Fu->tmp;

home

User's $HOME directory.

my $dir = File::Fu->home;

program_name

The absolute name of your program. This will be relative from the time File::Fu was loaded. It dies if the name is '-e'.

my $prog = File::Fu->program_name;

If File::Fu was loaded after a chdir and the $0 was relative, calling program_name() throws an error. (Unless you set $0 correctly before requiring File::Fu.)

program_dir

Returns what typically corresponds to program_name()->dirname, but just the compile-time cwd() when $0 is -e/-E.

my $dir = File::Fu->program_dir;

Class Methods

THIS_FILE

A nicer way to say __FILE__.

my $file = File::Fu->THIS_FILE;

cwd

The current working directory.

my $dir = File::Fu->cwd;

Temporary Directories and Files

These class methods call the corresponding File::Fu::Dir methods on the value of tmp(). That is, you get a temporary file/dir in the '/tmp/' directory.

temp_dir

my $dir = File::Fu->temp_dir;

temp_file

my $handle = File::Fu->temp_file;

Subclassing

You may wish to subclass File:Fu and override the dir_class() and/or file_class() class methods to point to your own Dir/File subclasses.

my $class = 'My::FileFu';
my $dir = $class->dir("foo");

See File::Fu::File and File::Fu::Dir for more info.

See Also

File::Fu::why if I need to explain my motivations.

Path::Class, from which many an idea was taken.

File::stat, IO::File, File::Spec, File::Find, File::Temp, File::Path, File::Basename, perlfunc, perlopentut.

AUTHOR

Eric Wilhelm @ <ewilhelm at cpan dot org>

http://scratchcomputing.com/

BUGS

If you found this module on CPAN, please report any bugs or feature requests through the web interface at http://rt.cpan.org. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

If you pulled this development version from my /svn/, please contact me directly.

COPYRIGHT

Copyright (C) 2008 Eric L. Wilhelm, All Rights Reserved.

NO WARRANTY

Absolutely, positively NO WARRANTY, neither express or implied, is offered with this software. You use this software at your own risk. In case of loss, no person or entity owes you anything whatsoever. You have been warned.

LICENSE

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.