watchr 0.5.5 → 0.5.6

data/README.rdoc

@@ -101,4 +101,6 @@ bugs::   http://github.com/mynyml/watchr/issues
 
 === Acknowledgement
 
-* Thanks to macournoyer[http://github.com/macournoyer] for the evented backend idea
+* macournoyer[http://github.com/macournoyer] for the evented backend idea
+* foca[http://github.com/foca] for suggesting automatically picking up watchr
+  scripts bundled in gems

data/Rakefile

@@ -23,3 +23,27 @@ if defined? YARD
     t.options = %w( -o doc/yard --readme README.rdoc --files LICENSE,TODO.txt )
   end
 end
+
+namespace(:test) do
+
+  desc "Run all tests"
+  task(:all) do
+    tests = Dir['test/**/test_*.rb'] - ['test/test_helper.rb']
+    cmd = "ruby -rubygems -Ilib -e'%w( #{tests.join(' ')} ).each {|file| require file }'"
+    puts cmd if ENV['VERBOSE']
+    system cmd
+  end
+
+  desc "Run all tests on multiple ruby versions (requires rvm with 1.8.6 and 1.8.7)"
+  task(:portability) do
+    versions = %w( 1.8.6  1.8.7 )
+    versions.each do |version|
+      system <<-BASH
+        bash -c 'source ~/.rvm/scripts/rvm;
+                 rvm use #{version};
+                 echo "--------- `ruby -v` ----------\n";
+                 rake -s test:all'
+      BASH
+    end
+  end
+end

data/TODO.txt

@@ -1,6 +1,5 @@
 
-* refactor Script#parse!
-  * only accept paths in initialize?
+* 1.9 compatibility
 
 * sometimes an action is fired without a file being saved
   * buffer flushing issue?
@@ -10,7 +9,8 @@
   * seems like rev/libev drops the file watch
 
 * test on other platforms
-  * mswin
+  x mswin
+  x cygwin
   * bsd
   * osx
   * solaris
@@ -21,6 +21,7 @@
   * post main links in readme
 
 * eval script within own context?
+  * use case: using <tt>path</tt> within script accesses Script#path
 
 * respond to different file events?
   * modified
@@ -28,5 +29,10 @@
   * deleted
   * etc.
   * watch(pattern, EVENT, &action)
+  * use case: a script updates a manifest file when a file is deleted
 
 * memory profiling / benchmarks
+
+* version.watchr
+  * sync versions (gemspec & Watchr::VERSION)
+

data/bin/watchr

@@ -5,15 +5,56 @@ require 'optparse'
 
 require 'watchr'
 
-def usage
-  "Usage: watchr [opts] path/to/script"
-end
-def version
-  "watchr version: %s" % Watchr::VERSION
+module Watchr
+  # Namespaced to avoid defining global methods
+  module Bin #:nodoc:
+    extend self
+
+    def usage
+      "Usage: watchr [opts] path/to/script"
+    end
+
+    def version
+      "watchr version: %s" % Watchr::VERSION
+    end
+
+    # Find a partial path name in load path
+    #
+    # ===== Params
+    # path<Pathname>:: partial pathname
+    #
+    # ===== Returns
+    # <Pathname>::
+    #   absolute path of first occurence of partial path in load path, or nil if not found
+    #
+    def find_in_load_path(path)
+      dir = potentially_with_gem( path.basename('.watchr') ) do
+        $LOAD_PATH.detect {|p| Pathname(p).join(path).exist? }
+      end
+      dir ? path.expand_path(dir) : nil
+    end
+
+    private
+
+    # If the block returns nil, requires gem <tt>name</tt> and tries running the
+    # block again. If all fails, returns nil
+    #
+    # ===== Params
+    # name<Pathname,String>:: name of gem to require
+    #
+    # ===== Returns
+    # block's value or nil if gem <tt>name</tt> doesn't exist
+    #
+    def potentially_with_gem(name)
+      yield || (require(name) && yield)
+    rescue LoadError
+      nil
+    end
+  end
 end
 
 opts = OptionParser.new do |opts|
-  opts.banner = usage
+  opts.banner = Watchr::Bin.usage
 
   opts.on('-d', '--debug', "Print extra debug info while program runs") {
     Watchr.options.debug = true
@@ -23,16 +64,14 @@ opts = OptionParser.new do |opts|
     end
   }
 
-  opts.on_tail('-h', '--help', "Print inline help") { puts opts;    exit }
-  opts.on_tail('-v', '--version', "Print version" ) { puts version; exit }
+  opts.on_tail('-h', '--help', "Print inline help") { puts opts; exit }
+  opts.on_tail('-v', '--version', "Print version" ) { puts Watchr::Bin.version; exit }
 
   opts.parse! ARGV
 end
 
-abort(usage) unless ARGV.first
-
-file = Pathname(ARGV.first).expand_path
-abort(%|no script found; file "#{file.to_s}" doesn't exist.|) unless file.exist?
+relative_path = Pathname( ARGV.first )                   rescue abort(Watchr::Bin.usage)
+absolute_path = Watchr::Bin.find_in_load_path(relative_path) or abort("no script found; file #{relative_path.to_s.inspect} is not in path.")
 
-Watchr::Controller.new(Watchr::Script.new(file), Watchr.handler.new).run
+Watchr::Controller.new(Watchr::Script.new(absolute_path), Watchr.handler.new).run
 

data/lib/watchr.rb

@@ -13,16 +13,23 @@ require 'rbconfig'
 # See README for more details
 #
 module Watchr
+  begin
+    require 'rev'
+    HAVE_REV = true
+  rescue LoadError, RuntimeError
+    HAVE_REV = false
+  end
+
   autoload :Script,     'watchr/script'
   autoload :Controller, 'watchr/controller'
 
   module EventHandler
     autoload :Base,     'watchr/event_handlers/base'
-    autoload :Unix,     'watchr/event_handlers/unix'
+    autoload :Unix,     'watchr/event_handlers/unix' if ::Watchr::HAVE_REV
     autoload :Portable, 'watchr/event_handlers/portable'
   end
 
-  VERSION = '0.5.5'
+  VERSION = '0.5.6'
 
   class << self
     attr_accessor :options
@@ -69,9 +76,6 @@ module Watchr
 
     # Detect current OS and return appropriate handler.
     #
-    # NOTE temporarily returns Portable handler for all platforms, until
-    # issue #1 is fixed
-    #
     # ===== Examples
     #
     #   Config::CONFIG['host_os'] #=> 'linux-gnu'
@@ -95,10 +99,10 @@ module Watchr
           when /mswin|windows|cygwin/i
             Watchr::EventHandler::Portable
           when /sunos|solaris|darwin|mach|osx|bsd|linux/i, 'unix'
-            begin
-              require 'rev'
+            if ::Watchr::HAVE_REV
               Watchr::EventHandler::Unix
-            rescue LoadError, RuntimeError
+            else
+              Watchr.debug "rev not found. `gem install rev` to get evented handler"
               Watchr::EventHandler::Portable
             end
           else

data/lib/watchr/event_handlers/unix.rb

@@ -1,5 +1,3 @@
-require 'rev'
-
 module Watchr
   module EventHandler
     class Unix

data/lib/watchr/script.rb

@@ -23,23 +23,16 @@ module Watchr
     class API #:nodoc:
     end
 
-    # Creates a script object for <tt>file</tt>.
+    # Creates a script object for <tt>path</tt>.
     #
     # Will also immediatly parse the script so it is ready to be passed to a
     # controller.
     #
     # ===== Parameters
-    # file<Pathname>:: the path to the script
+    # path<Pathname>:: the path to the script
     #
-    # ===== TODO
-    # * only accept Pathname/String
-    #
-    #--
-    # see issue with #parse!
-    # (update class example when fixed)
-    #
-    def initialize(file = StringIO.new)
-      @file  = file
+    def initialize(path)
+      @path  = path
       @rules = []
       @default_action = lambda {}
       parse!
@@ -113,19 +106,23 @@ module Watchr
 
     # Eval content of script file.
     #--
-    # TODO @file.read will only work with Pathname objects!
     # TODO fix script file not found error
     def parse!
-      Watchr.debug('loading script file %s' % @file.to_s.inspect)
+      Watchr.debug('loading script file %s' % @path.to_s.inspect)
 
-      @rules.clear
-      instance_eval(@file.read)
+      reset
+      instance_eval(@path.read)
 
     rescue Errno::ENOENT
       # TODO figure out why this is happening. still can't reproduce
       Watchr.debug('script file "not found". wth')
       sleep(0.3) #enough?
-      instance_eval(@file.read)
+      instance_eval(@path.read)
+    end
+
+    def reset
+      @default_action = lambda {}
+      @rules.clear
     end
 
     # Find an action corresponding to a path. The returned action is actually a
@@ -159,7 +156,7 @@ module Watchr
     # path<Pathname>:: path to script file
     #
     def path
-      Pathname(@file.respond_to?(:to_path) ? @file.to_path : @file.to_s).expand_path
+      Pathname(@path.respond_to?(:to_path) ? @path.to_path : @path.to_s).expand_path
     end
 
     private

data/specs.watchr

@@ -5,18 +5,14 @@
 # --------------------------------------------------
 # Convenience Methods
 # --------------------------------------------------
-def all_test_files
-  Dir['test/**/test_*.rb'] - ['test/test_helper.rb']
-end
-
 def run(cmd)
   puts(cmd)
   system(cmd)
 end
 
 def run_all_tests
-  cmd = "ruby -rubygems -Ilib -e'%w( #{all_test_files.join(' ')} ).each {|file| require file }'"
-  run(cmd)
+  # see Rakefile for the definition of the test:all task
+  system( "rake -s test:all VERBOSE=true" )
 end
 
 # --------------------------------------------------
@@ -24,6 +20,7 @@ end
 # --------------------------------------------------
 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/watchr/(.*)\.rb'                )  { |m| run( "ruby -rubygems test/test_%s.rb"                % m[1] ) }
 watch( '^lib/watchr/event_handlers/(.*)\.rb' )  { |m| run( "ruby -rubygems test/event_handlers/test_%s.rb" % m[1] ) }
 watch( '^test/test_helper\.rb'               )  { run_all_tests }
 
@@ -39,5 +36,3 @@ end
 # Ctrl-C
 Signal.trap('INT') { abort("\n") }
 
-
-# vim:ft=ruby

data/test/event_handlers/test_unix.rb

@@ -1,3 +1,5 @@
+if Watchr::HAVE_REV
+
 require 'test/test_helper'
 
 class UnixEventHandlerTest < Test::Unit::TestCase
@@ -54,3 +56,5 @@ class UnixEventHandlerTest < Test::Unit::TestCase
     @loop.watchers.every.path.should exclude('bar')
   end
 end
+
+end  # if Watchr::HAVE_REV

data/test/test_controller.rb

@@ -15,7 +15,8 @@ class TestController < Test::Unit::TestCase
   end
 
   def setup
-    @script     = Script.new
+    tmpfile     = Tempfile.new('foo')
+    @script     = Script.new( Pathname.new( tmpfile.path ) )
     @handler    = MockHandler.new
     @controller = Controller.new(@script, @handler)
   end
@@ -41,10 +42,9 @@ class TestController < Test::Unit::TestCase
       b/c
       b/c/y.z
     ))
-    script = Script.new
-    script.watch('.\.z') { :x }
+    @script.watch('.\.z') { :x }
 
-    contrl = Controller.new(script, MockHandler.new)
+    contrl = Controller.new(@script, MockHandler.new)
     contrl.monitored_paths.should include(to_p('b/x.z'))
     contrl.monitored_paths.should include(to_p('b/c/y.z'))
   end
@@ -56,10 +56,9 @@ class TestController < Test::Unit::TestCase
       b/c
       b/c/y.z
     ))
