watchful 0.0.0.pre1 → 0.0.1.1

data/.autotest

@@ -0,0 +1,7 @@
+require 'autotest/fsevent'
+require 'autotest/growl'
+require 'redgreen/autotest'
+
+module Autotest::Growl
+	@@clear_terminal = false
+end

data/.gitignore

@@ -1,3 +1,6 @@
 .DS_Store
 pkg/*
 pkg
+coverage/*
+coverage
+*.gemspec

data/README.md

@@ -6,60 +6,69 @@ A shell script for busy web developers
 What?
 -----
 
-Watchful is a lightweight tool that runs command line tools on updated files. It was built by a web developer who got seriously tired of managing a whole range of CLI minification, translation, and compression tools on his CSS and Javascript.
+Watchful is a lightweight tool that runs command line tools on updated files. It was built by a web developer who got seriously tired of managing a whole range of CLI minification, translation, and compression tools on his CSS, Javascript, PNGs, etc.
 
-You can think of Watchful as kind of recursive, specialized [Rake](http://rake.rubyforge.org/): you tell it which tools to run on which files, then fire it off in your current project directory and go back to your text editor. When you save a change to a relevant file under that directory, Watchful will run the proper tool on it. If you are on OS X and have [Growl](http://growl.info/) installed, you’ll get a notification.
+You can think of Watchful as kind of recursive, constantly-running [Rake](http://rake.rubyforge.org/): you tell it which tools to run on which files, then fire it off in your current project directory and go back to your text editor. When you save a change to a relevant file under that directory, Watchful will run the proper tool on it. If you have [Growl](http://growl.info/) installed, you’ll get a notification. If you’re on OS X Leopard and have [the FSEvents gem](http://rubygems.org/gems/fsevents) installed, you’ll get a rather nice performance to boot.
 
 Where?
 ------
 
-Watchful is currently hosted on [GitHub](http://github.com):
+Watchful is available as a Gem:
+	
+    sudo gem install watchful
+
+The development git repo is currently hosted on [GitHub](http://github.com):
 
 [http://github.com/kemitchell/watchful](http://github.com/kemitchell/watchful)
 
 Please feel free to fork me!
-	
-Eventually, Watchful will be available as a Ruby Gem:
-	
-    sudo gem install watchful
 
+To install the latest from GitHub:
+
+    cd /tmp
+    git clone git://github.com/kemitchell/watchful.git
+    cd watchful
+    rake build
+    sudo rake install
+	
 How?
 ----
 
-All configuration is done in pure Ruby. Configurations are created by subclassing `Watchful::Configuration` in “watchful” files. An example follows:
+All configuration is done in pure Ruby. Configurations are created by subclassing `Watchful::Configuration` in `watchful` files. Configurations contain `action` lines which describe CLI commands, the extension of the files they should be run on, and the extension that should be used for the resulting output. An example follows:
 
+    require 'rubygems'
     require 'watchful/configuration'
-
+    
     class MyConfiguration < Watchful::Configuration
-    	
-    	description 'LESS CSS and YUI Compressor'
-    	
-    	# actions are applied in order, hence Less is defined before YUI
-    	
-    	action	:name => "Less CSS", 
-    			:in => ".less",				# The extension of files to use as input
-    			:out => ".css",				# Extension to replace the above for output files
-    			:command => "lessc %s %s",	# The command to create output files from input files
-    										# Currently the command is built using sprintf.
-    										# In the future all of the above will also take blocks.
-    										# For now, the first %s is the full input path,
-    										# and the second the full output path.
-    			:dependencies => ['less']	# If “less” isn’t found in PATH, this action will be disabled.
-    	
-    	action	:name => 'YUI Compressor',
-    			:in => '.css',
-    			:out => '.min.css',			# Notice that Watchful computers extensions differently than basename
-    										# Namely, the extension is anything in the file name from the
-    										# first period onward.
-    			:command => 'java -jar /usr/local/utils/yuicompressor-2.4.2.jar --type css --charset utf-8 %s -o %s',
-    			:dependencies => ['java', '/usr/local/utils/yuicompressor-2.4.2.jar']
-    										# Dependencies can be programs (e.g. “java”), or full file paths.
-    	
+        
+        description 'LESS CSS and YUI Compressor'
+        
+        # actions are applied in order, hence Less is defined before YUI
+        
+        action  :name => "Less CSS",        # Used for command line and Growl notifications
+                :in => ".less",             # The extension of files to use as input
+                :out => ".css",             # Extension to replace the above for output files
+                :command => "lessc %s %s",  # The command to create output files from input files
+                                            # In the future all of the above will also take blocks.
+                                            # Currently the command is built using sprintf.
+                                            # The first %s is the full input path.
+                                            # The second %s is the full output path.
+                :dependencies => ['less']   # If “less” isn’t found in PATH, this action will be disabled.
+        
+        action  :name => 'YUI Compressor',
+                :in => '.css',
+                :out => '.min.css',         # Notice that Watchful computes extensions differently than basename
+                                            # Namely, the extension is anything in the file name from the
+                                            # first period onward, hence this.big.ext.name => '.big.ext.name'
+                :command => 'java -jar /usr/local/utils/yuicompressor-2.4.2.jar --type css --charset utf-8 %s -o %s',
+                :dependencies => ['java', '/usr/local/utils/yuicompressor-2.4.2.jar']
+                                            # Dependencies can be programs (e.g. “java”), or full file paths.
+        
     end
 
-When Watchful is started, it searches in the following locations (in the following order) for files called “watchful” and loads them:
+When Watchful is started, it searches in the following locations (in the following order) for files called `watchful` and loads them:
 
 1. In the directory Watchful is told to monitor
 2. In the current user’s home directory
 
-If no such files are found, Watchful will use the default configuration, which searches your PATH for tools it recognizes. If your tool isn't listed in [http://github.com/kemitchell/watchful/blob/master/lib/watchful/defaultconfiguration.rb](defaultconfiguration.rb) and you would like it to be, please fork the project on github or send me a patch. I would be happy to include any tools with current stable or Beta releases.
+If no such files are found, Watchful will use the default configuration, which searches your PATH for tools it recognizes. If your tool isn't listed in [http://github.com/kemitchell/watchful/blob/master/lib/watchful/defaultconfiguration.rb](defaultconfiguration.rb) and you would like it to be, please fork the project or send me a patch. I would be happy to include any web development tools with current stable or Beta releases.

data/Rakefile

@@ -9,38 +9,36 @@ begin
 		gem.description = 'Applies intermediary tools to modified files'
 		gem.email = "kyleevanmitchell@gmail.com"
 		gem.homepage = "http://github.com/kemitchell/watchful"
-		gem.authors = ["KEM"]
-		gem.add_development_dependency "thoughtbot-shoulda"
-		gem.add_dependency('commandline')
-		gem.add_dependency('extensions')
-		gem.add_dependency('open4')
+		gem.authors = ["K E Mitchell"]
+		gem.add_dependency('commandline', '>= 0.7.10')
+		gem.add_dependency('extensions', '>= 0.6.0')
+		gem.add_dependency('open4', '>= 1.0.1')
 		gem.rubyforge_project = 'watchful'
 	end
 	Jeweler::RubyforgeTasks.new do |rubyforge|
-		rubyforge.doc_task = 'watchful'
+		rubyforge.doc_task = 'rdoc'
 	end
 rescue LoadError
 	puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-Jeweler::RubyforgeTasks.new do |rf|
-	rf.doc_task = 'rdoc'
-end
-
 require 'rake/testtask'
 
+TEST_FILE_PATTERN = 'test/unit/*_test.rb'
+
 Rake::TestTask.new(:test) do |test|
 	test.libs << 'lib' << 'test'
-	test.pattern = 'test/**/*_test.rb'
+	test.pattern = TEST_FILE_PATTERN
 	test.verbose = true
 end
 
 begin
 	require 'rcov/rcovtask'
