1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
|
package App::PRT::Command::RenameClass;
use strict;
use warnings;
use PPI;
use App::PRT::Util::DestinationFile;
use Path::Class;
sub new {
my ($class) = @_;
bless {
rule => undef,
}, $class;
}
# parse arguments from CLI
# arguments:
# @arguments
# returns:
# @rest_arguments
sub parse_arguments {
my ($self, @arguments) = @_;
die "source and destination class are required" unless @arguments >= 2;
$self->register(shift @arguments => shift @arguments);
@arguments;
}
# register a replacing rule
# arguments:
# $source: source class name
# $dest: destination class name
sub register {
my ($self, $source_class_name, $destination_class_name) = @_;
$self->{source_class_name} = $source_class_name;
$self->{destination_class_name} = $destination_class_name;
}
sub source_class_name {
my ($self) = @_;
$self->{source_class_name};
}
sub destination_class_name {
my ($self) = @_;
$self->{destination_class_name};
}
# refactor a file
# argumensts:
# $file: filename for refactoring
sub execute {
my ($self, $file) = @_;
my $replaced = 0;
my $document = PPI::Document->new($file);
# When parse failed
return unless $document;
my $should_rename = $self->_try_rename_package_statement($document);
$replaced += $self->_try_rename_includes($document);
$replaced += $self->_try_rename_parent_class($document);
$replaced += $self->_try_rename_quotes($document);
$replaced += $self->_try_rename_tokens($document);
$replaced += $self->_try_rename_symbols($document);
if ($should_rename) {
my $dest_file = App::PRT::Util::DestinationFile::destination_file($self->source_class_name, $self->destination_class_name, $file);
my $dest_dir = file($dest_file)->dir;
$dest_dir->mkpath;
$document->save($dest_file);
unlink($file);
$dest_file;
} else {
return unless $replaced;
$document->save($file);
$file;
}
}
# returns: should rename this document?
sub _try_rename_package_statement {
my ($self, $document) = @_;
my $package = $document->find_first('PPI::Statement::Package');
return unless $package;
return unless $package->namespace eq $self->source_class_name;
my $namespace = $package->schild(1);
return unless $namespace->isa('PPI::Token::Word');
$namespace->set_content($self->destination_class_name);
# Rename this file when the first significant token is package (heuristic).
# This skips comments and POD before the package statement.
return $document->schild(0)->DOES('PPI::Statement::Package');
}
sub _try_rename_includes {
my ($self, $document) = @_;
my $replaced = 0;
my $statements = $document->find('PPI::Statement::Include');
return 0 unless $statements;
for my $statement (@$statements) {
next unless defined $statement->module;
next unless $statement->module eq $self->source_class_name;
my $module = $statement->schild(1);
return unless $module->isa('PPI::Token::Word');
$module->set_content($self->destination_class_name);
$replaced++;
}
$replaced;
}
sub _try_rename_quotes {
my ($self, $document) = @_;
my $replaced = 0;
my $quotes = $document->find('PPI::Token::Quote');
return 0 unless $quotes;
for my $quote (@$quotes) {
next unless $quote->string eq $self->source_class_name;
$quote->set_content("'@{[ $self->destination_class_name ]}'");
$replaced++;
}
$replaced;
}
# TODO: too complicated
sub _try_rename_parent_class {
my ($self, $document) = @_;
my $replaced = 0;
my $includes = $document->find('PPI::Statement::Include');
return 0 unless $includes;
for my $statement (@$includes) {
next unless defined $statement->pragma;
next unless $statement->pragma =~ /^parent|base$/; # only 'use parent' and 'use base' are supported
# schild(2) is 'Foo' of use parent Foo
my $parent = $statement->schild(2);
if ($parent->isa('PPI::Token::Quote')) {
# The 'literal' method is not implemented by ::Quote::Double or ::Quote::Interpolate.
my $string = $parent->can('literal') ? $parent->literal : $parent->string;
if ($string eq $self->source_class_name) {
$parent->set_content("'@{[ $self->destination_class_name ]}'");
$replaced++;
}
} elsif ($parent->isa('PPI::Token::QuoteLike::Words')) {
# use parent qw(A B C) pattern
# literal is array when QuoteLike::Words
my $_replaced = 0;
my @new_literal = map {
if ($_ eq $self->source_class_name) {
$_replaced++;
$self->destination_class_name;
} else {
$_;
}
} $parent->literal;
if ($_replaced) {
$parent->set_content('qw(' . join(' ', @new_literal) . ')');
$replaced++;
}
}
}
$replaced;
}
# discussions:
# seems too wild
sub _try_rename_tokens {
my ($self, $document) = @_;
my $replaced = 0;
my $tokens = $document->find('PPI::Token');
return 0 unless $tokens;
for my $token (@$tokens) {
next unless $token->content eq $self->source_class_name;
$token->set_content($self->destination_class_name);
$replaced++;
}
$replaced;
}
# e.g.
# $Foo::Bar::GLOBAL_VAR
# ~~~~~~~~ Rename here
#
# $Foo::Bar::Buz::GLOBAL_VAR <= Don't rename because it's not the same class
sub _try_rename_symbols {
my ($self, $document) = @_;
my $replaced = 0;
my $symbols = $document->find('PPI::Token::Symbol');
return 0 unless $symbols;
my $source_class_name = $self->source_class_name;
my $destination_class_name = $self->destination_class_name;
for my $symbol (@$symbols) {
my $content = $symbol->content;
my $sigil = substr $content, 0, 1, '';
if ($content =~ s/\A${source_class_name}::// && scalar(split /::/, $content) == 1) {
$symbol->set_content($sigil . $destination_class_name . '::' . $content);
$replaced++;
}
}
$replaced;
}
1;
|