rerun 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5186659055558e298a987ddc358c03fb2ca23dc
-  data.tar.gz: 93afa739db65f198c20d09520efcfa6e08800e06
+  metadata.gz: a237bdcfe8672bdd765c6a480fbd397e30f0fc45
+  data.tar.gz: 46a4241842ffad57cfdb560bf2b7da0088f35c47
 SHA512:
-  metadata.gz: 60e098c424e134c5456c0ed871f62224bb2fe33f93aed659e554a55729b56f2cdd06a4c910a5f6a498c8d1a131d67e82861a0acfdcca874cb0799031eacd289a
-  data.tar.gz: 5f0fbd5006a6bae73e8ac6104ec6d4c7648ee79baf9c3ba01b14e6ed544386922b6472e3d3fec9e852dea6f4857449673b3b7a93ac7ce4798ef697748b8ac5fa
+  metadata.gz: 3abd42a820c468ae5c5ac50095a888106967e0c64dfe4bdb4c8aca3adef2ce84e85262278a7c9c5382a276437c359de5f875b578da7624c001b2b0d4d7c5d458
+  data.tar.gz: 20964c0461cb634bbe11ea931b2eb25d740e4dd228c6a6e8ab18cdf6e2a368376b8e47c3614a073385323856d0ad6238db5031cfb3fbc732415c7fce5d4f9f38

data/README.md

@@ -14,7 +14,7 @@ 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 only `*.{rb,js,css,coffee,scss,sass,erb,html,haml,ru,slim,md}` files are watched.
+By default it watches files ending in: `rb,js,coffee,css,scss,sass,erb,html,haml,ru,yml,slim,md,feature`.
 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
@@ -116,7 +116,7 @@ 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,css,coffee,scss,sass,erb,html,haml,ru,slim,md`.
+By default it watches files ending in: `rb,js,coffee,css,scss,sass,erb,html,haml,ru,yml,slim,md,feature`.
 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.
 
@@ -125,31 +125,44 @@ Run `rerun --help` to see the actual list.
 
   *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 (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`)
 
+`--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.
 
 `--background` (or -b) disable on-the-fly commands, allowing the process to be backgrounded
 
-`--no-growl` don't use growl
+`--notify NOTIFIER` use `growl` or `osx` for notifications (see below)
+
+`--no-notify` don't use growl (or osx) notifications
 
 `--name` set the app name (for display)
 
 Also `--version` and `--help`, naturally.
 
-# Growl Notifications
+# Notifications
 
 If you have `growlnotify` available on the `PATH`, it sends notifications to
-growl in addition to the console. If you have growl but don't want rerun to use it,
-set the `--no-growl` option.
+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 a notifier installed but don't want rerun to use it,
+set the `--no-notify` option.
 
 Download [growlnotify here](http://growl.info/downloads.php#generaldownloads)
 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-The-Fly Commands
 
 While the app is (re)running, you can make things happen by pressing keys:
@@ -174,6 +187,21 @@ 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.
 
+# Troubleshooting
+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>
+```
+This is because `**/*.rb` gets expanded into the command by `zsh` instead of passing it through to rerun. The solution is to simply quote ('' or "") the pattern.
+i.e
+```
+rerun -p **/*.rb rake test
+```
+becomes
+```
+rerun -p "**/*.rb" rake test
+```
+
 # To Do:
 
 ## Must have for v1.0
@@ -186,6 +214,7 @@ restart.
 * 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
@@ -289,9 +318,19 @@ Based upon and/or inspired by:
 * <https://github.com/FND>
 * Barry Sia <https://github.com/bsia>
 * Paul Rangel <https://github.com/ismell>
+* 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>
 
 # Version History
 
+* 0.11.0    7 October 2015
+  * better 'changed' message
+  * `--notify osx` option
+  * `--restart` option (with bugfix by Mike Pastore)
+  * use Listen 3 gem
+  * add `.feature` files to default watchlist (thanks @jmuheim)
+
 * v0.10.0   4 May 2014
   * add '.coffee,.slim,.md' to default pattern (thanks @xylinq)
   * --ignore option

data/Rakefile

@@ -73,3 +73,10 @@ task 'release' => [:check_git, package('.gem'), package('.tar.gz')] do |t|
   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/lib/rerun.rb

@@ -4,6 +4,7 @@ $: << 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"

data/lib/rerun/notification.rb

@@ -0,0 +1,64 @@
+# 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

data/lib/rerun/options.rb

