« blib/lib/Perl/Lint/Policy/ErrorHandling/RequireCarping.pm
↑ Summary
blib/lib/Perl/Lint/Policy/Variables/ProhibitConditionalDeclarations.pm »
| 1 | package Perl::Lint::Policy::Modules::RequireFilenameMatchesPackage; | ||
| 2 | use strict; | ||
| 3 | use warnings; | ||
| 4 | use Perl::Lint::Constants::Type; | ||
| 5 | use parent "Perl::Lint::Policy"; | ||
| 6 | |||
| 7 | use constant { | ||
| 8 | DESC => 'Package declaration must match filename', | ||
| 9 | EXPL => 'Correct the filename or package statement', | ||
| 10 | }; | ||
| 11 | |||
| 12 | sub evaluate { | ||
| 13 | my ($class, $realfile, $tokens, $src, $args) = @_; | ||
| 14 | |||
| 15 | if ($src =~ /\A#!/) { # for exempt | ||
| 16 | return []; | ||
| 17 | } | ||
| 18 | |||
| 19 | # Determine the filename with considering directive | ||
| 20 | my $file; | ||
| 21 | my @src_rows = split /\r?\n/, $src; | ||
| 22 | my $row = 0; | ||
| 23 | my $directive_declared_row = 0; | ||
| 24 | for my $src_row (@src_rows) { | ||
| 25 | $row++; | ||
| 26 | if ($src_row =~ /\A#line\s\d+\s(.+)\Z/) { | ||
| 27 | if ($file) { | ||
| 28 | return [{ | ||
| 29 | filename => $realfile, | ||
| 30 | line => $row, | ||
| 31 | description => DESC, | ||
| 32 | explanation => EXPL, | ||
| 33 | policy => __PACKAGE__, | ||
| 34 | }]; | ||
| 35 | } | ||
| 36 | ($file = $1) =~ s/['"]//g; | ||
| 37 | $directive_declared_row = $row; | ||
| 38 | } | ||
| 39 | } | ||
| 40 | $file ||= $realfile; | ||
| 41 | |||
| 42 | my @violations; | ||
| 43 | my @paths; | ||
| 44 | for (my $i = 0, my $next_token, my $token_type, my $token_data; my $token = $tokens->[$i]; $i++) { | ||
| 45 | $next_token = $tokens->[$i+1]; | ||
| 46 | $token_type = $token->{type}; | ||
| 47 | $token_data = $token->{data}; | ||
| 48 | if ($token_type == PACKAGE) { | ||
| 49 | if ($next_token->{type} == CLASS) { | ||
| 50 | push @paths, { | ||
| 51 | path => "$next_token->{data}", | ||
| 52 | line => $token->{line}, | ||
| 53 | }; | ||
| 54 | next; | ||
| 55 | } | ||
| 56 | |||
| 57 | my $path = ''; | ||
| 58 | for ($i++; my $token = $tokens->[$i]; $i++) { | ||
| 59 | my $token_type = $token->{type}; | ||
| 60 | if ($token_type == NAMESPACE) { | ||
| 61 | $path .= $token->{data}; | ||
| 62 | } | ||
| 63 | elsif ($token_type == NAMESPACE_RESOLVER) { | ||
| 64 | $path .= '/'; | ||
| 65 | } | ||
| 66 | else { | ||
| 67 | push @paths, { | ||
| 68 | path => $path, | ||
| 69 | line => $token->{line}, | ||
| 70 | }; | ||
| 71 | last; | ||
| 72 | } | ||
| 73 | } | ||
| 74 | } | ||
| 75 | } | ||
| 76 | |||
| 77 | for my $p (@paths) { | ||
| 78 | my $is_directive_declared_after = 0; | ||
| 79 | my $should_be_no_error = 0; | ||
| 80 | |||
| 81 | my $path = $p->{path}; | ||
| 82 | my $package_declared_line = $p->{line}; | ||
| 83 | |||
| 84 | if ($directive_declared_row && $package_declared_line < $directive_declared_row) { | ||
| 85 | $is_directive_declared_after = 1; | ||
| 86 | } | ||
| 87 | |||
| 88 | my $last_path = @{[split(/\//, $path)]}[-1]; | ||
| 89 | (my $module_name = $path) =~ s!/!-!; | ||
| 90 | |||
| 91 | if ($path eq 'main' && !$is_directive_declared_after) { | ||
| 92 | last; | ||
| 93 | } | ||
| 94 | elsif (defined $file) { | ||
| 95 | if ($file !~ m!/!) { | ||
| 96 | my $last_path = @{[split(/\//, $path)]}[-1] || ''; | ||
| 97 | if ($file =~ /$last_path\.p[ml]/) { | ||
| 98 | $should_be_no_error = 1; | ||
| 99 | } | ||
| 100 | } | ||
| 101 | elsif ($file =~ /$path\.p[ml]/) { | ||
| 102 | $should_be_no_error = 1; | ||
| 103 | } | ||
| 104 | elsif ($file =~ m!$module_name(?:-\d[\d\.]*?\d)?/$last_path!) { | ||
| 105 | $should_be_no_error = 1; | ||
| 106 | } | ||
| 107 | elsif ($file =~ m![A-Z]\w*-\d[\d\.]*\d/$last_path!) { | ||
| 108 | $should_be_no_error = 1; | ||
| 109 | } | ||
| 110 | } | ||
| 111 | |||
| 112 | if ( | ||
| 113 | !$should_be_no_error || | ||
| 114 | ($should_be_no_error && $is_directive_declared_after) | ||
| 115 | ) { | ||
| 116 | push @violations, { | ||
| 117 | filename => $realfile, | ||
| 118 | line => $package_declared_line, | ||
| 119 | description => DESC, | ||
| 120 | explanation => EXPL, | ||
| 121 | policy => __PACKAGE__, | ||
| 122 | }; | ||
| 123 | } | ||
| 124 | } | ||
| 125 | |||
| 126 | return \@violations; | ||
| 127 | } | ||
| 128 | |||
| 129 | 1; | ||
| 130 |