Best way to require all files from a directory in ruby?

RubyFileDirectoryRequire

Ruby Problem Overview


What's the best way to require all files from a directory in ruby ?

Ruby Solutions


Solution 1 - Ruby

How about:

Dir["/path/to/directory/*.rb"].each {|file| require file }

Solution 2 - Ruby

If it's a directory relative to the file that does the requiring (e.g. you want to load all files in the lib directory):

Dir[File.dirname(__FILE__) + '/lib/*.rb'].each {|file| require file }

Edit: Based on comments below, an updated version:

Dir[File.join(__dir__, 'lib', '*.rb')].each { |file| require file }

Solution 3 - Ruby

Try the require_all gem:

  1. http://github.com/jarmo/require_all
  2. https://rubygems.org/gems/require_all

It lets you simply:

require_all 'path/to/directory'

Solution 4 - Ruby

Dir[File.dirname(__FILE__) + '/../lib/*.rb'].each do |file| 
  require File.basename(file, File.extname(file))
end

If you don't strip the extension then you may end up requiring the same file twice (ruby won't realize that "foo" and "foo.rb" are the same file). Requiring the same file twice can lead to spurious warnings (e.g. "warning: already initialized constant").

Solution 5 - Ruby

Dir.glob(File.join('path', '**', '*.rb'), &method(:require))

or alternatively, if you want to scope the files to load to specific folders:

Dir.glob(File.join('path', '{folder1,folder2}', '**', '*.rb'), &method(:require))

explanation:

Dir.glob takes a block as argument.

method(:require) will return the require method.

&method(:require) will convert the method to a bloc.

Solution 6 - Ruby

The best way is to add the directory to the load path and then require the basename of each file. This is because you want to avoid accidentally requiring the same file twice -- often not the intended behavior. Whether a file will be loaded or not is dependent on whether require has seen the path passed to it before. For example, this simple irb session shows that you can mistakenly require and load the same file twice.

$ irb
irb(main):001:0> require 'test'
=> true
irb(main):002:0> require './test'
=> true
irb(main):003:0> require './test.rb'
=> false
irb(main):004:0> require 'test'
=> false

Note that the first two lines return true meaning the same file was loaded both times. When paths are used, even if the paths point to the same location, require doesn't know that the file was already required.

Here instead, we add a directory to the load path and then require the basename of each *.rb file within.

dir = "/path/to/directory"
$LOAD_PATH.unshift(dir)
Dir[File.join(dir, "*.rb")].each {|file| require File.basename(file) }

If you don't care about the file being required more than once, or your intention is just to load the contents of the file, perhaps load should be used instead of require. Use load in this case, because it better expresses what you're trying to accomplish. For example:

Dir["/path/to/directory/*.rb"].each {|file| load file }

Solution 7 - Ruby

Dir[File.join(__dir__, "/app/**/*.rb")].each do |file|
  require file
end

This will work recursively on your local machine and a remote (Like Heroku) which does not use relative paths.

Solution 8 - Ruby

Instead of concatenating paths like in some answers, I use File.expand_path:

Dir[File.expand_path('importers/*.rb', File.dirname(__FILE__))].each do |file|
  require file
end

Update:

Instead of using File.dirname you could do the following:

Dir[File.expand_path('../importers/*.rb', __FILE__)].each do |file|
  require file
end

Where .. strips the filename of __FILE__.

Solution 9 - Ruby

In Rails, you can do:

Dir[Rails.root.join('lib', 'ext', '*.rb')].each { |file| require file }

Update: Corrected with suggestion of @Jiggneshh Gohel to remove slashes.

Solution 10 - Ruby

I'm a few years late to the party, but I kind of like this one-line solution I used to get rails to include everything in app/workers/concerns:

Dir[ Rails.root.join *%w(app workers concerns *) ].each{ |f| require f }

Solution 11 - Ruby

And what about: require_relative *Dir['relative path']?

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
QuestionGaetan DubarView Question on Stackoverflow
Solution 1 - RubySam StokesView Answer on Stackoverflow
Solution 2 - RubyjandotView Answer on Stackoverflow
Solution 3 - RubyTony ArcieriView Answer on Stackoverflow
Solution 4 - RubyPete HodgsonView Answer on Stackoverflow
Solution 5 - RubymetakungfuView Answer on Stackoverflow
Solution 6 - RubyRyan McGearyView Answer on Stackoverflow
Solution 7 - Rubyuser470069View Answer on Stackoverflow
Solution 8 - RubyKoen.View Answer on Stackoverflow
Solution 9 - RubyDan KohnView Answer on Stackoverflow
Solution 10 - RubyJazzView Answer on Stackoverflow
Solution 11 - RubyAleksanderView Answer on Stackoverflow