Alan Haggai Alavi > Path-Trim > Path::Trim

Download:
Path-Trim-v0.0.3.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: v0.0.3   Source  

NAME ^

Path::Trim - Makes paths compact

VERSION ^

This document describes Path::Trim version 0.0.3

SYNOPSIS ^

    use Path::Trim;

    my $path = 'a/b/../.././c/d';
    my $pt = Path::Trim->new();
    $pt->set_directory_separator('/');
    $trimmed_path = $pt->trim_path($path);

DESCRIPTION ^

Trims paths containing redundant current directory and parent directory entries.

For example:

    a/b/../.././c/d

is equivalent to:

    c/d

INTERFACE ^

new()

Returns an object of Path::Trim.

get_current_directory()

Returns the current directory representation.

Example:

    .

Defaults to . if not set with set_current_directory().

set_current_directory( current_directory )

Sets the current directory representation to the value of current_directory.

get_parent_directory()

Returns the parent directory representation.

Example:

    ..

Defaults to .. if not set with set_parent_directory().

set_parent_directory( parent_directory )

Sets the parent directory representation to the value of parent_directory.

get_directory_separator()

Returns the directory separator, if it has already been set with set_directory_separator().

set_directory_separator( directory_separator )

Sets the directory separator to the value of directory_separator.

trim_path( path )

Accepts a path (without volume) and returns the trimmed version. It assumes that a directory separator has already been set with set_directory_separator().

This is different from Cwd's abs_path() in that it does not have any filesystem ties.

CONFIGURATION AND ENVIRONMENT ^

Path::Trim requires no configuration files or environment variables.

DEPENDENCIES ^

None.

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-path-trim@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR ^

Alan Haggai Alavi <haggai@cpan.org>

LICENCE AND COPYRIGHT ^

Copyright (c) 2010, 2011 Alan Haggai Alavi <haggai@cpan.org>. All rights reserved.

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

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: