File::Fu::Dir::Temp - temporary directories


File-Fu documentation Contained in the File-Fu distribution.

Index


Code Index:

NAME

Top

File::Fu::Dir::Temp - temporary directories

SYNOPSIS

Top

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

new

  my $tmp = File::Fu::Dir::Temp->new($dir, 'foo');

chdir

  my $dir = $dir->chdir;

rename

Same as the base rename(), but promotes the temp dir to a regular Dir object (prevents any cleanup actions.)

  $temp = $temp->rename($dest);

nocleanup

Disable autocleanup.

  $dir->nocleanup;

DESTROY

Called automatically when the object goes out of scope.

  $dir->DESTROY;

AUTHOR

Top

Eric Wilhelm @ <ewilhelm at cpan dot org>

http://scratchcomputing.com/

BUGS

Top

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

Top

NO WARRANTY

Top

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

Top

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


File-Fu documentation Contained in the File-Fu distribution.
package File::Fu::Dir::Temp;
$VERSION = v0.0.7;

use warnings;
use strict;
use Carp;

use File::Fu::File::Temp;
  *_validate = \&File::Fu::File::Temp::_validate;
  *XXX = \&File::Fu::File::Temp::XXX;

use base 'File::Fu::Dir';
use overload (
  '/=' => sub {croak("cannot mutate a temp dir");},
  '+=' => sub {croak("cannot mutate a temp dir");},
  '.=' => sub {croak("cannot mutate a temp dir");},
);

use Class::Accessor::Classy;
rs auto_delete => \(my $set_auto_delete);
rs dir_class => \(my $set_dir_class);
no  Class::Accessor::Classy;

{
my %argmap = (
  nocleanup => [UNLINK => 0],
);
sub new {
  my $proto = shift;
  if(ref($proto)) { # calls to subdir, etc are not in the Temp class
    return $proto->dir_class->new(@_);
  }
  my $class = $proto;
  #warn "args: @_";
  my ($dir, $send, $opt) = $class->_validate(\%argmap, @_);

  #warn "dir: $dir";
  #warn "opts: @$send";
  my $temp = File::Temp::tempdir(@$send);
  my $self = $class->SUPER::new($temp);
  $self->{$_} = $opt->{$_} for(keys(%$opt));
  $self->{_proc} = $$;
  $self->$set_dir_class(ref($dir));

  return($self);
}} # end subroutine new definition
########################################################################

sub chdir {
  my $self = shift;

  my $dir = $self->SUPER::chdir;
  $dir->{temp_parent} = $self;
  return($dir);
} # chdir ##############################################################

sub clone {
  my $self = shift;
  $self = $self->SUPER::clone;
  bless($self, $self->dir_class);
} # end subroutine clone definition
########################################################################

sub rename {
  my $self = shift->SUPER::rename(@_);
  bless($self, $self->dir_class);
  return($self);
}

# TODO File::Fu->temp_dir->chdir causes immediate deletion?

# XXX I think this is named wrong -- should probably just delete the
# dependency on File::Temp because I can't override that END block
sub nocleanup {
  my $self = shift;
  $self->$set_auto_delete(0);
} # end subroutine nocleanup definition
########################################################################

sub DESTROY {
  my $self = shift;

  # ? should this have:
  return unless($self->auto_delete);

  # forked case
  return unless($$ == $self->{_proc});

  my $string = $self->stringify;
  #warn "DESTROY ($$/$self->{_proc}", $string;
  # XXX overload stops operating in DESTROY()?

  die("$string does not exist") unless(-d $string);
  $self->remove;
  $self->{auto_delete} = 0;
} # end subroutine DESTROY definition
########################################################################

# vi:ts=2:sw=2:et:sta
1;