001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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 License
017     * along with this program; if not, write to the Free Software Foundation,
018     * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019     */
020    package org.sonar.batch.rule;
021    
022    import org.sonar.api.batch.Decorator;
023    import org.sonar.api.batch.DecoratorContext;
024    import org.sonar.api.batch.DependedUpon;
025    import org.sonar.api.measures.CoreMetrics;
026    import org.sonar.api.measures.Measure;
027    import org.sonar.api.measures.Metric;
028    import org.sonar.api.resources.Project;
029    import org.sonar.api.resources.Resource;
030    import org.sonar.api.resources.ResourceUtils;
031    
032    /**
033     * Aggregate which Quality profiles have been used on the current module.
034     */
035    public class QProfileDecorator implements Decorator {
036    
037      @DependedUpon
038      public Metric provides() {
039        return CoreMetrics.QUALITY_PROFILES;
040      }
041    
042      public boolean shouldExecuteOnProject(Project project) {
043        return !project.getModules().isEmpty();
044      }
045    
046      @Override
047      public void decorate(Resource resource, DecoratorContext context) {
048        if (!ResourceUtils.isProject(resource)) {
049          return;
050        }
051        UsedQProfiles used = new UsedQProfiles();
052        for (Measure childProfilesMeasure : context.getChildrenMeasures(CoreMetrics.QUALITY_PROFILES)) {
053          String data = childProfilesMeasure.getData();
054          if (data != null) {
055            UsedQProfiles childProfiles = UsedQProfiles.fromJson(data);
056            used.add(childProfiles);
057          }
058        }
059    
060        Measure detailsMeasure = new Measure(CoreMetrics.QUALITY_PROFILES, used.toJson());
061        context.saveMeasure(detailsMeasure);
062      }
063    
064      @Override
065      public String toString() {
066        return getClass().getSimpleName();
067      }
068    
069    }