kicker 2.1.0 → 2.2.0

data/.gitignore

@@ -0,0 +1,10 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+html/*.html
+html/*.rid
+html/*.css
+html/classes
+html/files

data/.kick

@@ -0,0 +1,37 @@
+recipe :ignore
+recipe :ruby
+
+process do |files|
+  test_files = files.take_and_map do |file|
+    case file
+    when %r{^lib/kicker(\.rb|/validate\.rb|/growl\.rb)$}
+      ["test/initialization_test.rb", ("test/filesystem_change_test.rb" if $1 == '.rb')]
+    when %r{^lib/kicker/(.+)\.rb$}
+      "test/#{$1}_test.rb"
+    end
+  end
+  
+  Ruby.run_tests test_files
+end
+
+process do |files|
+  execute("rake docs:generate && open -a Safari html/index.html") if files.delete("README.rdoc")
+end
+
+startup do
+  log "Good choice mate!"
+end
+
+# process do
+#   execute "ls -l" do |status|
+#     if status.before?
+#       status.stdout? ? "Here we go!: #{status.command}" : "Here we go! GROWL"
+#     elsif status.after?
+#       if status.success?
+#         status.stdout? ? "Nice!\n\n#{status.output}" : "Nice!"
+#       else
+#         status.stdout? ? "Damn brow!\n\n#{status.output}" : "Damn bro!"
+#       end
+#     end
+#   end
+# end

data/README.rdoc

@@ -11,21 +11,22 @@ feel offended; live with it.</i>
 
 == Installation
 
-  $ sudo gem install kicker -s http://gemcutter.org
+  $ gem install kicker -s http://gemcutter.org
 
 == The short version
 
-  Usage: kicker [options] [paths to watch]
-      -e, --execute [COMMAND]          The command to execute.
+  Usage: ./bin/kicker [options] [paths to watch]
+
+    Available recipes: active_record, ignore, jstest, rails, ruby.
+
+      -s, --silent                     Keep output to a minimum.
           --[no-]growl                 Whether or not to use Growl. Default is to use growl.
           --growl-command [COMMAND]    The command to execute when the Growl succeeded message is clicked.
-      -l, --latency [FLOAT]            The time to collect file change events before acting on them. Defaults to 1.5 sec.
+      -l, --latency [FLOAT]            The time to collect file change events before acting on them. Defaults to 1 second.
       -r, --recipe [NAME]              A named recipe to load.
+      -e, --execute [COMMAND]          The command to execute.
+      -b, --ruby [PATH]                Use an alternate Ruby binary for spawned test runners. (Default is `ruby')
 
-    Available recipes:
-      - ignore
-      - jstest
-      - rails
 
 == The long version
 
@@ -55,9 +56,10 @@ the <tt>rails</tt> recipe will map models, concerns, controllers, helpers, and
 views to their respective test files. These will then all be ran with Ruby.
 
 A few recipes come shipped with Kicker:
+* Typical Ruby library.
 * Ruby on Rails, as aforementioned.
-* JavaScript tests, needs
-  HeadlessSquirrel[http://github.com/Fingertips/Headless-squirrel] to run.
+* JavaScript tests, to run it needs
+  HeadlessSquirrel[http://github.com/Fingertips/Headless-squirrel].
 * Ignore, ignores logs, tmp, and svn and git files.
 
 Add your own shared recipes to <tt>~/.kick</tt>.
@@ -111,7 +113,7 @@ be added:
       end
     end
 
-    run_ruby_tests test_files
+    Ruby.run_tests test_files
   end
 
 The files list is iterated over with the Array#take_and_map method, which both
@@ -119,23 +121,24 @@ removes and maps the results. This is an easy way to do a common thing in
 recipes. See Kicker::ArrayExt for details.
 
 The handler then checks if the file is a mailer view and if so runs the
-mailers test case. The <tt>run_ruby_tests</tt> runs them with the following
+mailers test case. Ruby.run_tests runs them with something like the following
 command:
 
   execute "ruby -r #{test_files.join(' -r ')} -e ''" unless test_files.empty?
 
 See Kernel for more info on the utility methods.
 
-==== Addendum
+To load recipes from your <tt>~/.kick</tt> file:
 
-The recipes directory that ships with Kicker and <tt>~/.kick</tt> are both
-added to the load path, so any recipes can be required. Once they’re required
-they are added to the callback chains.
-
-As an example, say you might want to ignore files in <tt>./data</tt>:
-
-  require 'ignore'
+  recipe :ignore
   ignore(/^data\//)
 
 That’s basically it, just remember that the order of specifying handlers _can_
-be important in your decision on where to specify handlers.
+be important in your decision on where to specify handlers.
+
+== Contributors
+
+* Manfred Stienstra (@manfred)
+* Cristi Balan (@evilchelu)
+* Damir Zekic (@sidonath)
+* Adam Keys (@therealadam)

data/Rakefile

@@ -11,7 +11,6 @@ begin
     gem.email = "eloy.de.enige@gmail.com"
     gem.homepage = "http://github.com/alloy/kicker"
     gem.authors = ["Eloy Duran"]
-    gem.executables << 'kicker'
     gem.files.concat FileList['vendor/**/*']
     gem.require_paths = ["lib", "vendor"]
     gem.has_rdoc = true

