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.Sensor;
023    import org.sonar.api.batch.SensorContext;
024    import org.sonar.api.batch.fs.FileSystem;
025    import org.sonar.api.measures.CoreMetrics;
026    import org.sonar.api.measures.Measure;
027    import org.sonar.api.resources.Project;
028    
029    /**
030     * Stores which Quality profiles have been used on the current module.
031     */
032    public class QProfileSensor implements Sensor {
033    
034      private final ModuleQProfiles moduleQProfiles;
035      private final FileSystem fs;
036    
037      public QProfileSensor(ModuleQProfiles moduleQProfiles, FileSystem fs) {
038        this.moduleQProfiles = moduleQProfiles;
039        this.fs = fs;
040      }
041    
042      public boolean shouldExecuteOnProject(Project project) {
043        // Should be only executed on leaf modules
044        return project.getModules().isEmpty();
045      }
046    
047      public void analyse(Project project, SensorContext context) {
048        UsedQProfiles used = new UsedQProfiles();
049        for (String language : fs.languages()) {
050          QProfile profile = moduleQProfiles.findByLanguage(language);
051          if (profile != null) {
052            used.add(profile);
053          }
054        }
055        Measure detailsMeasure = new Measure(CoreMetrics.QUALITY_PROFILES, used.toJson());
056        context.saveMeasure(detailsMeasure);
057      }
058    
059      @Override
060      public String toString() {
061        return getClass().getSimpleName();
062      }
063    }