-	Rcov::RcovTask.new do |test|
-		test.libs << 'test'
-		test.pattern = 'test/**/*_test.rb'
-		test.verbose = true
+	Rcov::RcovTask.new do |t|
+		t.libs << 'lib' << 'test'
+		t.test_files = FileList[TEST_FILE_PATTERN]
+		t.verbose = true
+		t.rcov_opts << '--exclude gems'
 	end
 rescue LoadError
 	task :rcov do
@@ -48,10 +46,6 @@ rescue LoadError
 	end
 end
 
-task :test => :check_dependencies
-
-task :default => [:test, :build]
-
 require 'rake/rdoctask'
 
 Rake::RDocTask.new do |rdoc|
@@ -66,3 +60,7 @@ Rake::RDocTask.new do |rdoc|
 	rdoc.rdoc_files.include('README*')
 	rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+task :test => :check_dependencies
+
+task :default => :test

data/VERSION

@@ -1 +1 @@
-0.0.0.pre1
+0.0.1.1

data/bin/watchful

@@ -6,19 +6,8 @@ require 'rubygems'
 require 'commandline'
 require 'watchful'
 
-begin
-	require 'growl' # OS X notifications
-rescue LoadError
- 	HAVE_GROWL = false
-else
-	if (Growl.installed? rescue false)		
-		HAVE_GROWL = true
-	else
-		HAVE_GROWL = false
-	end
-end
-
-class App < CommandLine::Application
+class App < CommandLine::Application_wo_AutoRun
+	
 	def initialize
 		version Watchful::version
 		author 'KEM'
