package PPIx::EditorTools::RenamePackage;
use strict;
BEGIN {
$^W = 1;
}
use base 'PPIx::EditorTools';
use Class::XSAccessor accessors => { 'replacement' => 'replacement' };
use PPI;
use Carp;
our $VERSION = '0.07';
=pod
=head1 NAME
PPIx::EditorTools::RenamePackage - Change the package name
=head1 SYNOPSIS
my $munged = PPIx::EditorTools::RenamePackage->new->rename(
code => "package TestPackage;\nuse strict;\nBEGIN {
$^W = 1;
}\n1;\n",
replacement => 'NewPackage'
);
my $new_code_as_string = $munged->code;
my $package_ppi_element = $munged->element;
=head1 DESCRIPTION
This module uses PPI to change the package name of code.
=head1 METHODS
=over 4
=item new()
Constructor. Generally shouldn't be called with any arguments.
=item rename( ppi => PPI::Document $ppi, replacement => Str )
=item rename( code => Str $code, replacement => Str )
Accepts either a C<PPI::Document> to process or a string containing
the code (which will be converted into a C<PPI::Document>) to process.
Replaces the package name with that supplied in the C<replacement>
parameter and returns a C<PPIx::EditorTools::ReturnObject> with the
new code available via the C<ppi> or C<code> accessors, as a
C<PPI::Document> or C<string>, respectively.
Croaks with a "package name not found" exception if unable to find the
package name.
=back
=cut
sub rename {
my ( $self, %args ) = @_;
$self->process_doc(%args);
my $replacement = $args{replacement} || croak "replacement required";
my $doc = $self->ppi;
# TODO: support MooseX::Declare
my $package = $doc->find_first('PPI::Statement::Package')
or die "no package found";
my $namespace = $package->schild(1) or croak "package name not found";
$namespace->isa('PPI::Token::Word') or croak "package name not found";
$namespace->{content} = $replacement;
return PPIx::EditorTools::ReturnObject->new( ppi => $doc,
element => $package );
}
1;
__END__
=head1 SEE ALSO
This class inherits from C<PPIx::EditorTools>.
Also see L<App::EditorTools>, L<Padre>, and L<PPI>.
=head1 AUTHOR
Mark Grimes, E<lt>mgrimes@cpan.orgE<gt>
=head1 COPYRIGHT AND LICENSE
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.
=cut