What are the paths that "require" looks up by default?

RubyRequire

Ruby Problem Overview


In Ruby, I have been told that when doing

require "some_file"

Ruby will look for the file in certain places.

I know that it looks for some_file.rb, but where does it look for it by default?

Ruby Solutions


Solution 1 - Ruby

It depends on your platform, and how Ruby was compiled, so there is no "the" answer to this. You can find out by running:

ruby -e 'puts $:'

Generally, though, you have the standard, site, and vendor Ruby library paths, including an arch, version, and general directory under each.

Solution 2 - Ruby

Ruby looks in all the paths specified in the $LOAD_PATH array.

You can also add a directory to search like so:

$LOAD_PATH.unshift File.expand_path('../path/from/this/file/to/another/directory', __FILE__)

Solution 3 - Ruby

additional paths can be specified by setting RUBYLIB environment variable

Solution 4 - Ruby

The $LOAD_PATH global variable (also named $:) contains the list of directories that are searched.

See: http://www.ruby-doc.org/core-1.9.3/Kernel.html#method-i-require

Solution 5 - Ruby

require(string) => true or false

Ruby tries to load the library named string, returning true if successful. If the filename does not resolve to an absolute path, it will be searched for in the directories listed in $:. If the file has the extension ".rb", it is loaded as a source file; if the extension is ".so", ".o", or ".dll", or whatever the default shared library extension is on the current platform, Ruby loads the shared library as a Ruby extension. Otherwise, Ruby tries adding ".rb", ".so", and so on to the name. The name of the loaded feature is added to the array in $:.

Solution 6 - Ruby

When calling ruby on command line, you can provide additional search paths using the -I argument. Compare the output of

$ ruby -e 'puts $:'

with the output of

$ ruby -I /tmp -e 'puts $:'

note how the second one lists /tmp as an option. You can use multiple -I to add multiple path.

You can also use it with the shebang:

#!/usr/bin/ruby -I /tmp -I /usr/local/lib/ruby

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionMark ProvanView Question on Stackoverflow
Solution 1 - RubyDaniel PittmanView Answer on Stackoverflow
Solution 2 - RubyBrian HempelView Answer on Stackoverflow
Solution 3 - RubymighqView Answer on Stackoverflow
Solution 4 - RubyPerryView Answer on Stackoverflow
Solution 5 - RubyericraioView Answer on Stackoverflow
Solution 6 - RubyMeckiView Answer on Stackoverflow