watchful 0.0.0.pre1 → 0.0.1.1

data/lib/watchful/paths.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'extensions/string'
 
 module Watchful

data/lib/watchful/watch.rb

@@ -12,15 +12,6 @@ module Watchful
 		end
 	end
 	
-	def self.check_for_interrupts
-		begin
-			sleep 1
-		rescue Interrupt
-			puts # new line
-			exit 0
-		end
-	end
-	
 	CONFIGURATION_FILE_NAME = 'watchful'
 	
 	def self.load_configuration(path, use_default = false)
@@ -32,49 +23,100 @@ module Watchful
 		user = File.expand_path("~/#{CONFIGURATION_FILE_NAME}")
 		
 		if File.exists? local
-			debug "Loading #{local}"
+			puts "=> Loading configuration #{local}"
 			load local
 		elsif File.exists? user
-			debug "Loading #{user}"
+			puts "=> Loading configuration #{user}"
 			load user
 		end
 		
 	end
 	
+	# If a tool returns an error code when running, don’t run the tool on the
+	# file again until the source file has been saved again. Otherwise the error
+	# will be repeated every time the errant source file is traversed.
 	@files_with_errors = Hash.new # {:path => '', :mtime => ### }
 	
-	def self.watch_files(path)
-		@output_file_extensions = Configuration.active_configuration.actions.collect do |a|
-			a.out
+	def self.watch_files(path, force_polling = false)
+		
+		if force_polling
+			use_fsevents = false
+		elsif RUBY_PLATFORM.include?('darwin') # todo: better check for OS fsevents support
+			begin
+				require 'fsevents'
+				use_fsevents = true
+			rescue LoadError
+				use_fsevents = false
+				puts
+				puts "*****************************************************************"
+				puts "* Using fsevents significantly improves Watchful’s performance. *"
+				puts "*                                                               *"
+				puts "*                      Install it with:                         *"
+				puts "*                                                               *"
+				puts "*                 sudo gem install fsevents                     *"
+				puts "*                                                               *"
+				puts "*****************************************************************"
+				puts
+			end
 		end
-		loop do
-			check_for_interrupts
-			each_source_file_in_dir(path) do |file_path|
-				extension = compound_extension_of(file_path)
+		
+		puts "... Watching #{path} ..."
+		
+		if use_fsevents # OS X filesystem events API
+			
+			begin
+			
+				fsevents_stream = FSEvents::Stream.watch(path) do |events|
+					events.modified_files.each do |file|
+						action = Configuration.active_configuration.action_for_file(file)
+						do_action(file, action) unless action.nil?
+					end
+				end
+				fsevents_stream.run
+				
+			rescue Interrupt
+				fsevents_stream.stop
+			end
+			
+		else # stat polling
+			
+			begin
+				loop do
+					check_for_interrupts
+					each_source_file_in_dir(path) do |file_path|
+						
+						extension = compound_extension_of(file_path)
+						
+						action = Configuration.active_configuration.action_for_file(file_path)
 				
-				action = Configuration.active_configuration.actions.find { |a| a.input_file? file_path}
+						next if action.nil?
 				
-				next if action.nil?
+						output_path = action.output_path_for(file_path)
 				
-				output_path = action.output_path_for(file_path)
+						if (!File.exists?(output_path)) or younger_than(file_path, output_path)
+							error_mtime = @files_with_errors[file_path]
+							next if error_mtime && error_mtime >= File.stat(file_path).mtime
+							do_action(file_path, action)
+						end
 				
-				if (!File.exists?(output_path)) or younger_than(file_path, output_path)
-					error_mtime = @files_with_errors[file_path]
-					next if error_mtime && error_mtime >= File.stat(file_path).mtime
-					do_action(file_path, action)
+					end
 				end
-				
+			rescue Interrupt
+				# pass
 			end
+			
 		end
+		
 	end
 	
+	# apply an action to a change file and post notifications
 	def self.do_action(source_file, action)
 
-		puts "#{action.name}: #{source_file}"
+		puts "! #{action.name}: #{source_file}"
 
 		command = action.command_string(source_file)
 		
-		debug "\t#{command}"
+		puts "!\t#{command}"
 		
 		proc_pid, proc_stdin, proc_stdout, proc_stderr = Open4::popen4(command)
 		proc_ignored, proc_status = Process::waitpid2(proc_pid)

data/test/unit/action_test.rb