data/TODO.rdoc

@@ -1,35 +1,5 @@
+* Move larger parts of README to the GitHub wiki so the README is to the point.
 * Add a recipe which implements the basic autotest mapping API.
-* Need to figure out how this can occur:
-
-  [Thu Oct 01 17:21:04 +0200 2009] Could not handle: tmp/_variants/banners/bn, tmp/_variants/banners/bn/85, tmp/_variants/banners/bn/85/kz, tmp/_variants/banners/bn/85/kz/44, tmp/_variants/images/zx, tmp/_variants/images/zx/10, tmp/_variants/images/zx/10/nx, tmp/_variants/images/zx/10/nx/71
-  [Thu Oct 01 17:21:04 +0200 2009] 
-  [Thu Oct 01 17:21:05 +0200 2009] 
-  [Thu Oct 01 17:21:05 +0200 2009] Could not handle: tmp/_variants, tmp/_variants/review_photos, tmp/_variants/review_photos/kh, tmp/_variants/review_photos/kh/57, tmp/_variants/review_photos/kh/57/ll, tmp/_variants/review_photos/kh/57/ll/40
-  [Thu Oct 01 17:21:05 +0200 2009] 
-  [Thu Oct 01 17:21:15 +0200 2009] 
-  [Thu Oct 01 17:21:15 +0200 2009] Could not handle: tmp/_variants, tmp/_variants/flyers, tmp/_variants/flyers/rx, tmp/_variants/flyers/rx/84, tmp/_variants/flyers/rx/84/mc, tmp/_variants/flyers/rx/84/mc/22
-  [Thu Oct 01 17:21:15 +0200 2009] 
-  [Thu Oct 01 17:21:16 +0200 2009] 
-  [Thu Oct 01 17:21:16 +0200 2009] Could not handle: tmp/_variants, tmp/_variants/images, tmp/_variants/images/mr, tmp/_variants/images/mr/36, tmp/_variants/images/mr/36/as, tmp/_variants/images/mr/36/as/85
-  [Thu Oct 01 17:21:16 +0200 2009] 
-  [Thu Oct 01 17:21:17 +0200 2009] 
-  [Thu Oct 01 17:21:17 +0200 2009] Could not handle: tmp/_variants/images/zm/86/ez/68
-  [Thu Oct 01 17:21:17 +0200 2009] 
-  [Thu Oct 01 17:21:19 +0200 2009] 
-  [Thu Oct 01 17:21:19 +0200 2009] Could not handle: tmp/_variants, tmp/_variants/review_photos, tmp/_variants/review_photos/xd, tmp/_variants/review_photos/xd/81, tmp/_variants/review_photos/xd/81/wd, tmp/_variants/review_photos/xd/81/wd/97
-  [Thu Oct 01 17:21:19 +0200 2009] 
-  /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/lib/kicker.rb:115:in `files_in_directory': undefined method `map' for nil:NilClass (NoMethodError)
-  	from /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/lib/kicker.rb:110:in `changed_files'
-  	from /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/lib/kicker.rb:109:in `map'
-  	from /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/lib/kicker.rb:109:in `changed_files'
-  	from /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/lib/kicker.rb:102:in `process'
-  	from /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/lib/kicker.rb:88:in `run_watch_dog!'
-  	from /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/vendor/rucola/fsevents.rb:112:in `call'
-  	from /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/vendor/rucola/fsevents.rb:112:in `initialize'
-  	from /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/lib/kicker.rb:81:in `call'
-  	from /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/lib/kicker.rb:81:in `CFRunLoopRun'
-  	from /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/lib/kicker.rb:81:in `start'
-  	from /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/lib/kicker.rb:35:in `run'
-  	from /Library/Ruby/Gems/1.8/gems/kicker-2.0.2/bin/kicker:5
-  	from /usr/bin/kicker:19:in `load'
-  	from /usr/bin/kicker:19
+* Make the loggers, stdout and growl, work in a chain so one can add others.
+  This should improve portability as well, as people can easily insert growl
+  alternatives for their platform.

