AppRoot

Detect the application's root directory.

Installation

Add this line to your application's Gemfile:

gem 'app_root'

And then execute:

$ bundle

Or install it yourself as:

$ gem install app_root

Usage

Basic Usage

require "app_root"

puts AppRoot.path("config.ru")
#=> /path/to/your/application/root

Integrate Your App

Using AppRoot.path:

class MyApp
  def self.root
    AppRoot.path("config.ru")
  end
end

Including AppRoot:

class MyApp
  include AppRoot

  def self.root_flag
    "config.ru"
  end
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/nownabe/app_root/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request