watchr 0.6 → 0.7

data/README.md

@@ -77,11 +77,16 @@ Install
 
     gem install watchr
 
-If you're on \*nix and have the [rev][4] gem installed, Watchr will detect it
-and use it automatically. This will make Watchr evented.
+If you're on Linux/BSD and have the [rev][4] gem installed, Watchr will detect
+it and use it automatically. This will make Watchr evented.
 
     gem install rev
 
+You can get the same evented behaviour on OS X by installing
+[ruby-fsevent][10].
+
+    gem install ruby-fsevent
+
 See Also
 --------
 
@@ -110,4 +115,5 @@ Links
 [7]:  http://github.com/mynyml/phocus
 [8]:  http://github.com/viking/autowatchr
 [9]:  http://github.com/francois/nestor
+[10]: http://github.com/sandro/ruby-fsevent
 

data/Rakefile

@@ -1,3 +1,12 @@
+def gem_opt
+  defined?(Gem) ? "-rubygems" : ""
+end
+
+def ruby
+  require 'rbconfig'
+  File.join([Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name']]) << Config::CONFIG['EXEEXT']
+end
+
 # --------------------------------------------------
 # Tests
 # --------------------------------------------------
@@ -8,7 +17,7 @@ namespace(:test) do
   desc "Run all tests"
   task(:all) do
     tests = Dir['test/**/test_*.rb'] - ['test/test_helper.rb']
-    exit system("ruby -rubygems -I.:lib -e'%w( #{tests.join(' ')} ).each {|file| require file }'")
+    exit system(%Q{#{ruby} #{gem_opt} -I.:lib -e"%w( #{tests.join(' ')} ).each {|file| require file }"})
   end
 
   desc "Run all tests on multiple ruby versions (requires rvm)"

data/TODO.md

@@ -9,6 +9,8 @@ Features
   * requires new handler(s)
   * will allow recognizing `:added` events
 
+* allow setting latency
+
 Bugs
 ----
 

data/bin/watchr

@@ -4,7 +4,7 @@ require 'pathname'
 require 'optparse'
 require 'tempfile'
 
-require 'watchr'
+require File.dirname(__FILE__) + '/../lib/watchr'
 
 module Watchr
   # Namespaced to avoid defining global methods

data/lib/watchr.rb

@@ -12,8 +12,16 @@ require 'rbconfig'
 #     # on command line, from project's root dir
 #     $ watchr path/to/script
 #
+$LOAD_PATH.unshift(File.dirname(__FILE__))
 module Watchr
-  VERSION = '0.6'
+  VERSION = '0.7'
+
+  begin
+    require 'fsevent'
+    HAVE_FSE = true
+  rescue LoadError, RuntimeError
+    HAVE_FSE = false
+  end
 
   begin
     require 'rev'
@@ -27,8 +35,9 @@ module Watchr
 
   module EventHandler
     autoload :Base,     'watchr/event_handlers/base'
-    autoload :Unix,     'watchr/event_handlers/unix' if ::Watchr::HAVE_REV
     autoload :Portable, 'watchr/event_handlers/portable'
+    autoload :Unix,     'watchr/event_handlers/unix'      if ::Watchr::HAVE_REV
+    autoload :Darwin,   'watchr/event_handlers/darwin'    if ::Watchr::HAVE_FSE
   end
 
   class << self
@@ -100,15 +109,22 @@ module Watchr
     def handler
       @handler ||=
         case ENV['HANDLER'] || Config::CONFIG['host_os']
-          when /mswin|windows|cygwin/i
-            Watchr::EventHandler::Portable
-          when /sunos|solaris|darwin|mach|osx|bsd|linux/i, 'unix'
-            if ::Watchr::HAVE_REV
+          when /darwin|mach|osx|fsevents?/i
+            if Watchr::HAVE_FSE
+              Watchr::EventHandler::Darwin
+            else
+              Watchr.debug "fsevent not found. `gem install ruby-fsevent` to get evented handler"
+              Watchr::EventHandler::Portable
+            end
+          when /sunos|solaris|bsd|linux|unix/i
+            if Watchr::HAVE_REV
               Watchr::EventHandler::Unix
             else
               Watchr.debug "rev not found. `gem install rev` to get evented handler"
               Watchr::EventHandler::Portable
             end
+          when /mswin|windows|cygwin/i
+            Watchr::EventHandler::Portable
           else
             Watchr::EventHandler::Portable
         end

data/lib/watchr/controller.rb

@@ -58,6 +58,7 @@ module Watchr
     def update(path, event_type = nil)
       path = Pathname(path).expand_path
 
+      Watchr.debug("received #{event_type.inspect} event for #{path.relative_path_from(Pathname(Dir.pwd))}")
       if path == @script.path
         @script.parse!
         @handler.refresh(monitored_paths)

data/lib/watchr/event_handlers/darwin.rb

@@ -0,0 +1,160 @@
+module Watchr
+  module EventHandler
+
+    class ::FSEvents
+      # Same as Watch.debug, but prefixed with [fsevents] instead.
+      #
+      # @example
+      #
+      #     FSEvents.debug('missfired')
+      #
+      # @param [String] message
+      #   debug message to print
+      #
+      # @return [nil]
+      #
+      def self.debug(msg)
+        puts "[fsevents] #{msg}" if Watchr.options.debug
+      end
+    end
+
+    # FSEvents based event handler for Darwin/OSX
+    #
+    # Uses ruby-fsevents (http://github.com/sandro/ruby-fsevent)
+    #
+    class Darwin < FSEvent
+      include Base
+
+      def initialize
+        super
+        self.latency = 0.2
+      end
+
+      # Enter listening loop. Will block control flow until application is
+      # explicitly stopped/killed.
+      #
+      # @return [undefined]
+      #
+      def listen(monitored_paths)
+        register_paths(monitored_paths)
+        start
+      end
+
+      # Rebuild file bindings. Will detach all current bindings, and reattach
+      # the `monitored_paths`
+      #
+      # @param [Array<Pathname>] monitored_paths
+      #   list of paths the application is currently monitoring.
+      #
+      # @return [undefined]
+      #
+      def refresh(monitored_paths)
+        register_paths(monitored_paths)
+        restart
+      end
+
+      private
+
+        # Callback. Called on file change event. Delegates to
+        # {Controller#update}, passing in path and event type
+        #
+        # @return [undefined]
+        #
+        def on_change(dirs)
+          dirs.each do |dir|
+            path, type = detect_change(dir)
+            notify(path, type) unless path.nil?
+          end
+        end
+
+        # Detected latest updated file within given directory
+        #
+        # @param [Pathname, String] dir
+        #   directory reporting event
+        #
+        # @return [Array(Pathname, Symbol)] path and type
+        #   path to updated file and event type
+        #
+        def detect_change(dir)
+          paths = monitored_paths_for(dir)
+          type  = nil
+          path  = paths.find {|path| type = event_type(path) }
+
+          FSEvents.debug("event detection error") if type.nil?
+
+          update_reference_times
+          [path, type]
+        end
+
+        # Detect type of event for path, if any
+        #
+        # Path times (atime, mtime, ctime) are compared to stored references.
+        # If any is more recent, the event is reported as a symbol.
+        #
+        # @param [Pathname] path
+        #
+        # @return [Symbol, nil] event type
+        #   Event type if detected, nil otherwise.
+        #   Symbol is on of :deleted, :modified, :accessed, :changed
+        #
+        def event_type(path)
+          return :deleted   if !path.exist?
+          return :modified  if  path.mtime > @reference_times[path][:mtime]
+          return :accessed  if  path.atime > @reference_times[path][:atime]
+          return :changed   if  path.ctime > @reference_times[path][:ctime]
+          nil
+        end
+
+        # Monitored paths within given dir
+        #
+        # @param [Pathname, String] dir
+        #
+        # @return [Array<Pathname>] monitored_paths
+        #
+        def monitored_paths_for(dir)
+          dir = Pathname(dir).expand_path
+          @paths.select {|path| path.dirname.expand_path == dir }
+        end
+
+        # Register watches for paths
+        #
+        # @param [Array<Pathname>] paths
+        #
+        # @return [undefined]
+        #
+        def register_paths(paths)
+          @paths = paths
+          watch_directories(dirs_for(@paths))
+          update_reference_times
+        end
+
+        # Directories for paths
+        #
+        # A unique list of directories containing given paths
+        #
+        # @param [Array<Pathname>] paths
+        #
+        # @return [Array<Pathname>] dirs
+        #
+        def dirs_for(paths)
+          paths.map {|path| path.dirname.to_s }.uniq
+        end
+
+        # Update reference times for registered paths
+        #
+        # @return [undefined]
+        #
+        def update_reference_times
+          @reference_times = {}
+          now = Time.now
+          @paths.each do |path|
+            @reference_times[path] = {}
+            @reference_times[path][:atime] = now
+            @reference_times[path][:mtime] = now
+            @reference_times[path][:ctime] = now
+          end
+        end
+    end
+  end
+end
+

data/test/event_handlers/test_darwin.rb

@@ -0,0 +1,111 @@
+require 'test/test_helper'
+
+if Watchr::HAVE_FSE
+
+class Watchr::EventHandler::Darwin
+  attr_accessor :paths
+
+  def start()   end #noop
+  def restart() end #noop
+
+  public :on_change, :registered_directories
+end
+
+class DarwinEventHandlerTest < MiniTest::Unit::TestCase
+  include Watchr
+
+  def tempfile(name)
+    file = Tempfile.new(name, @root.to_s)
+    Pathname(file.path)
+  ensure
+    file.close
+  end
+
+  def setup
+    @root = Pathname(Dir.mktmpdir("WATCHR_SPECS-"))
+
+    @now = Time.now
+    @handler = EventHandler::Darwin.new
+
+    @foo = tempfile('foo').expand_path
+    @bar = tempfile('bar').expand_path
+  end
+
+  def teardown
+    FileUtils.remove_entry_secure(@root.to_s)
+  end
+
+  test "listening triggers listening state" do
+    @handler.expects(:start)
+    @handler.listen([])
+  end
+
+  test "listens for events on monitored files" do
+    @handler.listen [ @foo, @bar ]
+    assert_includes @handler.paths, @foo
+    assert_includes @handler.paths, @bar
+  end
+
+  test "reattaches to new monitored files" do
+    @baz = tempfile('baz').expand_path
+    @bax = tempfile('bax').expand_path
+
+    @handler.listen [ @foo, @bar ]
+    assert_includes @handler.paths, @foo
+    assert_includes @handler.paths, @bar
+
+    @handler.refresh [ @baz, @bax ]
+    assert_includes @handler.paths, @baz
+    assert_includes @handler.paths, @bax
+    refute_includes @handler.paths, @foo
+    refute_includes @handler.paths, @bar
+  end
+
+  ## event types
+
+  test "deleted file event" do
+    @foo.stubs(:exist?).returns(false)
+
+    @handler.listen [ @foo, @bar ]
+    @handler.expects(:notify).with(@foo, :deleted)
+    @handler.on_change [@root]
+  end
+
+  test "modified file event" do
+    @foo.stubs(:mtime).returns(@now + 100)
+    @handler.expects(:notify).with(@foo, :modified)
+
+    @handler.listen [ @foo, @bar ]
+    @handler.on_change [@root]
+  end
+
+  test "accessed file event" do
+    @foo.stubs(:atime).returns(@now + 100)
+    @handler.expects(:notify).with(@foo, :accessed)
+
+    @handler.listen [ @foo, @bar ]
+    @handler.on_change [@root]
+  end
+
+  test "changed file event" do
+    @foo.stubs(:ctime).returns(@now + 100)
+    @handler.expects(:notify).with(@foo, :changed)
+
+    @handler.listen [ @foo, @bar ]
+    @handler.on_change [@root]
+  end
+
+  ## internal
+
+  test "registers directories" do
+    @handler.listen [ @foo, @bar ]
+
+    assert_equal @foo.dirname, @bar.dirname # make sure all tempfiles are in same dir
+    assert_equal 1, @handler.registered_directories.size
+    assert_includes @handler.registered_directories, @foo.dirname.to_s
+    assert_includes @handler.registered_directories, @bar.dirname.to_s
+  end
+end
+
+end  # if Watchr::HAVE_FSE
+

data/test/test_helper.rb

@@ -1,6 +1,7 @@
 require 'pathname'
+require 'tmpdir'
 require 'tempfile'
-require 'set'
+require 'fileutils'
 
 require 'minitest/autorun'
 require 'mocha'
@@ -30,3 +31,7 @@ unless Watchr::HAVE_REV
   puts "Skipping Unix handler tests. Install Rev (gem install rev) to properly test full suite"
 end
 
+unless Watchr::HAVE_FSE
+  puts "Skipping Darwin handler tests. Install FSEvent (gem install ruby-fsevent) to properly test full suite (osx only)"
+end
+

data/test/test_watchr.rb

@@ -35,12 +35,24 @@ class TestWatchr < MiniTest::Unit::TestCase
     assert_equal Watchr::EventHandler::Unix, Watchr.handler
 
     Watchr.handler = nil
-    ENV['HANDLER'] = 'darwin'
+    ENV['HANDLER'] = 'unix'
     assert_equal Watchr::EventHandler::Unix, Watchr.handler
 
+    end
+
+    if Watchr::HAVE_FSE
+
     Watchr.handler = nil
-    ENV['HANDLER'] = 'unix'
-    assert_equal Watchr::EventHandler::Unix, Watchr.handler
+    ENV['HANDLER'] = 'darwin'
+    assert_equal Watchr::EventHandler::Darwin, Watchr.handler
+
+    Watchr.handler = nil
+    ENV['HANDLER'] = 'osx'
+    assert_equal Watchr::EventHandler::Darwin, Watchr.handler
+
+    Watchr.handler = nil
+    ENV['HANDLER'] = 'fsevent'
+    assert_equal Watchr::EventHandler::Darwin, Watchr.handler
 
     end
 

data/watchr.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.bindir              = "bin"
   s.executables         = "watchr"
   s.version             =  Watchr::VERSION
-  s.files               =  File.read("Manifest").strip.split("\n")
+  s.files               =  `git ls-files`.strip.split("\n")
 
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'mocha'

metadata

@@ -1,7 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: watchr
 version: !ruby/object:Gem::Version 
-  version: "0.6"
+  prerelease: false
+  segments: 
+  - 0
+  - 7
+  version: "0.7"
 platform: ruby
 authors: 
 - mynyml
@@ -9,39 +13,45 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-10 00:00:00 -05:00
+date: 2010-08-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: minitest
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: every
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 description: Modern continious testing (flexible alternative to autotest).
 email: mynyml@gmail.com
 executables: 
@@ -54,7 +64,6 @@ files:
 - .gitignore
 - History.txt
 - LICENSE
-- Manifest
 - README.md
 - Rakefile
 - TODO.md
@@ -65,12 +74,14 @@ files:
 - lib/watchr.rb
 - lib/watchr/controller.rb
 - lib/watchr/event_handlers/base.rb
+- lib/watchr/event_handlers/darwin.rb
 - lib/watchr/event_handlers/portable.rb
 - lib/watchr/event_handlers/unix.rb
 - lib/watchr/script.rb
 - specs.watchr
 - test/README
 - test/event_handlers/test_base.rb
+- test/event_handlers/test_darwin.rb
 - test/event_handlers/test_portable.rb
 - test/event_handlers/test_unix.rb
 - test/test_controller.rb
@@ -91,18 +102,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: watchr
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Modern continious testing (flexible alternative to autotest)

data/Manifest

@@ -1,27 +0,0 @@
-.gitignore
-History.txt
-LICENSE
-Manifest
-README.md
-Rakefile
-TODO.md
-bin/watchr
-contributions.txt
-docs.watchr
-gem.watchr
-lib/watchr.rb
-lib/watchr/controller.rb
-lib/watchr/event_handlers/base.rb
-lib/watchr/event_handlers/portable.rb
-lib/watchr/event_handlers/unix.rb
-lib/watchr/script.rb
-specs.watchr
-test/README
-test/event_handlers/test_base.rb
-test/event_handlers/test_portable.rb
-test/event_handlers/test_unix.rb
-test/test_controller.rb
-test/test_helper.rb
-test/test_script.rb
-test/test_watchr.rb
-watchr.gemspec