File Coverage

blib/lib/Perl/Critic/Policy/TooMuchCode/ProhibitUnnecessaryScalarKeyword.pm

Criterion	Covered	Total	%
statement	22	23	95.6
branch	5	8	62.5
condition	6	18	33.3
subroutine	6	7	85.7
pod	3	3	100.0
total	42	59	71.1

package Perl::Critic::Policy::TooMuchCode::ProhibitUnnecessaryScalarKeyword;
use strict;
use warnings;

use Perl::Critic::Utils;
use parent 'Perl::Critic::Policy';

sub default_themes       { return qw(maintenance)    }
sub applies_to           { return 'PPI::Token::Word' }

sub violates {
    my ( $self, $elem, undef ) = @_;
    return unless $elem->content eq 'scalar';
    my $e = $elem->snext_sibling;
    return unless $e && $e->isa('PPI::Token::Symbol') && $e->raw_type eq '@';
    $e = $elem->sprevious_sibling;
    return unless $e && $e->isa('PPI::Token::Operator') && $e->content eq '=';
    $e = $e->sprevious_sibling;
    return unless $e && $e->isa('PPI::Token::Symbol') && $e->raw_type eq '$';

    return $self->violation('Unnecessary scalar keyword', "Assigning an array to a scalar implies scalar context.", $elem);
}

1;

__END__

=head1 NAME

TooMuchCode::ProhibitUnnecessaryScalarKeyword - Finds `scalar` in scalar context.

=head1 DESCRIPTION

This policy dictates that the use of `scalar` for in statement like this needs to be removed:

    my $n = scalar @items;

If the left-hand side of assignment is a single scalar variable, then the assignment is in scalar
context. There is no need to add C<scalar> keyword.