de.saumya.mojo.gem

Class AbstractGemMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

de.saumya.mojo.jruby.AbstractJRubyMojo

de.saumya.mojo.gem.AbstractGemMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

RailsMojo, RakeMojo

public abstract class AbstractGemMojo
extends AbstractJRubyMojo

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	binDirectory directory of JRuby bin path to use when forking JRuby.
protected java.io.File	gemHome directory of gem home to use when forking JRuby.
protected java.util.Map<java.lang.String,java.lang.String>	gemHomes map different install locations for rubygems (GEM_HOME) to a directory.
protected java.io.File	gemPath directory of JRuby path to use when forking JRuby.
protected GemsConfig	gemsConfig
protected GemsInstaller	gemsInstaller
protected boolean	gemUseSystem use system gems instead of setting up GemPath/GemHome inside the build directory and ignores any set gemHome and gemPath.
protected java.lang.String	includeGemsInResources EXPERIMENTAL this gives the scope of the gems which shall be included to resources.
protected boolean	includeLibDirectoryInResources /** flag whether to include file under the lib directory Command line -Dgem.includeLibDirectoryInResources=...
protected boolean	includeOpenSSL flag whether to include open-ssl gem or not Command line -Dgem.includeOpenSSL=...
protected boolean	includeRubygemsInResources flag whether to include all gems to resources, i.e.
protected boolean	includeRubygemsInTestResources flag whether to include all gems to test-resources, i.e.
protected boolean	installRDoc flag whether to install rdocs of the used gems or not Command line -Dgem.installRDoc=...
protected boolean	installRI flag whether to install ri of the used gems or not Command line -Dgem.installRDoc=...
protected GemManager	manager
protected org.apache.maven.plugin.descriptor.PluginDescriptor	plugin
protected boolean	supportNative flag to indicate to setup jruby's native support for C-extensions Command line -Dgem.supportNative=...
protected org.codehaus.plexus.archiver.UnArchiver	unzip

Fields inherited from class de.saumya.mojo.jruby.AbstractJRubyMojo

args, classRealm, DEFAULT_JRUBY_VERSION, env, factory, JRUBY_COMPLETE, JRUBY_CORE, JRUBY_STDLIB, jrubyFork, jrubyJvmArgs, jrubySwitches, jrubyVerbose, libDirectory, localRepository, logger, project, repositorySystem, rubySourceDirectory

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractGemMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addResource(java.util.List<org.apache.maven.model.Resource> resources, org.apache.maven.model.Resource resource)
void	execute()
protected void	executeJRuby()
protected abstract void	executeWithGems()
protected java.io.File	gemHome(java.lang.String base, java.lang.String key)
protected java.util.List<org.apache.maven.artifact.repository.ArtifactRepository>	getRemoteRepos()
protected ScriptFactory	newScriptFactory(org.apache.maven.artifact.Artifact artifact)

Methods inherited from class de.saumya.mojo.jruby.AbstractJRubyMojo

getJrubyVersion, launchDirectory, resolveJRubyArtifact, resolveJRubyCompleteArtifact, resolveJRubyStdlibArtifact

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

unzip

protected org.codehaus.plexus.archiver.UnArchiver unzip

plugin

protected org.apache.maven.plugin.descriptor.PluginDescriptor plugin

includeOpenSSL

protected boolean includeOpenSSL

flag whether to include open-ssl gem or not
Command line -Dgem.includeOpenSSL=...

includeRubygemsInTestResources

protected boolean includeRubygemsInTestResources

flag whether to include all gems to test-resources, i.e. to test-classpath or not
Command line -Dgem.includeRubygemsInTestResources=...

includeRubygemsInResources

protected boolean includeRubygemsInResources

flag whether to include all gems to resources, i.e. to classpath or not
Command line -Dgem.includeRubygemsInResources=...

includeGemsInResources

protected java.lang.String includeGemsInResources

EXPERIMENTAL this gives the scope of the gems which shall be included to resources. flag whether to include all gems to resources, i.e. to classpath or not. the difference to the includeRubygemsInResources is that it does not depend on rubygems during runtime since the required_path of the gems gets added to resources. note that it expect the required_path of the gem to be lib which is the default BUT that is not true for all gems. in this sense this feature is incomplete and might not work for you !!! IMPORTANT: it only adds the gems with provided scope since they are packed with the jar and then the pom.xml will not have them (since they are marked 'provided') as transitive dependencies. this feature can be helpful in situations where the classloader does not work for rubygems due to rubygems uses file system globs to find the gems and this only works if the classloader reveals the jar url of its jars (i.e. URLClassLoader). for example OSGi classloader can not work with rubygems !!
Command line -Dgem.includeGemsInResources=...

includeLibDirectoryInResources

protected boolean includeLibDirectoryInResources

/** flag whether to include file under the lib directory
Command line -Dgem.includeLibDirectoryInResources=...

installRDoc

protected boolean installRDoc

flag whether to install rdocs of the used gems or not
Command line -Dgem.installRDoc=...

installRI

protected boolean installRI

flag whether to install ri of the used gems or not
Command line -Dgem.installRDoc=...

gemUseSystem

protected boolean gemUseSystem

use system gems instead of setting up GemPath/GemHome inside the build directory and ignores any set gemHome and gemPath. you need to have both GEM_HOME and GEM_PATH environment variable set to make it work.
Command line -Dgem.useSystem=...

gemHomes

protected java.util.Map<java.lang.String,java.lang.String> gemHomes

map different install locations for rubygems (GEM_HOME) to a directory. for example compile dependencies will be installed in ${project.build.directory}/rubygems and provided dependencies in ${project.build.directory}/rubygems-provided, and ${project.build.directory}/rubygems-test for the test scope. this mapping here allows to map those different directories onto a single one, i.e.: test => ${gem.home}, provided => ${gem.home}

gemHome

protected java.io.File gemHome

directory of gem home to use when forking JRuby. default will be ignored when gemUseSystem is true.
Command line -Dgem.home=...

gemPath

protected java.io.File gemPath

directory of JRuby path to use when forking JRuby. default will be ignored when gemUseSystem is true.
Command line -Dgem.path=...

binDirectory

protected java.io.File binDirectory

directory of JRuby bin path to use when forking JRuby.
Command line -Dgem.binDirectory=...

supportNative

protected boolean supportNative

flag to indicate to setup jruby's native support for C-extensions
Command line -Dgem.supportNative=...

manager

protected GemManager manager

gemsConfig

protected GemsConfig gemsConfig

gemsInstaller

protected GemsInstaller gemsInstaller

Constructor Detail

AbstractGemMojo

public AbstractGemMojo()

Method Detail

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractJRubyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

newScriptFactory

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

Overrides:

newScriptFactory in class AbstractJRubyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

gemHome

protected java.io.File gemHome(java.lang.String base,
                   java.lang.String key)

executeJRuby

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

Specified by:

executeJRuby in class AbstractJRubyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

java.io.IOException

ScriptException

addResource

protected void addResource(java.util.List<org.apache.maven.model.Resource> resources,
               org.apache.maven.model.Resource resource)

executeWithGems

protected abstract void executeWithGems()
                                 throws org.apache.maven.plugin.MojoExecutionException,
                                        ScriptException,
                                        GemException,
                                        java.io.IOException,
                                        org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

ScriptException

GemException

java.io.IOException

org.apache.maven.plugin.MojoFailureException

getRemoteRepos

protected java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> getRemoteRepos()