Skip to content
This repository was archived by the owner on Sep 18, 2020. It is now read-only.
/ sextant Public archive

find your route on a long journey over Rails with Sextant

License

Notifications You must be signed in to change notification settings

schneems/sextant

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Dec 30, 2017
cd8d6c8 · Dec 30, 2017

History

59 Commits
May 1, 2013
Dec 23, 2012
Jun 14, 2013
Jan 14, 2013
May 14, 2012
Jun 14, 2013
Jun 14, 2013
Jun 14, 2013
May 14, 2012
Dec 30, 2017
Jun 14, 2013
Jun 14, 2013
Jun 14, 2013

Repository files navigation

Sextant Build Status

Help Contribute to Open Source

Helps you find your routes on a long Journey on Rails, in Rails apps 3.2+.

Logo

What

Show routes in your Rails app while working in development. Visit http://localhost:3000/rails/routes and you'll see an output similar to rake routes

Sextant Gem

The Future

The core functionality of Sextant is now merged into Rails 4.0 under rails/info/routes. If you want this functionality in earlier rails use Sextant. I would like to improve that functionality and this gem is a good place to experiment. If you have ideas on functionality you would like, check the issues to make sure it hasn't been suggested before, and then create one, or send me a message @schneems

Why?

Running rake routes is slow and painful, mostly due to the time to initialize rails. When you're working in development you likely have your rails server booted, you can save this time by rendering the routes in a web request. You can only develop as quick as your tools will allow, so speeding up your tools speeds your development. Sextant allows you to quickly see your routes.

Install

Add this to the development group in your Gemfile

group :development do
  gem 'sextant'
end

Then run bundle install and you're ready to start

Optional for users of catch-all routes

If (and only if) you have catch all routes like match '*not_found' => 'errors#handle404' in your app already, you can add sextant to your routes (config/routes.rb) before the catch-all routes like this.

mount_sextant if Rails.env.development?
match '*not_found' => 'errors#handle404'

Use

Visit /rails/routes in your app and you'll see your routes. It's that simple.

About

If you have a question file an issue or find me on the Twitters @schneems.

This project rocks and uses MIT-LICENSE.