filewatcher 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 822dcac9d604c0ba52d968e3bf92df44da1e1512
-  data.tar.gz: 6851bd0744d58eb1a9150c35fb27ace77f261793
+  metadata.gz: 2fb39cdddc7a64525396dac78226807bb53e450a
+  data.tar.gz: 641cea3ede6d8d1eb20fe7a0b8aa5ad75e86d75e
 SHA512:
-  metadata.gz: 173d5fc6f40ef6180110bf21169ab6b59f6f40a78cecad86bef0a21541e218febca5f13ed57247f4b0eb84ac08f1cbd2bbac89f6a4a25e61e9378e4f5ac70d21
-  data.tar.gz: 32a2ac8c557f68880771eb6423be097fca08b8eff914812361de881a3fe7f19342f2afc9e81f1051fe7d60c00825279405f81d9494ca2854c804654f860008f7
+  metadata.gz: 728a408d87cfb6be8eb5556f31bc74972645275d0bb0c3c9a1045a9d4287e1aa3ff4f5a15fb46dfa14953e837ed2b38cdcfc8ad8e34e380b6f2980a9cebbc932
+  data.tar.gz: bad167aae4d3e3e7fe9848ea7295f1a0fd71e4984480f35765ee869814eeee8555f0fe705b5b61a33c7dc4cc8fd95d3e6bbce6410935e3c0c22b3233effcc950

data/README.md

@@ -8,6 +8,19 @@ Filewatcher
 
 Lightweight filewatcher weighing less than 200 LoC. No dependencies or platform specific code.
 Works everywhere. Monitors changes in the filesystem by polling. No config files needed to run.
+When running filewatcher from the command line, you specify which files to monitor and what action
+to perform on updates.
+
+Search recursively for javascript files and run jshint when a file is updated, added,
+renamed or deleted:
+
+Linux/OSX:
+
+    $ filewatcher '**/*.js' 'jshint $FILENAME'
+
+In Windows:
+
+    > filewatcher "**/*.js" "jshint %FILENAME%"
 
 Install
 -------
@@ -20,10 +33,10 @@ Command line utility
 --------------------
 
 Filewatcher scans the filesystem and execute shell commands when files are
-changed.
+updated, added, renamed or deleted.
 
     Usage:
-        filewatcher [-i interval] "<filename>" "<shell command>"
+        filewatcher [-i interval][-l] "<filename>" "<shell command>"
 
     Where
         filename: filename(s) to scan.
@@ -47,13 +60,13 @@ In Linux/OSX:
 
 Place filenames or filenames in quotes to use ruby filename globbing instead
 of shell filename globbing. This will make filewatcher look for files in
-subdirectories too.
+subdirectories too. To watch all javascript files in subdirectories:
 
-    > filewatcher "*.js" "node %FILENAME%"
+    > filewatcher "**/*.js" "node %FILENAME%"
 
 In Linux/OSX:
 
-    > filewatcher '*.js' 'node $FILENAME'
+    > filewatcher '**/*.js' 'node $FILENAME'
 
 Try to run the updated file as a script when it is updated by using the
 --exec/-e option. Works with files with file extensions that looks like a
@@ -71,6 +84,13 @@ filesystem gets updated:
 
     $ filewatcher "src test" "ruby test/test_suite.rb"
 
+Automatic restart of processes
+------------------------------
+
+The `--restart` option restarts the command when changes happens on the file system. The `--dontwait` starts the command when filewatcher is started. To start a webserver and have it automatically restart when html files are updated:
+
+    $ filewatcher --dontwait --restart "*.html" "python -m SimpleHTTPServer"
+
 Available enviroment variables
 ------------------------------
 
@@ -101,7 +121,7 @@ Watch a list of files and directories:
     require 'filewatcher'
 
     FileWatcher.new(["lib/", "Rakefile"]).watch do |filename|
-      puts "Updated " + filename
+      puts "Changed " + filename
     end
 
 Watch a single directory, for changes in all files and subdirectories:
@@ -142,6 +162,8 @@ To detect if a file is updated, added or deleted:
       end
     end
 
+When a file is renamed it is detected as a deletion and a file addition.
+
 To check for changes more often than the default once every second:
 
     FileWatcher.new(["README.rdoc"]).watch(0.5) do |filename|
@@ -172,14 +194,14 @@ with no dependencies.
 
 Credits
 -------
+This project would not be where it is today without the generous help provided by people reporting issues and these contributors: 
 
-Support for absolute and globbed paths by flbulgarelli: https://github.com/flbulgarelli
 
-Code inspired by Tom Lieber's blogg posting: http://alltom.com/pages/detecting-file-changes-with-ruby
+ * Support for absolute and globbed paths by Franco Leonardo Bulgarelli: https://github.com/flbulgarelli
 
-Find method by c00lrguy: http://snippets.dzone.com/posts/show/5457
+ * Command line globbing by Kristoffer Roupé https://github.com/kitofr
 
-Globbing by Kristoffer Roupé https://github.com/kitofr
+This gem was initially inspired by Tom Lieber's blogg posting: http://alltom.com/pages/detecting-file-changes-with-ruby
 
 Note on Patches/Pull Requests
 -----------------------------
