Build all packages removed dependencies of libtest-exception-perl libtest-warn-perl...
[dh-make-perl] / dev / i386 / libperl-critic-perl / libperl-critic-perl-1.088 / lib / Perl / Critic / Policy / RegularExpressions / ProhibitCaptureWithoutTest.pm
diff --git a/dev/i386/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/Policy/RegularExpressions/ProhibitCaptureWithoutTest.pm b/dev/i386/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/Policy/RegularExpressions/ProhibitCaptureWithoutTest.pm
new file mode 100644 (file)
index 0000000..73cc2da
--- /dev/null
@@ -0,0 +1,161 @@
+##############################################################################
+#      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Policy/RegularExpressions/ProhibitCaptureWithoutTest.pm $
+#     $Date: 2008-07-03 10:19:10 -0500 (Thu, 03 Jul 2008) $
+#   $Author: clonezone $
+# $Revision: 2489 $
+##############################################################################
+
+package Perl::Critic::Policy::RegularExpressions::ProhibitCaptureWithoutTest;
+
+use 5.006001;
+use strict;
+use warnings;
+use Readonly;
+
+use Perl::Critic::Utils qw{ :severities };
+use base 'Perl::Critic::Policy';
+
+our $VERSION = '1.088';
+
+#-----------------------------------------------------------------------------
+
+Readonly::Scalar my $DESC => q{Capture variable used outside conditional};
+Readonly::Scalar my $EXPL => [ 253 ];
+
+#-----------------------------------------------------------------------------
+
+sub supported_parameters { return ()                       }
+sub default_severity     { return $SEVERITY_MEDIUM         }
+sub default_themes       { return qw(core pbp maintenance) }
+sub applies_to           { return 'PPI::Token::Magic'      }
+
+#-----------------------------------------------------------------------------
+
+sub violates {
+    my ($self, $elem, $doc) = @_;
+    return if $elem !~ m/\A \$[1-9] \z/mx;
+    return if _is_in_conditional_expression($elem);
+    return if _is_in_conditional_structure($elem);
+    return $self->violation( $DESC, $EXPL, $elem );
+}
+
+sub _is_in_conditional_expression {
+    my $elem = shift;
+
+    # simplistic check: is there one of qw(&& || ?) between a match and the capture var?
+    my $psib = $elem->sprevious_sibling;
+    while ($psib) {
+        if ($psib->isa('PPI::Token::Operator')) {
+            my $op = $psib->content;
+            if ($op eq q{&&} || $op eq q{||} || $op eq q{?}) {
+                $psib = $psib->sprevious_sibling;
+                while ($psib) {
+                    return 1 if ($psib->isa('PPI::Token::Regexp::Match'));
+                    return 1 if ($psib->isa('PPI::Token::Regexp::Substitute'));
+                    $psib = $psib->sprevious_sibling;
+                }
+                return; # false
+            }
+        }
+        $psib = $psib->sprevious_sibling;
+    }
+
+    return; # false
+}
+
+sub _is_in_conditional_structure {
+    my $elem = shift;
+
+    my $stmt = $elem->statement();
+    while ($stmt && $elem->isa('PPI::Statement::Expression')) {
+       #return if _is_in_conditional_expression($stmt);
+       $stmt = $stmt->statement();
+    }
+    return if !$stmt;
+
+    # Check if any previous statements in the same scope have regexp matches
+    my $psib = $stmt->sprevious_sibling;
+    while ($psib) {
+        if ($psib->isa('PPI::Node')) {  # skip tokens
+            return if $psib->find_any('PPI::Token::Regexp::Match'); # fail
+            return if $psib->find_any('PPI::Token::Regexp::Substitute'); # fail
+        }
+        $psib = $psib->sprevious_sibling;
+    }
+
+    # Check for an enclosing 'if', 'unless', 'endif', or 'else'
+    my $parent = $stmt->parent;
+    while ($parent) { # never false as long as we're inside a PPI::Document
+        if ($parent->isa('PPI::Statement::Compound')) {
+            return 1;
+        }
+        elsif ($parent->isa('PPI::Structure')) {
+           return 1 if _is_in_conditional_expression($parent);
+           return 1 if _is_in_conditional_structure($parent);
+           $parent = $parent->parent;
+        }
+        else {
+           last;
+        }
+    }
+
+    return; # fail
+}
+
+1;
+
+#-----------------------------------------------------------------------------
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Perl::Critic::Policy::RegularExpressions::ProhibitCaptureWithoutTest - Capture variable used outside conditional.
+
+=head1 AFFILIATION
+
+This Policy is part of the core L<Perl::Critic> distribution.
+
+
+=head1 DESCRIPTION
+
+If a regexp match fails, then any capture variables (C<$1>, C<$2>,
+...) will be undefined.  Therefore it's important to check the return
+value of a match before using those variables.
+
+This policy checks that capture variables are inside a
+conditional and do not follow an regexps.
+
+This policy does not check whether that conditional is actually
+testing a regexp result, nor does it check whether a regexp actually
+has a capture in it.  Those checks are too hard.
+
+
+=head1 CONFIGURATION
+
+This Policy is not configurable except for the standard options.
+
+
+=head1 AUTHOR
+
+Chris Dolan <cdolan@cpan.org>
+
+=head1 COPYRIGHT
+
+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.
+
+=cut
+
+# Local Variables:
+#   mode: cperl
+#   cperl-indent-level: 4
+#   fill-column: 78
+#   indent-tabs-mode: nil
+#   c-indentation-style: bsd
+# End:
+# ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :