rerun 0.7.1 → 0.8.0

data/README.md

@@ -55,9 +55,9 @@ to restart when you change a config file like this:
 
 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:
+the `app` and `web` subdirectories:
 
-        rerun --dir app -- thin start --debug --port=4000 -R config.ru
+        rerun --dir app,web -- 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.
@@ -104,22 +104,31 @@ Procfile processes locally and restart them all when necessary.
 
 # Options:
 
-`--dir` directory to watch (default = ".")
+`--dir` directory (or directories) to watch (default = "."). Separate multiple paths with ','.
 
 `--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 files ending in: `rb,js,css,scss,sass,erb,html,haml,ru`.
 It also ignores directories named `.rbx .bundle .git .svn log tmp vendor` and files named `.DS_Store`.
 
+`--signal` (or -s) use specified signal (instead of the default SIGTERM) to terminate the previous process.
+This may be useful for forcing the respective process to terminate as quickly as possible.
+(`--signal KILL` is the equivalent of `kill -9`)
+
 `--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.
 
+`--background` (or -b) disable on-the-fly commands, allowing the process to be backgrounded
+
+`--no-growl` don't use growl
+
 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.
+growl in addition to the console. If you have growl but don't want rerun to use it,
+set the `--no-growl` option.
 
 Download [growlnotify here](http://growl.info/downloads.php#generaldownloads)
 now that Growl has moved to the App Store.
@@ -132,19 +141,29 @@ While the app is (re)running, you can make things happen by pressing keys:
 * **c** -- clear the screen
 * **x** or **q** -- exit (just like control-C)
 
+# Signals
+
+The current algorithm for killing the process is:
+
+* send [SIGTERM](http://en.wikipedia.org/wiki/SIGTERM)
+* if that doesn't work after 4 seconds, send SIGINT (aka control-C)
+* if that doesn't work after 2 more seconds, send SIGKILL (aka kill -9)
+
+This seems like the most gentle and unixy way of doing things, but it does
+mean that if your program ignores SIGTERM, it takes an extra 4 to 6 seconds to
+restart.
+
 # To Do:
 
 * 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`
 * Exclude files beginning with a dot, unless the pattern explicitly says to include them
-* Allow multiple sets of directories and patterns
 * --exclude pattern
 * ".rerun" file to specify options per project or in $HOME.
 * Test on Linux.
 * On OS X, use a C library using growl's developer API <http://growl.info/developer/>
 * Use growl's AppleScript or SDK instead of relying on growlnotify
 * "Failed" icon
-* Get Rails icon working
 * Figure out an algorithm so "-x" is not needed (if possible)
 * Specify (or deduce) port to listen for to determine success of a web server launch
 * Make sure to pass through quoted options correctly to target process [bug]
@@ -152,6 +171,7 @@ While the app is (re)running, you can make things happen by pressing keys:
   * https://github.com/guard/guard/issues/59
   * https://github.com/guard/guard/issues/27
 * Optionally do "bundle install" before and "bundle exec" during launch
+
 # Other projects that do similar things
 
 * Restartomatic: <http://github.com/adammck/restartomatic>
@@ -236,9 +256,20 @@ Based upon and/or inspired by:
 * Jens B <https://github.com/dpree>
 * Andrés Botero <https://github.com/anbotero>
 * Dreamcat4
+* <https://github.com/FND>
+* Barry Sia <https://github.com/bsia>
 
 # Version History
 
+* v0.8.0
+  * --background option (thanks FND!) to disable the keyboard listener
+  * --signal option (thanks FND!)
+  * --no-growl option
+  * --dir supports multiple directories (thanks Barry!)
+
+* v0.7.1
+  * bugfix: make rails icon work again
+
 * v0.7.0
   * uses Listen gem (which uses rb-fsevent for lightweight filesystem snooping)
 

data/bin/rerun

@@ -1,66 +1,12 @@
 #!/usr/bin/env ruby
 
 require 'rubygems'
-
 libdir = "#{File.expand_path(File.dirname(File.dirname(__FILE__)))}/lib"
 $LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
 
-load "#{libdir}/../rerun.gemspec" # defines "$spec" variable, which we read the version from
-
 require 'rerun'
 require 'optparse'
 
-options = {}
-
-opts = OptionParser.new("", 24, '  ') { |opts|
-  opts.banner = "Usage: rerun [options] [--] cmd"
-
-  opts.separator ""
-  opts.separator "Launches an app, and restarts it when the filesystem changes."
-  opts.separator "See http://github.com/alexch/rerun for more info."
-  opts.separator ""
-  opts.separator "Options:"
-
-  opts.on("-d dir", "--dir dir", "directory to watch") do |dir|
-    options[:dir] = dir
-  end
-
-  opts.on("-p pattern", "--pattern pattern", "file glob, default = \"#{Rerun::DEFAULT_PATTERN}\"") do |pattern|
-    options[:pattern] = pattern
-  end
-
-  opts.on("-c", "--clear", "clear screen before each run") do
-    options[:clear] = true
-  end
-
-  opts.on("-x", "--exit", "expect the program to exit. With this option, rerun checks the return value; without it, rerun checks that the process is running.") do |dir|
-    options[:exit] = true
-  end
-
-  opts.on_tail("-h", "--help", "--usage", "show this message") do
-    puts opts
-    exit
-  end
-
-  opts.on_tail("--version", "show version") do
-    puts $spec.version
-    exit
-  end
-
-  opts.parse! ARGV
-}
-
-#config = ARGV[0] || "config.ru"
-#abort "configuration #{config} not found"  unless File.exist? config
-#
-#if config =~ /\.ru$/ && File.read(config)[/^#\\(.*)/]
-#  opts.parse! $1.split(/\s+/)
-#end
-
-if ARGV.empty?
-  puts opts
-  exit
-end
-
-cmd = ARGV.join(" ")
-runner = Rerun::Runner.keep_running(cmd, options)
+options = Rerun::Options.parse
+exit if options.nil?
+runner = Rerun::Runner.keep_running(options[:cmd], options)

data/lib/rerun.rb

@@ -2,6 +2,7 @@ here = File.expand_path(File.dirname(__FILE__))
 $: << here unless $:.include?(here)
 
 require "listen"  # pull in the Listen gem
+require "rerun/options"
 require "rerun/system"
 require "rerun/runner"
 require "rerun/watcher"

data/lib/rerun/options.rb

@@ -0,0 +1,79 @@
+require 'optparse'
+
+libdir = "#{File.expand_path(File.dirname(File.dirname(__FILE__)))}"
+load "#{libdir}/../rerun.gemspec" # defines "$spec" variable, which we read the version from
+
+module Rerun
+  class Options
+    DEFAULT_PATTERN = "**/*.{rb,js,css,scss,sass,erb,html,haml,ru}"
+
+    DEFAULTS = {
+        :dir => ["."],
+        :pattern => DEFAULT_PATTERN,
+        :signal => "TERM",
+        :growl => true,
+    }
+
+    def self.parse args = ARGV
+      options = DEFAULTS.dup
+      opts = OptionParser.new("", 24, '  ') do |opts|
+        opts.banner = "Usage: rerun [options] [--] cmd"
+
+        opts.separator ""
+        opts.separator "Launches an app, and restarts it when the filesystem changes."
+        opts.separator "See http://github.com/alexch/rerun for more info."
+        opts.separator "Version: #{$spec.version}"
+        opts.separator ""
+        opts.separator "Options:"
+
+        opts.on("-d dir", "--dir dir", "directory to watch, default = \"#{DEFAULTS[:dir]}\". Separate multiple paths with ','.") do |dir|
+          options[:dir] = dir.split(",")
+        end
+
+        opts.on("-p pattern", "--pattern pattern", "file glob, default = \"#{DEFAULTS[:pattern]}\"") do |pattern|
+          options[:pattern] = pattern
+        end
+
+        opts.on("-s", "--signal signal", "terminate process using this signal, default = \"#{DEFAULTS[:signal]}\"") do |signal|
+          options[:signal] = signal
+        end
+
+        opts.on("-c", "--clear", "clear screen before each run") do
+          options[:clear] = true
+        end
+
+        opts.on("-x", "--exit", "expect the program to exit. With this option, rerun checks the return value; without it, rerun checks that the process is running.") do |dir|
+          options[:exit] = true
+        end
+
+        opts.on("-b", "--background", "disable on-the-fly commands, allowing the process to be backgrounded") do
+          options[:background] = true
+        end
+
+        opts.on("--no-growl", "don't use growl") do
+          options[:growl] = false
+        end
+
+        opts.on_tail("-h", "--help", "--usage", "show this message") do
+          puts opts
+          return
+        end
+
+        opts.on_tail("--version", "show version") do
+          puts $spec.version
+          return
+        end
+      end
+
+      if args.empty?
+        puts opts
+        nil
+      else
+        opts.parse! args
+        options[:cmd] = args.join(" ")
+        options
+      end
+    end
+
+  end
+end

data/lib/rerun/runner.rb

@@ -18,6 +18,8 @@ module Rerun
     end
 
     def start_keypress_thread
+      return if @options[:background]
+
       @keypress_thread = Thread.new do
         while true
           if c = key_pressed
@@ -59,11 +61,15 @@ module Rerun
     end
 
     def dir
+      @options[:dir]
+    end
+
+    def dirs
       @options[:dir] || "."
     end
 
     def pattern
-      @options[:pattern] || DEFAULT_PATTERN
+      @options[:pattern]
     end
 
     def clear?
@@ -140,7 +146,7 @@ module Rerun
 
       unless @watcher
 
-        watcher = Watcher.new(:directory => dir, :pattern => pattern) do |changes|
+        watcher = Watcher.new(:directory => dirs, :pattern => pattern) do |changes|
 
           message = [:modified, :added, :removed].map do |change|
             count = changes[change].size
@@ -181,12 +187,13 @@ module Rerun
 
     # todo: test escalation
     def stop
+      default_signal = @options[:signal] || "TERM"
       if @pid && (@pid != 0)
         notify "stopping", "All good things must come to an end." unless @restarting
         begin
           timeout(4) do  # todo: escalation timeout setting
             # start with a polite SIGTERM
-            signal("TERM") && Process.wait(@pid)
+            signal(default_signal) && Process.wait(@pid)
           end
         rescue Timeout::Error
           begin
@@ -216,7 +223,7 @@ module Rerun
     end
 
     def notify(title, body)
-      growl title, body
+      growl title, body if @options[:growl]
       puts
       say "#{app_name} #{title}"
     end

data/lib/rerun/system.rb

@@ -14,7 +14,7 @@ module Rerun
     end
 
     # do we have growl or not?
-    def growl?
+    def growl_available?
       mac? && (growlcmd != "")
     end
 
@@ -37,7 +37,7 @@ module Rerun
     end
 
     def growl(title, body, background = true)
-      if growl?
+      if growl_available?
         icon_str = ("--image \"#{icon}\"" if icon)
         s = "#{growlcmd} -n \"#{app_name}\" -m \"#{body}\" \"#{app_name} #{title}\" #{icon_str}"
         s += " &" if background

data/lib/rerun/watcher.rb

@@ -30,25 +30,33 @@ module Rerun
       }.merge(options)
 
       @pattern = options[:pattern]
-      @directory = options[:directory]
-      @directory.chomp!("/")
-      unless FileTest.exists?(@directory) && FileTest.readable?(@directory)
-        raise InvalidDirectoryError, "Directory '#{@directory}' either doesnt exist or isnt readable"
-      end
+      @directories = options[:directory]
+      @directories = sanitize_dirs(@directories)
       @priority = options[:priority]
       @thread = nil
     end
 
+    def sanitize_dirs(dirs)
+      dirs = [*dirs]
+      dirs.map do |d|
+        d.chomp!("/")
+        unless FileTest.exists?(d) && FileTest.readable?(d) && FileTest.directory?(d)
+          raise InvalidDirectoryError, "Directory '#{d}' either doesnt exist or isnt readable"
+        end
+        d
+      end
+    end
+
     def start
       if @thread then
         raise RuntimeError, "already started"
       end
 
       @thread = Thread.new do
-        # todo: multiple dirs
-
         regexp = Glob.new(@pattern).to_regexp
-        @listener = Listen::Listener.new(@directory, :filter => regexp) do |modified, added, removed|
+        dirs = @directories
+        params = dirs << { :filter => regexp }
+        @listener = Listen::MultiListener.new(*params) do |modified, added, removed|
           @client_callback.call(:modified => modified, :added => added, :removed => removed)
         end
         @listener.start

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.7.1'
+  s.version = '0.8.0'
 
   s.description = "Restarts your app when a file changes. A no-frills, command-line alternative to Guard, Shotgun, Autotest, etc."
   s.summary     = "Launches an app, and restarts it whenever the filesystem changes. A no-frills, command-line alternative to Guard, Shotgun, Autotest, etc."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rerun
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-05 00:00:00.000000000 Z
+date: 2013-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -44,6 +44,7 @@ files:
 - icons/rails_grn_sml.png
 - icons/rails_red_sml.png
 - lib/rerun/glob.rb
+- lib/rerun/options.rb
 - lib/rerun/runner.rb
 - lib/rerun/system.rb
 - lib/rerun/watcher.rb
@@ -62,7 +63,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1349085845198859924
+      hash: 3891504021895001236
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: