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 */
020package org.sonar.xoo.rule;
021
022import org.sonar.api.batch.fs.FilePredicates;
023import org.sonar.api.batch.fs.FileSystem;
024import org.sonar.api.batch.fs.InputFile;
025import org.sonar.api.batch.fs.InputFile.Type;
026import org.sonar.api.batch.sensor.Sensor;
027import org.sonar.api.batch.sensor.SensorContext;
028import org.sonar.api.batch.sensor.SensorDescriptor;
029import org.sonar.api.batch.sensor.issue.Issue.Severity;
030import org.sonar.api.rule.RuleKey;
031import org.sonar.xoo.Xoo;
032
033public class OneIssuePerLineSensor implements Sensor {
034
035  public static final String RULE_KEY = "OneIssuePerLine";
036  private static final String EFFORT_TO_FIX_PROPERTY = "sonar.oneIssuePerLine.effortToFix";
037  public static final String FORCE_SEVERITY_PROPERTY = "sonar.oneIssuePerLine.forceSeverity";
038
039  @Override
040  public void describe(SensorDescriptor descriptor) {
041    descriptor
042      .name("One Issue Per Line")
043      .onlyOnLanguages(Xoo.KEY)
044      .createIssuesForRuleRepositories(XooRulesDefinition.XOO_REPOSITORY);
045  }
046
047  @Override
048  public void execute(SensorContext context) {
049    FileSystem fs = context.fileSystem();
050    FilePredicates p = fs.predicates();
051    for (InputFile file : fs.inputFiles(p.and(p.hasLanguages(Xoo.KEY), p.hasType(Type.MAIN)))) {
052      createIssues(file, context);
053    }
054  }
055
056  private void createIssues(InputFile file, SensorContext context) {
057    RuleKey ruleKey = RuleKey.of(XooRulesDefinition.XOO_REPOSITORY, RULE_KEY);
058    String severity = context.settings().getString(FORCE_SEVERITY_PROPERTY);
059    for (int line = 1; line <= file.lines(); line++) {
060      context.newIssue()
061        .forRule(ruleKey)
062        .onFile(file)
063        .atLine(line)
064        .effortToFix(context.settings().getDouble(EFFORT_TO_FIX_PROPERTY))
065        .overrideSeverity(severity != null ? Severity.valueOf(severity) : null)
066        .message("This issue is generated on each line")
067        .save();
068    }
069  }
070}