rerun 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a237bdcfe8672bdd765c6a480fbd397e30f0fc45
-  data.tar.gz: 46a4241842ffad57cfdb560bf2b7da0088f35c47
+  metadata.gz: a1489afa035f2da5780ee35de95b95bd272c5440
+  data.tar.gz: 2610078f1caaf80bb29540fd398149b539b88b12
 SHA512:
-  metadata.gz: 3abd42a820c468ae5c5ac50095a888106967e0c64dfe4bdb4c8aca3adef2ce84e85262278a7c9c5382a276437c359de5f875b578da7624c001b2b0d4d7c5d458
-  data.tar.gz: 20964c0461cb634bbe11ea931b2eb25d740e4dd228c6a6e8ab18cdf6e2a368376b8e47c3614a073385323856d0ad6238db5031cfb3fbc732415c7fce5d4f9f38
+  metadata.gz: ff6bf2054ab858b4a9bfde9600ffb5966be77c63584e1049bf2f4299b01b437fe5fdf83b7e890b55d2ab249243d02cd60ad035ce2ad1145d83f904f9a53b272e
+  data.tar.gz: 88f0dd6fd81c98ab774a4ab2f5a7f545b827f3295d19a4613a0504b42e6de0dd4a13a5d6381e59a43f0f067aca3100ff4d2b177bb3a46f723100c85d369c7764

data/README.md

@@ -14,14 +14,18 @@ Rerun's advantage is its simple design. Since it uses `exec` and the 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.
 
-By default it watches files ending in: `rb,js,coffee,css,scss,sass,erb,html,haml,ru,yml,slim,md,feature`.
+By default it watches files ending in: `rb,js,coffee,css,scss,sass,erb,html,haml,ru,yml,slim,md,feature,c,h`.
 Use the `--pattern` option if you want to change this.
 
 As of version 0.7.0, we use the Listen gem, which tries to use your OS's
 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".
+**UPDATE**: Now Rerun *does* work on Windows. Caveats:
+  * not well-tested
+  * after running, it may continue to slurp up some of your console input, so run it in a separate window, and/or use `--background` to disable on-the-fly commands, and/or press `q` to quit instead of CTRL-C
+  * you may need to install the `wdm` gem manually: `gem install wdm`
+  * You may see this persistent `INFO` error message; to remove it, use`--no-notify`:
+    * `INFO: Could not find files for the given pattern(s)`
 
 # Installation:
 
