org.sonar.javascript.checks.AssignmentWithinConditionCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javascript-checks
There is a newer version: 2.5
/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011 SonarSource and Eriks Nukis
 * [email protected]
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.javascript.checks;

import com.google.common.collect.Lists;
import com.sonar.sslr.api.AstNode;
import com.sonar.sslr.api.AstNodeType;
import org.sonar.check.BelongsToProfile;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.javascript.parser.EcmaScriptGrammar;
import org.sonar.squidbridge.checks.SquidCheck;
import org.sonar.sslr.parser.LexerlessGrammar;

import javax.annotation.Nullable;
import java.util.List;

@Rule(
  key = "AssignmentWithinCondition",
  priority = Priority.MAJOR)
@BelongsToProfile(title = CheckList.SONAR_WAY_PROFILE, priority = Priority.MAJOR)
public class AssignmentWithinConditionCheck extends SquidCheck {

  private List stack;

  private static final AstNodeType[] SCOPES = {
    EcmaScriptGrammar.CONDITION,
    EcmaScriptGrammar.FUNCTION_BODY,
    EcmaScriptGrammar.RELATIONAL_EXPRESSION,
    EcmaScriptGrammar.RELATIONAL_EXPRESSION_NO_IN,
    EcmaScriptGrammar.EQUALITY_EXPRESSION,
    EcmaScriptGrammar.EQUALITY_EXPRESSION_NO_IN
  };

  @Override
  public void init() {
    subscribeTo(
      EcmaScriptGrammar.ASSIGNMENT_EXPRESSION,
      EcmaScriptGrammar.EXPRESSION,
      EcmaScriptGrammar.EXPRESSION_NO_IN);
    subscribeTo(SCOPES);
  }

  @Override
  public void visitFile(@Nullable AstNode astNode) {
    stack = Lists.newArrayList();
  }

  @Override
  public void visitNode(AstNode astNode) {
    if (isTargetedExpression(astNode) || astNode.is(SCOPES)) {
      stack.add(astNode.getType());
    } else if (astNode.is(EcmaScriptGrammar.ASSIGNMENT_EXPRESSION) && inExpression() && !exclusion()) {
      getContext().createLineViolation(this, "Extract the assignment out of this expression.", astNode);
    }
  }

  @Override
  public void leaveNode(AstNode astNode) {
    if (isTargetedExpression(astNode) || astNode.is(SCOPES)) {
      pop();
    }
  }

  private boolean inExpression() {
    AstNodeType t = peek(0);
    return EcmaScriptGrammar.EXPRESSION.equals(t) || EcmaScriptGrammar.EXPRESSION_NO_IN.equals(t) || EcmaScriptGrammar.CONDITION.equals(t);
  }

  /**
   *    *   while ((line = nextLine()) != null)
   * 
   */
  private boolean exclusion() {
    AstNodeType t = peek(1);
    return (peek(2) == EcmaScriptGrammar.CONDITION) && isExcludedExpression(t);
  }

  private boolean isExcludedExpression(AstNodeType node) {
    return EcmaScriptGrammar.EQUALITY_EXPRESSION.equals(node) || EcmaScriptGrammar.EQUALITY_EXPRESSION_NO_IN.equals(node)
      || EcmaScriptGrammar.RELATIONAL_EXPRESSION.equals(node) || EcmaScriptGrammar.RELATIONAL_EXPRESSION_NO_IN.equals(node);
  }

  private boolean isTargetedExpression(AstNode astNode) {
    return astNode.is(EcmaScriptGrammar.EXPRESSION, EcmaScriptGrammar.EXPRESSION_NO_IN)
      && astNode.getParent().isNot(EcmaScriptGrammar.EXPRESSION_STATEMENT, EcmaScriptGrammar.CONDITION, EcmaScriptGrammar.FOR_STATEMENT);
  }

  private void pop() {
    stack.remove(stack.size() - 1);
  }

  @Nullable
  private AstNodeType peek(int i) {
    if (i < stack.size()) {
      return stack.get(stack.size() - 1 - i);
    } else {
      return null;
    }
  }

}