# $Id: UseParrotCoda.pm 36833 2009-02-17 20:09:26Z allison $
package Perl::Critic::Policy::CodeLayout::UseParrotCoda;

# Copyright (C) 2006-2007, Parrot Foundation.

use strict;
use warnings;
use Perl::Critic::Utils;
use Perl::Critic::Violation;
use base 'Perl::Critic::Policy';

=head1 NAME

Perl::Critic::Policy::CodeLayout::UseParrotCoda

=head1 DESCRIPTION

The pumpking has declared that all parrot source code must include a series of
comments at the end of the source.  After much discussion C<__END__> and
C<__DATA__> blocks are exempt from this policy.

=cut

our $VERSION = '0.1';
$VERSION = eval $VERSION;    ## no critic

my $desc = q{Missing properly located perl coda for parrot source};
my $expl = q{According to PDD07, all perl source in parrot must contain a comment coda};

#----------------------------------------------------------------------------

sub default_severity { return $SEVERITY_LOW }
sub applies_to       { return 'PPI::Document' }

#----------------------------------------------------------------------------

# The actual coda we're looking for:

our $CODA = <<'END_CODA';
# Local Variables:
#   mode: cperl
#   cperl-indent-level: 4
#   fill-column: 100
# End:
# vim: expandtab shiftwidth=4:
END_CODA

#----------------------------------------------------------------------------

sub violates {
    my ( $self, $elem, $doc ) = @_;

    my @coda_lines = split /\n/, $CODA;

    my $last_node = $doc->last_element;

    # __END__ and __DATA__ blocks are excepted from having the coda
    if (   $last_node->isa('PPI::Statement::End')
        or $last_node->isa('PPI::Statement::Data') )
    {
        return;
    }
    else {
        for (
            $last_node = $doc->last_element ;
            $last_node && @coda_lines ;
            $last_node = $last_node->previous_sibling
            )
        {

            next if ( $last_node->isa('PPI::Token::Whitespace') );
            last if ( !$last_node->isa('PPI::Token::Comment') );

            my $last_coda_line   = $coda_lines[-1];
            my $last_actual_line = $last_node->content;
            chomp $last_actual_line;
            last if ( $last_coda_line ne $last_actual_line );
            pop @coda_lines;
        }
    }

    return if ( !@coda_lines );    # We made it through all the coda lines
    return $self->violation( $desc, $expl, $last_node || $doc );
}

1;

# How meta! We ourselves must have this coda to be a valid perl file in the
# parrot repository...

# Local Variables:
#   mode: cperl
#   cperl-indent-level: 4
#   fill-column: 100
# End:
# vim: expandtab shiftwidth=4:
