de.saumya.mojo.jruby

Class AbstractJRubyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

de.saumya.mojo.jruby.AbstractJRubyMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

CompileMojo, JRubyMojo

public abstract class AbstractJRubyMojo
extends org.apache.maven.plugin.AbstractMojo

Base for all JRuby mojos.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addProjectClasspath add project class path to JVM classpath on executing jruby.
protected String	args common arguments
protected org.codehaus.classworlds.ClassRealm	classRealm classrealm for internal use.
protected static String	DEFAULT_JRUBY_VERSION
protected List<String>	eclipseRefresh
protected List<String>	eclipseWatches
protected Map<String,String>	env environment values passed on to the jruby process.
protected ScriptFactory	factory
protected static String	JRUBY_COMPLETE
protected static String	JRUBY_CORE
protected static String	JRUBY_STDLIB
protected boolean	jrubyFork fork the JRuby execution.
protected String	jrubyJvmArgs jvm arguments for the java command executing jruby
protected String	jrubySwitches switches for the jruby command, like '--1.9'
protected boolean	jrubyVerbose verbose jruby related output
protected File	libDirectory directory with ruby sources - added to ruby loadpath only
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository local repository for internal use.
protected Logger	logger
protected org.apache.maven.project.MavenProject	project reference to maven project for internal use.
protected org.apache.maven.repository.RepositorySystem	repositorySystem
protected File	rubySourceDirectory directory with ruby sources - added to java classpath and ruby loadpath

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractJRubyMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
protected abstract void	executeJRuby()
protected String	getDefaultJRubyVersion()
protected JRubyVersion	getJrubyVersion()
protected List<String>	getProjectClasspath()
protected File	launchDirectory()
protected ScriptFactory	newScriptFactory(org.apache.maven.artifact.Artifact artifact)
protected org.apache.maven.artifact.Artifact	resolveJRubyArtifact()
protected org.apache.maven.artifact.Artifact	resolveJRubyCompleteArtifact(String version)
protected org.apache.maven.artifact.Artifact	resolveJRubyStdlibArtifact(org.apache.maven.artifact.Artifact jruby)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JRUBY_COMPLETE

protected static final String JRUBY_COMPLETE

See Also:

Constant Field Values

JRUBY_CORE

protected static final String JRUBY_CORE

See Also:

Constant Field Values

JRUBY_STDLIB

protected static final String JRUBY_STDLIB

See Also:

Constant Field Values

DEFAULT_JRUBY_VERSION

protected static final String DEFAULT_JRUBY_VERSION

See Also:

Constant Field Values

args

@Parameter(property="args")
protected String args

common arguments

jrubyJvmArgs

@Parameter(property="jruby.jvmargs")
protected String jrubyJvmArgs

jvm arguments for the java command executing jruby

jrubySwitches

@Parameter(property="jruby.switches")
protected String jrubySwitches

switches for the jruby command, like '--1.9'

env

@Parameter(property="jruby.env")
protected Map<String,String> env

environment values passed on to the jruby process. needs jrubyFork true.

jrubyFork

@Parameter(property="jruby.fork",
           defaultValue="true")
protected boolean jrubyFork

fork the JRuby execution.

jrubyVerbose

@Parameter(property="jruby.verbose",
           defaultValue="false")
protected boolean jrubyVerbose

verbose jruby related output

rubySourceDirectory

@Parameter(property="jruby.sourceDirectory",
           defaultValue="src/main/ruby")
protected File rubySourceDirectory

directory with ruby sources - added to java classpath and ruby loadpath

libDirectory

@Parameter(property="jruby.lib",
           defaultValue="lib")
protected File libDirectory

directory with ruby sources - added to ruby loadpath only

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

reference to maven project for internal use.

addProjectClasspath

@Parameter(defaultValue="true",
           property="jruby.addProjectClasspath")
protected boolean addProjectClasspath

add project class path to JVM classpath on executing jruby.

localRepository

@Parameter(readonly=true,
           defaultValue="${localRepository}")
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

local repository for internal use.

classRealm

@Parameter(readonly=true,
           defaultValue="${dummy}")
protected org.codehaus.classworlds.ClassRealm classRealm

classrealm for internal use.

repositorySystem

@Component
protected org.apache.maven.repository.RepositorySystem repositorySystem

logger

protected Logger logger

factory

protected ScriptFactory factory

eclipseWatches

@Parameter(property="m2e.jruby.watch")
protected List<String> eclipseWatches

eclipseRefresh

@Parameter(property="m2e.jruby.refresh")
protected List<String> eclipseRefresh

Constructor Detail

AbstractJRubyMojo

public AbstractJRubyMojo()

Method Detail

getDefaultJRubyVersion

protected String getDefaultJRubyVersion()

getJrubyVersion

protected JRubyVersion getJrubyVersion()

newScriptFactory

protected ScriptFactory newScriptFactory(org.apache.maven.artifact.Artifact artifact)
                                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeJRuby

protected abstract void executeJRuby()
                              throws org.apache.maven.plugin.MojoExecutionException,
                                     org.apache.maven.plugin.MojoFailureException,
                                     IOException,
                                     ScriptException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

IOException

ScriptException

launchDirectory

protected File launchDirectory()

resolveJRubyCompleteArtifact

protected org.apache.maven.artifact.Artifact resolveJRubyCompleteArtifact(String version)
                                                                   throws org.apache.maven.artifact.DependencyResolutionRequiredException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

resolveJRubyArtifact

protected org.apache.maven.artifact.Artifact resolveJRubyArtifact()
                                                           throws org.apache.maven.artifact.DependencyResolutionRequiredException,
                                                                  org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

org.apache.maven.plugin.MojoExecutionException

resolveJRubyStdlibArtifact

protected org.apache.maven.artifact.Artifact resolveJRubyStdlibArtifact(org.apache.maven.artifact.Artifact jruby)
                                                                 throws org.apache.maven.artifact.DependencyResolutionRequiredException,
                                                                        org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

org.apache.maven.plugin.MojoExecutionException

getProjectClasspath

protected List<String> getProjectClasspath()
                                    throws org.apache.maven.artifact.DependencyResolutionRequiredException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException