wake 0.1.0

data/manifest.wk

@@ -0,0 +1,70 @@
+# Run me with:
+#
+#   $ wake -f manifest.wk
+#
+# This script will remove a file from from the Manifest when it gets deleted,
+# and will rebuild the Manifest on Ctrl-\
+#
+# Mostly serves as a demo for the :delete event type (and eventually for the
+# :added event type). In reality this is much better implemented as a git
+# post-commit script.
+#
+
+require 'pathname'
+# --------------------------------------------------
+# Helpers
+# --------------------------------------------------
+module Project
+  extend self
+  def files
+    `git ls-files --full-name`.strip.split($/).sort
+  end
+end
+
+class Manifest
+  attr_accessor :path
+
+  def initialize(path)
+    @path = Pathname(path).expand_path
+    create!
+  end
+
+  def remove(path)
+    paths = @path.read.strip.split($/)
+    @path.open('w') {|f| f << (paths - [path]).join("\n") }
+  end
+
+  def add(path)
+    paths = @path.read.strip.split($/)
+    @path.open('w') {|f| f << paths.push(path).sort.join("\n") }
+  end
+
+  private
+  def create!
+    File.open(@path.to_s, 'w') {} unless @path.exist?
+  end
+end
+
+
+@manifest = Manifest.new('Manifest')
+
+# --------------------------------------------------
+# Wake Rules
+# --------------------------------------------------
+watch('.*', :deleted ) do |md|
+  @manifest.remove(md[0])
+  puts "removed #{md[0].inspect} from Manifest"
+end
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Updated Manifest ---\n"
+  @manifest.path.open('w') {|m| m << Project.files.join("\n").strip }
+end
+
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }
+

data/specs.wk

@@ -0,0 +1,38 @@
+# Run me with:
+#
+#   $ wake -f specs.wk
+
+# --------------------------------------------------
+# Convenience Methods
+# --------------------------------------------------
+def run(cmd)
+  puts(cmd)
+  system(cmd)
+end
+
+def run_all_tests
+  # see Rakefile for the definition of the test:all task
+  system( "rake -s test:all VERBOSE=true" )
+end
+
+# --------------------------------------------------
+# Wake Rules
+# --------------------------------------------------
+watch( '^test.*/test_.*\.rb'                 )  { |m| run( "ruby -rubygems %s"                             % m[0] ) }
+watch( '^lib/(.*)\.rb'                       )  { |m| run( "ruby -rubygems test/test_%s.rb"                % m[1] ) }
+watch( '^lib/wake/(.*)\.rb'                )  { |m| run( "ruby -rubygems test/test_%s.rb"                % m[1] ) }
+watch( '^lib/wake/event_handlers/(.*)\.rb' )  { |m| run( "ruby -rubygems test/event_handlers/test_%s.rb" % m[1] ) }
+watch( '^test/test_helper\.rb'               )  { run_all_tests }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Running all tests ---\n\n"
+  run_all_tests
+end
+
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }
+

data/test/README

@@ -0,0 +1,11 @@
+
+To use local wake executable for dev work:
+
+  $ ruby -rubygems -Ilib ./bin/wake -d specs.wk
+
+To force a specific handler:
+
+  $ HANDLER=protable wake -d specs.wk
+  $ HANDLER=unix wake -d specs.wk
+
+  (see Wake.handler)

data/test/event_handlers/test_base.rb

@@ -0,0 +1,24 @@
+require 'test/test_helper'
+
+class BaseEventHandlerTest < Test::Unit::TestCase
+
+  class Handler
+    include Wake::EventHandler::Base
+  end
+
+  def setup
+    @handler = Handler.new
+  end
+
+  test "api" do
+    @handler.should respond_to(:notify)
+    @handler.should respond_to(:listen)
+    @handler.should respond_to(:refresh)
+    @handler.class.ancestors.should include(Observable)
+  end
+
+  test "notifies observers" do
+    @handler.expects(:notify_observers).with('foo/bar', nil)
+    @handler.notify('foo/bar', nil)
+  end
+end

data/test/event_handlers/test_em.rb

