AdaRuleRepository.java

/*
 * Ada Sonar Plugin
 * Copyright (C) 2010 Akram Ben Aissi
 * dev@sonar.codehaus.org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */

package org.sonar.plugins.ada.rules;

import java.io.File;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

import org.sonar.api.platform.ServerFileSystem;
import org.sonar.api.rules.Rule;
import org.sonar.api.rules.RuleRepository;
import org.sonar.api.rules.XMLRuleParser;

import org.sonar.plugins.ada.Ada;

/**
 * The Class AdaRuleRepository handles ruleset and profile import and export
 */
public final class AdaRuleRepository extends RuleRepository {

  public static final String REPOSITORY_KEY = "ada-rule-repository";
  public static final String REPOSITORY_NAME = "Ada rules";

  // for user extensions
  private ServerFileSystem fileSystem;
  private XMLRuleParser parser;

  public AdaRuleRepository(ServerFileSystem fileSystem, XMLRuleParser parser) {
    super(REPOSITORY_KEY, Ada.LANGUAGE_KEY);
    setName(REPOSITORY_NAME);
    this.fileSystem = fileSystem;
    this.parser = parser;
  }

  /**
   * @see org.sonar.api.rules.RuleRepository#createRules()
   */
  @Override
  public List<Rule> createRules() {
    List<Rule> rules = new ArrayList<Rule>();
    InputStream inputStream = getClass().getResourceAsStream("/org/sonar/plugins/ada/rules.xml");
    List<Rule> parsedRules = parser.parse(inputStream);
    rules.addAll(parsedRules);
    // Gives the ability for the user to extends system rules withs its own rules.
    // user rules must be set in SONAR_HOME/extensions/rules/REPOSITORY_KEY/*.xml
    for (File userExtensionXml : fileSystem.getExtensions(REPOSITORY_KEY, "xml")) {
      List<Rule> userRules = parser.parse(userExtensionXml);
      rules.addAll(userRules);
    }
    return rules;
  }

}