gwen.core.node.gherkin.Feature.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwen Show documentation
A Given-When-Then interpreter for Gherkin
There is a newer version: 4.2.1
/*
 * Copyright 2014-2021 Branko Juric, Brady Wood
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package gwen.core.node.gherkin

import gwen.core.Occurrence
import gwen.core.node.GwenNode
import gwen.core.node.NodeType
import gwen.core.node.RecurringNode
import gwen.core.node.SourceRef

import scala.jdk.CollectionConverters._

import io.cucumber.messages.{ types => cucumber }

import java.io.File


/**
  * Captures a gherkin feature node.
  *
  * @param language the language identifier (example: en for English)
  * @param sourceRef the location in source
  * @param tags list of tags
  * @param keyword the Gherkin keyword for this Feature
  * @param name the feature name
  * @param occurrence the data feed occurrence
  * @param description optional description
  */
case class Feature(
    language: String, 
    sourceRef: Option[SourceRef],
    tags: List[Tag],
    keyword: String, 
    name: String, 
    occurrence: Option[Occurrence],
    description: List[String]) extends GherkinNode with RecurringNode {

  override val nodeType: NodeType = NodeType.Feature

  override def siblingsIn(parent: GwenNode): List[GwenNode] = {
    parent match {
      case spec: Spec => List(spec.feature)
      case _ => Nil
    }
  }
  
  def specType = if (sourceRef.map(_.uri.contains(".meta")).getOrElse(false)) SpecType.Meta else SpecType.Feature

  def copy(
      withLanguage: String = language, 
      withSourceRef: Option[SourceRef] = sourceRef,
      withTags: List[Tag] = tags,
      withKeyword: String = keyword, 
      withName: String = name, 
      withOccurrence: Option[Occurrence] = occurrence,
      withDescription: List[String] = description): Feature = {
    Feature(withLanguage, withSourceRef, withTags, withKeyword, withName, withOccurrence, withDescription)
  }

  /**
    * Interpolate placeholder references in this feature.
    *
    * @param interpolator the interpolator to use
    * @return the interpolated step
    */
  override def interpolate(interpolator: String => String): Feature = {
    copy(
      withTags = tags.map(_.interpolate(interpolator)),
      withName = interpolator.apply(name),
      withDescription = description.map(interpolator)
    )
  }

}

object Feature {
  def apply(file: Option[File], feature: cucumber.Feature): Feature = {
    Feature(
      feature.getLanguage,  
      Option(feature.getLocation).map(loc => SourceRef(file, loc)),
      Option(feature.getTags).map(_.asScala.toList).getOrElse(Nil) map { t => Tag(file, t)  },
      feature.getKeyword,
      feature.getName, 
      None,
      Option(feature.getDescription).filter(_.length > 0).map(_.split("\n").toList.map(_.trim)).getOrElse(Nil).distinct
    )
  }
}