@@ -0,0 +1,68 @@
+require "test/unit"
+
+require "watchful/action"
+
+class TestWatchfulAction < Test::Unit::TestCase
+	
+	def test_construction
+		assert_equal	Watchful::Action.new(:name => 'test', :out => '.out').enabled?,
+						false,
+						'Disable new action w/o @in'
+		assert_equal	Watchful::Action.new(:name => 'test', :in => '.in').enabled?,
+						false,
+						'Disable new action w/o @out'
+		assert_equal	Watchful::Action.new(:name => 'test', :in => '.in', :out => '.out').enabled?,
+						false,
+						'Disable new action w/o @command'
+		assert_equal	Watchful::Action.new(
+							:name => 'test', :in => '.in', :out => '.out',
+							:command => 'blargh %s %s', :dependencies => ['blargh']
+						).enabled?,
+						false,
+						'Disable new action w/ missing dependencies'
+		assert Watchful::Action.new(
+					:name => 'a', :in => ".in", :out => ".out", :command => "cat %s > %s"
+				),
+				'Successful creation'
+		assert_raise ArgumentError do
+			Watchful::Action.new :dependencies => Hash.new
+		end
+		assert Watchful::Action.new(
+					:name => 'a', :in => ".in", :out => ".out", :command => "cat %s > %s"
+				).enabled?,
+				'Complete action is enabled'
+		assert Watchful::Action.new(
+					:name => 'a', :in => ".in", :out => ".out"
+				).enabled? == false,
+				'Incomplete action is disabled'
+		assert Watchful::Action.new(
+					:name => 'a', :in => ".in", :command => "cat %s > %s"
+				).enabled? == false,
+				'Incomplete action is disabled'
+	end
+	
+	def test_have_command
+		assert Watchful::Action.have_command? 'cat'
+		assert Watchful::Action.have_command? 'echo'
+		assert Watchful::Action.have_command? 'less'
+		assert_equal (Watchful::Action.have_command? 'asdfjkasdf'), false
+	end
+	
+	def test_paths_computations
+		a = Watchful::Action.new	:name => "Test Action", 
+									:in => ".in", 
+									:out => ".out", 
+									:command => "cat %s > %s", 
+									:dependencies => ['cat']
+		assert a.input_file?('/test.in')
+		assert_equal a.input_file?('/test.blah'), false
+		assert a.output_file?('/test.out')
+		assert_equal a.output_file?('/test.blah'), false
+		assert_equal a.output_path_for('/tmp/test.in'), '/tmp/test.out'
+		assert_equal a.command_string('/tmp/test.in'), 'cat /tmp/test.in > /tmp/test.out'
+		assert_raise ArgumentError do
+			a.output_path_for('/test.someother')
+		end
+	end
+	
+end

data/test/unit/configuration_test.rb

@@ -0,0 +1,39 @@
+require "test/unit"
+
+require "watchful/configuration"
+
+class TestWatchfulConfiguration < Test::Unit::TestCase
+	
+	class FirstConf < Watchful::Configuration; action :name => 'Placeholder Action'; end
+
+	def test_action_added
+		assert FirstConf.actions.length == 1
+	end
+	
+	DESC = 'This is a test'
+	
+	class SecondTestConfiguration < Watchful::Configuration; description DESC; end
+	
+	def test_description
+		assert SecondTestConfiguration._description == DESC
+	end
+	
+	class ThirdConfig < Watchful::Configuration
+		action	:key => "First"
+		action	:name => "Second"
+	end
+	
+	def test_multiple_actions
+		assert ThirdConfig.actions.length == 2
+	end
+	
+	class FourthConfig < Watchful::Configuration
+		action :name => 'One', :in => ".one", :out => ".one.out", :command => "cat %s > %s" 
+		action :name => 'Two', :in => ".two", :out => ".two.out", :command => "cat %s > %s"
+	end
+	
+	def test_action_for_file
+		assert FourthConfig.action_for_file('test.two')
+	end
+	
+end

data/test/unit/paths_test.rb

@@ -0,0 +1,48 @@
+require "test/unit"
+
+require "watchful/paths"
+
+require "fileutils"
+
+class TestWatchfulPaths < Test::Unit::TestCase
+	
+	def setup
+		@testfiles = ['/tmp/a', '/tmp/b']
+		@testfiles.each do |f|
+			FileUtils.touch f
+		end
+	end
+	
+	def test_younger_than
+		
+		sleep 1
+		FileUtils.touch @testfiles[0]
+		assert Watchful.younger_than(@testfiles[0], @testfiles[1]), 'Compares mtimes'
+		
+		sleep 1
+		FileUtils.touch @testfiles[1]
+		assert Watchful.younger_than(@testfiles[1], @testfiles[0]), 'Compares mtimes'
+		
+		assert_raises Exception do
+			Watchful.younger_than(@testfiles[1], '/asdfasdf/asdfasdf')
+		end
+		
+		assert_raises Exception do
+			Watchful.younger_than('/asdfasdf/asdfasdf', @testfiles[1])
+		end
+		
+	end
+	
+	def test_compound_extension_of
+		
+		assert_equal Watchful.compound_extension_of('test.min.css'), '.min.css', 'Compound extension'
+		
+		assert_equal Watchful.compound_extension_of('test.css'), '.css', 'Simple extension'
+		
+		assert_nil Watchful.compound_extension_of('test'), 'File with no extension'
+		
+		assert_nil Watchful.compound_extension_of('.test'), '.profile type'
+		
+	end
+	
+end

data/test/unit/watch_test.rb

