Pathological is a Ruby tool that provides a lightweight mechanism for managing your project's load path.
When you're writing a gem, you don't have to worry about paths much, because Rubygems makes sure that
makes it into your path for you. On the other hand, if you have large Ruby projects which aren't organized as
gems, you may encounter some of the following problems:
- If you don't have relative requires, you have to run your project from the project root.
If you want relative requires, you have something nasty like this in your code:
require File.expand_path(File.join(File.dirname(__FILE__), 'myfile'))
Ruby 1.9.2 breaks your load path if you are expecting
.to be in it. You might have to use
require_relativeor similar to remedy this.
- You have symlinks to shared libraries or non-gemified vendor code living all over your project in order to keep your load paths sane.
Pathological provides one way to manage these issues.
Getting started with pathological is easy. First, make a file called
Pathfile at your project root:
$ cd path/to/myproject $ touch Pathfile
Now require the gem at the start of any executable ruby file:
#!/usr/bin/env ruby require "bundler/setup" # If you're using bundler require "pathological" # other requires...
Now your project root will be in your load path. If your project has, for example,
lib/foo will work in any of your ruby files. This works because when Pathological is required it will search
up the directory tree until it finds a
Pathfile. (It will raise an error if one cannot be found).
Note that Pathological should be the first require in your main file so that it will be loaded first. An
exception to this is when you're using Bundler, in which case you should
require bundler/setup before
Pathological (and of course you should have
gem "pathological" in your
Pathfiles should be kept in version control.
To add more paths to your load path, just put the paths in your
Pathfile. The paths are relative to the
location of the
Pathfile. The paths will be inserted in the order they appear; the project root itself will
be first. If any of the paths are not valid directories, then an exception will be raised when Pathological is
Suppose that you have a directory structure like this:
repos/ |-shared_lib/ | `-common.rb `-my_project/ |-Pathfile |-run_my_project.rb `-foo.rb
Pathfile contains the following:
require "pathological" require "foo" require "common" # ...
Pathological is packaged as a Rubygem and hence can be trivially installed with
$ gem install pathological
In some cases, you might want slightly different behavior. This customization is done through the use of custom modes. You may use any combination of modes.
This adds debugging statements to
STDOUT that explain what Pathological is doing.
In this mode, the project root (where the
Pathfile is located) is not added to the load path (so only paths
specified in the
Pathfile will be loaded).
This is used if you don't want to raise exceptions if you have bad paths (i.e. non-existent paths or not
directories) in your
Bundlerize mode enables Bundler to work with your project regardless of your current directory, in the same
way as Pathological, by attempting to set the
BUNDLE_GEMFILE environment variable to match the directory
Pathfile is located. Note that you have to run this before requiring
bundler/setup. Also, this
will not take effect if you are running with
This mode makes Pathological add the unique parents of all paths it finds (instead of the paths themselves).
The purpose of parentdir is to enable Pathological to work in a drop-in fashion with legacy code written with
all requires being relative to the root of the codebase. Note that this will allow one to require files
located in any child of the parents, not just from the directories specified in the
Pathfile. This mode
should be avoided if possible.
There are two ways to specify modes. First, you can enable any modes you want using the Pathological API:
require "pathological/base" Pathological.debug_mode Pathological.parentdir_mode Pathological.add_paths!
A quicker way is also provided: if you only need to use one special mode, then there is a dedicated file you can require:
For even more configurable custom integration with Pathological, a public API is provided. See the generated documentation for details on the following public methods:
Pathological was written by the following Ooyala engineers:
- Harry Robertson for the idea to not use a dot-prefixed configuration file
If you would like to commit a patch, great! Just do the usual github pull request stuff and we'll check it out.
Pathological is licensed under the MIT license.