@@ -0,0 +1,162 @@
+require 'test/test_helper'
+
+if false && HAVE_EM
+
+class Wake::EventHandler::Unix::SingleFileWatcher
+  public :type
+end
+
+class UnixEventHandlerTest < Test::Unit::TestCase
+  include Wake
+
+  SingleFileWatcher = EventHandler::Unix::SingleFileWatcher
+
+  def setup
+    @now = Time.now
+    pathname = Pathname.new('foo/bar')
+    pathname.stubs(:atime ).returns(@now)
+    pathname.stubs(:mtime ).returns(@now)
+    pathname.stubs(:ctime ).returns(@now)
+    pathname.stubs(:exist?).returns(true)
+    SingleFileWatcher.any_instance.stubs(:pathname).returns(pathname)
+
+    @loop    = Rev::Loop.default
+    @handler = EventHandler::Unix.new
+    @watcher = SingleFileWatcher.new('foo/bar')
+    @loop.stubs(:run)
+  end
+
+  def teardown
+    SingleFileWatcher.handler = nil
+    Rev::Loop.default.watchers.every.detach
+  end
+
+  test "triggers listening state" do
+    @loop.expects(:run)
+    @handler.listen([])
+  end
+
+  ## SingleFileWatcher
+
+  test "watcher pathname" do
+    @watcher.pathname.should be_kind_of(Pathname)
+    @watcher.pathname.to_s.should be(@watcher.path)
+  end
+
+  test "stores reference times" do
+    @watcher.pathname.stubs(:atime).returns(:time)
+    @watcher.pathname.stubs(:mtime).returns(:time)
+    @watcher.pathname.stubs(:ctime).returns(:time)
+
+    @watcher.send(:update_reference_times)
+    @watcher.instance_variable_get(:@reference_atime).should be(:time)
+    @watcher.instance_variable_get(:@reference_mtime).should be(:time)
+    @watcher.instance_variable_get(:@reference_ctime).should be(:time)
+  end
+
+  test "stores initial reference times" do
+    SingleFileWatcher.any_instance.expects(:update_reference_times)
+    SingleFileWatcher.new('foo')
+  end
+
+  test "updates reference times on change" do
+    @watcher.expects(:update_reference_times)
+    @watcher.on_change
+  end
+
+  test "detects event type" do
+    trigger_event @watcher, @now, :atime
+    @watcher.type.should be(:accessed)
+
+    trigger_event @watcher, @now, :mtime
+    @watcher.type.should be(:modified)
+
+    trigger_event @watcher, @now, :ctime
+    @watcher.type.should be(:changed)
+
+    trigger_event @watcher, @now, :atime, :mtime
+    @watcher.type.should be(:modified)
+
+    trigger_event @watcher, @now, :mtime, :ctime
+    @watcher.type.should be(:modified)
+
+    trigger_event @watcher, @now, :atime, :ctime
+    @watcher.type.should be(:accessed)
+
+    trigger_event @watcher, @now, :atime, :mtime, :ctime
+    @watcher.type.should be(:modified)
+
+    @watcher.pathname.stubs(:exist?).returns(false)
+    @watcher.type.should be(:deleted)
+  end
+
+  ## monitoring file events
+
+  test "listens for events on monitored files" do
+    @handler.listen %w( foo bar )
+    @loop.watchers.size.should be(2)
+    @loop.watchers.every.path.should include('foo', 'bar')
+    @loop.watchers.every.class.uniq.should be([SingleFileWatcher])
+  end
+
+  test "notifies observers on file event" do
+    @watcher.stubs(:path).returns('foo')
+    @handler.expects(:notify).with('foo', anything)
+    @watcher.on_change
+  end
+
+  test "notifies observers of event type" do
+    trigger_event @watcher, @now, :atime
+    @handler.expects(:notify).with('foo/bar', :accessed)
+    @watcher.on_change
+
+    trigger_event @watcher, @now, :mtime
+    @handler.expects(:notify).with('foo/bar', :modified)
+    @watcher.on_change
+
+    trigger_event @watcher, @now, :ctime
+    @handler.expects(:notify).with('foo/bar', :changed)
+    @watcher.on_change
+
+    trigger_event @watcher, @now, :atime, :mtime, :ctime
+    @handler.expects(:notify).with('foo/bar', :modified)
+    @watcher.on_change
+
+    @watcher.pathname.stubs(:exist?).returns(false)
+    @handler.expects(:notify).with('foo/bar', :deleted)
+    @watcher.on_change
+  end
+
+  ## on the fly updates of monitored files list
+
+  test "reattaches to new monitored files" do
+    @handler.listen %w( foo bar )
+    @loop.watchers.size.should be(2)
+    @loop.watchers.every.path.should include('foo')
+    @loop.watchers.every.path.should include('bar')
+
+    @handler.refresh %w( baz bax )
+    @loop.watchers.size.should be(2)
+    @loop.watchers.every.path.should include('baz')
+    @loop.watchers.every.path.should include('bax')
+    @loop.watchers.every.path.should exclude('foo')
+    @loop.watchers.every.path.should exclude('bar')
+  end
+
+  private
+
+  def trigger_event(watcher, now, *types)
+    watcher.pathname.stubs(:atime).returns(now)
+    watcher.pathname.stubs(:mtime).returns(now)
+    watcher.pathname.stubs(:ctime).returns(now)
+    watcher.instance_variable_set(:@reference_atime, now)
+    watcher.instance_variable_set(:@reference_mtime, now)
+    watcher.instance_variable_set(:@reference_ctime, now)
+
+    types.each do |type|
+      watcher.pathname.stubs(type).returns(now+10)
+    end
+  end
+end
+
+end  # if Wake::HAVE_EM

