Launches your app, then watches the filesystem. If a relevant file changes, then it restarts your app.
By default only *.{rb,js,css,scss,sass,erb,html,haml,ru} files are watched.
Use the
--pattern option if you want to change this.
If you're on Mac OS X, and using the built-in ruby,
it uses the
built-in facilities for monitoring
the filesystem, so CPU use is very
light. And if you have growlnotify
available on the
PATH, it sends notifications to growl in addition to
the
console. Here's how to install
growlnotify:
The Installer package for growlnotify is in the growlnotify folder in the Extras folder on the Growl disk image. Simply open the Installer package and follow the on-screen instructions.
Rerun does not work on Windows. Sorry, but you can't do much relaunching without "fork".
sudo gem install rerun
rerun [options] [--] cmd
For example, if you're running a Sinatra app whose main file is app.rb:
rerun ruby app.rb
If the first part of the command is a .rb filename, then
ruby is
optional, so the above can also be accomplished like
this:
rerun app.rb
Or if you're using Thin to run a Rack app that's configured in
config.ru
but you want it on port 4000 and in debug mode, and only want to
watch
the app subdirectory:
rerun --dir app -- thin start --debug --port=4000 -R config.ru
The -- is to separate rerun options from cmd options. You can
also
use a quoted string for the command, e.g.
rerun --dir app "thin start --debug --port=4000 -R config.ru"
Rackup can also be used to launch a Rack server, so let's try that:
rerun -- rackup --port 4000 config.ru
Want to mimic autotest? Try
rerun -x rake
or
rerun -cx rspec
How about regenerating your HTML files after every change to your Erector widgets?
rerun -x erector --to-html my_site.rb
–dir directory to watch (default = “.”)
–pattern glob to match inside directory. This uses the Ruby Dir glob style
– see www.ruby-doc.org/core/classes/Dir.html#M002322
for details.
By default it watches these files:
rb,js,css,scss,sass,erb,html,haml,ru.
–clear (or -c) clear the screen before each run
–exit (or -x) expect the program to exit. With this option, rerun checks the return value; without it, rerun checks that the launched process is still running.
Also –version and –help.
Cooldown (so if a dozen files appear in a burst, say from 'git pull', it only restarts once)
If the last element of the command is a .ru file and
there's no other command then use rackup
Allow arbitrary sets of directories and file types, possibly with “include” and “exclude” sets
“.rerun” file to specify options per project or in $HOME.
Test on Linux.
Merge with Kicker (using it as a library and writing a Rerun recipe) or Watchr
On OS X, use a C library using growl's developer API growl.info/developer/
“Failed” icon
Get Rails icon working
Figure out an algorithm so “-x” is not needed (if possible)
Restartomatic: github.com/adammck/restartomatic
Shotgun: github.com/rtomayko/shotgun
Rack::Reloader middleware: github.com/rack/rack/blob/5ca8f82fb59f0bf0e8fd438e8e91c5acf3d98e44/lib/rack/reloader.rb
The Sinatra FAQ has a discussion at www.sinatrarb.com/faq.html#reloading
Kicker: github.com/alloy/kicker/
Watchr: github.com/mynyml/watchr
Shotgun does a “fork” after the web framework has loaded but before your application is loaded. It then loads your app, processes a single request in the child process, then exits the child process.
Rerun launches the whole app, then when it's time to restart, uses "kill" to shut it down and starts the whole thing up again from scratch.
So rerun takes somewhat longer than Shotgun to restart the app, but does it much less frequently. And once it's running it behaves more normally and consistently with your production app.
Also, Shotgun reloads the app on every request, even if it doesn't need to. This is fine if you're loading a single file, but my web pages all load other files (CSS, JS, media) and that adds up quickly. The developers of shotgun are probably using caching or a front web server so this doesn't affect them too much.
YMMV!
Rack::Reloader is certifiably beautiful code, and is a very elegant use of Rack's middleware architecture. But because it relies on the LOADED_FEATURES variable, it only reloads .rb files that were 'require'd, not 'load'ed. That leaves out (non-Erector) template files, and also, the way I was doing it, sub-actions (see this thread).
Rack::Reloader also doesn't reload configuration changes or redo other things that happen during app startup. Rerun takes the attitude that if you want to restart an app, you should just restart the whole app. You know?
I've been using Sinatra and loving it. In order to simplify their system, the Rat Pack just removed auto-reloading from Sinatra proper. I approve of this: a web application framework should be focused on serving requests, not on munging Ruby ObjectSpace for dev-time convenience. But I still wanted automatic reloading during development. Shotgun wasn't working for me (see above) so I spliced Rerun together out of code from Rspactor, FileSystemWatcher, and Shotgun -- with a heavy amount of refactoring and rewriting.
Rerun: Alex Chaffee, alex@stinky.com, github.com/alexch/
Based upon and/or inspired by:
Shotgun: github.com/rtomayko/shotgun
Rspactor: github.com/mislav/rspactor
(In turn based on rails.aizatto.com/2007/11/28/taming-the-autotest-beast-with-fsevents/ )
FileSystemWatcher: paulhorman.com/filesystemwatcher/
David Billskog billskog@gmail.com
Jens B github.com/dpree
Andrés Botero github.com/anbotero
Dreamcat4
Open Source MIT License. See “LICENSE” file.