guard 0.1.1 → 0.2.0.beta.1

data/README.rdoc

@@ -4,17 +4,17 @@ Guard is a command line tool to easly handle events on files modifications.
 
 == Features
 
-- FSEvent support on Mac OS X (without RubyCocoa!)
-- Inotify support on Linux (beta)
-- Super fast change detection
+- FSEvent support on Mac OS X 10.5+ (without RubyCocoa!, please install {rb-fsevent, >= 0.3.2}[https://rubygems.org/gems/rb-fsevent])
+- Inotify support on Linux (beta, please install {rb-inotify, >= 0.5.1}[https://rubygems.org/gems/rb-inotify])
+- Polling for others (help us to support more systems)
+- Super fast change detection (when polling not used)
 - Automatic files modifications detection (even new files are detected)
 - Growl notification (please install {growlnotify}[http://growl.info/documentation/growlnotify.php])
 - Libnotify notification
+- Tested on Ruby 1.8.7 & 1.9.2.
 
 == Install
 
-Only Mac OS X (10.5+) & Linux are supported. Tested on Ruby 1.8.7 & 1.9.2.
-
 Install the gem:
 
     gem install guard
@@ -35,9 +35,13 @@ Just launch Guard inside your ruby/rails project with:
 
     guard
 
+Shell can be cleared after each change with:
+
+    guard -c
+
 Options list is available with:
 
-    guard help
+    guard help [TASK]
 
 Signal handlers are used to interact with Guard:
 
@@ -48,11 +52,11 @@ Signal handlers are used to interact with Guard:
 == Available Guards
 
 - {guard-rspec}[http://github.com/guard/guard-rspec]
+- {guard-livereload}[http://github.com/guard/guard-livereload]
 
 guard ideas:
 
 - guard-spork
-- guard-livereload
 - guard-cucumber
 - guard-test
 - guard-sass
@@ -65,7 +69,7 @@ Add it to your Gemfile (inside test group):
 
     gem '<guard-name>'
 
-Add guard definition to your Guardfile with:
+Add guard definition to your Guardfile by running this command:
 
     guard init <guard-name>
 

data/lib/guard.rb

@@ -14,7 +14,7 @@ module Guard
     
     def start(options = {})
       @options  = options
-      @listener = Listener.new
+      @listener = Listener.init
       @guards   = []
       
       Dsl.evaluate_guardfile
@@ -59,7 +59,7 @@ module Guard
     
     def run
       listener.stop
-      UI.clear if options[:clear]
+      UI. clear if options[:clear]
       yield
       listener.start
     end

data/lib/guard/listener.rb

@@ -1,51 +1,39 @@
-require 'sys/uname'
+require 'rbconfig'
 
 module Guard
+  
+  autoload :Darwin,  'guard/listeners/darwin'
+  autoload :Linux,   'guard/listeners/linux'
+  autoload :Polling, 'guard/listeners/polling'
+  
   class Listener
-    attr_reader :last_event, :callback, :pipe
-    
-    def initialize
-      update_last_event
-    end
-    
-    def on_change(&block)
-      @callback = block
-    end
-    
-    def start
-      @pipe = case Sys::Uname.sysname
-      when 'Darwin'
-        IO.popen("#{bin_path}/fsevent_watch .")
-      when 'Linux'
-        IO.popen("#{bin_path}/inotify_watch .")
+    attr_reader :last_event
+    
+    def self.init
+      if mac? && Darwin.usable?
+        Darwin.new
+      elsif linux? && Linux.usable?
+        Linux.new
+      else
+        UI.info "Using polling (Please help us to support your system better than that.)"
+        Polling.new
       end
-      watch_change
     end
     
-    def stop
-      Process.kill("HUP", pipe.pid) if pipe
+    def initialize
+      update_last_event
     end
     
   private
     
-    def watch_change
-      while !pipe.eof?
-        if line = pipe.readline
-          modified_dirs = line.split(" ")
-          files = modified_files(modified_dirs)
-          update_last_event
-          callback.call(files)
-        end
-      end
-    end
-    
-    def modified_files(dirs)
-      files = potentially_modified_files(dirs).select { |file| recent_file?(file) }
+    def modified_files(dirs, options = {})
+      files = potentially_modified_files(dirs, options).select { |path| File.file?(path) && recent_file?(path) }
       files.map! { |file| file.gsub("#{Dir.pwd}/", '') }
     end
     
-    def potentially_modified_files(dirs)
-      Dir.glob(dirs.map { |dir| "#{dir}*" })
+    def potentially_modified_files(dirs, options = {})
+      match = options[:all] ? "**/*" : "*"
+      Dir.glob(dirs.map { |dir| "#{dir}#{match}" })
     end
     
     def recent_file?(file)
@@ -58,8 +46,12 @@ module Guard
       @last_event = Time.now
     end
     
-    def bin_path
-      File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'bin'))
+    def self.mac?
+      Config::CONFIG['target_os'] =~ /darwin/i
+    end
+    
+    def self.linux?
+      Config::CONFIG['target_os'] =~ /linux/i
     end
     
   end

data/lib/guard/listeners/darwin.rb

@@ -0,0 +1,40 @@
+module Guard
+  class Darwin < Listener
+    attr_reader :fsevent
+    
+    def initialize
+      super
+      @fsevent = FSEvent.new
+    end
+    
+    def on_change(&callback)
+      @fsevent.watch Dir.pwd do |modified_dirs|
+        files = modified_files(modified_dirs)
+        update_last_event
+        callback.call(files)
+      end
+    end
+    
+    def start
+      @fsevent.run
+    end
+    
+    def stop
+      @fsevent.stop
+    end
+    
+    def self.usable?
+      require 'rb-fsevent'
+      if !defined?(FSEvent::VERSION) || Gem::Version.new(FSEvent::VERSION) < Gem::Version.new('0.3.2')
+        UI.info "Please update rb-fsevent (>= 0.3.2)"
+        false
+      else
+        true
+      end
+    rescue LoadError
+      UI.info "Please install rb-fsevent gem for Mac OSX FSEvents support"
+      false
+    end
+    
+  end
+end

data/lib/guard/listeners/linux.rb

@@ -0,0 +1,58 @@
+module Guard
+  class Linux < Listener
+    attr_reader :inotify, :files, :latency, :callback
+    
+    def initialize
+      @inotify = INotify::Notifier.new
+      @files   = []
+      @latency = 0.5
+    end
+    
+    def on_change(&callback)
+      @callback = callback
+      inotify.watch(Dir.pwd, :recursive, :attrib, :modify, :create) do |event|
+        unless event.name == "" # Event on root directory
+          @files << event.absolute_name
+        end
+      end
+    end
+    
+    def start
+      @stop = false
+      watch_change
+    end
+    
+    def stop
+      @stop = true
+      inotify.stop
+    end
+    
+    def self.usable?
+      require 'rb-inotify'
+      if !defined?(INotify::VERSION) || Gem::Version.new(INotify::VERSION) < Gem::Version.new('0.5.1')
+        UI.info "Please update rb-inotify (>= 0.5.1)"
+        false
+      else
+        true
+      end
+    rescue LoadError
+      UI.info "Please install rb-inotify gem for Linux inotify support"
+      false
+    end
+    
+  private
+    
+    def watch_change
+      while !@stop
+        inotify.process
+        unless files.empty?
+          files.map! { |file| file.gsub("#{Dir.pwd}/", '') }
+          callback.call(files)
+          files.clear
+        end
+        sleep latency
+      end
+    end
+    
+  end
+end

data/lib/guard/listeners/polling.rb

@@ -0,0 +1,37 @@
+module Guard
+  class Polling < Listener
+    attr_reader :callback, :latency
+    
+    def initialize
+      super
+      @latency = 1.5
+    end
+    
+    def on_change(&callback)
+      @callback = callback
+    end
+    
+    def start
+      @stop = false
+      watch_change
+    end
+    
+    def stop
+      @stop = true
+    end
+    
+  private
+    
+    def watch_change
+      while !@stop
+        start = Time.now.to_f
+        files = modified_files([Dir.pwd + '/'], :all => true)
+        update_last_event
+        callback.call(files) unless files.empty?
+        nap_time = latency - (Time.now.to_f - start)
+        sleep(nap_time) if nap_time > 0
+      end
+    end
+    
+  end
+end

data/lib/guard/notifier.rb

@@ -1,10 +1,10 @@
-require 'sys/uname'
+require 'rbconfig'
 require 'pathname'
 
-case Sys::Uname.sysname
-when 'Darwin'
+case Config::CONFIG['target_os']
+when /darwin/i
   require 'growl'
-when 'Linux'
+when /linux/i
   require 'libnotify'
 end
 
@@ -15,10 +15,10 @@ module Guard
       unless ENV["GUARD_ENV"] == "test"
         image = options[:image] || :success
         title = options[:title] || "Guard"
-        case Sys::Uname.sysname
-        when 'Darwin'
+        case Config::CONFIG['target_os']
+        when /darwin/i
           Growl.notify message, :title => title, :icon => image_path(image), :name => "Guard"
-        when 'Linux'
+        when /linux/i
           Libnotify.show :body => message, :summary => title, :icon_path => image_path(image)
         end
       end

data/lib/guard/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  VERSION = "0.1.1"
+  VERSION = "0.2.0.beta.1"
 end

metadata

@@ -1,13 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: guard
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
+  hash: 62196353
+  prerelease: true
   segments: 
   - 0
+  - 2
+  - 0
+  - beta
   - 1
-  - 1
-  version: 0.1.1
+  version: 0.2.0.beta.1
 platform: ruby
 authors: 
 - Thibaud Guillaume-Gentil
@@ -15,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-10 00:00:00 +02:00
+date: 2010-10-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,13 +28,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7712058
+        hash: 15
         segments: 
         - 2
         - 0
         - 0
-        - rc
-        version: 2.0.0.rc
+        version: 2.0.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -43,12 +44,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 29
         segments: 
         - 0
         - 1
-        - 0
-        version: 0.1.0
+        - 3
+        version: 0.1.3
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -83,26 +84,10 @@ dependencies:
         version: 0.14.3
   type: :runtime
   version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: sys-uname
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 55
-        segments: 
-        - 0
-        - 8
-        - 4
-        version: 0.8.4
-  type: :runtime
-  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: growl
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -114,27 +99,11 @@ dependencies:
         - 3
         version: 1.0.3
   type: :runtime
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rb-inotify
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 61
-        segments: 
-        - 0
-        - 8
-        - 1
-        version: 0.8.1
-  type: :runtime
-  version_requirements: *id007
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: libnotify
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -146,19 +115,18 @@ dependencies:
         - 3
         version: 0.1.3
   type: :runtime
-  version_requirements: *id008
+  version_requirements: *id006
 description: Guard is a command line tool to easily handle events on files modifications.
 email: 
 - thibaud@thibaud.me
 executables: 
 - guard
-extensions: 
-- ext/extconf.rb
+extensions: []
+
 extra_rdoc_files: []
 
 files: 
 - bin/guard
-- bin/inotify_watch
 - images/failed.png
 - images/pending.png
 - images/success.png
@@ -167,14 +135,15 @@ files:
 - lib/guard/guard.rb
 - lib/guard/interactor.rb
 - lib/guard/listener.rb
+- lib/guard/listeners/darwin.rb
+- lib/guard/listeners/linux.rb
+- lib/guard/listeners/polling.rb
 - lib/guard/notifier.rb
 - lib/guard/templates/Guardfile
 - lib/guard/ui.rb
 - lib/guard/version.rb
 - lib/guard/watcher.rb
 - lib/guard.rb
-- ext/extconf.rb
-- ext/fsevent/fsevent_watch.c
 - LICENSE
 - README.rdoc
 has_rdoc: true

data/bin/inotify_watch

@@ -1,25 +0,0 @@
-#!/usr/bin/env ruby
-require 'rubygems'
-require 'rb-inotify'
-
-folders = Array.new
-notifier = INotify::Notifier.new
-
-notifier.watch(ARGV.first || '.', :modify, :recursive) do |event|
-  dir = File.expand_path(File.dirname(event.absolute_name)) + '/'
-  if !folders.include?(dir)
-    folders << dir
-  end
-end
-
-while true do
-  notifier.process
-  
-  if !folders.empty?
-    $stdout.puts folders.join(' ')
-    $stdout.flush
-    folders.clear
-  end
-  
-  sleep(0.1)
-end

data/ext/extconf.rb

@@ -1,18 +0,0 @@
-# Workaround to make Rubygems believe it builds a native gem
-require 'mkmf'
-create_makefile('none')
-
-if `uname -s`.chomp == 'Darwin'
-  gem_root      = File.expand_path(File.join('..'))
-  darwin_verion = `uname -r`.to_i
-  sdk_verion    = { 9 => '10.5', 10 => '10.6', 11 => '10.7' }[darwin_verion]
-  
-  raise "Darwin #{darwin_verion} is not supported" unless sdk_verion
-  
-  # Compile the actual fsevent_watch binary
-  system("CFLAGS='-isysroot /Developer/SDKs/MacOSX#{sdk_verion}.sdk -mmacosx-version-min=#{sdk_verion}' /usr/bin/gcc -framework CoreServices -o '#{gem_root}/bin/fsevent_watch' fsevent/fsevent_watch.c")
-  
-  unless File.executable?("#{gem_root}/bin/fsevent_watch")
-    raise "Compilation of fsevent_watch failed (see README)"
-  end
-end

data/ext/fsevent/fsevent_watch.c

@@ -1,44 +0,0 @@
-#include <CoreServices/CoreServices.h>
-
-void callback(ConstFSEventStreamRef streamRef,
-  void *clientCallBackInfo,
-  size_t numEvents,
-  void *eventPaths,
-  const FSEventStreamEventFlags eventFlags[],
-  const FSEventStreamEventId eventIds[]
-) {
-  // Print modified dirs
-  int i;
-  char **paths = eventPaths;
-  for (i = 0; i < numEvents; i++) {
-    printf("%s", paths[i]);
-    printf(" ");
-  }
-  printf("\n");
-  fflush(stdout);
-}
-
-int main (int argc, const char * argv[]) {
-  // Create event stream
-  CFStringRef pathToWatch = CFStringCreateWithCString(kCFAllocatorDefault, argv[1], kCFStringEncodingUTF8);
-  CFArrayRef pathsToWatch = CFArrayCreate(NULL, (const void **)&pathToWatch, 1, NULL);  
-  void *callbackInfo = NULL;
-  FSEventStreamRef stream;
-  CFAbsoluteTime latency = 0.1;
-  stream = FSEventStreamCreate(
-    kCFAllocatorDefault,
-    callback,
-    callbackInfo,
-    pathsToWatch,
-    kFSEventStreamEventIdSinceNow,
-    latency,
-    kFSEventStreamCreateFlagNone
-  );
-  
-  // Add stream to run loop
-  FSEventStreamScheduleWithRunLoop(stream, CFRunLoopGetCurrent(), kCFRunLoopDefaultMode);
-  FSEventStreamStart(stream);
-  CFRunLoopRun();
-  
-  return 2;
-}