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.xoo.rule;
021    
022    import org.sonar.api.batch.fs.InputDir;
023    import org.sonar.api.batch.fs.InputFile;
024    import org.sonar.api.batch.sensor.Sensor;
025    import org.sonar.api.batch.sensor.SensorContext;
026    import org.sonar.api.batch.sensor.SensorDescriptor;
027    import org.sonar.api.rule.RuleKey;
028    import org.sonar.xoo.Xoo;
029    
030    public class OneIssueOnDirPerFileSensor implements Sensor {
031    
032      public static final String RULE_KEY = "OneIssueOnDirPerFile";
033    
034      @Override
035      public void describe(SensorDescriptor descriptor) {
036        descriptor
037          .name("One Issue On Dir Per File")
038          .workOnLanguages(Xoo.KEY)
039          .createIssuesForRuleRepositories(XooRulesDefinition.XOO_REPOSITORY)
040          .workOnFileTypes(InputFile.Type.MAIN, InputFile.Type.TEST);
041      }
042    
043      @Override
044      public void execute(SensorContext context) {
045        for (InputFile file : context.fileSystem().inputFiles(context.fileSystem().predicates().hasLanguages(Xoo.KEY))) {
046          createIssues(file, context);
047        }
048      }
049    
050      private void createIssues(InputFile file, SensorContext context) {
051        RuleKey ruleKey = RuleKey.of(XooRulesDefinition.XOO_REPOSITORY, RULE_KEY);
052        InputDir inputDir = context.fileSystem().inputDir(file.file().getParentFile());
053        if (inputDir != null) {
054          context.addIssue(context.issueBuilder()
055            .ruleKey(ruleKey)
056            .onDir(inputDir)
057            .message("This issue is generated for file " + file.relativePath())
058            .build());
059        }
060      }
061    }