2008-08-12T20:40:41Z
Added comment about JRE and server option on windows under troubleshooting
167
FAQs
21
17486
[[Home|» JRuby Project Wiki Home Page]]
<h1>JRuby Frequently Asked Questions (FAQs)</h1>
__TOC__
==Execution Environments==
====Can I run JRuby on Java Micro Edition?====
Somewhat. See [[JRubyOnJavaMicroEdition|JRuby on JME]].
====How can I run JRuby using Java Web Start?====
Here is a page dedicated to answering this question: [[JRuby on Web Start]]
====How can I make my Ruby scripts execute with JRuby on unix systems like other scripts?====
Include a "hash bang" line on the top of your jruby script like this:
#!/usr/bin/env jruby
That will use the system wide installed jruby interpreter to run your script.
If you would like to use a local copy of JRuby to run your script, give the relative or absolute path to the jruby program:
#!/usr/bin/env jruby-1.1RC2/bin/jruby
To run the script directly, you need to set the "x" flag on it:
chmod +x your_script.rb
You can now start your script with
./your_script.rb
==General==
====Where can I find more information about the Ruby language?====
[http://www.ruby-lang.org The Ruby Language Home Page] has links to a wide range of resources for learning about Ruby, downloading releases of the C implementation of Ruby, documentation on Ruby, and community outlets for talking about Ruby.
[http://www.pragmaticprogrammer.com/ The Pragmatic Programmers] are the publishers of the de facto standard Ruby text, "Programming Ruby". It is considered a must-have manual to the Ruby language and libraries.
Almost everything you learn about the Ruby language is directly applicable to working with JRuby. JRuby aims to be a drop-in replacement for the C implementation of Ruby.
====What incompatibilities does JRuby have with the C implementation of Ruby? ====
See [[DifferencesBetweenMriAndJruby|Differences Between MRI and JRuby]].
====How do I run JRuby without the command-line scripts?====
Frequently users want to run JRuby from NetBeans, from Eclipse, launched from an existing Java application, or in other ways that don't use the command-line scripts. In addition to having <tt>jruby.jar</tt> and its dependency jars available in CLASSPATH, you must also have the following system property set:
jruby.home=''path-to-root-of-JRuby-installation''
You might also want to ensure the maximum memory is set higher than the JVM default. JRuby's own command-line scripts use a maximum of 256MB.
====What if I want to use JRuby alongside C Ruby? How do I keep from getting confused?====
You have two options:
* Always invoke JRuby with e.g., <tt>jruby -S gem</tt>.
* Put a handy bash snippet like this in your .bashrc to create <tt>j</tt> aliases to all the available commands (<tt>rails</tt> becomes <tt>jrails</tt>, <tt>rake</tt> becomes <tt>jrake</tt>, etc.)
for f in $JRUBY_HOME/bin/*; do
f=$(basename $f)
case $f in jruby*|jirb*|*.bat|*.rb|_*) continue ;; esac
eval "alias j$f='jruby -S $f'"
done
====Why can't JRuby find my installed gems?====
JRuby can only see the gems installed with the gem command shipped with JRuby. The gems installed this way will be stored under <tt>$JRUBY_HOME/lib/ruby</tt>. If you try to run Rails and get the error, "Cannot find gem for Rails ~>1.2.2.0:" (or whatever version you are using), the problem is probably that you haven't installed the Rails-gem and its dependencies with the JRuby gem-command.
====When I implement a Java interface and provide my own initialize method, I can't construct it anymore.====
In JRuby 0.9.0, any class implementing a Java interface must explicitly call <tt>super</tt> in their initializers to set up the interface proxy. Add a <tt>super</tt> call to your implementation's <tt>initialize</tt> method and it should work.
====How do I call JRuby from my existing Java program?====
If you don't want to launch JRuby as a separate process, we recommend you use the [http://jakarta.apache.org/bsf/ Bean Scripting Framework] (BSF) or [https://scripting.dev.java.net/ Java 6's Scripting Support] (JSR223). We do not recommend calling directly into the JRuby runtime, since that code is subject to change.
==== Where can I find the javadoc? ====
====Why do I get a NoSuchMethodError when running JRuby 0.9.0?====
Some users will see the following error when running JRuby 0.9.0:
Exception in thread "main" java.lang.NoSuchMethodError:
java.lang.StringBuffer.append(Ljava/lang/CharSequence;)Ljava/lang/StringBuffer;
at org.jruby.RubyString.cat(RubyString.java:223)
at org.jruby.RubyString.append(RubyString.java:508)
at org.jruby.RubyString.concat(RubyString.java:518)
This error occurs when JRuby is built under Java 5 or higher and run on Java 1.4. Java 5 has the <tt>append(CharSequence)</tt> method, so it uses that during compilation. Java 1.4 does not have that method.
The first release of JRuby 0.9.0 was mistakenly build with Java 5, so we released a second version compiled with Java 1.4. Make sure you're using a JRuby compiled with Java 1.4 if that's the version of Java you intend to run it under.
====How do I get a Ruby backtrace when calling JRuby code from Java?====
You need to do something along the lines of:
try {
rubyCode.doSomething();
} catch (RaiseException e) {
e.getException().printBacktrace(System.err);
}
Note that Java 6's scripting via the BSF libraries might not preserve stack traces, and also launches more slowly. It's often preferable (as of February 2007) to use JRuby's own integration.
====Why do I get a <tt>java.lang.NoSuchMethodError: org.objectweb.asm.ClassWriter.visit()</tt> error when running JRuby 1.X with a custom classpath?====
The problem stems from an ASM jar conflict. It was found by setting a custom classpath, which includes a version of Spring that has a conflicting ASM jar, and then invoking JRuby. The easiest workaround is to build <tt>jruby-complete</tt> as a single jar and edit the JRuby config file (not sure about Windows, but it should be similar) to source only the <tt>jruby-complete</tt> jar. You will need to add ALL other jars, which I believe includes your jdbc driver as well.
svn co <nowiki>http://svn.codehaus.org/jruby/tags/jruby-1_0/</nowiki>
cd jruby-1_0
ant jar-complete
vi bin/jruby (see diff for edit)
#diff bin/jruby bin/jruby.orig
#89c89
#< for j in "$JRUBY_HOME"/lib/jruby-complete.jar; do
#---
#> for j in "$JRUBY_HOME"/lib/*.jar; do
====How come Java can't find resources in class folders that I've appended to the $CLASSPATH global variable at runtime? ====
JRubyClassLoader extends <tt>java.net.URLClassLoader</tt>, which treats any URL that doesn't end with a slash as a jar. See [http://java.sun.com/j2se/1.5.0/docs/api/java/net/URLClassLoader.html URLClassLoader].
====Why don't my special characters (like ção) appear correctly in my Swing app ?====
The file encoding for the <tt>.rb</tt> file containing the special characters must be set to UTF-8. There were also issues in versions of JRuby before 1.2 where unicode characters were not properly pulled out via the <tt>toString</tt> method on Ruby objects. Try upgrading to 1.2 or higher.
====Under OSX I get this error when trying to execute jruby: "Exception in thread 'main' java.lang.NoClassDefFoundError: org/jruby/Main" ====
The source of this problem is the inclusion of <tt>'.'</tt> (current directory) in your $PATH. You're also trying to execute JRuby from <tt>$JRUBY_HOME/bin</tt>. There's a bug in the JRuby bash script that prevents this from working.
To correct the issue, remove <tt>'.'</tt> from your $PATH and relaunch the shell. Alternately, if you really want to keep <tt>'.'</tt> in your $PATH (which you shouldn't, but see google for reasons why), then just change your working directory to something other than <tt>$JRUBY_HOME/bin</tt> and execute the <tt>jruby</tt> command. It should launch just fine.
% cd /any/path/other/than/jruby_home
% jruby # should work
'''Note:'''' This bug has been fixed in JRuby 1.2.
====How do I check which version of the JVM JRuby is running on?====
% jruby -rjava -e "puts java.lang.System.get_property('java.version')"
==Running Rails==
====Why does script/server (WEBrick) terminate right after saying "Booting WEBrick..."?====
This happens if you require ActiveRecord-JDBC in your environment, but you haven't installed the gem. Make sure you have the ActiveRecord-JDBC gem installed.
====How do I avoid installing the Rails gem twice for both CRuby and JRuby?====
You just need to set GEM_HOME to point to your CRuby's gem directory. For example, in tcsh:
setenv GEM_HOME /usr/local/lib/ruby/gems/1.8
Note that on Windows, you should specify the path using unix-style directory separators. For example, if ruby is installed in <tt>C:\ruby</tt>:
set GEM_HOME=c:/ruby/lib/ruby/gems/1.8
====I get the error "undefined method 'cattr_accessor' for ActiveRecord::Base:Class (NoMethodError)" after configuring activerecord-jdbc. What is wrong?====
You're not requiring activerecord-jdbc properly. Try requiring activerecord-jdbc in <tt>config/environment.rb</tt> this way:
require 'jdbc_adapter'
====I keep getting "500.html running rails app built by goldspike in a JEE Container". What is wrong?====
You might not have set the production DB settings in <tt>database.yml</tt> properly. Goldspike by default builds a war that runs the app in production mode.
You can confirm the problem by finding the <tt>production.log</tt> file. If you're using JBoss, then it lives in <tt>$JBOSS_HOME/server/my_app/tmp/my_rails_war</tt>''1234''<tt>.war</tt>, where ''1234'' is a random number generated by JBoss.
In <tt>production.log</tt>, you'll see an error this:
RuntimeError (The driver encountered an error: can't convert nil into String)
To fix this, just set the production DB settings in <tt>database.yml</tt> properly.
====How can I load a ResourceBundle from the Rails config directory ?====
You can add the config directory to the JRuby classpath in <tt>config/environment.rb</tt>:
$CLASSPATH << "file:///#{File.expand_path(File.join(RAILS_ROOT, 'config'))}/"
Now, because <tt>ResourceBundle.getBundle</tt> doesn't seem to use the JRuby class loader, we need to pass it explicitly. In the file where you want to use the resource bundle do :
include Java
require 'jruby'
...
bundle = java.util.ResourceBundle::getBundle
("i18n", java.util.Locale::FRENCH, JRuby.runtime.j_ruby_class_loader)
Now you just need to put your <tt>i18n[_*].properties</tt> files in <tt>config/</tt>, et voilà!
==Calling Into Java==
====Why do I get <tt>ClassNotFoundException</tt> when I call <tt>java.lang.Class.forName</tt> from Ruby?====
When JRuby runs at the command line, it loads into the bootstrap class loader. This class loader lives above CLASSPATH, so libraries you add to CLASSPATH are not normally visible. Because <tt>Class.forName</tt> uses the class loader of the nearest non-system class that called it, it ends up seeing JRuby as the caller and looking for classes only in CLASSPATH.
The workaround for this is simple: Uuse JRuby's import or include_class methods to load the class, or just reference it directly as in <tt>Java::my.package.MyClass</tt> or <tt>org.postgresql.Driver</tt>.
====How do I access an inner class with a lowercase name?====
Sometimes, developers name their inner classes beginning with a lowercase letter. This prevents JRuby from accessing it the "normal way" (it thinks it's a method). For example:
In Java (from the <tt>com.sun.enterprise.ee.cms.core</tt> package of the [https://shoal.dev.java.net/ Shoal project])
GMSConstants.shutdownType.INSTANCE_SHUTDOWN
Whereas in JRuby, you can get at that using the following:
>> ShutdownType = JavaUtilities.get_proxy_class(
'com.sun.enterprise.ee.cms.core.GMSConstants$shutdownType')
==Java and JRuby Interoperation==
==== How do I create a primitive Java array in JRuby?====
You can convert existing ruby arrays to primitive Java arrays very simply:
[1,2,3].to_java => makes an object array
[1,2,3].to_java :byte => makes a byte array
[1,2,3].to_java :String => makes a String array
To create empty arrays:
Java::byte[12].new => makes a new byte[]
java.lang.String[12].new => makes a new String[]
====How can I implement a Java Interface using a Ruby Class?====
There are two separate ways:
* Include an interface into the class.
class MyListener
include java.awt.event.ActionListener
def actionPerformed(event)
button.text = "I have been pressed"
end
end
* Use implicit closure conversion.
button.add_action_listener { |event| button.text = "I have been pressed" }
== Compiler-related questions==
====How can I compile my Ruby into Java?====
You can do an Ahead-Of-Time (AOT) compile by using these [[JRubyCompiler|instructions]].
== Troubleshooting==
==== Why do my ruby scripts under cygwin get executed as if they are bourne shell scripts?====
Add <tt>.bat</tt> extension to JRuby scripts.
If you try to run JRuby on cygwin for Windows and use the commands without the <tt>.bat</tt> extension, it will default to the bourne shell versions, which might not work properly.
'''Example using gems:'''
$JRUBY_HOME/bin/gem.bat install rails -y --no-ri --no-rdoc
==== Why does my db:migrate fail with "undefined method 'create_database' for class '#<Class:01x1e30857>'"?====
In this case, try to run the migrations with:
jruby -S rake db:migrate SKIP_AR_JDBC_RAKE_REDEFINES=1
You can also just put the following line somewhere in your Rakefile, or in a custom Rakefile in <tt>lib/tasks/*.rake</tt>:
ENV['SKIP_AR_JDBC_RAKE_REDEFINES'] = '1'
<span id="troubleshooting_JNI"></span>
==== I am having a weird JNI problem. Help me!====
There are two scenarios in which JNI problems occur:
* When the jar is in JRuby 1.1.2's lib.
* When the jar is loaded using ruby's "require" statement in JRuby < 1.1.
These two scenarios are described below.
===== JRuby 1.1.2 + =====
JRuby 1.1.2 changed how it set up the classpath. Earlier versions merged the CLASSPATH environment variable with all .jar files in <tt>JRUBY_HOME/lib</tt> and passed them to the JVM via the <tt>-classpath</tt> option. JRuby 1.1.2 instead passes all <tt>.jar</tt> files in <tt>lib</tt> to the JVM via the <tt>-Xbootclasspath/a:</tt> option, while CLASSPATH is passed using <tt>-classpath</tt>. Jar files that use JNI (e.g. <tt>sqljdbc.jar</tt>) don't work correctly when they're in the boot classpath, so they should not be placed in JRuby's <tt>lib</tt> directory. Instead, they should be loaded with <tt>require</tt> or by setting the CLASSPATH environment variable.
===== JRuby < 1.1 =====
In older versions of JRuby (pre 1.1), loading a jar into multiple JRuby runtimes with <tt>require</tt> can cause problems with JNI. For example, when using Microsoft SQL Server and integrated security in a rails application with <tt>sqljdbc</tt> loaded with a <tt>require</tt> statement, running <tt>jruby</tt> <tt>-S</tt> <tt>rake</tt> <tt>test:units</tt> results in the following error:
com.microsoft.sqlserver.jdbc.AuthenticationJNI
<clinit>
WARNING: Failed to load the sqljdbc_auth.dll
The error message is displayed because <tt>sqljdbc.jar</tt> is loaded twice, but the OS and/or JVM and/or native library will only allow the native library to be loaded and initialized once. There are two ways to work around this problem.
* Load the jar on the classpath instead of using <tt>require</tt>. This will cause it to be loaded by a different class loader, so the jar file will only be loaded once per process.
* Tell JRuby to launch other jrubies out-of-proc with <br/><tt>jruby '''-J-Djruby.launch.inproc=false''' ''rest of command''</tt><br/> This will cause a second JVM to be launched in the <tt>rake</tt> <tt>test:units</tt> example above.
==== I tried the --server option and received an error====
You tried the performance tuning option --server but received an error like "Error: no `server' JVM at `c:\Program Files\Java\jre6\bin\server\jvm.dll'."
On windows the Java Runtime Environment (JRE) does not include the server VM. You should download an install the Java Development Kit (JDK).
If you want to use the server with the JRE, you can copy JDK's jre\bin\server folder to a bin\server directory in the Java SE Runtime Environment.
<p><a href='<?url_for_page Home?>' class='internal'>» JRuby Project Wiki Home Page</a><h1>JRuby Frequently Asked Questions (FAQs)</h1>
</p><div id='toc' class='toc'>
<div id='toctitle' class='toc-title'>
<span>Contents</span>
</div>
<div id='toccontents' class='toc-contents'><ul><ul><li>1 <a href='#Execution_Environments'>Execution Environments</a></li>
<ul><ul><li>1.1 <a href='#Can_I_run_JRuby_on_Java_Micro_Edition?'>Can I run JRuby on Java Micro Edition?</a></li>
<li>1.2 <a href='#How_can_I_run_JRuby_using_Java_Web_Start?'>How can I run JRuby using Java Web Start?</a></li>
<li>1.3 <a href='#How_can_I_make_my_Ruby_scripts_execute_with_JRuby_on_unix_systems_like_other_scripts?'>How can I make my Ruby scripts execute with JRuby on unix systems like other scripts?</a></li>
</ul></ul><li>2 <a href='#General'>General</a></li>
<ul><ul><li>2.1 <a href='#Where_can_I_find_more_information_about_the_Ruby_language?'>Where can I find more information about the Ruby language?</a></li>
<li>2.2 <a href='#What_incompatibilities_does_JRuby_have_with_the_C_implementation_of_Ruby?'>What incompatibilities does JRuby have with the C implementation of Ruby? </a></li>
<li>2.3 <a href='#How_do_I_run_JRuby_without_the_command-line_scripts?'>How do I run JRuby without the command-line scripts?</a></li>
<li>2.4 <a href='#What_if_I_want_to_use_JRuby_alongside_C_Ruby?_How_do_I_keep_from_getting_confused?'>What if I want to use JRuby alongside C Ruby? How do I keep from getting confused?</a></li>
<li>2.5 <a href='#Why_can_t_JRuby_find_my_installed_gems?'>Why can't JRuby find my installed gems?</a></li>
<li>2.6 <a href='#When_I_implement_a_Java_interface_and_provide_my_own_initialize_method,_I_can_t_construct_it_anymore.'>When I implement a Java interface and provide my own initialize method, I can't construct it anymore.</a></li>
<li>2.7 <a href='#How_do_I_call_JRuby_from_my_existing_Java_program?'>How do I call JRuby from my existing Java program?</a></li>
<li>2.8 <a href='#Where_can_I_find_the_javadoc?'> Where can I find the javadoc? </a></li>
<li>2.9 <a href='#Why_do_I_get_a_NoSuchMethodError_when_running_JRuby_0.9.0?'>Why do I get a NoSuchMethodError when running JRuby 0.9.0?</a></li>
<li>2.10 <a href='#How_do_I_get_a_Ruby_backtrace_when_calling_JRuby_code_from_Java?'>How do I get a Ruby backtrace when calling JRuby code from Java?</a></li>
<li>2.11 <a href='#Why_do_I_get_a_java.lang.NoSuchMethodError:_org.objectweb.asm.ClassWriter.visit()_error_when_running_JRuby_1.X_with_a_custom_classpath?'>Why do I get a <tt>java.lang.NoSuchMethodError: org.objectweb.asm.ClassWriter.visit()</tt> error when running JRuby 1.X with a custom classpath?</a></li>
<li>2.12 <a href='#How_come_Java_can_t_find_resources_in_class_folders_that_I_ve_appended_to_the_$CLASSPATH_global_variable_at_runtime?'>How come Java can't find resources in class folders that I've appended to the $CLASSPATH global variable at runtime? </a></li>
<li>2.13 <a href='#Why_don_t_my_special_characters_(like_ção)_appear_correctly_in_my_Swing_app_?'>Why don't my special characters (like ção) appear correctly in my Swing app ?</a></li>
<li>2.14 <a href='#Under_OSX_I_get_this_error_when_trying_to_execute_jruby:_"Exception_in_thread__main__java.lang.NoClassDefFoundError:_org/jruby/Main"'>Under OSX I get this error when trying to execute jruby: "Exception in thread 'main' java.lang.NoClassDefFoundError: org/jruby/Main" </a></li>
<li>2.15 <a href='#How_do_I_check_which_version_of_the_JVM_JRuby_is_running_on?'>How do I check which version of the JVM JRuby is running on?</a></li>
</ul></ul><li>3 <a href='#Running_Rails'>Running Rails</a></li>
<ul><ul><li>3.1 <a href='#Why_does_script/server_(WEBrick)_terminate_right_after_saying_"Booting_WEBrick..."?'>Why does script/server (WEBrick) terminate right after saying "Booting WEBrick..."?</a></li>
<li>3.2 <a href='#How_do_I_avoid_installing_the_Rails_gem_twice_for_both_CRuby_and_JRuby?'>How do I avoid installing the Rails gem twice for both CRuby and JRuby?</a></li>
<li>3.3 <a href='#I_get_the_error_"undefined_method__cattr_accessor__for_ActiveRecord::Base:Class_(NoMethodError)"_after_configuring_activerecord-jdbc._What_is_wrong?'>I get the error "undefined method 'cattr_accessor' for ActiveRecord::Base:Class (NoMethodError)" after configuring activerecord-jdbc. What is wrong?</a></li>
<li>3.4 <a href='#I_keep_getting_"500.html_running_rails_app_built_by_goldspike_in_a_JEE_Container"._What_is_wrong?'>I keep getting "500.html running rails app built by goldspike in a JEE Container". What is wrong?</a></li>
<li>3.5 <a href='#How_can_I_load_a_ResourceBundle_from_the_Rails_config_directory_?'>How can I load a ResourceBundle from the Rails config directory ?</a></li>
</ul></ul><li>4 <a href='#Calling_Into_Java'>Calling Into Java</a></li>
<ul><ul><li>4.1 <a href='#Why_do_I_get_ClassNotFoundException_when_I_call_java.lang.Class.forName_from_Ruby?'>Why do I get <tt>ClassNotFoundException</tt> when I call <tt>java.lang.Class.forName</tt> from Ruby?</a></li>
<li>4.2 <a href='#How_do_I_access_an_inner_class_with_a_lowercase_name?'>How do I access an inner class with a lowercase name?</a></li>
</ul></ul><li>5 <a href='#Java_and_JRuby_Interoperation'>Java and JRuby Interoperation</a></li>
<ul><ul><li>5.1 <a href='#How_do_I_create_a_primitive_Java_array_in_JRuby?'> How do I create a primitive Java array in JRuby?</a></li>
<li>5.2 <a href='#How_can_I_implement_a_Java_Interface_using_a_Ruby_Class?'>How can I implement a Java Interface using a Ruby Class?</a></li>
</ul></ul><li>6 <a href='#Compiler-related_questions'> Compiler-related questions</a></li>
<ul><ul><li>6.1 <a href='#How_can_I_compile_my_Ruby_into_Java?'>How can I compile my Ruby into Java?</a></li>
</ul></ul><li>7 <a href='#Troubleshooting'> Troubleshooting</a></li>
<ul><ul><li>7.1 <a href='#Why_do_my_ruby_scripts_under_cygwin_get_executed_as_if_they_are_bourne_shell_scripts?'> Why do my ruby scripts under cygwin get executed as if they are bourne shell scripts?</a></li>
<li>7.2 <a href='#Why_does_my_db:migrate_fail_with_"undefined_method__create_database__for_class__#<Class:01x1e30857>_"?'> Why does my db:migrate fail with "undefined method 'create_database' for class '#<Class:01x1e30857>'"?</a></li>
<li>7.3 <a href='#I_am_having_a_weird_JNI_problem._Help_me!'> I am having a weird JNI problem. Help me!</a></li>
<ul><li>7.3.1 <a href='#JRuby_1.1.2_+'> JRuby 1.1.2 + </a></li>
<li>7.3.2 <a href='#JRuby_<_1.1'> JRuby < 1.1 </a></li>
</ul><li>7.4 <a href='#I_tried_the_--server_option_and_received_an_error'> I tried the --server option and received an error</a></li>
</ul></ul></ul></ul></div>
</div><h2><a name='Execution_Environments'></a>Execution Environments</h2>
<h4><a name='Can_I_run_JRuby_on_Java_Micro_Edition?'></a>Can I run JRuby on Java Micro Edition?</h4>
<p>Somewhat. See <a href='<?url_for_page JRubyOnJavaMicroEdition?>' class='internal'>JRuby on JME</a>.
</p><h4><a name='How_can_I_run_JRuby_using_Java_Web_Start?'></a>How can I run JRuby using Java Web Start?</h4>
<p>Here is a page dedicated to answering this question: <a href='<?url_for_page JRuby on Web Start?>' class='internal'>JRuby on Web Start</a>
</p><h4><a name='How_can_I_make_my_Ruby_scripts_execute_with_JRuby_on_unix_systems_like_other_scripts?'></a>How can I make my Ruby scripts execute with JRuby on unix systems like other scripts?</h4>
<p>Include a "hash bang" line on the top of your jruby script like this:
</p><pre> #!/usr/bin/env jruby
</pre><p>That will use the system wide installed jruby interpreter to run your script.
</p><p>If you would like to use a local copy of JRuby to run your script, give the relative or absolute path to the jruby program:
</p><pre> #!/usr/bin/env jruby-1.1RC2/bin/jruby
</pre><p>
To run the script directly, you need to set the "x" flag on it:
</p><pre> chmod +x your_script.rb
</pre><p>
You can now start your script with
</p><pre> ./your_script.rb
</pre><h2><a name='General'></a>General</h2>
<h4><a name='Where_can_I_find_more_information_about_the_Ruby_language?'></a>Where can I find more information about the Ruby language?</h4>
<p><a class='external' href="http://www.ruby-lang.org">The Ruby Language Home Page</a> has links to a wide range of resources for learning about Ruby, downloading releases of the C implementation of Ruby, documentation on Ruby, and community outlets for talking about Ruby.
</p><p><a class='external' href="http://www.pragmaticprogrammer.com/">The Pragmatic Programmers</a> are the publishers of the de facto standard Ruby text, "Programming Ruby". It is considered a must-have manual to the Ruby language and libraries.
</p><p>Almost everything you learn about the Ruby language is directly applicable to working with JRuby. JRuby aims to be a drop-in replacement for the C implementation of Ruby.
</p><h4><a name='What_incompatibilities_does_JRuby_have_with_the_C_implementation_of_Ruby?'></a>What incompatibilities does JRuby have with the C implementation of Ruby? </h4>
<p>See <a href='<?url_for_page DifferencesBetweenMriAndJruby?>' class='internal'>Differences Between MRI and JRuby</a>.
</p><h4><a name='How_do_I_run_JRuby_without_the_command-line_scripts?'></a>How do I run JRuby without the command-line scripts?</h4>
<p>Frequently users want to run JRuby from NetBeans, from Eclipse, launched from an existing Java application, or in other ways that don't use the command-line scripts. In addition to having <tt>jruby.jar</tt> and its dependency jars available in CLASSPATH, you must also have the following system property set:
</p><pre> jruby.home=<i>path-to-root-of-JRuby-installation</i>
</pre><p>
You might also want to ensure the maximum memory is set higher than the JVM default. JRuby's own command-line scripts use a maximum of 256MB.
</p><h4><a name='What_if_I_want_to_use_JRuby_alongside_C_Ruby?_How_do_I_keep_from_getting_confused?'></a>What if I want to use JRuby alongside C Ruby? How do I keep from getting confused?</h4>
<p>You have two options:
</p><ul><li> Always invoke JRuby with e.g., <tt>jruby -S gem</tt>.
</li><li> Put a handy bash snippet like this in your .bashrc to create <tt>j</tt> aliases to all the available commands (<tt>rails</tt> becomes <tt>jrails</tt>, <tt>rake</tt> becomes <tt>jrake</tt>, etc.)
</li></ul><pre> for f in $JRUBY_HOME/bin/*; do
f=$(basename $f)
case $f in jruby*|jirb*|*.bat|*.rb|_*) continue ;; esac
eval "alias j$f='jruby -S $f'"
done
</pre><h4><a name='Why_can_t_JRuby_find_my_installed_gems?'></a>Why can't JRuby find my installed gems?</h4>
<p>JRuby can only see the gems installed with the gem command shipped with JRuby. The gems installed this way will be stored under <tt>$JRUBY_HOME/lib/ruby</tt>. If you try to run Rails and get the error, "Cannot find gem for Rails ~>1.2.2.0:" (or whatever version you are using), the problem is probably that you haven't installed the Rails-gem and its dependencies with the JRuby gem-command.
</p><h4><a name='When_I_implement_a_Java_interface_and_provide_my_own_initialize_method,_I_can_t_construct_it_anymore.'></a>When I implement a Java interface and provide my own initialize method, I can't construct it anymore.</h4>
<p>In JRuby 0.9.0, any class implementing a Java interface must explicitly call <tt>super</tt> in their initializers to set up the interface proxy. Add a <tt>super</tt> call to your implementation's <tt>initialize</tt> method and it should work.
</p><h4><a name='How_do_I_call_JRuby_from_my_existing_Java_program?'></a>How do I call JRuby from my existing Java program?</h4>
<p>If you don't want to launch JRuby as a separate process, we recommend you use the <a class='external' href="http://jakarta.apache.org/bsf/">Bean Scripting Framework</a> (BSF) or <a class='external' href="https://scripting.dev.java.net/">Java 6's Scripting Support</a> (JSR223). We do not recommend calling directly into the JRuby runtime, since that code is subject to change.
</p><h4><a name='Where_can_I_find_the_javadoc?'></a> Where can I find the javadoc? </h4>
<p><br />
</p><h4><a name='Why_do_I_get_a_NoSuchMethodError_when_running_JRuby_0.9.0?'></a>Why do I get a NoSuchMethodError when running JRuby 0.9.0?</h4>
<p>Some users will see the following error when running JRuby 0.9.0:
</p><pre> Exception in thread "main" java.lang.NoSuchMethodError:
java.lang.StringBuffer.append(Ljava/lang/CharSequence;)Ljava/lang/StringBuffer;
at org.jruby.RubyString.cat(RubyString.java:223)
at org.jruby.RubyString.append(RubyString.java:508)
at org.jruby.RubyString.concat(RubyString.java:518)
</pre><p>
This error occurs when JRuby is built under Java 5 or higher and run on Java 1.4. Java 5 has the <tt>append(CharSequence)</tt> method, so it uses that during compilation. Java 1.4 does not have that method.
</p><p>The first release of JRuby 0.9.0 was mistakenly build with Java 5, so we released a second version compiled with Java 1.4. Make sure you're using a JRuby compiled with Java 1.4 if that's the version of Java you intend to run it under.
</p><h4><a name='How_do_I_get_a_Ruby_backtrace_when_calling_JRuby_code_from_Java?'></a>How do I get a Ruby backtrace when calling JRuby code from Java?</h4>
<p>You need to do something along the lines of:
</p><pre> try {
rubyCode.doSomething();
} catch (RaiseException e) {
e.getException().printBacktrace(System.err);
}
</pre><p>
Note that Java 6's scripting via the BSF libraries might not preserve stack traces, and also launches more slowly. It's often preferable (as of February 2007) to use JRuby's own integration.
</p><h4><a name='Why_do_I_get_a_java.lang.NoSuchMethodError:_org.objectweb.asm.ClassWriter.visit()_error_when_running_JRuby_1.X_with_a_custom_classpath?'></a>Why do I get a <tt>java.lang.NoSuchMethodError: org.objectweb.asm.ClassWriter.visit()</tt> error when running JRuby 1.X with a custom classpath?</h4>
<p>The problem stems from an ASM jar conflict. It was found by setting a custom classpath, which includes a version of Spring that has a conflicting ASM jar, and then invoking JRuby. The easiest workaround is to build <tt>jruby-complete</tt> as a single jar and edit the JRuby config file (not sure about Windows, but it should be similar) to source only the <tt>jruby-complete</tt> jar. You will need to add ALL other jars, which I believe includes your jdbc driver as well.
</p><pre> svn co http://svn.codehaus.org/jruby/tags/jruby-1_0/
cd jruby-1_0
ant jar-complete
vi bin/jruby (see diff for edit)
#diff bin/jruby bin/jruby.orig
#89c89
#< for j in "$JRUBY_HOME"/lib/jruby-complete.jar; do
#---
#> for j in "$JRUBY_HOME"/lib/*.jar; do
</pre><h4><a name='How_come_Java_can_t_find_resources_in_class_folders_that_I_ve_appended_to_the_$CLASSPATH_global_variable_at_runtime?'></a>How come Java can't find resources in class folders that I've appended to the $CLASSPATH global variable at runtime? </h4>
<p>JRubyClassLoader extends <tt>java.net.URLClassLoader</tt>, which treats any URL that doesn't end with a slash as a jar. See <a class='external' href="http://java.sun.com/j2se/1.5.0/docs/api/java/net/URLClassLoader.html">URLClassLoader</a>.
</p><h4><a name='Why_don_t_my_special_characters_(like_ção)_appear_correctly_in_my_Swing_app_?'></a>Why don't my special characters (like ção) appear correctly in my Swing app ?</h4>
<p>The file encoding for the <tt>.rb</tt> file containing the special characters must be set to UTF-8. There were also issues in versions of JRuby before 1.2 where unicode characters were not properly pulled out via the <tt>toString</tt> method on Ruby objects. Try upgrading to 1.2 or higher.
</p><h4><a name='Under_OSX_I_get_this_error_when_trying_to_execute_jruby:_"Exception_in_thread__main__java.lang.NoClassDefFoundError:_org/jruby/Main"'></a>Under OSX I get this error when trying to execute jruby: "Exception in thread 'main' java.lang.NoClassDefFoundError: org/jruby/Main" </h4>
<p>The source of this problem is the inclusion of <tt>'.'</tt> (current directory) in your $PATH. You're also trying to execute JRuby from <tt>$JRUBY_HOME/bin</tt>. There's a bug in the JRuby bash script that prevents this from working.
</p><p>To correct the issue, remove <tt>'.'</tt> from your $PATH and relaunch the shell. Alternately, if you really want to keep <tt>'.'</tt> in your $PATH (which you shouldn't, but see google for reasons why), then just change your working directory to something other than <tt>$JRUBY_HOME/bin</tt> and execute the <tt>jruby</tt> command. It should launch just fine.
</p><pre> % cd /any/path/other/than/jruby_home
% jruby # should work
</pre><p><b>Note:</b>' This bug has been fixed in JRuby 1.2.
</p><h4><a name='How_do_I_check_which_version_of_the_JVM_JRuby_is_running_on?'></a>How do I check which version of the JVM JRuby is running on?</h4>
<pre> % jruby -rjava -e "puts java.lang.System.get_property('java.version')"
</pre><h2><a name='Running_Rails'></a>Running Rails</h2>
<h4><a name='Why_does_script/server_(WEBrick)_terminate_right_after_saying_"Booting_WEBrick..."?'></a>Why does script/server (WEBrick) terminate right after saying "Booting WEBrick..."?</h4>
<p>This happens if you require ActiveRecord-JDBC in your environment, but you haven't installed the gem. Make sure you have the ActiveRecord-JDBC gem installed.
</p><h4><a name='How_do_I_avoid_installing_the_Rails_gem_twice_for_both_CRuby_and_JRuby?'></a>How do I avoid installing the Rails gem twice for both CRuby and JRuby?</h4>
<p>You just need to set GEM_HOME to point to your CRuby's gem directory. For example, in tcsh:
</p><pre> setenv GEM_HOME /usr/local/lib/ruby/gems/1.8
</pre><p>
Note that on Windows, you should specify the path using unix-style directory separators. For example, if ruby is installed in <tt>C:\ruby</tt>:
</p><pre> set GEM_HOME=c:/ruby/lib/ruby/gems/1.8
</pre><h4><a name='I_get_the_error_"undefined_method__cattr_accessor__for_ActiveRecord::Base:Class_(NoMethodError)"_after_configuring_activerecord-jdbc._What_is_wrong?'></a>I get the error "undefined method 'cattr_accessor' for ActiveRecord::Base:Class (NoMethodError)" after configuring activerecord-jdbc. What is wrong?</h4>
<p>You're not requiring activerecord-jdbc properly. Try requiring activerecord-jdbc in <tt>config/environment.rb</tt> this way:
</p><pre> require 'jdbc_adapter'
</pre><h4><a name='I_keep_getting_"500.html_running_rails_app_built_by_goldspike_in_a_JEE_Container"._What_is_wrong?'></a>I keep getting "500.html running rails app built by goldspike in a JEE Container". What is wrong?</h4>
<p>You might not have set the production DB settings in <tt>database.yml</tt> properly. Goldspike by default builds a war that runs the app in production mode.
</p><p>You can confirm the problem by finding the <tt>production.log</tt> file. If you're using JBoss, then it lives in <tt>$JBOSS_HOME/server/my_app/tmp/my_rails_war</tt><i>1234</i><tt>.war</tt>, where <i>1234</i> is a random number generated by JBoss.
</p><p>In <tt>production.log</tt>, you'll see an error this:
</p><pre> RuntimeError (The driver encountered an error: can't convert nil into String)
</pre><p>
To fix this, just set the production DB settings in <tt>database.yml</tt> properly.
</p><h4><a name='How_can_I_load_a_ResourceBundle_from_the_Rails_config_directory_?'></a>How can I load a ResourceBundle from the Rails config directory ?</h4>
<p>You can add the config directory to the JRuby classpath in <tt>config/environment.rb</tt>:
</p><pre> $CLASSPATH << "file:///#{File.expand_path(File.join(RAILS_ROOT, 'config'))}/"
</pre><p>
Now, because <tt>ResourceBundle.getBundle</tt> doesn't seem to use the JRuby class loader, we need to pass it explicitly. In the file where you want to use the resource bundle do :
</p><pre> include Java
require 'jruby'
...
bundle = java.util.ResourceBundle::getBundle
("i18n", java.util.Locale::FRENCH, JRuby.runtime.j_ruby_class_loader)
</pre><p>
Now you just need to put your <tt>i18n[_*].properties</tt> files in <tt>config/</tt>, et voilà!
</p><h2><a name='Calling_Into_Java'></a>Calling Into Java</h2>
<h4><a name='Why_do_I_get_ClassNotFoundException_when_I_call_java.lang.Class.forName_from_Ruby?'></a>Why do I get <tt>ClassNotFoundException</tt> when I call <tt>java.lang.Class.forName</tt> from Ruby?</h4>
<p>When JRuby runs at the command line, it loads into the bootstrap class loader. This class loader lives above CLASSPATH, so libraries you add to CLASSPATH are not normally visible. Because <tt>Class.forName</tt> uses the class loader of the nearest non-system class that called it, it ends up seeing JRuby as the caller and looking for classes only in CLASSPATH.
</p><p>The workaround for this is simple: Uuse JRuby's import or include_class methods to load the class, or just reference it directly as in <tt>Java::my.package.MyClass</tt> or <tt>org.postgresql.Driver</tt>.
</p><h4><a name='How_do_I_access_an_inner_class_with_a_lowercase_name?'></a>How do I access an inner class with a lowercase name?</h4>
<p>Sometimes, developers name their inner classes beginning with a lowercase letter. This prevents JRuby from accessing it the "normal way" (it thinks it's a method). For example:
</p><p>In Java (from the <tt>com.sun.enterprise.ee.cms.core</tt> package of the <a class='external' href="https://shoal.dev.java.net/">Shoal project</a>)
</p><pre> GMSConstants.shutdownType.INSTANCE_SHUTDOWN
</pre><p>
Whereas in JRuby, you can get at that using the following:
</p><pre> >> ShutdownType = JavaUtilities.get_proxy_class(
'com.sun.enterprise.ee.cms.core.GMSConstants$shutdownType')
</pre><h2><a name='Java_and_JRuby_Interoperation'></a>Java and JRuby Interoperation</h2>
<h4><a name='How_do_I_create_a_primitive_Java_array_in_JRuby?'></a> How do I create a primitive Java array in JRuby?</h4>
<p>You can convert existing ruby arrays to primitive Java arrays very simply:
</p><pre> [1,2,3].to_java => makes an object array
[1,2,3].to_java :byte => makes a byte array
[1,2,3].to_java :String => makes a String array
</pre><p>
To create empty arrays:
</p><pre> Java::byte[12].new => makes a new byte[]
java.lang.String[12].new => makes a new String[]
</pre><h4><a name='How_can_I_implement_a_Java_Interface_using_a_Ruby_Class?'></a>How can I implement a Java Interface using a Ruby Class?</h4>
<p>There are two separate ways:
</p><ul><li> Include an interface into the class.
</li></ul><pre> class MyListener
include java.awt.event.ActionListener
def actionPerformed(event)
button.text = "I have been pressed"
end
end
</pre><ul><li> Use implicit closure conversion.
</li></ul><pre> button.add_action_listener { |event| button.text = "I have been pressed" }
</pre><h2><a name='Compiler-related_questions'></a> Compiler-related questions</h2>
<h4><a name='How_can_I_compile_my_Ruby_into_Java?'></a>How can I compile my Ruby into Java?</h4>
<p>You can do an Ahead-Of-Time (AOT) compile by using these <a href='<?url_for_page JRubyCompiler?>' class='internal'>instructions</a>.
</p><h2><a name='Troubleshooting'></a> Troubleshooting</h2>
<h4><a name='Why_do_my_ruby_scripts_under_cygwin_get_executed_as_if_they_are_bourne_shell_scripts?'></a> Why do my ruby scripts under cygwin get executed as if they are bourne shell scripts?</h4>
<p>Add <tt>.bat</tt> extension to JRuby scripts.
</p><p>If you try to run JRuby on cygwin for Windows and use the commands without the <tt>.bat</tt> extension, it will default to the bourne shell versions, which might not work properly.
</p><p><b>Example using gems:</b></p><pre> $JRUBY_HOME/bin/gem.bat install rails -y --no-ri --no-rdoc
</pre><h4><a name='Why_does_my_db:migrate_fail_with_"undefined_method__create_database__for_class__#<Class:01x1e30857>_"?'></a> Why does my db:migrate fail with "undefined method 'create_database' for class '#<Class:01x1e30857>'"?</h4>
<p>In this case, try to run the migrations with:
</p><pre> jruby -S rake db:migrate SKIP_AR_JDBC_RAKE_REDEFINES=1
</pre><p>
You can also just put the following line somewhere in your Rakefile, or in a custom Rakefile in <tt>lib/tasks/*.rake</tt>:
</p><pre> ENV['SKIP_AR_JDBC_RAKE_REDEFINES'] = '1'
</pre><p><span id="troubleshooting_JNI" /></p><h4><a name='I_am_having_a_weird_JNI_problem._Help_me!'></a> I am having a weird JNI problem. Help me!</h4>
<p>There are two scenarios in which JNI problems occur:
</p><ul><li> When the jar is in JRuby 1.1.2's lib.
</li><li> When the jar is loaded using ruby's "require" statement in JRuby < 1.1.
</li></ul><p>These two scenarios are described below.
</p><h5><a name='JRuby_1.1.2_+'></a> JRuby 1.1.2 + </h5>
<p>JRuby 1.1.2 changed how it set up the classpath. Earlier versions merged the CLASSPATH environment variable with all .jar files in <tt>JRUBY_HOME/lib</tt> and passed them to the JVM via the <tt>-classpath</tt> option. JRuby 1.1.2 instead passes all <tt>.jar</tt> files in <tt>lib</tt> to the JVM via the <tt>-Xbootclasspath/a:</tt> option, while CLASSPATH is passed using <tt>-classpath</tt>. Jar files that use JNI (e.g. <tt>sqljdbc.jar</tt>) don't work correctly when they're in the boot classpath, so they should not be placed in JRuby's <tt>lib</tt> directory. Instead, they should be loaded with <tt>require</tt> or by setting the CLASSPATH environment variable.
</p><h5><a name='JRuby_<_1.1'></a> JRuby < 1.1 </h5>
<p>In older versions of JRuby (pre 1.1), loading a jar into multiple JRuby runtimes with <tt>require</tt> can cause problems with JNI. For example, when using Microsoft SQL Server and integrated security in a rails application with <tt>sqljdbc</tt> loaded with a <tt>require</tt> statement, running <tt>jruby</tt> <tt>-S</tt> <tt>rake</tt> <tt>test:units</tt> results in the following error:
</p><pre> com.microsoft.sqlserver.jdbc.AuthenticationJNI
<clinit>
WARNING: Failed to load the sqljdbc_auth.dll
</pre><p>
The error message is displayed because <tt>sqljdbc.jar</tt> is loaded twice, but the OS and/or JVM and/or native library will only allow the native library to be loaded and initialized once. There are two ways to work around this problem.
</p><ul><li> Load the jar on the classpath instead of using <tt>require</tt>. This will cause it to be loaded by a different class loader, so the jar file will only be loaded once per process.
</li><li> Tell JRuby to launch other jrubies out-of-proc with <br /><tt>jruby <b>-J-Djruby.launch.inproc=false</b> <i>rest of command</i></tt><br /> This will cause a second JVM to be launched in the <tt>rake</tt> <tt>test:units</tt> example above.
</li></ul><h4><a name='I_tried_the_--server_option_and_received_an_error'></a> I tried the --server option and received an error</h4>
<p>You tried the performance tuning option --server but received an error like "Error: no `server' JVM at `c:\Program Files\Java\jre6\bin\server\jvm.dll'."
On windows the Java Runtime Environment (JRE) does not include the server VM. You should download an install the Java Development Kit (JDK).
If you want to use the server with the JRE, you can copy JDK's jre\bin\server folder to a bin\server directory in the Java SE Runtime Environment.</p>
2009-07-12T03:02:11Z
320