RubyEnvConfigurator

open class RubyEnvConfigurator : BuildFeature

A Ruby Environment Configurator build feature passes Ruby interpreter to all build steps.

Example. Adds a Ruby Environment Configurator build feature with specified Ruby interpreter path with a reference to a configuration parameter.

buildType {
// Other Build Type settings ...
features {
// Other Build Features ...
        rubyEnvConfigurator {
method = rubyInterpreter {
path = "%path.to.inverpreter%"
}
}
}
}

Example. Adds a Ruby Environment Configurator build feature with specified RVM interpreter.

buildType {
// Other Build Type settings ...
features {
// Other Build Features ...
        rubyEnvConfigurator {
method = interpreterAndGemset {
interpreter = "jruby-1.4.0"
gemset = "gemset"
requireRVM = true
}
}
}
}

Example. Adds a Ruby Environment Configurator build feature with specified RVM with .rvmrc file.

buildType {
// Other Build Type settings ...
features {
// Other Build Features ...
        rubyEnvConfigurator {
method = rvmrc {
path = "rubyProject/.rvmrc"
requireRVM = true
}
}
}
}

Example. Adds a Ruby Environment Configurator build feature with specified RVM with .rvmrc file and a path to a directory with .ruby-version or .rbenv-version file relative to a checkout directory.

buildType {
// Other Build Type settings ...
features {
// Other Build Features ...
        rubyEnvConfigurator {
method = rvmConfigDirectory {
path = "rubyProject"
requireRVM = true
}
}
}
}

Example. Adds a Ruby Environment Configurator build feature with specified rbenv.

buildType {
// Other Build Type settings ...
features {
// Other Build Features ...
        rubyEnvConfigurator {
method = rbenv {
interpreterVersion = "jruby-1.7.0"
requireRbenv = true
}
failIfInterpreterNotFound = false
}
}
}

Example. Adds a Ruby Environment Configurator build feature with specified rbenv configuration directory and a path to a directory with .ruby-version or .rbenv-version file relative to a checkout directory.

buildType {
// Other Build Type settings ...
features {
// Other Build Features ...
        rubyEnvConfigurator {
method = rbenvConfigDirectory {
path = "rubyProject"
requireRbenv = true
}
}
}
}

See also

Constructors

Link copied to clipboard
fun RubyEnvConfigurator(init: RubyEnvConfigurator.() -> Unit)
Link copied to clipboard
fun RubyEnvConfigurator()

Types

Link copied to clipboard
sealed class Method : CompoundParam<RubyEnvConfigurator.Method>

Functions

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): SingleDelegateProvider<Boolean>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<T>
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard
open fun create(): BuildFeature

Creates an instance of this build feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

Link copied to clipboard
fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): SingleDelegateProvider<Int>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun rbenv(init: RubyEnvConfigurator.Method.Rbenv.() -> Unit = {}): RubyEnvConfigurator.Method.Rbenv
Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
Link copied to clipboard
fun rvmrc(init: RubyEnvConfigurator.Method.Rvmrc.() -> Unit = {}): RubyEnvConfigurator.Method.Rvmrc
Link copied to clipboard
fun stringParameter(customName: String? = null): SingleDelegateProvider<String>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

Link copied to clipboard
var enabled: Boolean = true

Specifies whether the feature is enabled, true by default

Link copied to clipboard
var failIfInterpreterNotFound: Boolean?

Whether fail a build if the Ruby environment configurator cannot pass the Ruby interpreter to the step execution environment because the interpreter wasn't found on the agent.

Link copied to clipboard
var id: String? = null

Build feature id, if not specified will be generated

Link copied to clipboard
var method: RubyEnvConfigurator.Method?

Ruby Environment Configurator method.

Link copied to clipboard
val params: List<Parameter>
Link copied to clipboard
var type: String

Build feature type