commonMain.io.gianluigip.spectacle.specification.SpecificationBuilder.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spectacle-dsl-js Show documentation

DSL for writing BDD tests

The newest version!

package io.gianluigip.spectacle.specification

import io.gianluigip.spectacle.specification.model.SpecInteraction
import io.gianluigip.spectacle.specification.model.SpecStatus
import io.gianluigip.spectacle.specification.model.SpecificationStep
import io.gianluigip.spectacle.specification.model.StepType

/**
 * Helper class to provide a mutable representation of a specification while the lib is still collecting the data.
 */
class SpecificationBuilder(
    var specName: String? = null,
    var featureName: String? = null,
    var featureDescription: String? = null,
    var team: String? = null,
    var status: SpecStatus? = null,
    var tags: MutableSet = mutableSetOf(),
    var interactions: MutableSet = mutableSetOf()
) {
    private val stepsRegistered: MutableList = mutableListOf()
    val steps: List get() = stepsRegistered

    internal fun addStep(type: StepType, description: String): SpecificationBuilder {
        stepsRegistered.add(SpecificationStep(type, description, index = steps.size + 1))
        return this
    }

    internal fun addInteraction(interaction: SpecInteraction): SpecificationBuilder {
        interactions += interaction
        return this
    }

    internal fun fillMissingWithExternalMetadata(externalSpecName: String, metadata: SpecificationMetadata): SpecificationBuilder {
        specName = specName ?: externalSpecName
        featureName = featureName ?: metadata.featureName
        featureDescription = featureDescription ?: metadata.featureDescription
        team = team ?: metadata.team
        status = status ?: metadata.status
        tags.addAll(metadata.tags)
        return this
    }

    internal fun build() = Specification(
        metadata = SpecificationMetadata(
            featureName = featureName ?: "Unknown",
            featureDescription = featureDescription ?: "",
            team = team ?: "Unknown",
            status = status ?: SpecStatus.IMPLEMENTED,
            tags = tags.toList().sortedBy { it },
        ),
        name = specName ?: "Unknown",
        steps = stepsRegistered.toList(),
        interactions = interactions.toList(),
    )
}