org.sonar.php.checks.ConstructorDependencyInversionCheck Maven / Gradle / Ivy

Go to download
/*
 * SonarQube PHP Plugin
 * Copyright (C) 2010-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * 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  02110-1301, USA.
 */
package org.sonar.php.checks;

import java.util.ArrayDeque;
import java.util.Deque;
import org.sonar.check.Rule;
import org.sonar.plugins.php.api.tree.declaration.ClassDeclarationTree;
import org.sonar.plugins.php.api.tree.declaration.ClassMemberTree;
import org.sonar.plugins.php.api.tree.declaration.ClassTree;
import org.sonar.plugins.php.api.tree.declaration.MethodDeclarationTree;
import org.sonar.plugins.php.api.tree.expression.AnonymousClassTree;
import org.sonar.plugins.php.api.tree.expression.NewExpressionTree;
import org.sonar.plugins.php.api.tree.statement.ThrowStatementTree;
import org.sonar.plugins.php.api.visitors.PHPVisitorCheck;

@Rule(key = ConstructorDependencyInversionCheck.KEY)
public class ConstructorDependencyInversionCheck extends PHPVisitorCheck {

  public static final String KEY = "S2830";
  private static final String MESSAGE = "Remove this creation of object in constructor. Use dependency injection instead.";

  private Deque inConstructor = new ArrayDeque<>();

  @Override
  public void visitClassDeclaration(ClassDeclarationTree tree) {
    visitClass(tree);
  }

  @Override
  public void visitAnonymousClass(AnonymousClassTree tree) {
    visitClass(tree);
  }

  private void visitClass(ClassTree tree) {
    inConstructor.addLast(false);

    MethodDeclarationTree constructor = tree.fetchConstructor();

    for (ClassMemberTree memberTree : tree.members()) {
      if (memberTree.equals(constructor)) {
        inConstructor.addLast(true);
        scan(memberTree);
        inConstructor.removeLast();
        inConstructor.addLast(false);

      } else {
        scan(memberTree);
      }
    }

    inConstructor.removeLast();
  }

  @Override
  public void visitThrowStatement(ThrowStatementTree tree) {
    // Ignore instantiation in throw statement.
  }

  @Override
  public void visitNewExpression(NewExpressionTree tree) {
    if (!inConstructor.isEmpty() && inConstructor.getLast()) {
      context().newIssue(this, tree.newToken(), MESSAGE);
    }
    super.visitNewExpression(tree);
  }

}