@@ -40,10 +44,19 @@ they're not available. Unfortunately, Rubygems doesn't understand optional
 dependencies very well, so you may have to install extra gems (and/or put them
 in your Gemfile) to make Rerun work more smoothly on your system.
 (Learn more at <https://github.com/guard/listen#listen-adapters>.)
-For example, on Mac OS X, use
+
+On Mac OS X, use
 
         gem install rb-fsevent
 
+On Windows, use
+
+        gem install wdm
+
+On *BSD, use
+
+        gem install rb-kqueue
+
 # Usage:
 
         rerun [options] [--] cmd
@@ -116,44 +129,56 @@ Procfile processes locally and restart them all when necessary.
 `--dir` directory (or directories) to watch (default = "."). Separate multiple paths with ',' and/or use multiple `-d` options.
 
 `--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,coffee,css,scss,sass,erb,html,haml,ru,yml,slim,md,feature`.
+By default it watches files ending in: `rb,js,coffee,css,scss,sass,erb,html,haml,ru,yml,slim,md,feature,c,h`.
 On top of this, it also ignores dotfiles, `.tmp` files, and some other files and directories (like `.git` and `log`).
 Run `rerun --help` to see the actual list.
 
-`--ignore pattern` file glob to ignore (can be set many times). To ignore a directory, you must append '/*' e.g.
+`--ignore pattern` file glob to ignore (can be set many times). To ignore a directory, you must append `'/*'` e.g.
   `--ignore 'coverage/*'`.
 
   *On top of --pattern and --ignore, we ignore any changes to files and dirs starting with a dot.*
 
-`--signal` (or `-s`) use specified signal (instead of the default SIGTERM) to terminate the previous process.
+`--signal` (or `-s`) use specified signal(s) (instead of the default `TERM,INT,KILL`) to terminate the previous process. You can use a comma-delimited list if you want to try a signal, wait up to 5 seconds for the process to die, then try again with a different signal, and so on. 
 This may be useful for forcing the respective process to terminate as quickly as possible.
 (`--signal KILL` is the equivalent of `kill -9`)
 
+`--wait sec` (or `-w`)           after asking the process to terminate, wait this long (in seconds) before either aborting, or trying the next signal in series. Default: 2 sec
+
 `--restart` (or `-r`) expect process to restart itself, using signal HUP by default
 (e.g. `-r -s INT` will send a INT and then resume watching for changes)
 
-`--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.
 
+`--clear` (or -c) clear the screen before each run
+
 `--background` (or -b) disable on-the-fly commands, allowing the process to be backgrounded
 
-`--notify NOTIFIER` use `growl` or `osx` for notifications (see below)
+`--notify NOTIFIER` use `growl` or `osx` or `notify-send` for notifications (see below)
 
-`--no-notify` don't use growl (or osx) notifications
+`--no-notify` disable notifications
 
 `--name` set the app name (for display)
 
+`--force-polling` use polling instead of a native filesystem scan (useful for Vagrant)
+
+`--quiet` silences most messages
+
+`--verbose` enables even more messages (unless you also specified `--quiet`, which overrides `--verbose`)
+
 Also `--version` and `--help`, naturally.
 
 # Notifications
 
 If you have `growlnotify` available on the `PATH`, it sends notifications to
 growl in addition to the console.
+
 If you have `terminal-notifier`, it sends notifications to
 the OS X notification center in addition to the console.
 
-If you have both, Rerun will pick one, or you can choose between them using `--notify growl` or `--notify osx` respectively.
+If you have `notify-send`, it sends notifications to Freedesktop-compatible
+desktops in addition to the console.
+
+If you have more than one available notification program, Rerun will pick one, or you can choose between them using `--notify growl`, `--notify osx`, `--notify notify-send`, etc.
 
 If you have a notifier installed but don't want rerun to use it,
 set the `--no-notify` option.
@@ -163,11 +188,14 @@ now that Growl has moved to the App Store.
 
 Install [terminal-notifier](https://github.com/julienXX/terminal-notifier) using `gem install terminal-notifier`. (You may have to put it in your system gemset and/or use `sudo` too.) Using Homebrew to install terminal-notifier is not recommended.
 
+On Debian/Ubuntu, `notify-send` is availble in the `libnotify-bin` package. On other GNU/Linux systems, it might be in a package with a different name.
+
 # 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)
+* **f** -- force restart (stop and start)
 * **c** -- clear the screen
 * **x** or **q** -- exit (just like control-C)
 * **p** -- pause/unpause filesystem watching
@@ -180,14 +208,31 @@ keys to be trapped, so use the `--background` option.
 The current algorithm for killing the process is:
 
 * send [SIGTERM](http://en.wikipedia.org/wiki/SIGTERM) (or the value of the `--signal` option)
-* if that doesn't work after 4 seconds, send SIGINT (aka control-C)
+* if that doesn't work after 2 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
+mean that if your program ignores SIGTERM, it takes an extra 2 to 4 seconds to
 restart.
 
+If you want to use your own series of signals, use the `--signal` option. If you want to change the delay before attempting the next signal, use the `--wait` option.
+
+# Vagrant and VirtualBox
+
+If running inside a shared directory using Vagrant and VirtualBox, you must pass the `--force-polling` option. You may also have to pass some extra `--ignore` options too; otherwise each scan can take 10 or more seconds on directories with a large number of files or subdirectories underneath it.
+
 # Troubleshooting
+
+## Vagrant ##
+
+Rerun will not pick up changes made to shared folders. This means that the common
+method of using Vagrant for an execution environment and using the `/vagrant`
+shared folder for source code will not work.
+
+Instead, use [shotgun](https://rubygems.org/gems/shotgun).
+
+## zsh ##
+
 If you are using `zsh` as your shell, and you are specifying your `--pattern` as `**/*.rb`, you may face this error
 ```
 Errno::EACCES: Permission denied - <filename>
@@ -210,24 +255,17 @@ rerun -p "**/*.rb" rake test
 * Optionally do "bundle install" before and "bundle exec" during launch
 
 ## Nice to have
-* Smarter --signal option (specifying signal to try and a timeout to wait, repeated)
 * If the last element of the command is a `.ru` file and there's no other command then use `rackup`
 * Figure out an algorithm so "-x" is not needed (if possible) -- maybe by accepting a "--port" option or reading `config.ru`
 * Specify (or deduce) port to listen for to determine success of a web server launch
 * see also [todo.md](todo.md)
 
 ## Wacky Ideas
-* Make it work on Windows, like Guard now does. See
-  * https://github.com/guard/guard/issues/59
-  * https://github.com/guard/guard/issues/27
+
 * 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
-    * Use OS X notifications
     * "Failed" icon for notifications
-* On Linux:
-    * Test on Linux.
-    * Use libnotify or notify-send http://www.linuxjournal.com/content/tech-tip-get-notifications-your-scripts-notify-send
 
 # Other projects that do similar things
 
@@ -321,9 +359,28 @@ Based upon and/or inspired by:
 * James Edward Gray II <https://github.com/JEG2>
 * Raul E Rangel <https://github.com/ismell> and Antonio Terceiro <https://github.com/terceiro>
 * Mike Pastore <https://github.com/mwpastore>
+* Andy Duncan <https://github.com/ajduncan>
+* Brent Van Minnen
+* Matthew O'Riordan <https://github.com/mattheworiordan>
+* Antonio Terceiro <https://github.com/terceiro>
+* <https://github.com/mattbrictson>
+* <https://github.com/krissi>
 
 # Version History
 
+* v0.12.0   23 January 2018
+  * smarter `--signal` option, allowing you to specify a series of signals to try in order; also `--wait` to change how long between tries
+  * `--force-polling` option (thanks ajduncan)
+  * `f` key to force stop and start (thanks mwpastore)
+  * add `.c` and `.h` files to default ignore list
+  * support for Windows
+     * use `Kernel.spawn` instead of `fork`
+     * use `wdm` gem for Windows Directory Monitor
+     * TODO: fix `INFO` error message
+     * TODO: fix console input contention bug
+  * support for notifications on GNU/Linux using [notify-send](http://www.linuxjournal.com/content/tech-tip-get-notifications-your-scripts-notify-send) (thanks terceiro)
+  * fix `Gem::LoadError - terminal-notifier is not part of the bundle` [bug](https://github.com/alexch/rerun/issues/108) (thanks 	mattheworiordan)
+
 * 0.11.0    7 October 2015
   * better 'changed' message
   * `--notify osx` option

data/Rakefile

@@ -1,82 +1,82 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rspec/core/rake_task'
-
-task :default => [:spec]
-task :test => :spec
-
-desc "Run all specs"
-RSpec::Core::RakeTask.new('spec') do |t|
-  ENV['ENV'] = "test"
-  t.pattern = 'spec/**/*_spec.rb'
-  t.rspec_opts = ['--color']
-end
-
-$rubyforge_project = 'pivotalrb'
-
-$spec =
-  begin
-    require 'rubygems/specification'
-    data = File.read('rerun.gemspec')
-    spec = nil
-    #Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
-    spec = eval data
-    spec
-  end
-
-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) }
-
-desc 'Build and install as local gem'
-task :install => package('.gem') do
-  sh "gem install #{package('.gem')}"
-end
-
-directory 'pkg/'
-CLOBBER.include('pkg')
-
-file package('.gem') => %W[pkg/ #{$spec.name}.gemspec] + $spec.files do |f|
-  sh "gem build #{$spec.name}.gemspec"
-  mv File.basename(f.name), f.name
-end
-
-file package('.tar.gz') => %w[pkg/] + $spec.files do |f|
-  cmd = <<-SH
-    git archive \
-      --prefix=#{$spec.name}-#{$spec.version}/ \
-      --format=tar \
-      HEAD | gzip > #{f.name}
-  SH
-  sh cmd.gsub(/ +/, ' ')
-end
-
-desc 'Publish gem and tarball to rubyforge'
-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
-
-desc 'download github issues and pull requests'
-task 'github' do
-  %w(issues pulls).each do |type|
-    sh "curl -o #{type}.json https://api.github.com/repos/alexch/rerun/#{type}"
-  end
-end
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+task :test => :spec
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new('spec') do |t|
+  ENV['ENV'] = "test"
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ['--color']
+end
+
+$rubyforge_project = 'pivotalrb'
+
+$spec =
+  begin
+    require 'rubygems/specification'
+    data = File.read('rerun.gemspec')
+    spec = nil
+    #Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+    spec = eval data
+    spec
+  end
+
+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|tree) 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) }
+
+desc 'Build and install as local gem'
+task :install => package('.gem') do
+  sh "gem install #{package('.gem')}"
+end
+
+directory 'pkg/'
+CLOBBER.include('pkg')
+
+file package('.gem') => %W[pkg/ #{$spec.name}.gemspec] + $spec.files do |f|
+  sh "gem build #{$spec.name}.gemspec"
+  mv File.basename(f.name), f.name
+end
+
+file package('.tar.gz') => %w[pkg/] + $spec.files do |f|
+  cmd = <<-SH
+    git archive \
+      --prefix=#{$spec.name}-#{$spec.version}/ \
+      --format=tar \
+      HEAD | gzip > #{f.name}
+  SH
+  sh cmd.gsub(/ +/, ' ')
+end
+
+desc 'Publish gem and tarball to rubyforge'
+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
+
+desc 'download github issues and pull requests'
+task 'github' do
+  %w(issues pulls).each do |type|
+    sh "curl -o #{type}.json https://api.github.com/repos/alexch/rerun/#{type}"
+  end
+end

data/bin/rerun

@@ -1,12 +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)
-
-require 'rerun'
-require 'optparse'
-
-options = Rerun::Options.parse
-exit if options.nil?
-runner = Rerun::Runner.keep_running(options[:cmd], options)
+#!/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)
+
+require 'rerun'
+require 'optparse'
+
+options = Rerun::Options.parse
+exit if options.nil?
+runner = Rerun::Runner.keep_running(options[:cmd], options)

