org.sonar.gherkin.visitors.metrics.CommentLinesVisitor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gherkin-frontend Show documentation

The newest version!

/*
 * SonarQube Cucumber Gherkin Analyzer
 * Copyright (C) 2016-2017 David RACODON
 * [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  02110-1301, USA.
 */
package org.sonar.gherkin.visitors.metrics;

import com.google.common.collect.ImmutableList;
import org.sonar.plugins.gherkin.api.tree.SyntaxToken;
import org.sonar.plugins.gherkin.api.tree.Tree;
import org.sonar.plugins.gherkin.api.visitors.SubscriptionVisitor;

import java.util.List;

public class CommentLinesVisitor extends SubscriptionVisitor {

  private int commentLines;
  private final GherkinCommentAnalyser commentAnalyser = new GherkinCommentAnalyser();

  public CommentLinesVisitor(Tree tree) {
    commentLines = 0;
    scanTree(tree);
  }

  @Override
  public List nodesToVisit() {
    return ImmutableList.of(Tree.Kind.TOKEN);
  }

  @Override
  public void visitNode(Tree tree) {
    ((SyntaxToken) tree).trivias()
      .stream()
      .filter(t -> !commentAnalyser.isBlank(commentAnalyser.getContents(t.text())))
      .forEach(t -> commentLines++);
  }

  public int getNumberOfCommentLines() {
    return commentLines;
  }

}