org.sonar.javascript.checks.DuplicatePropertyNameCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javascript-checks
There is a newer version: 2.5
/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011 SonarSource and Eriks Nukis
 * [email protected]
 *
 * 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.javascript.checks;

import com.google.common.collect.Sets;
import com.sonar.sslr.api.AstNode;
import org.sonar.check.BelongsToProfile;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.javascript.parser.EcmaScriptGrammar;
import org.sonar.squidbridge.checks.SquidCheck;
import org.sonar.sslr.parser.LexerlessGrammar;

import java.util.List;
import java.util.Set;

@Rule(
  key = "DuplicatePropertyName",
  priority = Priority.CRITICAL)
@BelongsToProfile(title = CheckList.SONAR_WAY_PROFILE, priority = Priority.CRITICAL)
public class DuplicatePropertyNameCheck extends SquidCheck {

  @Override
  public void init() {
    subscribeTo(EcmaScriptGrammar.OBJECT_LITERAL);
  }

  @Override
  public void visitNode(AstNode astNode) {
    Set values = Sets.newHashSet();
    List propertyAssignments = astNode.getChildren(EcmaScriptGrammar.PROPERTY_DEFINITION);

    for (AstNode propertyAssignment : propertyAssignments) {

      if (propertyAssignment.getFirstChild().isNot(EcmaScriptGrammar.METHOD_DEFINITION)) {
        AstNode propertyName = getPropertyName(propertyAssignment);
        String value = propertyName.getTokenValue();

        if (value.startsWith("\"") || value.startsWith("'")) {
          value = value.substring(1, value.length() - 1);
        }
        String unescaped = EscapeUtils.unescape(value);

        if (values.contains(unescaped)) {
          getContext().createLineViolation(this, "Rename or remove duplicate property name '" + value + "'.", propertyName);
        } else {
          values.add(unescaped);
        }
      }
    }
  }

  private static AstNode getPropertyName(AstNode propertyAssignment) {
    AstNode objectProperty = propertyAssignment.getFirstChild();

    if (objectProperty.is(EcmaScriptGrammar.PAIR_PROPERTY)) {
      return objectProperty.getFirstChild(EcmaScriptGrammar.PROPERTY_NAME);

    } else /* COVER_INITIALIZED_NAME */ {
      return objectProperty.getFirstChild(EcmaScriptGrammar.IDENTIFIER_REFERENCE);
    }
  }

}