An open API service indexing awesome lists of open source software.

https://github.com/mjgardner/tree-path-class

Tree for Path::Class objects
https://github.com/mjgardner/tree-path-class

Last synced: 10 months ago
JSON representation

Tree for Path::Class objects

Awesome Lists containing this project

README

          

=pod

=encoding UTF-8

=for :stopwords Mark Gardner eBay Enterprise cpan testmatrix url annocpan anno bugtracker
rt cpants kwalitee diff irc mailto metadata placeholders metacpan

=head1 NAME

Tree::Path::Class - Tree for Path::Class objects

=head1 VERSION

version 0.008

=head1 SYNOPSIS

use Tree::Path::Class;
use Path::Class;

my $tree = Tree::Path::Class->new( dir('/parent/dir') );
my $child = Tree::Path::Class->new( file('child/file') );
$tree->add_child($child);

print $child->path->stringify;
# /parent/dir/child/file

=head1 DESCRIPTION

This module subclasses L to only accept
L or L
values, and provides a C attribute for retrieving the full path of a tree
branch or leaf.

=head1 ATTRIBUTES

=head2 path

A read-only accessor that returns the tree's full
L or L
object, with all parents prepended.

=head1 METHODS

=head2 FOREIGNBUILDARGS

Coerces the parameter passed to C into a
L or L
before passing it on to the superclass constructor.

=head2 add_child

Works just like L. Plain L
nodes will be recursively recreated as C
nodes when added.

=head2 meta

Unlike L, this method provides access to the underlying
L meta-object rather than a hashref of arbitrary metadata.

=head1 SUPPORT

=head2 Perldoc

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

perldoc Tree::Path::Class

=head2 Websites

The following websites have more information about this module, and may be of help to you. As always,
in addition to those websites please use your favorite search engine to discover more resources.

=over 4

=item *

Search CPAN

The default CPAN search engine, useful to view POD in HTML format.

L

=item *

AnnoCPAN

The AnnoCPAN is a website that allows community annotations of Perl module documentation.

L

=item *

CPAN Ratings

The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.

L

=item *

CPANTS

The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

L

=item *

CPAN Testers

The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions.

L

=item *

CPAN Testers Matrix

The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

L

=item *

CPAN Testers Dependencies

The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

L

=back

=head2 Bugs / Feature Requests

Please report any bugs or feature requests through the web
interface at L. You will be automatically notified of any
progress on the request by the system.

=head2 Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play
with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull
from your repository :)

L

git clone git://github.com/mjgardner/Tree-Path-Class.git

=head1 AUTHOR

Mark Gardner

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by eBay Enterprise.

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

=cut