Perl::Critic::Document - Caching wrapper around PPI::Document
use PPI::Document; use Perl::Critic::Document; my $doc = PPI::Document->new('Foo.pm'); $doc = Perl::Critic::Document->new($doc); ## Then use the instance just like a PPI::Document
Perl::Critic does a lot of iterations over the PPI document tree via the PPI::Document::find() method. To save some time, this class pre-caches a lot of the common find() calls in a single traversal. Then, on subsequent requests we return the cached data.
PPI::Document::find()
find()
This is implemented as a facade, where method calls are handed to the stored PPI::Document instance.
PPI::Document
This facade does not implement the overloaded operators from PPI::Document (that is, the use overload ... work). Therefore, users of this facade must not rely on that syntactic sugar. So, for example, instead of my $source = "$doc"; you should write my $source = $doc-content();>
use overload ...
my $source = "$doc";
my $source = $doc-
Perhaps there is a CPAN module out there which implements a facade better than we do here?
Create a new instance referencing a PPI::Document instance.
If $wanted is a simple PPI class name, then the cache is employed. Otherwise we forward the call to the corresponding method of the PPI::Document instance.
$wanted
Returns the filename for the source code if applicable (PPI::Document::File) or undef otherwise (PPI::Document).
undef
To be compatible with other modules that expect to get a PPI::Document, the Perl::Critic::Document class masquerades as the PPI::Document class.
Chris Dolan <cdolan@cpan.org>
Copyright (c) 2006 Chris Dolan. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.
To install Perl::Critic, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perl::Critic
CPAN shell
perl -MCPAN -e shell install Perl::Critic
For more information on module installation, please visit the detailed CPAN module installation guide.