-    script = Script.new
-    script.watch('.\.z') { :x }
+    @script.watch('.\.z') { :x }
 
-    contrl = Controller.new(script, MockHandler.new)
+    contrl = Controller.new(@script, MockHandler.new)
     contrl.monitored_paths.should exclude(to_p('a'))
     contrl.monitored_paths.should exclude(to_p('b/c'))
     contrl.monitored_paths.should exclude(to_p('p/q.z'))

data/test/test_helper.rb

@@ -1,5 +1,7 @@
 require 'pathname'
+require 'tempfile'
 require 'test/unit'
+
 require 'matchy'
 require 'mocha'
 require 'every'

data/test/test_script.rb

@@ -3,63 +3,79 @@ require 'test/test_helper'
 class TestScript < Test::Unit::TestCase
   include Watchr
 
+  def setup
+    tmpfile = Tempfile.new('foo')
+    @script = Script.new( Pathname.new( tmpfile.path ) )
+  end
+
   ## external api
 
   test "watch" do
-    Script.new.watch('pattern')
-    Script.new.watch('pattern') { nil }
+    @script.watch('pattern')
+    @script.watch('pattern') { nil }
   end
 
   test "default action" do
-    Script.new.default_action { nil }
+    @script.default_action { nil }
   end
 
   ## functionality
 
   test "rule object" do
-    rule = Script.new.watch('pattern') { nil }
+    rule = @script.watch('pattern') { nil }
     rule.pattern.should be('pattern')
     rule.action.call.should be(nil)
   end
 
   test "finds action for path" do
-    script = Script.new
-    script.watch('abc') { :x }
-    script.watch('def') { :y }
-    script.action_for('abc').call.should be(:x)
+    @script.watch('abc') { :x }
+    @script.watch('def') { :y }
+    @script.action_for('abc').call.should be(:x)
   end
 
   test "collects patterns" do
-    script = Script.new
-    script.watch('abc')
-    script.watch('def')
-    script.patterns.should include('abc')
-    script.patterns.should include('def')
+    @script.watch('abc')
+    @script.watch('def')
+    @script.patterns.should include('abc')
+    @script.patterns.should include('def')
   end
 
   test "parses script file" do
-    file = StringIO.new(<<-STR)
+    file = Pathname( Tempfile.open('bar').path )
+    file.open('w') {|f| f.write <<-STR }
       watch( 'abc' ) { :x }
     STR
     script = Script.new(file)
     script.action_for('abc').call.should be(:x)
   end
 
+  test "resets state" do
+    @script.default_action { 'x' }
+    @script.watch('foo') { 'bar' }
+    @script.reset
+    @script.instance_variable_get(:@default_action).should be_kind_of(Proc)
+    @script.instance_variable_get(:@default_action).call.should be(nil)
+    @script.instance_variable_get(:@rules).should be([])
+  end
+
+  test "resets state on parse" do
+    @script.stubs(:instance_eval)
+    @script.expects(:reset)
+    @script.parse!
+  end
+
   test "actions receive a MatchData object" do
