如何使用 PPI 查找注释，然后在其前面插入代码？

Question

我试图在 perl 源文件中找到注释 # VERSION 。然后我想在评论之前插入版本（或代替无关紧要）。谁能告诉我使用 PPI 执行此操作的正确方法？

之前，

use strict;
use warnings;
package My::Package;
# VERSION
...

之后

use strict;
use warnings;
package My::Package;
our $VERSION = 0.1;# VERSION
...

在维护最终结果中的 # VERSION

我实际上对如何查找 # VERSION 有一些想法，但其中一个是序列化 ppi 文档的正则表达式，这似乎不正确，并且另一个是在评论上使用 find_first ，但如果它不是第一个，我不知道该怎么做。

更新的代码 这似乎更接近正确的解决方案，因为它只查看注释。但我不确定如何使用或真正如何创建新变量。

#!/usr/bin/env perl
use 5.012;
use strict;
use warnings;

use PPI;

my $ppi = PPI::Document->new('test.pm');

my $comments = $ppi->find('PPI::Token::Comment');

my $version = PPI::Statement::Variable->new;

foreach ( @{$comments} ) {
    if ( /^\s*#\s+VERSION\b$/ ) {
        $_->replace($version);
    }
}

更新

这个问题的答案成为DZP::OurPkgVersion

Answer 1

这里有一些代码可以完成您所描述的操作 - 无论如何它都会让您开始。它是从 Catalyst::Helper::AuthDBIC (来源），这是使用 PPI 的完整示例（尽管其中一些可能不是最佳实践）：

sub make_model {
    ### snip some stuff
    my $module = "lib/$user_schema_path.pm";
    my $doc = PPI::Document->new($module);
    my $digest_code = # some code
    my $comments = $doc->find(
        sub { $_[1]->isa('PPI::Token::Comment')}
    );
    my $last_comment = $comments->[$#{$comments}];
    $last_comment->set_content($digest_code);
    $doc->save($module);
}

我想在您的情况下，您会获取 $comments arrayref 并修改与 /VERSION/ 匹配的第一个项目与替换内容。

这是海报提供的最终代码：

#!/usr/bin/env perl
use 5.012;
use warnings;

use PPI;

my $ppi = PPI::Document->new('test.pm');

my $comments = $ppi->find('PPI::Token::Comment');

my $version = 0.01;

my $_;
foreach ( @{$comments} ) {
    if ( /^(\s*)(#\s+VERSION\b)$/ ) {
        my $code = "$1" . 'our $VERSION = ' . "$version;$2\n";
        $_->set_content("$code");
    }
}
$ppi->save('test1.pm');