org.sonar.commonrules.internal.checks.CommentDensityCheck Maven / Gradle / Ivy

Go to download
/*
 * Sonar Common Rules
 * Copyright (C) 2012 SonarSource
 * [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.commonrules.internal.checks;

import org.sonar.api.batch.DecoratorContext;
import org.sonar.api.measures.CoreMetrics;
import org.sonar.api.measures.MeasureUtils;
import org.sonar.api.resources.Resource;
import org.sonar.api.resources.ResourceUtils;
import org.sonar.api.rules.Violation;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;

@Rule(
  key = "InsufficientCommentDensity",
  name = "Insufficient comment density",
  priority = Priority.MAJOR,
  description = "A violation is created on a file as soon as the comment density coverage on this file is less than the required threshold. "
    + "It gives the number of comment lines to be written in order to reach the required threshold.")
public class CommentDensityCheck extends CommonCheck {

  private static final double DEFAULT_MIN_DENSITY = 25;

  @RuleProperty(description = "The minimum required comment density.", defaultValue = "" + DEFAULT_MIN_DENSITY)
  private double minimumCommentDensity = DEFAULT_MIN_DENSITY;

  @SuppressWarnings("rawtypes")
  @Override
  public void checkResource(Resource resource, DecoratorContext context, org.sonar.api.rules.Rule rule) {
    if (minimumCommentDensity < 0 || minimumCommentDensity >= 100) {
      throw new IllegalArgumentException(minimumCommentDensity
        + " is not a valid value for minimum required comment density for rule 'CommentDensityCheck' (must be >= 0 and < 100).");
    }

    double commentDensity = MeasureUtils.getValue(context.getMeasure(CoreMetrics.COMMENT_LINES_DENSITY), 0.0);
    double linesOfCode = MeasureUtils.getValue(context.getMeasure(CoreMetrics.NCLOC), 0.0);
    if (ResourceUtils.isEntity(resource) && commentDensity < minimumCommentDensity && linesOfCode != 0) {
      double commentLines = MeasureUtils.getValue(context.getMeasure(CoreMetrics.COMMENT_LINES), 0.0);
      double missingCommentLines = Math.ceil(minimumCommentDensity * linesOfCode / (100 - minimumCommentDensity) - commentLines);

      Violation violation = createViolation(resource, rule, missingCommentLines);
      context.saveViolation(violation);
    }
  }

  private Violation createViolation(Resource resource, org.sonar.api.rules.Rule rule, double missingCommentLines) {
    Violation violation = Violation.create(rule, resource).setCost(missingCommentLines);
    violation.setMessage((int) missingCommentLines + " more comment lines need to be written to reach the minimum threshold of "
      + minimumCommentDensity + "% comment density.");
    return violation;
  }

  public void setMinimumCommentDensity(int threshold) {
    this.minimumCommentDensity = threshold;
  }
}