data/lib/goo.rb

@@ -0,0 +1,3 @@
+goooo
+goooo
+goooo

data/lib/rerun.rb

@@ -1,15 +1,15 @@
-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/notification"
-require "rerun/runner"
-require "rerun/watcher"
-require "rerun/glob"
-
-module Rerun
-
-end
-
+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/notification"
+require "rerun/runner"
+require "rerun/watcher"
+require "rerun/glob"
+
+module Rerun
+
+end
+

data/lib/rerun/notification.rb

@@ -1,64 +1,82 @@
-# todo: unit tests
-
-module Rerun
-  class Notification
-    include System
-
-    attr_reader :title, :body, :options
-
-    def initialize(title, body, options = Options::DEFAULTS.dup)
-      @title = title
-      @body = body
-      @options = options
-    end
-
-    def command
-      return unless mac?
-
-      # todo: strategy or subclass
-
-      s = nil
-
-      if options[:notify] == true or options[:notify] == "growl"
-        if (cmd = command_named("growlnotify"))
-          # todo: check version of growlnotify and warn if it's too old
-          icon_str = ("--image \"#{icon}\"" if icon)
-          s = "#{cmd} -n \"#{app_name}\" -m \"#{body}\" \"#{app_name} #{title}\" #{icon_str}"
-        end
-      end
-
-      if s.nil? and options[:notify] == true or options[:notify] == "osx"
-        if (cmd = command_named("terminal-notifier"))
-          icon_str = ("-appIcon \"#{icon}\"" if icon)
-          s = "#{cmd} -title \"#{app_name}\" -message \"#{body}\" \"#{app_name} #{title}\" #{icon_str}"
-        end
-      end
-
-      s
-    end
-
-    def command_named(name)
-      path = `which #{name}`.chomp
-      path.empty? ? nil : path
-    end
-
-    def send(background = true)
-      return unless command
-      `#{command}#{" &" if background}`
-    end
-
-    def app_name
-      options[:name]
-    end
-
-    def icon
-      "#{icon_dir}/rails_red_sml.png" if rails?
-    end
-
-    def icon_dir
-      here = File.expand_path(File.dirname(__FILE__))
-      File.expand_path("#{here}/../../icons")
-    end
-
-  end
-end
+# todo: unit tests
+
+module Rerun
+  class Notification
+    include System
+
+    attr_reader :title, :body, :options
+
+    def initialize(title, body, options = Options::DEFAULTS.dup)
+      @title = title
+      @body = body
+      @options = options
+    end
+
+    def command
+      # todo: strategy or subclass
+
+      s = nil
+
+      if options[:notify] == true or options[:notify] == "growl"
+        if (cmd = command_named("growlnotify"))
+          # todo: check version of growlnotify and warn if it's too old
+          icon_str = ("--image \"#{icon}\"" if icon)
+          s = "#{cmd} -n \"#{app_name}\" -m \"#{body}\" \"#{app_name} #{title}\" #{icon_str}"
+        end
+      end
+
+      if s.nil? and options[:notify] == true or options[:notify] == "osx"
+        if (cmd = command_named("terminal-notifier"))
+          icon_str = ("-appIcon \"#{icon}\"" if icon)
+          s = "#{cmd} -title \"#{app_name}\" -message \"#{body}\" \"#{app_name} #{title}\" #{icon_str}"
+        end
+      end
+
+      if s.nil? and options[:notify] == true or options[:notify] == "notify-send"
+        if (cmd = command_named('notify-send'))
+          icon_str = "--icon #{icon}" if icon
+          s = "#{cmd} -t 500 --hint=int:transient:1 #{icon_str} \"#{app_name}: #{title}\" \"#{body}\""
+        end
+      end
+
+      s
+    end
+
+    def command_named(name)
+      which_command = windows? ? 'where.exe' : 'which'
+      # TODO: remove 'INFO' error message
+      path = `#{which_command} #{name}`.chomp
+      path.empty? ? nil : path
+    end
+
+    def send(background = true)
+      return unless command
+      with_clean_env do
+        `#{command}#{" &" if background}`
+      end
+    end
+
+    def app_name
+      options[:name]
+    end
+
+    def icon
+      "#{icon_dir}/rails_red_sml.png" if rails?
+    end
+
+    def icon_dir
+      here = File.expand_path(File.dirname(__FILE__))
+      File.expand_path("#{here}/../../icons")
+    end
+
+    def with_clean_env
+      if defined?(Bundler)
+        Bundler.with_clean_env do
+          yield
+        end
+      else
+        yield
+      end
+    end
+  end
+end