data/test/event_handlers/test_portable.rb

@@ -0,0 +1,142 @@
+require 'test/test_helper'
+
+class Wake::EventHandler::Portable
+  attr_accessor :monitored_paths
+end
+
+class PortableEventHandlerTest < Test::Unit::TestCase
+  include Wake
+
+  def setup
+    @handler = EventHandler::Portable.new
+    @handler.stubs(:loop)
+
+    @foo = Pathname('foo').expand_path
+    @bar = Pathname('bar').expand_path
+    @baz = Pathname('baz').expand_path
+    @bax = Pathname('bax').expand_path
+
+    @now = Time.now
+    [@foo, @bar, @baz, @bax].each do |path|
+      path.stubs(:mtime ).returns(@now - 100)
+      path.stubs(:atime ).returns(@now - 100)
+      path.stubs(:ctime ).returns(@now - 100)
+      path.stubs(:exist?).returns(true)
+    end
+  end
+
+  test "triggers listening state" do
+    @handler.expects(:loop)
+    @handler.listen([])
+  end
+
+  ## monitoring file events
+
+  test "listens for events on monitored files" do
+    @handler.listen [ @foo, @bar ]
+    @handler.monitored_paths.should include(@foo)
+    @handler.monitored_paths.should include(@bar)
+  end
+
+  test "doesn't trigger on start" do
+  end
+
+  ## event types
+
+  test "deleted file event" do
+    @foo.stubs(:exist?).returns(false)
+
+    @handler.listen [ @foo, @bar ]
+    @handler.expects(:notify).with(@foo, :deleted)
+    @handler.trigger
+  end
+
+  test "modified file event" do
+    @foo.stubs(:mtime).returns(@now + 100)
+
+    @handler.listen [ @foo, @bar ]
+    @handler.expects(:notify).with(@foo, :modified)
+    @handler.trigger
+  end
+
+  test "accessed file event" do
+    @foo.stubs(:atime).returns(@now + 100)
+
+    @handler.listen [ @foo, @bar ]
+    @handler.expects(:notify).with(@foo, :accessed)
+    @handler.trigger
+  end
+
+  test "changed file event" do
+    @foo.stubs(:ctime).returns(@now + 100)
+
+    @handler.listen [ @foo, @bar ]
+    @handler.expects(:notify).with(@foo, :changed)
+    @handler.trigger
+  end
+
+  ## event type priorities
+
+  test "mtime > atime" do
+    @foo.stubs(:mtime).returns(@now + 100)
+    @foo.stubs(:atime).returns(@now + 100)
+    @foo.stubs(:ctime).returns(@now + 100)
+
+    @handler.listen [ @foo, @bar ]
+    @handler.expects(:notify).with(@foo, :modified)
+    @handler.trigger
+  end
+
+  test "mtime > ctime" do
+    @foo.stubs(:mtime).returns(@now + 100)
+    @foo.stubs(:ctime).returns(@now + 100)
+
+    @handler.listen [ @foo, @bar ]
+    @handler.expects(:notify).with(@foo, :modified)
+    @handler.trigger
+  end
+
+  test "atime > ctime" do
+    @foo.stubs(:atime).returns(@now + 100)
+    @foo.stubs(:ctime).returns(@now + 100)
+
+    @handler.listen [ @foo, @bar ]
+    @handler.expects(:notify).with(@foo, :accessed)
+    @handler.trigger
+  end
+
+  test "deleted > mtime" do
+    @foo.stubs(:exist?).returns(false)
+    @foo.stubs(:mtime ).returns(@now + 100)
+
+    @handler.listen [ @foo, @bar ]
+    @handler.expects(:notify).with(@foo, :deleted)
+    @handler.trigger
+  end
+
+  ## on the fly updates of monitored files list
+
+  test "reattaches to new monitored files" do
+    @handler.listen [ @foo, @bar ]
+    @handler.monitored_paths.should include(@foo)
+    @handler.monitored_paths.should include(@bar)
+
+    @handler.refresh [ @baz, @bax ]
+    @handler.monitored_paths.should include(@baz)
+    @handler.monitored_paths.should include(@bax)
+    @handler.monitored_paths.should exclude(@foo)
+    @handler.monitored_paths.should exclude(@bar)
+  end
+
+  test "retries on ENOENT errors" do
+    @oops = Pathname('oops').expand_path
+    @oops.stubs(:exist?).returns(true)
+    @oops.stubs(:mtime).raises(Errno::ENOENT).
+      then.returns(Time.now + 100)
+
+    @handler.listen [ @oops ]
+
+    @handler.expects(:notify).with(@oops, :modified)
+    @handler.trigger
+  end
+end