alloy-kicker 1.0.0 → 1.1.1

data/README.rdoc

@@ -2,15 +2,16 @@
 
 A simple OS X CLI tool which uses FSEvents to run a given shell command.
 
+http://github.com/alloy/kicker/raw/master/html/images/kikker.jpg
+
 == Usage
 
-At the least give it a path to a file or directory and a shell command to
-execute when any changes occur.
+Give it paths to files or directories and a shell command to execute when any
+changes occur.
 
-  Usage: kicker [options] -e [command] [path]
+  Usage: kicker [options] -e [command] [paths to watch]
       -e, --execute [COMMAND]          The command to execute.
           --[no-]growl                 Whether or not to use Growl. Default is to use growl.
-          --growl-message [MESSAGE]    The message to Growl when the command succeeded.
           --growl-command [COMMAND]    The command to execute when the Growl succeeded message is clicked.
 
 == Examples
@@ -21,12 +22,16 @@ Show all files whenever a change occurs in the current work directory:
 
 Run a Rake task whenever a given file is changed:
 
-  $ kicker -e "ONLY=nested_model_forms rake guides" guides/source/nested_model_forms.textile
+  $ kicker -e "rake guides" guides/source/nested_model_forms.textile
 
 Run a Run task whenever a given file is changed and specify a command to be
 executed if the user clicks a `succeeded' Growl message:
 
-  $ kicker -e "ONLY=nested_model_forms rake guides" --growl-command "open -a Safari guides/output/nested_model_forms.html" guides/source/nested_model_forms.textile
+  $ kicker -e "rake guides" --growl-command "open -a Safari guides/output/nested_model_forms.html" guides/source/nested_model_forms.textile
+
+And for fun, ghetto-autotest:
+
+  $ kicker -e "ruby test/test_case.rb" test/test_case.rb lib/file.rb
 
 == Installation
 

data/Rakefile

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'rake'
 require 'rake/testtask'
+require 'rake/rdoctask'
 
 begin
   require 'jeweler'
@@ -11,9 +12,9 @@ begin
     gem.homepage = "http://github.com/alloy/kicker"
     gem.authors = ["Eloy Duran"]
     gem.executables << 'kicker'
-    gem.files = FileList['**/**']
+    gem.files.concat FileList['vendor/**/*']
     gem.require_paths = ['vendor']
-    gem.has_rdoc = false
+    gem.has_rdoc = true
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
@@ -25,4 +26,11 @@ Rake::TestTask.new do |t|
   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")
+  end
+end
+
 task :default => :test

data/VERSION.yml

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

data/lib/kicker.rb

@@ -6,7 +6,7 @@ require 'optparse'
 class Kicker
   OPTION_PARSER = lambda do |options|
     OptionParser.new do |opts|
-      opts.banner = "Usage: #{$0} [options] -e [command] [path]"
+      opts.banner = "Usage: #{$0} [options] -e [command] [paths to watch]"
       
       opts.on('-e', '--execute [COMMAND]', 'The command to execute.') do |command|
         options[:command] = command
@@ -26,7 +26,7 @@ class Kicker
     argv = argv.dup
     options = { :growl => true }
     OPTION_PARSER.call(options).parse!(argv)
-    options[:path] = argv.first
+    options[:paths] = argv
     options
   end
   
@@ -45,37 +45,25 @@ class Kicker
   end
   
   attr_writer :command
-  attr_reader :path, :file
+  attr_reader :paths
   attr_accessor :use_growl, :growl_command
   
   def initialize(options)
-    self.path      = options[:path] if options[:path]
+    @paths         = options[:paths].map { |path| File.expand_path(path) }
     @command       = options[:command]
     @use_growl     = options[:growl]
     @growl_command = options[:growl_command]
   end
   
-  def path=(path)
-    @path = File.expand_path(path)
-    @file, @path = @path, File.dirname(@path) unless File.directory?(@path)
-  end
-  
   def start
     validate_options!
     
-    log "Watching for changes on `#{file || path}'"
+    log "Watching for changes on: #{@paths.join(', ')}"
     log "With command: #{command}"
     log ''
     
