File Coverage

blib/lib/Catmandu/DirectoryIndex/UUID.pm

Criterion	Covered	Total	%
statement	86	86	100.0
branch	18	26	69.2
condition	5	12	41.6
subroutine	20	20	100.0
pod	0	6	0.0
total	129	150	86.0

package Catmandu::DirectoryIndex::UUID;

our $VERSION = '1.16';

use Catmandu::Sane;
use Catmandu::Util qw(:is :check);
use Moo;
use Cwd;
use Path::Tiny;
use Path::Iterator::Rule;
use File::Spec;
use Catmandu::BadArg;
use Catmandu::Error;
use Data::Dumper;
use namespace::clean;

with "Catmandu::DirectoryIndex";

sub is_uuid {
    my $id = $_[0];
    is_string($id)
        && $id
        =~ /^[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12}$/o;
}

sub _to_path {
    my ($self, $id) = @_;

    Catmandu::BadArg->throw("need valid uuid") unless is_uuid($id);

    File::Spec->catdir($self->base_dir, unpack("(A3)*", $id));
}

sub _from_path {
    my ($self, $path) = @_;

    my @split_path = File::Spec->splitdir($path);
    my $id         = join("",
        splice(@split_path, scalar(File::Spec->splitdir($self->base_dir))));

    $id = uc($id);

    Catmandu::BadArg->throw("invalid uuid detected: $id") unless is_uuid($id);

    $id;
}

sub get {
    my ($self, $id) = @_;

    my $f_id = uc($id);
    my $path = $self->_to_path($f_id);

    is_string($path) && -d $path ? {_id => $f_id, _path => $path} : undef;

}

sub add {
    my ($self, $id) = @_;

    my $f_id = uc($id);
    my $path = $self->_to_path($f_id);

    unless (-d $path) {

        my $err;
        path($path)->mkpath({error => \$err});

        Catmandu::Error->throw(
            "unable to create directory $path: " . Dumper($err))
            if defined($err) && scalar(@$err);

    }

    {_id => $f_id, _path => $path};

}

sub delete {
    my ($self, $id) = @_;

    my $f_id = uc($id);
    my $path = $self->_to_path($f_id);

    if (is_string($path) && -d $path) {

        my $err;
        path($path)->remove_tree({error => \$err});

        Catmandu::Error->throw(
            "unable to remove directory $path: " . Dumper($err))
            if defined($err) && scalar(@$err);

    }

    1;
}

sub delete_all {
    my $self = $_[0];

    if (-d $self->base_dir) {

        my $err;
        path($self->base_dir)->remove_tree({keep_root => 1, error => \$err});

        Catmandu::Error->throw("unable to remove entries from base directory "
                . $self->base_dir . ": "
                . Dumper($err))
            if defined($err) && scalar(@$err);

    }

    1;
}

sub generator {
    my $self = $_[0];

    return sub {

        state $rule;
        state $iter;
        state $base_dir = $self->base_dir();

        unless ($iter) {

            $rule = Path::Iterator::Rule->new();
            $rule->min_depth(12);
            $rule->max_depth(12);
            $rule->directory();
            $iter = $rule->iter($base_dir, {depthfirst => 1});

        }

        my $path = $iter->();

        return unless defined $path;

        #Path::Iterator::Rule hardcodes forward slashes
        $path =~ s/\//\\/go if $^O eq "MSWin32";

#TODO: does not throw an error when directory is less than 12 levels (because no directories are validated)
        my $id = $self->_from_path($path);

        +{_id => $id, _path => $path};
    };
}

1;

__END__

=pod

=head1 NAME

Catmandu::DirectoryIndex::UUID - A uuid based path translator

=head1 SYNOPSIS

    use Catmandu::DirectoryIndex::UUID;

    my $p = Catmandu::DirectoryIndex::UUID->new(
        base_dir => "/data"
    );

    # Returns mapping like { _id  => "9A581C80-1189-11E8-AB6D-46BC153F89DB", "/data/9A5/81C/80-/118/9-1/1E8/-AB/6D-/46B/C15/3F8/9DB" }
    # Can be undef
    my $mapping = $p->get("9A581C80-1189-11E8-AB6D-46BC153F89DB");

    # Create path and return mapping
    my $mapping = $p->add("9A581C80-1189-11E8-AB6D-46BC153F89DB");

    # Catmandu::DirectoryIndex::Number is a Catmandu::Iterable
    # Returns list of records: [{ _id => 1234, _path => "/data/000/001/234" }]
    my $mappings = $p->to_array();

=head1 METHODS

=head2 new( base_dir => $base_dir )

Create a new Catmandu::DirectoryIndex::UUID with the following configuration
parameters:

=over

=item base_dir

See L<Catmandu::DirectoryIndex>

=back

=head1 LIMITATIONS

The keys in this directory can only be UUID identifiers.

=head1 INHERITED METHODS

This Catmandu::DirectoryIndex::Number implements:

=over 3

=item L<Catmandu::DirectoryIndex>

=back

=head1 SEE ALSO

L<Catmandu::DirectoryIndex>

=cut