com.threecrickets.scripturian.adapter

Class JRubyAdapter

java.lang.Object

com.threecrickets.scripturian.adapter.LanguageAdapterBase

com.threecrickets.scripturian.adapter.JRubyAdapter

All Implemented Interfaces:

LanguageAdapter

public class JRubyAdapter
extends LanguageAdapterBase

A LanguageAdapter that supports the Ruby language as implemented by JRuby.

Author:

Tal Liron

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jruby.Ruby	compilerRuntime A shared Ruby runtime instance used for scriptlet preparation.
static String	JRUBY_CLASS_CACHE The Ruby class cache attribute.
static String	JRUBY_ERR The switchable standard error attribute for the Ruby runtime.
static String	JRUBY_OUT The switchable standard output attribute for the Ruby runtime.
static String	JRUBY_RUNTIME The Ruby runtime instance attribute.
static String	RUBY_CACHE_DIR The default base directory for cached executables.

Fields inherited from interface com.threecrickets.scripturian.LanguageAdapter

DEFAULT_EXTENSION, DEFAULT_TAG, EXTENSIONS, LANGUAGE_NAME, LANGUAGE_VERSION, NAME, TAGS, VERSION

Constructor Summary

Constructors

Constructor and Description
JRubyAdapter() Constructor.

Method Summary

Modifier and Type	Method and Description
static ExecutionException	createExecutionException(org.jruby.exceptions.RaiseException x) Creates an execution exception with a full stack.
Program	createProgram(String sourceCode, boolean isScriptlet, int position, int startLineNumber, int startColumnNumber, Executable executable) Turns source code into a program.
Object	enter(String entryPointName, Executable executable, ExecutionContext executionContext, Object... arguments) Enters the executable at a stored, named location.
File	getCacheDir() The base directory for cached executables.
org.jruby.util.ClassCache<org.jruby.ast.executable.Script>	getRubyClassCache() The class cache shared between all Ruby runtime instances.
org.jruby.Ruby	getRubyRuntime(ExecutionContext executionContext) Gets a Ruby runtime instance stored in the execution context, creating it if it doesn't exist.
String	getSourceCodeForExpressionInclude(String expression, Executable executable) Creates source code for including the output of a text-with-scriptlets document.
String	getSourceCodeForExpressionOutput(String expression, Executable executable) Creates source code for outputting a source code expression to standard output.
String	getSourceCodeForLiteralOutput(String literal, Executable executable) Creates source code for outputting literal text to standard output.

Methods inherited from class com.threecrickets.scripturian.adapter.LanguageAdapterBase

getAttributes, getLock, getManager, isEphemeral, isThreadSafe, releaseContext, setManager

Methods inherited from class java.lang.Object

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

Field Detail

JRUBY_RUNTIME

public static final String JRUBY_RUNTIME

The Ruby runtime instance attribute.

JRUBY_CLASS_CACHE

public static final String JRUBY_CLASS_CACHE

The Ruby class cache attribute.

JRUBY_OUT

public static final String JRUBY_OUT

The switchable standard output attribute for the Ruby runtime.

JRUBY_ERR

public static final String JRUBY_ERR

The switchable standard error attribute for the Ruby runtime.

RUBY_CACHE_DIR

public static final String RUBY_CACHE_DIR

The default base directory for cached executables.

See Also:

Constant Field Values

compilerRuntime

protected final org.jruby.Ruby compilerRuntime

A shared Ruby runtime instance used for scriptlet preparation.

Constructor Detail

JRubyAdapter

public JRubyAdapter()
             throws LanguageAdapterException

Constructor.

Throws:

LanguageAdapterException - In case of an initialization error

Method Detail

createExecutionException

public static ExecutionException createExecutionException(org.jruby.exceptions.RaiseException x)

Creates an execution exception with a full stack.

Parameters:

x - The Ruby exception

Returns:

The execution exception

getRubyClassCache

public org.jruby.util.ClassCache<org.jruby.ast.executable.Script> getRubyClassCache()

