001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * Sonar is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.api.batch;
021    
022    import org.sonar.api.measures.CoreMetrics;
023    import org.sonar.api.measures.MeasureUtils;
024    import org.sonar.api.measures.Metric;
025    import org.sonar.api.resources.Language;
026    import org.sonar.api.resources.Project;
027    import org.sonar.api.resources.Resource;
028    
029    import java.util.Arrays;
030    import java.util.List;
031    
032    /**
033     * @deprecated a formula has been implemented on the metric, so no need to have decorator anymore
034     * @since 2.1
035     */
036    public abstract class AbstractFunctionComplexityDecorator implements Decorator {
037    
038      private Language language;
039    
040      /**
041       * @param language this will be use to defined whether the decorator should be executed on a project
042       */
043      public AbstractFunctionComplexityDecorator(Language language) {
044        this.language = language;
045      }
046    
047      /**
048       * {@inheritDoc}
049       */
050      public boolean shouldExecuteOnProject(Project project) {
051        return language.equals(project.getLanguage());
052      }
053    
054      /**
055       * Used to define upstream dependencies
056       */
057      @DependsUpon
058      public List<Metric> dependsUponFileAndComplexityMetrics() {
059        return Arrays.asList(CoreMetrics.FUNCTIONS, CoreMetrics.COMPLEXITY);
060      }
061    
062      /**
063       * Used to define downstream dependencies
064       */
065      @DependedUpon
066      public Metric generateFileComplexityMetric() {
067        return CoreMetrics.FUNCTION_COMPLEXITY;
068      }
069    
070      /**
071       * {@inheritDoc}
072       */
073      public void decorate(Resource resource, DecoratorContext context) {
074        if (!shouldDecorateResource(resource, context)) {
075          return;
076        }
077        Double functions = MeasureUtils.getValue(context.getMeasure(CoreMetrics.FUNCTIONS), null);
078        Double complexity = MeasureUtils.getValue(context.getMeasure(CoreMetrics.COMPLEXITY), null);
079        if (complexity != null && functions != null && functions > 0.0) {
080          context.saveMeasure(CoreMetrics.FUNCTION_COMPLEXITY, complexity / functions);
081        }
082      }
083    
084      private boolean shouldDecorateResource(Resource resource, DecoratorContext context) {
085        return !MeasureUtils.hasValue(context.getMeasure(CoreMetrics.FUNCTION_COMPLEXITY));
086      }
087    }