@@ -194,4 +216,4 @@ Note on Patches/Pull Requests
 Copyright
 ---------
 
-Copyright (c) 2011 - 2014 Thomas Flemming. See LICENSE for details.
+Copyright (c) 2011 - 2015 Thomas Flemming. See LICENSE for details.

data/Rakefile

@@ -3,6 +3,8 @@ require 'rake'
 require 'rake/testtask'
 
 task :default => :test
+
+desc "Run tests"
 task :test do
   sh "bacon -Ilib -Itest --automatic --quiet"
 end

data/bin/filewatcher

@@ -3,9 +3,10 @@ require 'rubygems'
 require 'filewatcher'
 require 'trollop'
 require 'pathname'
+require 'thread'
 
 options = Trollop::options do
-  version "filewatcher, version #{FileWatcher.VERSION} by Thomas Flemming 2014"
+  version "filewatcher, version #{FileWatcher.VERSION} by Thomas Flemming 2015"
   banner <<-EOS
 Filewatcher scans the filesystem and executes shell commands when files changes.
 
@@ -22,11 +23,13 @@ Examples:
 Options:
 EOS
 
-  opt :interval, "Interval to scan filesystem. Defaults to 0.5 seconds.", :short => 'i', :type => :float, :default => 0.5
+  opt :dontwait, "Do not wait for filesystem updates before running", :short => 'd', :type => :boolean, :default => false
+  opt :restart, "Restart process when filesystem is updated", :short => 'r', :type => :boolean, :default => false
+  opt :list, "Print name of files being watched"
   opt :exec, "Execute file as a script when file is updated.", :short => 'e', :type => :boolean, :default => false
   opt :include, "Include files", :type => :string, :default => "*"
   opt :exclude, "Exclude file(s) matching", :type => :string, :default => ""
-  opt :list, "Print name of files being watched"
+  opt :interval, "Interval to scan filesystem. Defaults to 0.5 seconds.", :short => 'i', :type => :float, :default => 0.5  
 end
 
 Trollop::die "must have at least one argument" if(ARGV.size == 0)
@@ -56,7 +59,45 @@ end
 
 files = split_files_void_escaped_whitespace(files)
 
-FileWatcher.new(files, options[:list]).watch(options[:interval]) do |filename, event|
+def fork_process(env, cmd)
+  pipe_read, pipe_write = IO.pipe
+  fork do
+    pipe_read.close
+    pipe_write.write Process.spawn(env,cmd).to_s
+    exit
+  end
+
+  Kernel.sleep 1
+  pipe_write.close
+  child_pid = pipe_read.read.to_i
+  pipe_read.close
+  return child_pid
+end
+
+def kill_process(child_pid)
+  still_running = true
+  begin
+    Process.kill(1, child_pid)
+  rescue Errno::ESRCH
+    still_running = false
+  end
+  while still_running do
+    begin
+      Process.getpgid( child_pid)
+      still_running = true
+    rescue Errno::ESRCH
+      still_running = false
+    end
+    Kernel.sleep 0.1
+  end
+end
+
+if(options[:restart])
+  rd, wr = IO.pipe
+  child_pid = nil
+end
+
+FileWatcher.new(files, options[:list], options[:dontwait]).watch(options[:interval]) do |filename, event|
   cmd = nil
   if(options[:exec] and File.exist?(filename))
     extension = filename[/(\.[^\.]*)$/,0]
@@ -91,8 +132,23 @@ FileWatcher.new(files, options[:list]).watch(options[:interval]) do |filename, e
     if(event != :delete)
       ENV['FILEPATH'] = path.realpath.to_s
     end
-    pid = Process.spawn(env, cmd);
-    pid = Process.wait();
+
+    if(options[:restart])
+      if(child_pid == nil)
+        child_pid = fork_process(env, cmd)
+      else
+        kill_process(child_pid)
+        child_pid = fork_process(env, cmd)
+      end
+    else
+      begin
+        pid = Process.spawn(env, cmd)
+        Process.wait()
+      rescue SystemExit, Interrupt
+        exit(0)
+      end
+    end
+
   else
     case(event)
     when :changed

data/lib/filewatcher.rb

@@ -6,14 +6,14 @@ class FileWatcher
   attr_accessor :filenames
 
   def self.VERSION
-    return '0.3.6'
+    return '0.4.0'
   end
 
-  def initialize(unexpanded_filenames, print_filelist=false)
+  def initialize(unexpanded_filenames, print_filelist=false, dontwait=false)
     @unexpanded_filenames = unexpanded_filenames
     @last_mtimes = { }
     @filenames = expand_directories(@unexpanded_filenames)
-
+    @dontwait = dontwait
     puts 'Watching:' if print_filelist
     @filenames.each do |filename|
       raise 'File does not exist' unless File.exist?(filename)
@@ -23,6 +23,9 @@ class FileWatcher
   end
 
   def watch(sleep=1, &on_update)
+    if(@dontwait)
+      yield '',''
+    end
     loop do
       begin
         Kernel.sleep sleep until filesystem_updated?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filewatcher
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Thomas Flemming
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-30 00:00:00.000000000 Z
+date: 2015-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop