kicker 2.0.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,20 @@
+require 'ignore'
+
+process do |files|
+  test_files = files.take_and_map do |file|
+    case file
+    when %r{^test/.+_test\.rb$}
+      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
+  
+  run_ruby_tests test_files
+end
+
+process do |files|
+  execute("rake docs:generate && open -a Safari html/index.html") if files.delete("README.rdoc")
+end

data/LICENSE

@@ -0,0 +1,54 @@
+Kicker:
+
+Copyright (c) 2009 Eloy Duran <eloy.de.enige@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+======================================================================
+
+Rucola: http://github.com/alloy/rucola/tree/master
+
+Copyright (c) 2008 Eloy Duran <eloy.de.enige@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+======================================================================
+
+growlnotifier: http://github.com/psychs/growlnotifier/tree/master
+
+Copyright (c) 2007-2008 Satoshi Nakagawa <psychs@limechat.net>, Eloy Duran <e.duran@superalloy.nl>
+You can redistribute it and/or modify it under the same terms as Ruby.

data/README.rdoc

@@ -0,0 +1,141 @@
+= Kicker
+
+A lean, agnostic, flexible file-change watcher, using OS X FSEvents.
+
+http://github.com/alloy/kicker/raw/master/html/images/kikker.jpg
+
+Meet king kikker, kicking stuff in your computers is his dream come true!
+
+<i>Drawing by Manfred Stienstra. The character is purely fictional, so if you
+feel offended; live with it.</i>
+
+== Installation
+
+  $ sudo gem install alloy-kicker -s http://gems.github.com
+
+== The short version
+
+  Usage: kicker [options] [paths to watch]
+      -e, --execute [COMMAND]          The command to execute.
+          --[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.
+      -r, --recipe [NAME]              A named recipe to load.
+
+    Available recipes:
+      - ignore
+      - jstest
+      - rails
+
+== The long version
+
+=== Execute a shell command
+
+Show all files, whenever a change occurs in the current work directory:
+
+  $ kicker -e "ls -l" .
+
+Show all files, whenever a change occurs to a specific file:
+
+  $ kicker -e "ls -l" foo.txt
+
+Or use it as a ghetto-autotest, running tests whenever files change:
+
+  $ kicker -e "ruby test/test_case.rb" test/test_case.rb lib/file.rb
+
+Et cetera.
+
+=== Using recipes
+
+A recipe is a predefined handler. You can use as many as you like, by
+specifying them with the <tt>--recipe</tt> (<tt>-r</tt>) option.
+
+For instance, when in the root of a typical Ruby on Rails application, using
+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:
+* Ruby on Rails, as aforementioned.
+* JavaScript tests, needs
+  HeadlessSquirrel[http://github.com/Fingertips/Headless-squirrel] to run.
+* Ignore, ignores logs, tmp, and svn and git files.
+
+Add your own shared recipes to <tt>~/.kick</tt>.
+
+=== Project specific handlers
+
+Most of the time, you’ll want to create handlers specific to the project at
+hand. This can be done by adding your handlers to a <tt>.kick</tt> file and
+running Kicker from the directory containing it.
+
+This file is reloaded once saved. No need to stop Kicker.
+
+== Writing handlers
+
+Whenever file-change events occur, Kicker will go through a chain of handlers
+until that the files list is empty, or the end of the chain is reached.
+
+Handlers are objects that respond to <tt>#call</tt>. These are typically Proc
+objects. (If you know Rack, you’re familiar with this concept.) Every handler
+gets passed a list of changed files and can decide whether or not to act on
+them. Normally when handling a file, you should remove it from the files list,
+unless you want to let the file fall through to another handler. In the same
+way, one can add files to handler to the files list.
+
+==== Time for a simple example
+
+  process do |files|
+    execute("rake docs:generate && open -a Safari html/index.html") if files.delete("README.rdoc")
+  end
+
+A handler is defined by passing a block to <tt>process</tt>. Which is one of
+three possible callback chains to add your handlers to, the others being:
+<tt>pre_process</tt> and <tt>post_process</tt>. See Kernel for more info.
+
+Then <tt>README.rdoc</tt> is deleted from the files array. If it did exist in
+the array and was deleted, a shell command is executed which runs a rake task
+to generate rdoc and open the docs with Safari.
+
+==== Something more elaborate.
+
+Consider a Rails application with a mailer. Since the naming convention of
+mailer views tend to be fairly application specific, a specific handler has to
+be added:
+
+  process do |files|
+    test_files = files.take_and_map do |file|
+      if path =~ %r{^app/views/mailer/\w+\.erb$}
+        'test/unit/mailer_test.rb'
+      
+      # elsif ... handle more app specific stuff
+      end
+    end
+
+    run_ruby_tests test_files
+  end
+
+The files list is iterated over with the Array#take_and_map method, which both
+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
+command:
+
+  execute "ruby -r #{test_files.join(' -r ')} -e ''" unless test_files.empty?
+
+See Kernel for more info on the utility methods.
+
+==== Addendum
+
+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'
+  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.

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "kicker"
+    gem.summary = %Q{A lean, agnostic, flexible file-change watcher, using OS X FSEvents.}
+    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
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.options = '-rs'
+end
+
+namespace :docs do
+  Rake::RDocTask.new('generate') do |t|
+    t.main = "README.rdoc"
+    t.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+    t.options << '--charset=utf8'
+  end
+end
+
+task :default => :test

data/TODO.rdoc

@@ -0,0 +1 @@
+* Add a recipe which implements the basic autotest mapping API.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 0
+:major: 2

data/bin/kicker

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path('../../lib', __FILE__) if $0 == __FILE__
+
+require 'kicker'
+Kicker.run

data/kicker.gemspec

@@ -0,0 +1,95 @@
+# 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.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eloy Duran"]
+  s.date = %q{2009-09-29}
+  s.email = %q{eloy.de.enige@gmail.com}
+  s.executables = ["kicker", "kicker"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     ".kick",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.rdoc",
+     "VERSION.yml",
+     "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/options.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/utils.rb",
+     "lib/kicker/validate.rb",
+     "test/callback_chain_test.rb",
+     "test/core_ext_test.rb",
+     "test/filesystem_change_test.rb",
+     "test/fixtures/a_file_thats_reloaded.rb",
+     "test/initialization_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/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 simple OS X CLI tool which uses FSEvents to run a given shell command.}
+  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/initialization_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/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

@@ -0,0 +1,135 @@
+$:.unshift File.expand_path('../../vendor', __FILE__)
+require 'rucola/fsevents'
+
+require 'kicker/callback_chain'
+require 'kicker/core_ext'
+require 'kicker/growl'
+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
+  end
+  
+  attr_reader :latency, :paths, :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]
+    
+    finished_processing!
+  end
+  
+  def start
+    validate_options!
+    
+    log "Watching for changes on: #{@paths.join(', ')}"
+    log ''
+    
+    run_watch_dog!
+    start_growl! if self.class.use_growl
+    
+    OSX.CFRunLoopRun
+  end
+  
+  private
+  
+  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) }
+    
+    trap('INT') do
+      log "Exiting…"
+      watch_dog.stop
+      exit
+    end
+  end
+  
+  def finished_processing!
+    @last_event_processed_at = Time.now
+  end
+  
+  def process(events)
+    unless (files = changed_files(events)).empty?
+      full_chain.call(files)
+      finished_processing!
+    end
+  end
+  
+  def changed_files(events)
+    make_paths_relative(events.map do |event|
+      files_in_directory(event.path).select { |file| file_changed_since_last_event? file }
+    end.flatten.uniq.sort)
+  end
+  
+  def files_in_directory(dir)
+    Dir.entries(dir)[2..-1].map { |f| File.join(dir, f) }
+  end
+  
+  def file_changed_since_last_event?(file)
+    File.mtime(file) > @last_event_processed_at
+  rescue Errno::ENOENT
+    false
+  end
+  
+  def make_paths_relative(files)
+    return files if files.empty?
+    wd = Dir.pwd
+    files.map do |file|
+      if file[0..wd.length-1] == wd
+        file[wd.length+1..-1]
+      else
+        file
+      end
+    end
+  end
+end