org.sonar.php.checks.utils.AbstractCommentContainsPatternCheck.java Source code

Introduction

Here is the source code for org.sonar.php.checks.utils.AbstractCommentContainsPatternCheck.java

Source

/*
 * SonarQube PHP Plugin
 * Copyright (C) 2010-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.php.checks.utils;

import org.apache.commons.lang.StringUtils;
import org.sonar.plugins.php.api.tree.lexical.SyntaxTrivia;
import org.sonar.plugins.php.api.visitors.PHPVisitorCheck;

public abstract class AbstractCommentContainsPatternCheck extends PHPVisitorCheck {

    protected abstract String pattern();

    protected abstract String message();

    @Override
    public void visitTrivia(SyntaxTrivia trivia) {
        String comment = trivia.text();

        if (StringUtils.containsIgnoreCase(comment, pattern())) {
            String[] lines = comment.split("\r\n?|\n");

            for (int i = 0; i < lines.length; i++) {
                if (StringUtils.containsIgnoreCase(lines[i], pattern()) && !isLetterAround(lines[i])) {
                    createIssue(trivia.line() + i);
                }
            }
        }
    }

    private boolean isLetterAround(String line) {
        int start = StringUtils.indexOfIgnoreCase(line, pattern());
        int end = start + pattern().length();

        boolean pre = start > 0 && Character.isLetter(line.charAt(start - 1));
        boolean post = end < line.length() - 1 && Character.isLetter(line.charAt(end));

        return pre || post;
    }

    private void createIssue(int line) {
        context().newIssue(this, message()).line(line);
    }

}