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:

AbstractGemMojo

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

Base for all JRuby mojos.

Field Summary

protected String	args common arguments Command line -Dargs=...
protected org.codehaus.classworlds.ClassRealm	classRealm classrealm for internal use.
protected static String	DEFAULT_JRUBY_VERSION
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 Command line -Djruby.jvmargs=...
protected String	jrubySwitches switches for the jruby command, like '--1.9' Command line -Djruby.switches=...
protected boolean	jrubyVerbose verbose jruby related output Command line -Djruby.verbose=...
protected String	jrubyVersion if the pom.xml has no runtime dependency to a jruby-complete.jar then this version is used to resolve the jruby-complete dependency from the local/remote maven repository.
protected File	libDirectory directory with ruby sources - added to ruby loadpath only Command line -Djruby.lib=...
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 Command line -Djruby.sourceDirectory=...

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

ROLE

Constructor Summary

AbstractJRubyMojo()

Method Summary

void	execute()
protected abstract void	executeJRuby()
protected File	launchDirectory()
protected ScriptFactory	newScriptFactory()
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

protected String args

common arguments
Command line -Dargs=...

jrubyJvmArgs

protected String jrubyJvmArgs

jvm arguments for the java command executing jruby
Command line -Djruby.jvmargs=...

jrubySwitches

protected String jrubySwitches

switches for the jruby command, like '--1.9'
Command line -Djruby.switches=...

jrubyVersion

protected String jrubyVersion

if the pom.xml has no runtime dependency to a jruby-complete.jar then this version is used to resolve the jruby-complete dependency from the local/remote maven repository. it overwrites the jruby version from the dependencies if any. i.e. you can easily switch jruby version from the commandline !
default: 1.7.1
Command line -Djruby.version=...

jrubyFork

protected boolean jrubyFork

fork the JRuby execution.
Command line -Djruby.fork=...

jrubyVerbose

protected boolean jrubyVerbose

verbose jruby related output
Command line -Djruby.verbose=...

rubySourceDirectory

protected File rubySourceDirectory

directory with ruby sources - added to java classpath and ruby loadpath
Command line -Djruby.sourceDirectory=...

libDirectory

protected File libDirectory

directory with ruby sources - added to ruby loadpath only
Command line -Djruby.lib=...

project

protected org.apache.maven.project.MavenProject project

reference to maven project for internal use.

localRepository

protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

local repository for internal use.

classRealm

protected org.codehaus.classworlds.ClassRealm classRealm

classrealm for internal use.

repositorySystem

protected org.apache.maven.repository.RepositorySystem repositorySystem

logger

protected Logger logger

factory

protected ScriptFactory factory

Constructor Detail

AbstractJRubyMojo

public AbstractJRubyMojo()

Method Detail

newScriptFactory

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

Throws:

org.apache.maven.plugin.MojoExecutionException

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