au.com.integradev.delphi.checks.TooManyNestedRoutinesCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of delphi-checks Show documentation
The newest version!
/*
 * Sonar Delphi Plugin
 * Copyright (C) 2019 Integrated Application Development
 *
 * 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 au.com.integradev.delphi.checks;

import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.sonar.plugins.communitydelphi.api.ast.RoutineImplementationNode;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheck;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheckContext;
import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;

@DeprecatedRuleKey(ruleKey = "TooManySubProceduresRule", repositoryKey = "delph")
@DeprecatedRuleKey(ruleKey = "TooManySubroutines", repositoryKey = "community-delphi")
@Rule(key = "TooManyNestedRoutines")
public class TooManyNestedRoutinesCheck extends DelphiCheck {
  private static final int DEFAULT_MAXIMUM = 3;

  @RuleProperty(
      key = "max",
      description = "Maximum authorized number of nested routines",
      defaultValue = "" + DEFAULT_MAXIMUM)
  public int max = DEFAULT_MAXIMUM;

  @Override
  public DelphiCheckContext visit(RoutineImplementationNode routine, DelphiCheckContext context) {
    int count = routine.findDescendantsOfType(RoutineImplementationNode.class).size();

    if (count > max) {
      reportIssue(
          context,
          routine.getRoutineNameNode(),
          String.format(
              "Routine has %d nested routines, which is greater than %d authorized.", count, max));
    }

    return context;
  }
}