org.sonar.plugins.javascript.JavaScriptProfile.java Source code

Introduction

Here is the source code for org.sonar.plugins.javascript.JavaScriptProfile.java

Source

/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * 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  02110-1301, USA.
 */
package org.sonar.plugins.javascript;

import com.google.common.base.Charsets;
import com.google.common.io.Resources;
import com.google.gson.Gson;
import java.io.IOException;
import java.net.URL;
import java.util.Set;
import org.sonar.api.profiles.ProfileDefinition;
import org.sonar.api.profiles.RulesProfile;
import org.sonar.api.rules.Rule;
import org.sonar.api.rules.RuleFinder;
import org.sonar.api.utils.ValidationMessages;
import org.sonar.javascript.checks.CheckList;

public class JavaScriptProfile extends ProfileDefinition {

    private final RuleFinder ruleFinder;

    public JavaScriptProfile(RuleFinder ruleFinder) {
        this.ruleFinder = ruleFinder;
    }

    @Override
    public RulesProfile createProfile(ValidationMessages messages) {
        RulesProfile profile = RulesProfile.create(CheckList.SONAR_WAY_PROFILE, JavaScriptLanguage.KEY);

        loadFromCommonRepository(profile);
        loadActiveKeysFromJsonProfile(profile);
        return profile;
    }

    private void loadFromCommonRepository(RulesProfile profile) {
        Rule duplicatedBlocksRule = ruleFinder.findByKey("common-" + JavaScriptLanguage.KEY, "DuplicatedBlocks");

        // in SonarLint duplicatedBlocksRule == null
        if (duplicatedBlocksRule != null) {
            profile.activateRule(duplicatedBlocksRule, null);
        }
    }

    private void loadActiveKeysFromJsonProfile(RulesProfile rulesProfile) {
        for (String ruleKey : activatedRuleKeys()) {
            Rule rule = ruleFinder.findByKey(CheckList.REPOSITORY_KEY, ruleKey);
            rulesProfile.activateRule(rule, null);
        }
    }

    public static Set<String> activatedRuleKeys() {
        URL profileUrl = JavaScriptProfile.class
                .getResource("/org/sonar/l10n/javascript/rules/javascript/Sonar_way_profile.json");
        try {
            Gson gson = new Gson();
            return gson.fromJson(Resources.toString(profileUrl, Charsets.UTF_8), Profile.class).ruleKeys;
        } catch (IOException e) {
            throw new IllegalStateException("Failed to read: " + profileUrl, e);
        }
    }

    private static class Profile {
        Set<String> ruleKeys;
    }

}