@@ -28,33 +17,46 @@ class App < CommandLine::Application
 			A configurable deamon for running source code translation and minification tools–
 			such as CSS and Javascript minification tools and generators—on updated files.
 		eos
-		synopsis "[-dhv] path"
+		synopsis "[-dhv] [--default] [--poll] path"
 		option :help
 		option :debug
 		option :version
-		option :names => %w{--use-default-configuration --default},
-			:opt_found => get_args,
-			:opt_description => 'Use the default configuration even if a local or user-level configuration is found.'
+		option	:flag,
+				:names => %w{--use-default-configuration --default -D},
+				:opt_description => 'Override custom configurations.'
+		option	:flag,
+				:names => %w{--force-polling --poll -P},
+				:opt_description => 'Use stat() polling, even if filesystem events are supported.'
 		expected_args :path
 	end
+	
 	def main
-		Watchful::Configuration.active_configuration = Watchful::DefaultConfiguration
-		# todo: check dependencies of actions of active configuration
-		
 		path = File.expand_path(args[0])
-		fail "No such directory: #{path} " unless File.directory? path
+		fail "? No such directory: #{path} " unless File.directory? path
 		
 		Watchful::load_configuration(path, opt['--use-default-configuration'])
 		
 		# show the active config
-		debug "Config: " + Watchful::Configuration.active_configuration._description
+		puts "=> " + Watchful::Configuration.active_configuration._description
 		
 		# list active actions
 		Watchful::Configuration.active_configuration.actions.each do |a|
-			debug "Action: \t#{a.name} (#{a.in} -> #{a.out})"
+			puts "=>\t+ #{a.name} (#{a.in} -> #{a.out})"
 		end
 		
-		puts "Watching #{Dir.pwd}..."
-		Watchful::watch_files(path)
+		begin
+			Watchful::watch_files(path, opt['--force-polling'])
+		rescue Exception => e
+			if HAVE_GROWL
+				growl = Growl.new
+		        growl.title = "GOING DOWN"
+		        growl.message = 'Uncaught exception'
+		        growl.run
+			end
+			raise e
+		end
 	end
-end
+	
+end
+
+App.run

data/lib/watchful.rb

@@ -10,6 +10,18 @@ require 'watchful/watch'
 require 'watchful/action'
 require 'watchful/defaultconfiguration'
 
+begin
+	require 'growl'
+rescue LoadError
+ 	HAVE_GROWL = false
+else
+	if (Growl.installed? rescue false)
+		HAVE_GROWL = true
+	else
+		HAVE_GROWL = false
+	end
+end
+
 module Watchful
 	def self.version
 		File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).strip

data/lib/watchful/action.rb

@@ -1,36 +1,40 @@
+require 'rubygems'
 require 'commandline' # for debug
+require 'extensions/string'
 
 module Watchful
 	
 	class Action
 		
-		# todo: support blocks for @in, @out, and @command
+		# todo: support blocks for @in, @out, @command, @dependencies
 		
 		PROPERTIES = [:name, :dependencies, :command, :in, :out]
 		
 		PROPERTIES.each { |k| attr_accessor k }
 		
