rerun 0.6.2 → 0.6.3

data/README.md

@@ -2,29 +2,37 @@
 
 <http://github.com/alexch/rerun>
 
-Launches your app, then watches the filesystem. If a relevant file
-changes, then it restarts your app.
+Rerun launches your program, then watches the filesystem. If a relevant file
+changes, then it restarts your program.
 
-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.
+Rerun works for both long-running processes (e.g. apps) and short-running ones
+(e.g. tests). So it works like shotgun and autotest (and guard and all the
+rest).
 
-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](http://growl.info/extras.php#growlnotify):
+Rerun's advantage is its simple design. Since it uses standard Unix "SIGINT"
+and "SIGKILL" signals, you're sure the restarted app is really acting just
+like it was when you ran it from the command line the first time.
 
-> 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.
+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.
 
 Rerun does not work on Windows. Sorry, but you can't do much relaunching
 without "fork".
 
 # Installation:
 
-        sudo gem install rerun
+        gem install rerun
+
+"sudo" may be required on older systems.
 
-# Usage: 
+If you are using RVM you might want to put this in your global gemset so it's available to all your apps. (There really should be a better way to distinguish gems-as-libraries from gems-as-tools.)
+
+        rvm @global do gem install rerun
+
+# Usage:
 
         rerun [options] [--] cmd
 
@@ -32,23 +40,23 @@ 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 
+
+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
@@ -65,18 +73,42 @@ How about regenerating your HTML files after every change to your [Erector](http
 
         rerun -x erector --to-html my_site.rb
 
+Use Heroku Cedar? `rerun` is now compatible with `foreman`. Run all your
+Procfile processes locally and restart them all when necessary.
+
+        rerun foreman start
+
 # Options:
 
---dir directory to watch (default = ".")
+`--dir` directory to watch (default = ".")
 
---pattern glob to match inside directory. This uses the Ruby Dir glob style -- see <http://www.ruby-doc.org/core/classes/Dir.html#M002322> for details. 
+`--pattern` glob to match inside directory. This uses the Ruby Dir glob style -- see <http://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
+`--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.
+`--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.
+Also --version and --help, naturally.
+
+# Growl Notifications
+
+If you have `growlnotify` available on the `PATH`, it sends notifications to
+growl in addition to the console.
+
+Here's how to install [growlnotify](http://growl.info/extras.php#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.
+
+**NOTE**: Growl recently moved to the App Store. I upgraded, and it still works for me, but I'd love it if someone can confirm that `growlnotify` is still available in a clean App Store install and works as advertised.
+
+# On-The-Fly Commands
+
+While the app is (re)running, you can make things happen by pressing keys:
+
+* **r** restart (as if a file had changed)
+* **c** clear the screen
+* **x** exit (just like control-C)
 
 # To Do:
 
@@ -85,7 +117,7 @@ Also --version and --help.
 * 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
+* Merge with Kicker or Watchr or Guard -- maybe by using it as a library and writing a Rerun recipe
 * On OS X, use a C library using growl's developer API <http://growl.info/developer/>
 * "Failed" icon
 * Get Rails icon working
@@ -99,6 +131,7 @@ Also --version and --help.
 * The Sinatra FAQ has a discussion at <http://www.sinatrarb.com/faq.html#reloading>
 * Kicker: <http://github.com/alloy/kicker/>
 * Watchr: <https://github.com/mynyml/watchr>
+* Guard: <http://github.com/guard/guard>
 
 # Why would I use this instead of Shotgun?
 
@@ -120,6 +153,9 @@ 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.
 
+And hey, does Shotgun reload your Worker processes if you're using Foreman and
+a Procfile? I'm pretty sure it doesn't.
+
 YMMV!
 
 # Why would I use this instead of Rack::Reloader?

data/Rakefile

@@ -28,6 +28,16 @@ def package(ext='')
   "pkg/#{$spec.name}-#{$spec.version}" + ext
 end
 
+desc 'Exit if git is dirty'
+task :check_git do
+  state = `git status 2> /dev/null | tail -n1`
+  clean = (state =~ /working directory clean/)
+  unless clean
+    warn "can't do that on an unclean git dir"
+    exit 1
+  end
+end
+
 desc 'Build packages'
 task :package => %w[.gem .tar.gz].map { |e| package(e) }
 
@@ -55,6 +65,10 @@ file package('.tar.gz') => %w[pkg/] + $spec.files do |f|
 end
 
 desc 'Publish gem and tarball to rubyforge'
-task 'release' => [package('.gem'), package('.tar.gz')] do |t|
+task 'release' => [:check_git, package('.gem'), package('.tar.gz')] do |t|
+  puts "Releasing #{$spec.version}"
   sh "gem push #{package('.gem')}"
+  puts "Tagging and pushing"
+  sh "git tag -v#{$spec.version}"
+  sh "git push && git push --tags"
 end

data/bin/rerun

@@ -64,6 +64,4 @@ if ARGV.empty?
 end
 
 cmd = ARGV.join(" ")
-runner = Rerun::Runner.new(cmd, options)
-runner.start
-runner.join
+runner = Rerun::Runner.keep_running(cmd, options)

data/lib/rerun/runner.rb

@@ -1,6 +1,15 @@
+require 'timeout'
+require 'io/wait'
+
 module Rerun
   class Runner
 
+    def self.keep_running(cmd, options)
+      runner = new(cmd, options)
+      runner.start
+      runner.join
+    end
+
     include System
 
     def initialize(run_command, options = {})
@@ -8,6 +17,44 @@ module Rerun
       @run_command = "ruby #{@run_command}" if @run_command.split(' ').first =~ /\.rb$/
     end
 
+    def start_keypress_thread
+      from = caller.first
+      @keypress_thread = Thread.new do
+        # puts "starting keypress thread #{Thread.current.object_id} from #{from}"
+        while true
+          if c = key_pressed
+            puts "\n#{c.inspect} pressed inside rerun"
+            case c.downcase
+            when 'c'
+              say "clearing screen"
+              clear_screen
+            when 'r'
+              say "'r' pressed - restarting"
+              restart
+              break  # the break will stop this thread
+            when 'x'
+              die
+              break  # the break will stop this thread, in case the 'die' doesn't
+            else
+              puts [["c", "clear screen"],
+               ["r", "restart"],
+               ["x", "stop and exit"]
+              ].map{|key, description| "  #{key} -- #{description}"}.join("\n")
+              puts
+            end
+          end
+          sleep 1  # todo: use select instead of polling somehow?
+        end
+        # puts "keypress thread #{Thread.current.object_id} ending"
+      end
+      @keypress_thread.run
+    end
+
+    def kill_keypress_thread
+      @keypress_thread.kill if @keypress_thread
+      @keypress_thread = nil
+    end
+
     def restart
       @restarting = true
       stop
@@ -53,7 +100,8 @@ module Rerun
         notify "restarted", taglines[rand(taglines.size)]
       end
 
-      print "\033[H\033[2J" if clear?  # see http://ascii-table.com/ansi-escape-sequences-vt-100.php
+      clear_screen if clear?
+      start_keypress_thread
 
       @pid = Kernel.fork do
         begin
@@ -66,17 +114,19 @@ module Rerun
       end
       status_thread = Process.detach(@pid) # so if the child exits, it dies
 
-      Signal.trap("INT") do  # INT = control-C
-        stop # first stop the child
-        exit
+      Signal.trap("INT") do # INT = control-C -- allows user to stop the top-level rerun process
+        die
+      end
+
+      Signal.trap("TERM") do  # TERM is the polite way of terminating a process
+        die
       end
 
       begin
         sleep 2
       rescue Interrupt => e
-        # in case someone hits control-C immediately
-        stop
-        exit
+        # in case someone hits control-C immediately ("oops!")
+        die
       end
 
       if exit?
@@ -106,7 +156,11 @@ module Rerun
         watcher.start
         @watcher = watcher
       end
+    end
 
+    def die
+      stop # stop the child process if it exists
+      exit 0  # todo: status code param
     end
 
     def join
@@ -126,8 +180,23 @@ module Rerun
 
     def stop
       if @pid && (@pid != 0)
-        notify "stopped", "All good things must come to an end." unless @restarting
-        signal("KILL") && Process.wait(@pid)
+        notify "stopping", "All good things must come to an end." unless @restarting
+        begin
+          timeout(2) do
+            # start with a polite SIGTERM
+            signal("TERM") && Process.wait(@pid)
+          end
+        rescue Timeout::Error
+          begin
+            timeout(2) do
+              # escalate to SIGINT aka control-C since some foolish process may be ignoring SIGTERM
+              signal("INT") && Process.wait(@pid)
+            end
+          rescue Timeout::Error
+            # escalate to SIGKILL aka "kill -9" which cannot be ignored
+            signal("KILL") && Process.wait(@pid)
+          end
+        end
       end
     rescue => e
       false
@@ -154,5 +223,36 @@ module Rerun
       puts "#{Time.now.strftime("%T")} - #{msg}"
     end
 
+    # non-blocking stdin reader.
+    # returns a 1-char string if a key was pressed; otherwise nil
+    #
+    def key_pressed
+      begin
+        # this "raw input" nonsense is because unix likes waiting for linefeeds before sending stdin
+        # "stty -echo" would make it not clutter the console, but be sure (ensure) to "stty echo" before exit
+        system("stty raw") # turn raw input on
+        c = nil
+        if $stdin.ready?
+          c = $stdin.getc
+        end
+        c.chr if c
+      ensure
+        system "stty -raw" # turn raw input off
+      end
+
+      # note: according to 'man tty' the proper way restore the settings is
+      # tty_state=`stty -g`
+      # ensure
+      #   system 'stty "#{tty_state}'
+      # end
+      # but this way seems fine and less confusing
+
+    end
+
+    def clear_screen
+      # see http://ascii-table.com/ansi-escape-sequences-vt-100.php
+      $stdout.print "\033[H\033[2J"
+    end
+
   end
 end

data/rerun.gemspec

@@ -3,7 +3,7 @@ $spec = Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
   s.name = 'rerun'
-  s.version = '0.6.2'
+  s.version = '0.6.3'
 
   s.description = "Restarts your app when a file changes"
   s.summary     = "Launches an app, and restarts it whenever the filesystem changes."

metadata

@@ -1,33 +1,24 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rerun
-version: !ruby/object:Gem::Version 
-  hash: 3
-  prerelease: false
-  segments: 
-  - 0
-  - 6
-  - 2
-  version: 0.6.2
+version: !ruby/object:Gem::Version
+  version: 0.6.3
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Alex Chaffee
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-18 00:00:00 -07:00
-default_executable: 
+date: 2011-11-27 00:00:00.000000000Z
 dependencies: []
-
 description: Restarts your app when a file changes
 email: alex@stinky.com
-executables: 
+executables:
 - rerun
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - README.md
 - LICENSE
 - Rakefile
@@ -41,39 +32,31 @@ files:
 - lib/rerun/runner.rb
 - lib/rerun/system.rb
 - lib/rerun/watcher.rb
-has_rdoc: true
 homepage: http://github.com/alexch/rerun/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 569371154783151759
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: pivotalrb
-rubygems_version: 1.3.7
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 2
 summary: Launches an app, and restarts it whenever the filesystem changes.
 test_files: []
-