Make sure the POD headings are linkable

[perl/modules/rgit.git] / lib / App / Rgit / Utils.pm

diff --git a/lib/App/Rgit/Utils.pm b/lib/App/Rgit/Utils.pm
index a4236ce39d924d26bf0424a9207cbfb37866365c..ee1fdd348014622aec683bd379cd034a4838c1f5 100644 (file)
--- a/lib/App/Rgit/Utils.pm
+++ b/lib/App/Rgit/Utils.pm
@@ -3,29 +3,61 @@ package App::Rgit::Utils;
 use strict;
 use warnings;
 
-use Carp qw/croak/;
+use Cwd        (); # abs_path
+use File::Spec (); # file_name_is_absolute, updir, splitdir, splitpath
 
 =head1 NAME
 
-App::Rgit::Utils - Miscellanous utilities for App::Rgit classes.
+App::Rgit::Utils - Miscellaneous utilities for App::Rgit classes.
 
 =head1 VERSION
 
-Version 0.05
+Version 0.08
 
 =cut
 
-our $VERSION = '0.05';
+our $VERSION = '0.08';
 
 =head1 DESCRIPTION
 
-Miscellanous utilities for L<App::Rgit> classes.
+Miscellaneous utilities for L<App::Rgit> classes.
 
 This is an internal module to L<rgit>.
 
+=head1 FUNCTIONS
+
+=head2 C<abs_path>
+
+    my $absolute_path = abs_path($path);
+
+Forcefully make a path C<$path> absolute (in L<Cwd/abs_path>'s meaning of the term) when it isn't already absolute or when it contains C<'..'>.
+
+=cut
+
+sub abs_path {
+ my ($path) = @_;
+
+ if (File::Spec->file_name_is_absolute($path)) {
+  my $updir  = File::Spec->updir;
+  my @chunks = File::Spec->splitdir((File::Spec->splitpath($path))[1]);
+
+  unless (grep $_ eq $updir, @chunks) {
+   return $path;
+  }
+ }
+
+ return Cwd::abs_path($path);
+}
+
 =head1 CONSTANTS
 
-=head2 C<NEXT>, C<REDO>, C<LAST>, C<SAVE>
+=head2 C<NEXT>
+
+=head2 C<REDO>
+
+=head2 C<LAST>
+
+=head2 C<SAVE>
 
 Codes to return from the C<report> callback to respectively proceed to the next repository, retry the current one, end it all, and save the return code.
 
@@ -38,7 +70,15 @@ use constant {
  LAST => 0x8,
 };
 
-=head2 C<DIAG>, C<INFO>, C<WARN>, C<ERR> and C<CRIT>
+=head2 C<DIAG>
+
+=head2 C<INFO>
+
+=head2 C<WARN>
+
+=head2 C<ERR>
+
+=head2 C<CRIT>
 
 Message levels.
 
@@ -51,25 +91,9 @@ use constant {
  CRIT => 0,
 };
 
-=head1 FUNCTIONS
-
-=head2 C<validate @method_args>
-
-Sanitize arguments passed to methods.
-
-=cut
-
-sub validate {
- my $class = shift;
- croak 'Optional arguments must be passed as key/value pairs' if @_ % 2;
- $class = ref($class) || $class;
- $class = caller unless $class;
- return $class, @_;
-}
-
 =head1 EXPORT
 
-C<validate> is only exported on request, either by its name or by the C<'funcs'> tag.
+L<abs_path> is only exported on request.
 
 C<NEXT> C<REDO>, C<LAST> and C<SAVE> are only exported on request, either by their name or by the C<'codes'> tags.
 
@@ -81,7 +105,7 @@ use base qw/Exporter/;
 
 our @EXPORT         = ();
 our %EXPORT_TAGS    = (
- funcs  => [ qw/validate/ ],
+ funcs  => [ qw/abs_path/ ],
  codes  => [ qw/SAVE NEXT REDO LAST/ ],
  levels => [ qw/INFO WARN ERR CRIT/ ],
 );
@@ -95,12 +119,13 @@ L<rgit>.
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://profvince.com>.
-   
+
 You can contact me by mail or on C<irc.perl.org> (vincent).
 
 =head1 BUGS
 
-Please report any bugs or feature requests to C<bug-rgit at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=rgit>.  I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
+Please report any bugs or feature requests to C<bug-rgit at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=rgit>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
 
 =head1 SUPPORT
 
@@ -110,7 +135,7 @@ You can find documentation for this module with the perldoc command.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2008-2009 Vincent Pit, all rights reserved.
+Copyright 2008,2009,2010 Vincent Pit, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.