org.sonar.php.checks.TooManyFieldsInClassCheck 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.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.stream.Stream;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.sonar.php.api.PHPKeyword;
import org.sonar.plugins.php.api.tree.Tree.Kind;
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.ClassPropertyDeclarationTree;
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.declaration.ParameterTree;
import org.sonar.plugins.php.api.tree.expression.AnonymousClassTree;
import org.sonar.plugins.php.api.tree.lexical.SyntaxToken;
import org.sonar.plugins.php.api.visitors.PHPVisitorCheck;

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

  public static final String KEY = "S1820";
  private static final String MESSAGE = "Refactor this class so it has no more than %s%s fields, rather than the %s it currently has.";

  public static final int DEFAULT_MAX = 20;
  public static final boolean DEFAULT_COUNT_NON_PUBLIC = true;

  @RuleProperty(
    key = "maximumFieldThreshold",
    defaultValue = "" + DEFAULT_MAX)
  public int maximumFieldThreshold = DEFAULT_MAX;

  @RuleProperty(
    key = "countNonpublicFields",
    defaultValue = "" + DEFAULT_COUNT_NON_PUBLIC,
    type = "BOOLEAN")
  public boolean countNonpublicFields = DEFAULT_COUNT_NON_PUBLIC;

  @Override
  public void visitClassDeclaration(ClassDeclarationTree tree) {
    super.visitClassDeclaration(tree);

    if (tree.is(Kind.CLASS_DECLARATION)) {
      visitClass(tree);
    }
  }

  private void visitClass(ClassTree tree) {
    var numberOfFields = getNumberOfFields(tree);
    var numberOfConstructorProperties = getNumberOfConstructorProperties(tree);
    var allFields = numberOfFields + numberOfConstructorProperties;

    if (allFields > maximumFieldThreshold) {
      var message = String.format(MESSAGE, maximumFieldThreshold, countNonpublicFields ? "" : " public", allFields);
      context().newIssue(this, tree.classToken(), message);
    }
  }

  @Override
  public void visitAnonymousClass(AnonymousClassTree tree) {
    super.visitAnonymousClass(tree);

    visitClass(tree);
  }

  private int getNumberOfFields(ClassTree tree) {
    List fields = getClassFields(tree);
    int nbFields = fields.size();

    if (!countNonpublicFields) {
      nbFields -= getNumberOfNonPublicFields(fields);
    }
    return nbFields;
  }

  private static List getClassFields(ClassTree classDeclaration) {
    List fields = new ArrayList<>();

    for (ClassMemberTree classMember : classDeclaration.members()) {
      if (classMember.is(Kind.CLASS_PROPERTY_DECLARATION)) {
        fields.add((ClassPropertyDeclarationTree) classMember);
      }
    }
    return fields;
  }

  private static int getNumberOfNonPublicFields(List fields) {
    var nbNonPublicFields = 0;

    for (ClassPropertyDeclarationTree field : fields) {

      // class constants are public in PHP
      if (field.is(Kind.CLASS_PROPERTY_DECLARATION) && isNonPublic(field.modifierTokens())) {
        nbNonPublicFields++;
      }
    }
    return nbNonPublicFields;
  }

  private static boolean isNonPublic(List modifiers) {
    for (SyntaxToken modifierToken : modifiers) {
      String modifier = modifierToken.text();
      if (!PHPKeyword.VAR.getValue().equals(modifier) && (PHPKeyword.PROTECTED.getValue().equals(modifier) || PHPKeyword.PRIVATE.getValue().equals(modifier))) {
        return true;
      }
    }
    return false;
  }

  private int getNumberOfConstructorProperties(ClassTree tree) {
    var constructors = getConstructors(tree);
    return (int) constructors.map(constructor -> constructor.parameters().parameters())
      .flatMap(Collection::stream)
      .filter(ParameterTree::isPropertyPromotion)
      .filter((ParameterTree parameter) -> {
        if (!countNonpublicFields) {
          return "public".equalsIgnoreCase(parameter.visibility().text());
        }
        return true;
      })
      .count();
  }

  private static Stream getConstructors(ClassTree tree) {
    return tree.members().stream()
      .filter(member -> member.is(Kind.METHOD_DECLARATION))
      .map(MethodDeclarationTree.class::cast)
      .filter(member -> "__construct".equals((member.name()).text()));
  }
}