-    watch_dog = Rucola::FSEvents.start_watching(path) { |events| process(events) }
-    
-    trap('INT') do
-      log "Cleaning up…"
-      watch_dog.stop
-      exit
-    end
-    
-    Growl::Notifier.sharedInstance.register('Kicker', Kicker::GROWL_NOTIFICATIONS.values) if @use_growl
+    run_watch_dog!
+    start_growl! if @use_growl
     
     OSX.CFRunLoopRun
   end
@@ -84,33 +72,33 @@ class Kicker
     "sh -c #{@command.inspect}"
   end
   
-  def process(events)
-    execute! unless file && !events.find { |e| e.last_modified_file == file }
+  private
+  
+  def validate_options!
+    validate_paths_and_command!
+    validate_paths_exist!
   end
   
-  def log(message)
-    puts "[#{Time.now}] #{message}"
+  def validate_paths_and_command!
+    if @paths.empty? && @command.nil?
+      puts OPTION_PARSER.call(nil).help
+      exit
+    end
   end
   
-  def execute!
-    log "Change occured. Executing command:"
-    growl(GROWL_NOTIFICATIONS[:change], 'Kicker: Change occured', 'Executing command') if @use_growl
-    
-    output = `#{command}`
-    output.strip.split("\n").each { |line| log "  #{line}" }
-    
-    log "Command #{last_command_succeeded? ? 'succeeded' : "failed (#{last_command_status})"}"
-    
-    if @use_growl
-      if last_command_succeeded?
-        callback = @growl_command.nil? ? GROWL_DEFAULT_CALLBACK : lambda { system(@growl_command) }
-        growl(GROWL_NOTIFICATIONS[:succeeded], "Kicker: Command succeeded", output, &callback)
-      else
-        growl(GROWL_NOTIFICATIONS[:failed], "Kicker: Command failed (#{last_command_status})", output, &GROWL_DEFAULT_CALLBACK)
+  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 log(message)
+    puts "[#{Time.now}] #{message}"
+  end
+  
   def last_command_succeeded?
     $?.success?
   end
@@ -119,22 +107,45 @@ class Kicker
     $?.to_i
   end
   
-  def validate_options!
-    validate_path_and_command!
-    validate_path_exists!
+  def start_growl!
+    Growl::Notifier.sharedInstance.register('Kicker', Kicker::GROWL_NOTIFICATIONS.values)
   end
   
-  def validate_path_and_command!
-    unless @path && @command
-      puts OPTION_PARSER.call(nil).help
+  def run_watch_dog!
+    dirs = @paths.map { |path| File.directory?(path) ? path : File.dirname(path) }
+    watch_dog = Rucola::FSEvents.start_watching(*dirs) { |events| process(events) }
+    
+    trap('INT') do
+      log "Cleaning up…"
+      watch_dog.stop
       exit
     end
   end
   
-  def validate_path_exists!
-    unless File.exist?(@path)
-      puts "The given path `#{@path}' does not exist"
-      exit 1
+  def process(events)
+    events.each do |event|
+      @paths.each do |path|
+        return execute! if event.last_modified_file =~ /^#{path}/
+      end
+    end
+  end
+  
+  def execute!
+    log "Change occured. Executing command:"
+    growl(GROWL_NOTIFICATIONS[:change], 'Kicker: Change occured', 'Executing command') if @use_growl
+    
+    output = `#{command}`
+    output.strip.split("\n").each { |line| log "  #{line}" }
+    
+    log "Command #{last_command_succeeded? ? 'succeeded' : "failed (#{last_command_status})"}"
+    
+    if @use_growl
+      if last_command_succeeded?
+        callback = @growl_command.nil? ? GROWL_DEFAULT_CALLBACK : lambda { system(@growl_command) }
+        growl(GROWL_NOTIFICATIONS[:succeeded], "Kicker: Command succeeded", output, &callback)
+      else
+        growl(GROWL_NOTIFICATIONS[:failed], "Kicker: Command failed (#{last_command_status})", output, &GROWL_DEFAULT_CALLBACK)
+      end
     end
   end
 end

data/test/kicker_test.rb

@@ -1,8 +1,10 @@
 require File.expand_path('../test_helper', __FILE__)
 
 describe "Kicker.parse_options" do
-  it "should parse the path" do
-    Kicker.parse_options(['/some/file.rb'])[:path].should == '/some/file.rb'
+  it "should parse the paths" do
+    Kicker.parse_options(%w{ /some/file.rb })[:paths].should == %w{ /some/file.rb }
+    Kicker.parse_options(%w{ /some/file.rb /a/dir /and/some/other/file.rb })[:paths].should ==
+      %w{ /some/file.rb /a/dir /and/some/other/file.rb }
   end
   
   it "should parse the command" do
@@ -22,41 +24,30 @@ end
 
 describe "Kicker, when initializing" do
   before do
-    @kicker = Kicker.new(:path => '/some/dir', :command => 'ls -l')
+    @kicker = Kicker.new(:paths => %w{ /some/dir a/relative/path }, :command => 'ls -l')
   end
   
-  it "should return the path to watch" do
-    File.stubs(:directory?).with('/some/dir').returns(true)
-    Kicker.new(:path => '/some/dir').path.should == '/some/dir'
+  it "should return the extended paths to watch" do
+    @kicker.paths.should == ['/some/dir', File.expand_path('a/relative/path')]
   end
   
   it "should return the command to execute once a change occurs" do
-    Kicker.new(:command => 'ls -l').command.should == 'sh -c "ls -l"'
-  end
-  
-  it "should return the dirname of the path if the given path is a file" do
-    File.stubs(:directory?).with('/some/file.rb').returns(false)
-    Kicker.new(:path => '/some/file.rb').path.should == '/some'
-  end
-  
-  it "should return the path to the file if the given path is a file" do
-    @kicker = Kicker.new(:path => '/some/file.rb', :command => 'ls -l')
-    @kicker.file.should == '/some/file.rb'
+    @kicker.command.should == 'sh -c "ls -l"'
   end
 end
 
 describe "Kicker, when starting" do
   before do
-    @kicker = Kicker.new(:path => '/some/file.rb', :command => 'ls -l')
+    @kicker = Kicker.new(:paths => %w{ /some/file.rb }, :command => 'ls -l')
     @kicker.stubs(:log)
     Rucola::FSEvents.stubs(:start_watching)
     OSX.stubs(:CFRunLoopRun)
   end
   
-  it "should show the usage banner when path and command are nil and exit" do
-    @kicker.instance_variable_set("@path", nil)
+  it "should show the usage banner and exit when there are no paths and a command" do
+    @kicker.instance_variable_set("@paths", [])
     @kicker.command = nil
-    @kicker.stubs(:validate_path_exists!)
+    @kicker.stubs(:validate_paths_exist!)
     
     Kicker::OPTION_PARSER.stubs(:call).returns(mock('OptionParser', :help => 'help'))
     @kicker.expects(:puts).with("help")
@@ -65,17 +56,25 @@ describe "Kicker, when starting" do
     @kicker.start
   end
   
-  it "should warn the user if the given path doesn't exist and exit" do
-    @kicker.expects(:puts).with("The given path `#{@kicker.path}' does not exist")
+  it "should warn the user and exit if any of the given paths doesn't exist" do
+    @kicker.expects(:puts).with("The given path `/some/file.rb' does not exist")
     @kicker.expects(:exit).with(1)
     
     @kicker.start
   end
   
-  it "should start a FSEvents stream with a block which calls #process with the events" do
+  it "should start a FSEvents stream which watches all paths, but the dirnames of paths if they're files" do
+    @kicker.stubs(:validate_options!)
+    File.stubs(:directory?).with('/some/file.rb').returns(false)
+    
+    Rucola::FSEvents.expects(:start_watching).with('/some')
+    @kicker.start
+  end
+  
+  it "should start a FSEvents stream with a block which calls #process with any generated events" do
     @kicker.stubs(:validate_options!)
     
-    Rucola::FSEvents.expects(:start_watching).with(@kicker.path).yields(['event'])
+    Rucola::FSEvents.expects(:start_watching).yields(['event'])
     @kicker.expects(:process).with(['event'])
     
     @kicker.start
@@ -120,40 +119,38 @@ end
 
 describe "Kicker, when a change occurs" do
   before do
-    File.stubs(:directory?).returns(false)
     Kicker.any_instance.stubs(:last_command_succeeded?).returns(true)
     Kicker.any_instance.stubs(:log)
-    @kicker = Kicker.new(:path => '/some/file.rb', :command => 'ls -l')
+    @kicker = Kicker.new(:paths => %w{ /some/file.rb /some/dir }, :command => 'ls -l')
   end
   
-  it "should execute the command if a change occured to the watched file" do
-    event = mock('Rucola::FSEvents::Event', :last_modified_file => '/some/file.rb')
+  it "should execute the command if a change occured to a watched path which is a file" do
+    event = stub('Event', :last_modified_file => '/some/file.rb')
     
     @kicker.expects(:`).with(@kicker.command).returns('')
-    @kicker.process([event])
+    @kicker.send(:process, [event])
   end
   
-  it "should _not_ execute the command if a change occured to another file than the one being watched" do
-    event = mock('Rucola::FSEvents::Event', :last_modified_file => '/some/other_file.rb')
+  it "should execute the command if a change occured to some file in watched path which is a directory" do
+    event = stub('Event', :last_modified_file => '/some/dir/with/file.rb')
     
-    @kicker.expects(:`).never
-    @kicker.process([event])
+    @kicker.expects(:`).with(@kicker.command).returns('')
+    @kicker.send(:process, [event])
   end
   
-  it "should execute the command if a change occured in the watched directory" do
-    File.stubs(:directory?).returns(true)
-    kicker = Kicker.new(:path => '/some/dir', :command => 'ls -l')
-    event = mock('Rucola::FSEvents::Event')
+  it "should _not_ execute the command if a change occured to a file that isn't being watched" do
+    event1 = stub('Event', :last_modified_file => '/some/other_file.rb')
+    event2 = stub('Event', :last_modified_file => '/some/not/watched/dir/with/file.rb')
     
-    kicker.expects(:`).with(kicker.command).returns('')
-    kicker.process([event])
+    @kicker.expects(:`).never
+    @kicker.send(:process, [event1, event2])
   end
 end
 
 describe "Kicker, in general" do
   before do
     Kicker.any_instance.stubs(:last_command_succeeded?).returns(true)
-    @kicker = Kicker.new(:path => '/some/dir', :command => 'ls -l')
+    @kicker = Kicker.new(:paths => %w{ /some/dir }, :command => 'ls -l')
   end
   
   it "should print a log entry with timestamp" do
@@ -161,7 +158,7 @@ describe "Kicker, in general" do
     Time.stubs(:now).returns(now)
     
     @kicker.expects(:puts).with("[#{now}] the message")
-    @kicker.log('the message')
+    @kicker.send(:log, 'the message')
   end
   
   it "should log the output of the command indented by 2 spaces and whether or not the command succeeded" do
@@ -171,7 +168,7 @@ describe "Kicker, in general" do
     @kicker.expects(:log).with('  line 1')
     @kicker.expects(:log).with('  line 2')
     @kicker.expects(:log).with('Command succeeded')
-    @kicker.execute!
+    @kicker.send(:execute!)
     
     @kicker.stubs(:last_command_succeeded?).returns(false)
     @kicker.stubs(:last_command_status).returns(123)
@@ -179,7 +176,7 @@ describe "Kicker, in general" do
     @kicker.expects(:log).with('  line 1')
     @kicker.expects(:log).with('  line 2')
     @kicker.expects(:log).with('Command failed (123)')
-    @kicker.execute!
+    @kicker.send(:execute!)
   end
   
   it "should send the Growl messages with the default click callback" do
@@ -192,13 +189,13 @@ describe "Kicker, in general" do
     
     @kicker.expects(:growl).with(Kicker::GROWL_NOTIFICATIONS[:change], 'Kicker: Change occured', 'Executing command')
     @kicker.expects(:growl).with(Kicker::GROWL_NOTIFICATIONS[:succeeded], 'Kicker: Command succeeded', "line 1\nline 2").yields
-    @kicker.execute!
+    @kicker.send(:execute!)
     
     @kicker.stubs(:last_command_succeeded?).returns(false)
     @kicker.stubs(:last_command_status).returns(123)
     @kicker.expects(:growl).with(Kicker::GROWL_NOTIFICATIONS[:change], 'Kicker: Change occured', 'Executing command')
     @kicker.expects(:growl).with(Kicker::GROWL_NOTIFICATIONS[:failed], 'Kicker: Command failed (123)', "line 1\nline 2").yields
-    @kicker.execute!
+    @kicker.send(:execute!)
   end
   
   it "should send the Growl messages with a click callback which executes the specified growl command when succeeded" do
@@ -213,12 +210,12 @@ describe "Kicker, in general" do
     
     @kicker.expects(:growl).with(Kicker::GROWL_NOTIFICATIONS[:change], 'Kicker: Change occured', 'Executing command')
     @kicker.expects(:growl).with(Kicker::GROWL_NOTIFICATIONS[:succeeded], 'Kicker: Command succeeded', "line 1\nline 2").yields
-    @kicker.execute!
+    @kicker.send(:execute!)
     
     @kicker.stubs(:last_command_succeeded?).returns(false)
     @kicker.stubs(:last_command_status).returns(123)
     @kicker.expects(:growl).with(Kicker::GROWL_NOTIFICATIONS[:change], 'Kicker: Change occured', 'Executing command')
     @kicker.expects(:growl).with(Kicker::GROWL_NOTIFICATIONS[:failed], 'Kicker: Command failed (123)', "line 1\nline 2").yields
-    @kicker.execute!
+    @kicker.send(:execute!)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: alloy-kicker
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - Eloy Duran
@@ -9,46 +9,36 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-14 00:00:00 -07:00
-default_executable: kicker
+date: 2009-04-12 00:00:00 -07:00
+default_executable: 
 dependencies: []
 
 description: 
 email: eloy.de.enige@gmail.com
 executables: 
 - kicker
+- kicker
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
 - LICENSE
+- README.rdoc
 files: 
-- bin
-- bin/kicker
-- kicker.gemspec
-- lib
-- lib/kicker.rb
 - LICENSE
-- pkg
-- pkg/kicker-0.1.0.gem
-- pkg/kicker-0.1.1.gem
-- Rakefile
 - README.rdoc
-- test
+- Rakefile
+- VERSION.yml
+- bin/kicker
+- lib/kicker.rb
 - test/kicker_test.rb
 - test/test_helper.rb
-- vendor
-- vendor/growlnotifier
 - vendor/growlnotifier/growl.rb
 - vendor/growlnotifier/growl_helpers.rb
-- vendor/rucola
 - vendor/rucola/fsevents.rb
-- VERSION.yml
 has_rdoc: true
 homepage: http://github.com/alloy/kicker
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --charset=UTF-8
 require_paths: 
 - vendor
@@ -71,5 +61,6 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: A simple OS X CLI tool which uses FSEvents to run a given shell command.
-test_files: []
-
+test_files: 
+- test/kicker_test.rb
+- test/test_helper.rb

data/kicker.gemspec

@@ -1,31 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{kicker}
-  s.version = "1.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-03-14}
-  s.default_executable = %q{kicker}
-  s.email = %q{eloy.de.enige@gmail.com}
-  s.executables = ["kicker"]
-  s.extra_rdoc_files = ["README.rdoc", "LICENSE"]
-  s.files = ["bin", "bin/kicker", "kicker.gemspec", "lib", "lib/kicker.rb", "LICENSE", "pkg", "pkg/kicker-0.1.0.gem", "pkg/kicker-0.1.1.gem", "Rakefile", "README.rdoc", "test", "test/kicker_test.rb", "test/test_helper.rb", "vendor", "vendor/growlnotifier", "vendor/growlnotifier/growl.rb", "vendor/growlnotifier/growl_helpers.rb", "vendor/rucola", "vendor/rucola/fsevents.rb", "VERSION.yml"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/alloy/kicker}
-  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
-  s.require_paths = ["vendor"]
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{A simple OS X CLI tool which uses FSEvents to run a given shell command.}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end