-		@enabled = true
 		def enabled?; @enabled ;end
 		
-		
 		def initialize(options = {})
 			
 			options[:dependencies] ||= []
 			
+			@enabled = true
+			
 			PROPERTIES.each do |key|
 				self.instance_variable_set('@' + key.to_s, options[key])
 			end
 			
 			@dependencies = [@dependencies] if @dependencies.kind_of? String
 			
-			raise "Dependencies option must be a string or array" if not @dependencies.kind_of? Array
+			raise ArgumentError.new("Dependencies option must be a string or array") if not @dependencies.kind_of? Array
 			
 			[@in, @out].each do |i|
-				@enabled = false unless i and i.instance_of? String and i.starts_with? '.'
+				@enabled = false unless i and i.instance_of?(String) and i.starts_with?('.')
 			end
 			
-			@enabled = @enabled && self.has_dependencies?
+			@enabled = false unless @command.instance_of?(String)
+			
+			@enabled = false unless self.has_dependencies?
 			
 		end
 		
@@ -40,7 +44,7 @@ module Watchful
 				(Action.have_command?(d)) || (File.exists?(File.expand_path(d)))
 			end
 			# todo: more detailed messages about missing dependencies
-			debug "Missing dependencies for action \"#{@name}\"" unless have_all
+			puts "Missing dependencies for action \"#{@name}\"" unless have_all
 			return have_all
 		end
 		
@@ -59,13 +63,17 @@ module Watchful
 			false
 		end
 		
+		# given an input file, return the path of an output file
 		def output_path_for(source_path)
+			unless self.input_file?(source_path)
+				raise ArgumentError.new("#{source_path} is not an input file for action #{@name}")
+			end
 			return File.dirname(source_path) + '/' + File.basename(source_path, @in) + @out
 		end
 		
 		# does the given path look like a path to which this action might write output?
 		def output_file?(path)
-			Watchful::compound_extension_of(path) == @in
+			Watchful::compound_extension_of(path) == @out
 		end
 		
 		# does the given path look like a path to which this action could be applied?

data/lib/watchful/configuration.rb

@@ -7,20 +7,20 @@ module Watchful
 		@@active_configuration = nil
 		
 		def self.active_configuration; @@active_configuration; end
-		def self.active_configuration=(x)
-			unless x.is_a? Class and x.ancestors.include? Watchful::Configuration
-				throw "Not a valid configuration class"
-			end
-			@@active_configuration = x
+		def self.active_configuration=(x); @@active_configuration = x; end
+		
+		def self.action_for_file(path)
+			@actions ||= []
+			@actions.find { |a| a.input_file?(path) && a.enabled?} 
 		end
 		
 		class << self
 		
 			attr_reader :actions
 		
-			def description(s); @description = s; end
-			
 			def _description; @description; end
+			
+			def description(s); @description = s; end
 		
 			def action(args)
 				# set the description in case the user doesn’t
@@ -29,7 +29,7 @@ module Watchful
 				# set to active configuration
 				@@active_configuration = self
 				
-				# todo: support block-passing style
+				# todo: support block-style action definition
 				@actions ||= []
 				a = Watchful::Action.new(args)
 				@actions << a

data/lib/watchful/defaultconfiguration.rb

@@ -1,15 +1,15 @@
 require 'watchful/configuration'
 
+# todo: Don't require DefaultConfiguration by default
+
 module Watchful
 	
 	class DefaultConfiguration < Configuration
 		
 		description "Default Configuration"
 		
-		# LESS CSS, if installed
-		
 		begin
-			gem "less"
+			require "less"
 			action	:name => 'LESS CSS',
 					:in => '.less',
 					:out => '.css',
@@ -19,8 +19,6 @@ module Watchful
 			# pass
 		end
 		
-		# SASS, if installed
-		
 		if Action.have_command? 'sass'
 			action	:name => 'SASS',
 					:in => '.sass',
@@ -29,6 +27,8 @@ module Watchful
 					:dependencies => 'sass'
 		end
 		
+		# todo: Add more actions to DefaultConfiguration
+		
 	end
 		
 end