PPIx::EditorTools::RenamePackageFromPath.3pm

Langue: en

Version: 2009-09-19 (ubuntu - 24/10/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

PPIx::EditorTools::RenamePackageFromPath - Change the package name based on the files path

SYNOPSIS

     my $munged = PPIx::EditorTools::RenamePackageFromPath->new->rename(
         code        => "package TestPackage;\nuse strict;\nBEGIN {
         $^W = 1;
 }\n1;\n",
         filename => './lib/Test/Code/Path.pm',
     );
 
     my $new_code_as_string = $munged->code;
     my $package_ppi_element = $munged->element;

DESCRIPTION

This module uses PPI to change the package name of code.

METHODS

new()
Constructor. Generally shouldn't be called with any arguments.
rename( ppi => PPI::Document $ppi, filename => Str ) =item rename( code => Str $code, filename => Str )
Accepts either a "PPI::Document" to process or a string containing the code (which will be converted into a "PPI::Document") to process. Replaces the package name with that supplied in the "filename" parameter and returns a "PPIx::EditorTools::ReturnObject" with the new code available via the "ppi" or "code" accessors, as a "PPI::Document" or "string", respectively.

An attempt will be made to derive the package name from the filename passed as a parameter. The filename's path will converted to an absolute path and it will be searched for a "lib" directory which will be assumed the start of the package name. If no "lib" directory can be found in the absolute path, the relative path will be used.

Croaks with a ``package name not found'' exception if unable to find the package name.

SEE ALSO

This class inherits from "PPIx::EditorTools". Also see App::EditorTools, Padre, and PPI.

AUTHOR

Mark Grimes, <mgrimes@cpan.org> Copyright (C) 2009 by Mark Grimes

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.2 or, at your option, any later version of Perl 5 you may have available.