com.qualinsight.plugins.sonarqube.wtf.internal.extension.WTFMeasurer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qualinsight-plugins-sonarqube-wtf-internal Show documentation
This plugin allows developers to programmatically report issues usually not seen by SonarQube but which should be taken into consideration when evaluating a project's technical debt. Usage documentation is available on http://sonarqube.wtf/
The newest version!
/*
 * qualinsight-plugins-sonarqube-wtf
 * Copyright (c) 2015, QualInsight
 * http://www.qualinsight.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, you can retrieve a copy
 * from .
 */
package com.qualinsight.plugins.sonarqube.wtf.internal.extension;

import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.EnumMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.io.Charsets;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.batch.SensorContext;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.measures.Measure;
import com.google.common.io.Files;
import com.qualinsight.plugins.sonarqube.wtf.api.annotation.WTF;
import com.qualinsight.plugins.sonarqube.wtf.api.model.WTFType;

/**
 * Helper class that scans {@link InputFile}s for the presence of {@link WTF} annotations and saves {@link Measure}s accordingly.
 *
 * @author Michel Pawlak
 */
public final class WTFMeasurer {

    private static final Logger LOGGER = LoggerFactory.getLogger(WTFMeasurer.class);

    private static final String EMPTY_FILE_CONTENT = "";

    private static final String WTF_ANNOTATION_TYPE_DETECTION_REGULAR_EXPRESSION = "@(com\\.qualinsight\\.plugins\\.sonarqube\\.wtf\\.api\\.annotation\\.)?WTF\\(.*type\\s?=\\s?(WTFType\\.)?([A-Z_]+).*?\\)";

    private static final String WTF_ANNOTATION_DEBT_DETECTION_REGULAR_EXPRESSION = "@(com\\.qualinsight\\.plugins\\.sonarqube\\.wtf\\.api\\.annotation\\.)?WTF\\(.*minutes\\s?=\\s?(\\d+).*?\\)";

    private SensorContext context;

    /**
     * {@link WTFMeasurer} constructor
     *
     * @param context context to be used to save {@link Measure}.
     */
    public WTFMeasurer(final SensorContext context) {
        this.context = context;
    }

    /**
     * Launches the measuring of a give {@link InputFile}.
     *
     * @param inputFile {@link InputFile} to be scanned for {@link WTF} annotation presence.
     */
    public void measure(final InputFile inputFile) {
        final String fileContent = getFileAsString(inputFile.file(), Charsets.UTF_8);
        measureWTFTypes(inputFile, fileContent);
        measureWTFDebt(inputFile, fileContent);
    }

    private void measureWTFTypes(final InputFile inputFile, final String fileContent) {
        final Map fileMeasures = parseAnnotations(fileContent);
        for (final Entry measure : fileMeasures.entrySet()) {
            final Double value = measure.getValue();
            this.context.saveMeasure(inputFile, WTFMetrics.metricFor(measure.getKey()), value);
        }
    }

    private Map parseAnnotations(final String fileContent) {
        final Pattern pattern = Pattern.compile(WTF_ANNOTATION_TYPE_DETECTION_REGULAR_EXPRESSION, Pattern.MULTILINE);
        final Matcher matcher = pattern.matcher(fileContent);
        final Map fileMeasures = new EnumMap(WTFType.class);
        while (matcher.find()) {
            final WTFType type = WTFType.valueOf(matcher.group(3));
            if (fileMeasures.containsKey(type)) {
                fileMeasures.put(type, fileMeasures.get(type) + 1);
            } else {
                fileMeasures.put(type, 1.0);
            }
        }
        return fileMeasures;
    }

    private void measureWTFDebt(final InputFile inputFile, final String fileContent) {
        final Pattern pattern = Pattern.compile(WTF_ANNOTATION_DEBT_DETECTION_REGULAR_EXPRESSION, Pattern.MULTILINE);
        final Matcher matcher = pattern.matcher(fileContent);
        Double debt = 0.0;
        while (matcher.find()) {
            debt += Integer.valueOf(matcher.group(2));
        }
        this.context.saveMeasure(inputFile, WTFMetrics.WTF_DEBT, debt);
    }

    private static String getFileAsString(final File file, final Charset charset) {
        try {
            return Files.toString(file, charset);
        } catch (final IOException e) {
            LOGGER.warn("A problem occured while reading file.", e);
            return EMPTY_FILE_CONTENT;
        }
    }
}