org.sonarsource.slang.checks.TooManyCasesCheck Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of slang-checks Show documentation

SonarSource Language analyzer

There is a newer version: 1.19.0.6612

/*
 * SonarSource SLang
 * Copyright (C) 2018-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 Sonar Source-Available License Version 1, as published by SonarSource SA.
 *
 * 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 Sonar Source-Available License for more details.
 *
 * You should have received a copy of the Sonar Source-Available License
 * along with this program; if not, see https://sonarsource.com/license/ssal/
 */
package org.sonarsource.slang.checks;

import java.util.List;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.sonarsource.slang.api.MatchTree;
import org.sonarsource.slang.api.Token;
import org.sonarsource.slang.checks.api.InitContext;
import org.sonarsource.slang.checks.api.SecondaryLocation;
import org.sonarsource.slang.checks.api.SlangCheck;

@Rule(key = "S1479")
public class TooManyCasesCheck implements SlangCheck {

  private static final int DEFAULT_MAX = 30;

  @RuleProperty(
    key = "maximum",
    description = "Maximum number of branches",
    defaultValue = "" + DEFAULT_MAX)
  public int maximum = DEFAULT_MAX;

  @Override
  public void initialize(InitContext init) {
    init.register(MatchTree.class, (ctx, tree) -> {
      int numberOfCases = tree.cases().size();
      if (numberOfCases > maximum) {
        Token matchKeyword = tree.keyword();
        String message = String.format(
          "Reduce the number of %s branches from %s to at most %s.",
          matchKeyword.text(),
          numberOfCases,
          maximum);
        List secondaryLocations = tree.cases().stream()
          .map(matchCase -> new SecondaryLocation(matchCase.rangeToHighlight(), null))
          .toList();
        ctx.reportIssue(matchKeyword, message, secondaryLocations);
      }
    });
  }

}