JRubyExecTraits (jruby-gradle-base-plugin 1.5.0 API)

com.github.jrubygradle.internal.JRubyExecTraits

Provides common traits for JRuby script execution across the JRubyExec task and {@project.jrubyexec} extension. This trait is primarily meant as a plugin-internal interface/implementation which allows for the asy set up and invocation of a JRuby environment unlike JRubyExec it is not meant to directly set up or execute a Ruby script. It's functions are primarily: * Prepare Ruby gem dependencies * Prepare JVm (jar) dependencies * Set up the execution environment After that, it is up to the actual subclass extending JRubyExecAbstractTask to decide how it wants to execute JRuby
Authors:
Schalk W. Cronjé
Since:
0.1.18

Properties Summary

Properties
Type	Name and description
`java.util.List<java.lang.String>`	`filterEnvKeys`
`boolean`	`inheritRubyEnv` Allow JRubyExec to inherit a Ruby env from the shell (e.g.

Methods Summary

Methods
Type	Name and description
`java.io.File`	`_convertGemWorkDir(org.gradle.api.Project project)`
`java.util.List<java.lang.String>`	`_convertJrubyArgs()`
`java.io.File`	`_convertScript()`
`java.util.List<java.lang.String>`	`_convertScriptArgs()`
`void`	`configuration(org.gradle.api.artifacts.Configuration newConfiguration)`
`void`	`configuration(java.lang.String newConfiguration)`
`void`	`gemWorkDir(java.lang.Object workingDir)` Set alternative GEM unpack directory to use
`java.lang.String`	`getComputedPATH(java.lang.String originalPath)` Return the computed `PATH` for the task
`java.lang.String`	`getConfiguration()`
`java.io.File`	`getGemWorkDir()` Returns the directory that will be used to unpack Gems into
`java.util.Map`	`getPreparedEnvironment(java.util.Map env)`
`void`	`jrubyArgs(java.lang.Object... args)` Add arguments for jruby
`void`	`prepareDependencies(org.gradle.api.Project project)` Prepare the Ruby and Java dependencies for the configured configuration
`void`	`prepareDependencies(org.gradle.api.Project project, OverwriteAction overwrite)` Prepare dependencies with a custom overwrite behavior
`void`	`script(java.lang.Object scr)` Set script to execute.
`void`	`scriptArgs(java.lang.Object... args)` Add arguments for script
`void`	`scriptArgs(groovy.lang.Closure c)` Add arguments for script in a closure style
`void`	`setScript(java.lang.Object scr)` Set script to execute.

- Property Detail
  - final java.util.List<java.lang.String> filterEnvKeys
  - @java.util.Optional @org.gradle.api.tasks.Input boolean inheritRubyEnv
    
    Allow JRubyExec to inherit a Ruby env from the shell (e.g. RVM)
    Since:
    0.1.10 (Moved from JRubyExec)
- Method Detail
  - java.io.File _convertGemWorkDir(org.gradle.api.Project project)
  - @groovy.transform.CompileDynamic java.util.List<java.lang.String> _convertJrubyArgs()
  - java.io.File _convertScript()
  - @groovy.transform.CompileDynamic /* collectMany is literally wrong here, stupid codenarc */ @java.lang.SuppressWarnings('UseCollectMany') java.util.List<java.lang.String> _convertScriptArgs()
  - void configuration(org.gradle.api.artifacts.Configuration newConfiguration)
  - @groovy.transform.CompileDynamic void configuration(java.lang.String newConfiguration)
  - void gemWorkDir(java.lang.Object workingDir)
    
    Set alternative GEM unpack directory to use
    Parameters:
    workingDir - New working directory (convertible to file)
  - java.lang.String getComputedPATH(java.lang.String originalPath)
    
    Return the computed `PATH` for the task
  - @org.gradle.api.tasks.Input java.lang.String getConfiguration()
  - @java.util.Optional @org.gradle.api.tasks.Input @groovy.transform.CompileDynamic java.io.File getGemWorkDir()
    
    Returns the directory that will be used to unpack Gems into
    Returns:
    Target directory
    Since:
    0.1.9
  - java.util.Map getPreparedEnvironment(java.util.Map env)
  - void jrubyArgs(java.lang.Object... args)
    
    Add arguments for jruby
    Parameters:
    args - Additional arguments to be passed to JRuby itself.
  - void prepareDependencies(org.gradle.api.Project project)
    
    Prepare the Ruby and Java dependencies for the configured configuration This method will determine the appropriate dependency overwrite behavior from the Gradle invocation. In effect, if the --refresh-dependencies flag is used, already installed gems will be overwritten.
    Parameters:
    project - The currently executing project
  - void prepareDependencies(org.gradle.api.Project project, OverwriteAction overwrite)
    
    Prepare dependencies with a custom overwrite behavior
  - void script(java.lang.Object scr)
    
    Set script to execute.
    Parameters:
    scr - Path to script. Can be any object that is convertible to File.
  - void scriptArgs(java.lang.Object... args)
    
    Add arguments for script
    Parameters:
    args - Arguments to be aqdded to script arguments
  - void scriptArgs(groovy.lang.Closure c)
    
    Add arguments for script in a closure style
    Parameters:
    args - Arguments to be aqdded to script arguments
  - void setScript(java.lang.Object scr)
    
    Set script to execute.
    Parameters:
    scr - Path to script. Can be any object that is convertible to File.

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Trait JRubyExecTraits

Properties Summary

Methods Summary

Property Detail

final java.util.List<java.lang.String> filterEnvKeys

@java.util.Optional @org.gradle.api.tasks.Input boolean inheritRubyEnv

Method Detail

java.io.File _convertGemWorkDir(org.gradle.api.Project project)

@groovy.transform.CompileDynamic java.util.List<java.lang.String> _convertJrubyArgs()

java.io.File _convertScript()

@groovy.transform.CompileDynamic /* collectMany is literally wrong here, stupid codenarc */ @java.lang.SuppressWarnings('UseCollectMany') java.util.List<java.lang.String> _convertScriptArgs()

void configuration(org.gradle.api.artifacts.Configuration newConfiguration)

@groovy.transform.CompileDynamic void configuration(java.lang.String newConfiguration)

void gemWorkDir(java.lang.Object workingDir)

java.lang.String getComputedPATH(java.lang.String originalPath)

@org.gradle.api.tasks.Input java.lang.String getConfiguration()

@java.util.Optional @org.gradle.api.tasks.Input @groovy.transform.CompileDynamic java.io.File getGemWorkDir()

java.util.Map getPreparedEnvironment(java.util.Map env)

void jrubyArgs(java.lang.Object... args)

void prepareDependencies(org.gradle.api.Project project)

void prepareDependencies(org.gradle.api.Project project, OverwriteAction overwrite)

void script(java.lang.Object scr)

void scriptArgs(java.lang.Object... args)

void scriptArgs(groovy.lang.Closure c)

void setScript(java.lang.Object scr)