@@ -8,19 +8,25 @@ $spec = Gem::Specification.load(File.join(libdir, "..", "rerun.gemspec"))
 
 module Rerun
   class Options
-    DEFAULT_PATTERN = "**/*.{rb,js,coffee,css,scss,sass,erb,html,haml,ru,yml,slim,md}"
+    DEFAULT_PATTERN = "**/*.{rb,js,coffee,css,scss,sass,erb,html,haml,ru,yml,slim,md,feature}"
     DEFAULT_DIRS = ["."]
 
     DEFAULTS = {
         :pattern => DEFAULT_PATTERN,
         :signal => "TERM",
-        :growl => true,
+        :notify => true,
         :name => Pathname.getwd.basename.to_s.capitalize,
-        :ignore => []
+        :ignore => [],
+        :dir => DEFAULT_DIRS
     }
 
     def self.parse args = ARGV
-      options = DEFAULTS.dup
+
+      default_options = DEFAULTS.dup
+      options = {
+          ignore: []
+      }
+
       opts = OptionParser.new("", 24, '  ') do |opts|
         opts.banner = "Usage: rerun [options] [--] cmd"
 
@@ -49,6 +55,11 @@ module Rerun
           options[:signal] = signal
         end
 
+        opts.on("-r", "--restart", "expect process to restart itself (uses the HUP signal unless overridden using --signal)") do |signal|
+          options[:restart] = true
+          default_options[:signal] = "HUP"
+        end
+
         opts.on("-c", "--clear", "clear screen before each run") do
           options[:clear] = true
         end
@@ -65,8 +76,15 @@ module Rerun
           options[:name] = name
         end
 
-        opts.on("--no-growl", "don't use growl") do
+        opts.on("--no-growl", "don't use growl [OBSOLETE]") do
           options[:growl] = false
+          $stderr.puts "--no-growl is obsolete; use --no-notify instead"
+          return
+        end
+
+        opts.on("--[no-]notify [notifier]", "send messages through growl (requires growlnotify) or osx (requires terminal-notifier gem)") do |notifier|
+          notifier = true if notifier.nil?
+          options[:notify] = notifier
         end
 
         opts.on_tail("-h", "--help", "--usage", "show this message") do
@@ -89,8 +107,10 @@ module Rerun
         nil
       else
         opts.parse! args
-        options[:cmd] = args.join(" ")
-        options[:dir] ||= DEFAULT_DIRS
+        default_options[:cmd] = args.join(" ")
+
+        options = default_options.merge(options)
+
         options
       end
     end

data/lib/rerun/runner.rb

@@ -60,8 +60,12 @@ module Rerun
 
     def restart
       @restarting = true
-      stop
-      start
+      if @options[:restart]
+        restart_with_signal(@options[:signal])
+      else
+        stop
+        start
+      end
       @restarting = false
     end
 
@@ -75,7 +79,7 @@ module Rerun
         @watcher.pause
         @pausing = true
       else
-        say "Resuming"
+        say "Resuming."
         @watcher.unpause
         @pausing = false
       end
@@ -113,19 +117,19 @@ module Rerun
       @options[:name]
     end
 
+    def restart_with_signal(restart_signal)
+      if @pid && (@pid != 0)
+        notify "restarting", "We will be with you shortly."
+        signal(restart_signal)
+      end
+    end
+
     def start
       if windows?
         raise "Sorry, Rerun does not work on Windows."
       end
 
-      if (!@already_running)
-        taglines = [
-          "To infinity... and beyond!",
-          "Charge!",
-        ]
-        notify "launched", taglines[rand(taglines.size)]
-        @already_running = true
-      else
+      if @already_running
         taglines = [
           "Here we go again!",
           "Keep on trucking.",
@@ -133,6 +137,13 @@ module Rerun
           "The road goes ever on and on, down from the door where it began.",
         ]
         notify "restarted", taglines[rand(taglines.size)]
+      else
+        taglines = [
+          "To infinity... and beyond!",
+          "Charge!",
+        ]
+        notify "launched", taglines[rand(taglines.size)]
+        @already_running = true
       end
 
       clear_screen if clear?
@@ -181,21 +192,35 @@ module Rerun
 
         watcher = Watcher.new(:directory => dirs, :pattern => pattern, :ignore => ignore) do |changes|
 