@@ -0,0 +1,81 @@
+require "test/unit"
+
+require "watchful/watch"
+
+require 'fileutils'
+
+class TestWatchfulWatch < Test::Unit::TestCase
+	
+	TMPDIR = '/tmp/watchfultest'
+		
+	def test_each_source_file_in_dir
+		
+		FileUtils.rm_r(TMPDIR) if File.directory?(TMPDIR)
+		
+		Dir.mkdir(TMPDIR)
+		
+		FileUtils.touch("#{TMPDIR}/a.txt")
+		FileUtils.touch("#{TMPDIR}/b.txt")
+		Dir.mkdir("#{TMPDIR}/subdir")
+		
+		found_files = []
+		
+		Watchful::each_source_file_in_dir(TMPDIR) { |f| found_files << f }
+		
+		assert found_files.include? "#{TMPDIR}/a.txt"
+		assert found_files.include? "#{TMPDIR}/b.txt"
+		assert_equal found_files.length, 2
+		
+		FileUtils.rm_r(TMPDIR)
+		
+	end
+	
+	USER_CONFIG = File.expand_path("~/#{Watchful::CONFIGURATION_FILE_NAME}")
+	USER_CONFIG_BACKUP = File.expand_path("~/#{Watchful::CONFIGURATION_FILE_NAME}.backup")
+	
+	def test_load_configuration
+		
+		# preserve existing user config file
+		replace_config = File.exists?(USER_CONFIG)
+		FileUtils.mv(USER_CONFIG, USER_CONFIG_BACKUP) if replace_config
+		
+		FileUtils.rm_r(TMPDIR) if File.directory?(TMPDIR)
+		Dir.mkdir(TMPDIR)
+		
+		Watchful::load_configuration(TMPDIR, false)
+		assert_equal Watchful::Configuration.active_configuration, Watchful::DefaultConfiguration
+		
+		
+		File.open("#{TMPDIR}/#{Watchful::CONFIGURATION_FILE_NAME}", 'w') do |f|
+			f.write <<-eos
+				class Conf < Watchful::Configuration
+					description 'the key'
+					action :name => 'test action'
+				end
+			eos
+		end
+		Watchful::load_configuration(TMPDIR, false)
+		assert_equal Watchful::Configuration.active_configuration._description, 'the key'
+		FileUtils.rm("#{TMPDIR}/#{Watchful::CONFIGURATION_FILE_NAME}")
+		
+		
+		File.open(USER_CONFIG, 'w') do |f|
+			f.write <<-eos
+				class Conf < Watchful::Configuration
+					description 'USER CONFIG'
+					action :name => 'an action'
+				end
+			eos
+		end
+		Watchful::load_configuration(TMPDIR, false)
+		assert_equal Watchful::Configuration.active_configuration._description, 'USER CONFIG'
+		FileUtils.rm(USER_CONFIG)
+		
+		FileUtils.rm_r(TMPDIR)
+		FileUtils.mv(USER_CONFIG_BACKUP, USER_CONFIG) if replace_config
+		
+	end
+	
+	# todo: find a way to temporarily disable gems while running unit tests
+	
+end

metadata

@@ -1,25 +1,25 @@
 --- !ruby/object:Gem::Specification 
 name: watchful
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 0
   - 0
-  - 0
-  - pre1
-  version: 0.0.0.pre1
+  - 1
+  - 1
+  version: 0.0.1.1
 platform: ruby
 authors: 
-- KEM
+- K E Mitchell
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-04-22 00:00:00 -05:00
+date: 2010-04-23 00:00:00 -05:00
 default_executable: watchful
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+  name: commandline
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
@@ -27,11 +27,13 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        version: "0"
-  type: :development
+        - 7
+        - 10
+        version: 0.7.10
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: commandline
+  name: extensions
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
@@ -39,33 +41,25 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        version: "0"
+        - 6
+        - 0
+        version: 0.6.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: extensions
+  name: open4
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 1
         - 0
-        version: "0"
+        - 1
+        version: 1.0.1
   type: :runtime
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: open4
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id004
 description: Applies intermediary tools to modified files
 email: kyleevanmitchell@gmail.com
 executables: 
@@ -76,25 +70,23 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files: 
+- .autotest
 - .gitignore
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
 - bin/watchful
-- doc/DSL-Specification.rb
 - lib/watchful.rb
 - lib/watchful/action.rb
 - lib/watchful/configuration.rb
 - lib/watchful/defaultconfiguration.rb
 - lib/watchful/paths.rb
 - lib/watchful/watch.rb
-- test/action_test.rb
-- test/configuration_test.rb
-- test/customconfiguration_test.rb
-- test/paths_test.rb
-- test/test_helper.rb
-- watchful.gemspec
+- test/unit/action_test.rb
+- test/unit/configuration_test.rb
+- test/unit/paths_test.rb
+- test/unit/watch_test.rb
 has_rdoc: true
 homepage: http://github.com/kemitchell/watchful
 licenses: []
@@ -113,13 +105,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: watchful
@@ -128,8 +118,7 @@ signing_key:
 specification_version: 3
 summary: Watchful, a tool for busy web devs
 test_files: 
-- test/action_test.rb
-- test/configuration_test.rb
-- test/customconfiguration_test.rb
-- test/paths_test.rb
-- test/test_helper.rb
+- test/unit/action_test.rb
+- test/unit/configuration_test.rb
+- test/unit/paths_test.rb
+- test/unit/watch_test.rb