The class cache shared between all Ruby runtime instances.

Returns:

The class cache

getRubyRuntime

public org.jruby.Ruby getRubyRuntime(ExecutionContext executionContext)

Gets a Ruby runtime instance stored in the execution context, creating it if it doesn't exist. Each execution context is guaranteed to have its own Ruby runtime. The runtime instance is updated to match the writers and services in the execution context.

Parameters:

executionContext - The execution context

Returns:

The Ruby runtime

getCacheDir

public File getCacheDir()

The base directory for cached executables.

Returns:

The cache directory

getSourceCodeForLiteralOutput

public String getSourceCodeForLiteralOutput(String literal,
                                            Executable executable)
                                     throws ParsingException

Description copied from interface: LanguageAdapter

Creates source code for outputting literal text to standard output.

Specified by:

getSourceCodeForLiteralOutput in interface LanguageAdapter

Overrides:

getSourceCodeForLiteralOutput in class LanguageAdapterBase

Parameters:

literal - The literal text

executable - The executable

Returns:

Source code

Throws:

ParsingException - In case of a parsing error

getSourceCodeForExpressionOutput

public String getSourceCodeForExpressionOutput(String expression,
                                               Executable executable)
                                        throws ParsingException

Description copied from interface: LanguageAdapter

Creates source code for outputting a source code expression to standard output.

Specified by:

getSourceCodeForExpressionOutput in interface LanguageAdapter

Overrides:

getSourceCodeForExpressionOutput in class LanguageAdapterBase

Parameters:

expression - The source code expression

executable - The executable

Returns:

Source code

Throws:

ParsingException - In case of a parsing error

getSourceCodeForExpressionInclude

public String getSourceCodeForExpressionInclude(String expression,
                                                Executable executable)
                                         throws ParsingException

Description copied from interface: LanguageAdapter

Creates source code for including the output of a text-with-scriptlets document.

For this to work, the executable must have been created with a container that supports an inclusion command named according to the language manager attribute LanguageManager.CONTAINER_INCLUDE_COMMAND_ATTRIBUTE.

Specified by:

getSourceCodeForExpressionInclude in interface LanguageAdapter

Overrides:

getSourceCodeForExpressionInclude in class LanguageAdapterBase

Parameters:

expression - The source code expression

executable - The executable

Returns:

Source code

Throws:

ParsingException - In case of a parsing error

See Also:

LanguageManager.getAttributes()

createProgram

public Program createProgram(String sourceCode,
                             boolean isScriptlet,
                             int position,
                             int startLineNumber,
                             int startColumnNumber,
                             Executable executable)
                      throws ParsingException

Description copied from interface: LanguageAdapter

Turns source code into a program. The intent is for the implementation to perform the bare minimum required for detecting errors in the source code. For better initialization, likely at the cost of extra processing up front, call Program.prepare() on the program.

Parameters:

sourceCode - The source code

isScriptlet - Whether the source code is a scriptlet

position - The program's position in the executable

startLineNumber - The line number in the document for where the program's source code begins

startColumnNumber - The column number in the document for where the program's source code begins

executable - The executable

Returns:

A program

Throws:

ParsingException - In case of a parsing error

enter

public Object enter(String entryPointName,
                    Executable executable,
                    ExecutionContext executionContext,
                    Object... arguments)
             throws NoSuchMethodException,
                    ParsingException,
                    ExecutionException

Description copied from interface: LanguageAdapter

Enters the executable at a stored, named location. According to the language, the entry point can be a function, method, lambda, closure, etc.

Specified by:

enter in interface LanguageAdapter

Overrides:

enter in class LanguageAdapterBase

Parameters:

entryPointName - The entry point name

executable - The executable

executionContext - The executable context

arguments - Optional state to pass to the entry point

Returns:

State returned from to the entry point or null

Throws:

NoSuchMethodException - In case the entry point does not exist

ParsingException - In case of a parsing error

ExecutionException - In case of an execution error