-          message = [:modified, :added, :removed].map do |change|
-            count = changes[change].size
-            if count and count > 0
-              "#{count} #{change}"
-            end
-          end.compact.join(", ")
+          message = change_message(changes)
+
           say "Change detected: #{message}"
           restart unless @restarting
         end
         watcher.start
         @watcher = watcher
         say "Watching #{dir.join(', ')} for #{pattern}" +
-                (ignore.empty? ? "" : " (ignoring #{ignore.join(',')})") +
-                " using #{watcher.adapter.class.name.split('::').last} adapter"
+                (ignore.empty? ? "" : " (ignoring #{ignore.join(',')})")
+      end
+    end
+
+    def change_message(changes)
+      message = [:modified, :added, :removed].map do |change|
+        count = changes[change] ? changes[change].size : 0
+        if count > 0
+          "#{count} #{change}"
+        end
+      end.compact.join(", ")
+
+      changed_files = changes.values.flatten
+      if changed_files.count > 0
+        message += ": "
+        message += changes.values.flatten[0..3].map { |path| path.split('/').last }.join(', ')
+        if changed_files.count > 3
+          message += ", ..."
+        end
       end
+      message
     end
 
     def die
@@ -257,8 +282,8 @@ module Rerun
       @git_head = File.exists?(git_head_file) && File.read(git_head_file)
     end
 
-    def notify(title, body)
-      growl title, body if @options[:growl]
+    def notify(title, body, background = true)
+      Notification.new(title, body, @options).send(background) if @options[:notify]
       puts
       say "#{app_name} #{title}"
     end

data/lib/rerun/system.rb

@@ -13,31 +13,9 @@ module Rerun
        RUBY_PLATFORM =~ /linux/i
     end
 
-    # do we have growl or not?
-    def growl_available?
-      mac? && (growlcmd != "")
-    end
-
-    def growlcmd
-      growlnotify = `which growlnotify`.chomp
-      # todo: check version of growlnotify and warn if it's too old
-      growlnotify
-    end
-
-    def icon
-      here = File.expand_path(File.dirname(__FILE__))
-      icondir = File.expand_path("#{here}/../../icons")
+    def rails?
       rails_sig_file = File.expand_path(".")+"/config/boot.rb"
-      "#{icondir}/rails_red_sml.png" if File.exists? rails_sig_file
-    end
-
-    def growl(title, body, background = true)
-      if growl_available?
-        icon_str = ("--image \"#{icon}\"" if icon)
-        s = "#{growlcmd} -n \"#{app_name}\" -m \"#{body}\" \"#{app_name} #{title}\" #{icon_str}"
-        s += " &" if background
-        `#{s}`
-      end
+      File.exists? rails_sig_file
     end
 
   end

data/lib/rerun/watcher.rb

@@ -85,13 +85,6 @@ module Rerun
       [dotfiles] + @ignore.map { |x| Rerun::Glob.new(x).to_regexp }
     end
 
-    def adapter
-      @listener.registry[:adapter] || (timeout(4) do
-        sleep 1 until adapter = @listener.registry[:adapter]
-        adapter
-      end)
-    end
-
     # kill the file watcher thread
     def stop
       @thread.wakeup rescue ThreadError
@@ -115,11 +108,11 @@ module Rerun
     end
 
     def unpause
-      @listener.unpause if @listener
+      @listener.start if @listener
     end
 
     def running?
-      @listener && @listener.instance_variable_get(:@adapter)
+      @listener && @listener.processing?
     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.10.0'
+  s.version = '0.11.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."
@@ -25,7 +25,7 @@ $spec = Gem::Specification.new do |s|
 
   s.extra_rdoc_files = %w[README.md]
 
-  s.add_runtime_dependency 'listen', '~> 2.7', '>= 2.7.3'
+  s.add_runtime_dependency 'listen', '~> 3.0'
 
   s.homepage = "http://github.com/alexch/rerun/"
   s.require_paths = %w[lib]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rerun
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Alex Chaffee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.3
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.3
+        version: '3.0'
 description: Restarts your app when a file changes. A no-frills, command-line alternative
   to Guard, Shotgun, Autotest, etc.
 email: alex@stinky.com
@@ -47,6 +41,7 @@ files:
 - icons/rails_red_sml.png
 - lib/rerun.rb
 - lib/rerun/glob.rb
+- lib/rerun/notification.rb
 - lib/rerun/options.rb
 - lib/rerun/runner.rb
 - lib/rerun/system.rb
@@ -72,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 2
 summary: Launches an app, and restarts it whenever the filesystem changes. A no-frills,