-    script = Script.new
-    script.watch('de(.)') {|m| [m[0], m[1]] }
-    script.action_for('def').call.should be(%w( def f ))
+    @script.watch('de(.)') {|m| [m[0], m[1]] }
+    @script.action_for('def').call.should be(%w( def f ))
   end
 
   test "rule's default action" do
-    script = Script.new
-
-    script.watch('abc')
-    script.action_for('abc').call.should be(nil)
-    script.default_action { :x }
+    @script.watch('abc')
+    @script.action_for('abc').call.should be(nil)
+    @script.default_action { :x }
 
-    script.watch('def')
-    script.action_for('def').call.should be(:x)
+    @script.watch('def')
+    @script.action_for('def').call.should be(:x)
   end
 
   test "file path" do
@@ -70,19 +86,15 @@ class TestScript < Test::Unit::TestCase
   end
 
   test "later rules take precedence" do
-    script = Script.new
+    @script.watch('a/(.*)\.x')   { :x }
+    @script.watch('a/b/(.*)\.x') { :y }
 
-    script.watch('a/(.*)\.x')   { :x }
-    script.watch('a/b/(.*)\.x') { :y }
-
-    script.action_for('a/b/c.x').call.should be(:y)
+    @script.action_for('a/b/c.x').call.should be(:y)
   end
 
   test "rule patterns match against paths relative to pwd" do
-    script = Script.new
-
-    script.watch('^abc') { :x }
+    @script.watch('^abc') { :x }
     path = Pathname(Dir.pwd) + 'abc'
-    script.action_for(path).call.should be(:x)
+    @script.action_for(path).call.should be(:x)
   end
 end

data/test/test_watchr.rb

@@ -26,19 +26,19 @@ class TestWatchr < Test::Unit::TestCase
 
     Watchr.handler = nil
     ENV['HANDLER'] = 'linux'
-    Watchr.handler.should be(Watchr::EventHandler::Unix)
+    Watchr.handler.should be(Watchr::HAVE_REV ? Watchr::EventHandler::Unix : Watchr::EventHandler::Portable)
 
     Watchr.handler = nil
     ENV['HANDLER'] = 'bsd'
-    Watchr.handler.should be(Watchr::EventHandler::Unix)
+    Watchr.handler.should be(Watchr::HAVE_REV ? Watchr::EventHandler::Unix : Watchr::EventHandler::Portable)
 
     Watchr.handler = nil
     ENV['HANDLER'] = 'darwin'
-    Watchr.handler.should be(Watchr::EventHandler::Unix)
+    Watchr.handler.should be(Watchr::HAVE_REV ? Watchr::EventHandler::Unix : Watchr::EventHandler::Portable)
 
     Watchr.handler = nil
     ENV['HANDLER'] = 'unix'
-    Watchr.handler.should be(Watchr::EventHandler::Unix)
+    Watchr.handler.should be(Watchr::HAVE_REV ? Watchr::EventHandler::Unix : Watchr::EventHandler::Portable)
 
     Watchr.handler = nil
     ENV['HANDLER'] = 'mswin'

data/watchr.gemspec

@@ -1,7 +1,7 @@
 
 Gem::Specification.new do |s|
   s.name              = 'watchr'
-  s.version           = '0.5.5'
+  s.version           = '0.5.6'
   s.summary           = "Modern continious testing (flexible alternative to autotest)"
   s.description       = "Modern continious testing (flexible alternative to autotest)."
   s.author            = "mynyml"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: watchr
 version: !ruby/object:Gem::Version 
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors: 
 - mynyml
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-25 00:00:00 -04:00
+date: 2009-09-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency