GroovyPlugin.java

/*
 * Sonar Groovy Plugin
 * Copyright (C) 2010 SonarSource
 * dev@sonar.codehaus.org
 *
 * 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.plugins.groovy;

import org.sonar.api.Plugin;
import org.sonar.api.Properties;
import org.sonar.api.Property;
import org.sonar.plugins.groovy.cobertura.CoberturaMavenPluginHandler;
import org.sonar.plugins.groovy.cobertura.CoberturaSensor;
import org.sonar.plugins.groovy.codenarc.*;
import org.sonar.plugins.groovy.foundation.Groovy;
import org.sonar.plugins.groovy.foundation.GroovyColorizerFormat;
import org.sonar.plugins.groovy.foundation.GroovyCpdMapping;
import org.sonar.plugins.groovy.foundation.GroovySourceImporter;
import org.sonar.plugins.groovy.gmetrics.GMetricsExecutor;
import org.sonar.plugins.groovy.gmetrics.GMetricsXMLParser;
import org.sonar.plugins.groovy.surefire.SurefireSensor;

import java.util.Arrays;
import java.util.List;

@Properties({
    @Property(
        key = GroovyPlugin.GMETRICS_REPORT_PATH,
        name = "Report file",
        description = "Path (absolute or relative) to GMetrics XML report in case generation is not handle by the plugin.",
        module = true,
        project = true,
        global = false
    ),
    @Property(
        key = GroovyPlugin.CODENARC_REPORT_PATH,
        name = "Report file",
        description = "Path (absolute or relative) to CodeNarc XML report in case generation is not handle by the plugin.",
        module = true,
        project = true,
        global = false
    ) })
public class GroovyPlugin implements Plugin {
  public final static String GMETRICS_REPORT_PATH = "sonar.groovy.gmetrics.reportPath";
  public final static String CODENARC_REPORT_PATH = "sonar.groovy.codenarc.reportPath";

  public String getKey() {
    return Groovy.KEY;
  }

  public String getName() {
    return "Groovy";
  }

  public String getDescription() {
    return "Analysis of Groovy projects";
  }

  public List getExtensions() {
    return Arrays.asList(
        // CodeNarc
        CodeNarcRuleRepository.class,
        CodeNarcProfileExporter.class,
        CodeNarcProfileImporter.class,
        SonarWayProfile.class,
        CodeNarcExecutor.class,
        CodeNarcXMLParser.class,
        // GMetrics
        GMetricsExecutor.class,
        GMetricsXMLParser.class,
        // Foundation
        Groovy.class,
        GroovyColorizerFormat.class,
        GroovySourceImporter.class,
        GroovyCpdMapping.class,
        // Main sensor
        GroovySensor.class,

        // Cobertura
        CoberturaSensor.class,
        CoberturaMavenPluginHandler.class,
        // Surefire
        SurefireSensor.class);
  }

}