data/VERSION

@@ -0,0 +1 @@
+2.2.0

data/kicker.gemspec

@@ -0,0 +1,106 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{kicker}
+  s.version = "2.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eloy Duran"]
+  s.date = %q{2009-11-29}
+  s.default_executable = %q{kicker}
+  s.email = %q{eloy.de.enige@gmail.com}
+  s.executables = ["kicker"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     ".kick",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.rdoc",
+     "VERSION",
+     "bin/kicker",
+     "html/images/kikker.jpg",
+     "kicker.gemspec",
+     "lib/kicker.rb",
+     "lib/kicker/callback_chain.rb",
+     "lib/kicker/core_ext.rb",
+     "lib/kicker/growl.rb",
+     "lib/kicker/log_status_helper.rb",
+     "lib/kicker/options.rb",
+     "lib/kicker/recipes.rb",
+     "lib/kicker/recipes/could_not_handle_file.rb",
+     "lib/kicker/recipes/dot_kick.rb",
+     "lib/kicker/recipes/execute_cli_command.rb",
+     "lib/kicker/recipes/ignore.rb",
+     "lib/kicker/recipes/jstest.rb",
+     "lib/kicker/recipes/rails.rb",
+     "lib/kicker/recipes/ruby.rb",
+     "lib/kicker/utils.rb",
+     "test/callback_chain_test.rb",
+     "test/core_ext_test.rb",
+     "test/filesystem_change_test.rb",
+     "test/fixtures/a_file_thats_reloaded.rb",
+     "test/growl_test.rb",
+     "test/initialization_test.rb",
+     "test/log_status_helper_test.rb",
+     "test/options_test.rb",
+     "test/recipes/could_not_handle_file_test.rb",
+     "test/recipes/dot_kick_test.rb",
+     "test/recipes/execute_cli_command_test.rb",
+     "test/recipes/ignore_test.rb",
+     "test/recipes/jstest_test.rb",
+     "test/recipes/rails_test.rb",
+     "test/recipes/ruby_test.rb",
+     "test/recipes_test.rb",
+     "test/test_helper.rb",
+     "test/utils_test.rb",
+     "vendor/growlnotifier/growl.rb",
+     "vendor/growlnotifier/growl.rb",
+     "vendor/growlnotifier/growl_helpers.rb",
+     "vendor/growlnotifier/growl_helpers.rb",
+     "vendor/rucola/fsevents.rb",
+     "vendor/rucola/fsevents.rb"
+  ]
+  s.homepage = %q{http://github.com/alloy/kicker}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib", "vendor"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A lean, agnostic, flexible file-change watcher, using OS X FSEvents.}
+  s.test_files = [
+    "test/callback_chain_test.rb",
+     "test/core_ext_test.rb",
+     "test/filesystem_change_test.rb",
+     "test/fixtures/a_file_thats_reloaded.rb",
+     "test/growl_test.rb",
+     "test/initialization_test.rb",
+     "test/log_status_helper_test.rb",
+     "test/options_test.rb",
+     "test/recipes/could_not_handle_file_test.rb",
+     "test/recipes/dot_kick_test.rb",
+     "test/recipes/execute_cli_command_test.rb",
+     "test/recipes/ignore_test.rb",
+     "test/recipes/jstest_test.rb",
+     "test/recipes/rails_test.rb",
+     "test/recipes/ruby_test.rb",
+     "test/recipes_test.rb",
+     "test/test_helper.rb",
+     "test/utils_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/kicker.rb

@@ -4,89 +4,67 @@ require 'rucola/fsevents'
 require 'kicker/callback_chain'
 require 'kicker/core_ext'
 require 'kicker/growl'
+require 'kicker/log_status_helper'
 require 'kicker/options'
 require 'kicker/utils'
-require 'kicker/validate'
-
-RECIPES_DIR = File.expand_path('../kicker/recipes', __FILE__)
-$:.unshift RECIPES_DIR
-require 'could_not_handle_file'
-require 'execute_cli_command'
-
-USER_RECIPES_DIR = File.expand_path('~/.kick')
-$:.unshift USER_RECIPES_DIR if File.exist?(USER_RECIPES_DIR)
 
 class Kicker #:nodoc:
-  class << self
-    attr_accessor :latency
-    
-    def latency
-      @latency ||= 1
-    end
-    
-    def paths
-      @paths ||= %w{ . }
-    end
-    
-    def run(argv = ARGV)
-      options = parse_options(argv)
-      load_recipes(options[:recipes]) if options[:recipes]
-      load_dot_kick
-      new(options).start
-    end
-    
-    private
-    
-    def load_dot_kick
-      if File.exist?('.kick')
-        require 'dot_kick'
-        ReloadDotKick.save_state
-        load '.kick'
-      end
-    end
-    
-    def load_recipes(recipes)
-      recipes.each do |recipe|
-        raise "Recipe `#{recipe}' does not exist." unless recipe_exists?(recipe)
-        require recipe
-      end
-    end
-    
-    def recipe_exists?(recipe)
-      File.exist?("#{RECIPES_DIR}/#{recipe}.rb") || File.exist?("#{USER_RECIPES_DIR}/#{recipe}.rb")
-    end
+  def self.run(argv = ARGV)
+    Kicker::Options.parse(argv)
+    new.start
   end
   
-  attr_reader :latency, :paths, :last_event_processed_at
+  attr_reader :last_event_processed_at
   
-  def initialize(options)
-    @paths = (options[:paths] ? options[:paths] : Kicker.paths).map { |path| File.expand_path(path) }
-    @latency = options[:latency] || self.class.latency
-    
-    self.class.use_growl     = options[:growl]
-    self.class.growl_command = options[:growl_command]
-    
+  def initialize
     finished_processing!
   end
   
+  def paths
+    @paths ||= Kicker.paths.map { |path| File.expand_path(path) }
+  end
+  
   def start
     validate_options!
     
-    log "Watching for changes on: #{@paths.join(', ')}"
+    log "Watching for changes on: #{paths.join(', ')}"
     log ''
     
     run_watch_dog!
-    start_growl! if self.class.use_growl
-    startup_chain.call([], false)
+    Kicker::Growl.start! if Kicker::Growl.use?
+    run_startup_chain
     
     OSX.CFRunLoopRun
   end
   
   private
   
+  def validate_options!
+    validate_paths_and_command!
+    validate_paths_exist!
+  end
+  
+  def validate_paths_and_command!
+    if startup_chain.empty?
+      puts Kicker::Options.parser.help
+      exit
+    end
+  end
+  
+  def validate_paths_exist!
+    paths.each do |path|
+      unless File.exist?(path)
+        puts "The given path `#{path}' does not exist"
+        exit 1
+      end
+    end
+  end
+  
   def run_watch_dog!
     dirs = @paths.map { |path| File.directory?(path) ? path : File.dirname(path) }
-    watch_dog = Rucola::FSEvents.start_watching(dirs, :latency => @latency) { |events| process(events) }
+    watch_dog = Rucola::FSEvents.start_watching(dirs, :latency => self.class.latency) do |events|
+      process events
+    end
     
     trap('INT') do
       log "Exiting…"
@@ -95,6 +73,10 @@ class Kicker #:nodoc:
     end
   end
   
+  def run_startup_chain
+    startup_chain.call([], false)
+  end
+  
   def finished_processing!
     @last_event_processed_at = Time.now
   end
@@ -135,4 +117,8 @@ class Kicker #:nodoc:
       end
     end
   end
-end
+end
+
+# Load this as last, because it actually loads all recipes, so everything has
+# to be defined before that.
+require 'kicker/recipes'

data/lib/kicker/callback_chain.rb

@@ -1,5 +1,5 @@
 class Kicker
-  class CallbackChain < Array
+  class CallbackChain < Array #:nodoc:
     alias_method :append_callback,  :push
     alias_method :prepend_callback, :unshift
     
@@ -60,9 +60,9 @@ class Kicker
 end
 
 module Kernel
-  # Adds a handler to the startup chain. This chain is ran before the once
-  # Kicker is done loading. Note that an empty files array is given to the
-  # callback.
+  # Adds a handler to the startup chain. This chain is ran once Kicker is done
+  # loading _before_ starting the normal operations. Note that an empty files
+  # array is given to the callback.
   #
   # Takes a +callback+ object that responds to <tt>#call</tt>, or a block.
   def startup(callback = nil, &block)