kicker 3.0.0pre1 → 3.0.0pre2

data/README.rdoc

@@ -11,6 +11,11 @@ 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>
 
+== Ruby Version support
+Beginning with 3.0.0 we are dropping Ruby 1.8 support.
+We are not running tests automatically so nothing is guaranteed.
+But it still might work. If it does not work for you. Use latest 2.x release.
+
 == Installation
 
   $ gem install kicker -s http://gemcutter.org
@@ -18,9 +23,9 @@ feel offended; live with it.</i>
 == The short version
 
   Usage: ./bin/kicker [options] [paths to watch]
- 
+
     Available recipes: ignore, jstest, rails, ruby.
- 
+
       -s, --silent                     Keep output to a minimum.
       -q, --quiet                      Quiet output. Don't print timestamps when logging.
       -c, --clear                      Clear console before each run.
@@ -64,7 +69,8 @@ A few recipes come shipped with Kicker:
   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>.
+Add your own shared recipes to <tt>~/.kick</tt> folder or
+current working directory <tt>.kick</tt>.
 
 === Project specific handlers
 
@@ -110,7 +116,7 @@ be added:
     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

data/lib/kicker.rb

@@ -2,6 +2,7 @@ require 'kicker/version'
 require 'kicker/fsevents'
 require 'kicker/callback_chain'
 require 'kicker/core_ext'
+require 'kicker/job'
 require 'kicker/notification'
 require 'kicker/options'
 require 'kicker/utils'
@@ -10,43 +11,49 @@ require 'kicker/recipes'
 class Kicker #:nodoc:
   def self.run(argv = ARGV)
     Kicker::Options.parse(argv)
-    new.start
+    new.start.loop!
   end
-  
+
   attr_reader :last_event_processed_at
-  
+
   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 ''
-    
+
     run_startup_chain
     run_watch_dog!
+
+    self
+  end
+
+  def loop!
+    (Thread.list - [Thread.current, Thread.main]).each(&:join)
   end
-  
+
   private
-  
+
   def validate_options!
     validate_paths_and_command!
     validate_paths_exist!
   end
-  
+
   def validate_paths_and_command!
     if startup_chain.empty? && process_chain.empty? && pre_process_chain.empty?
       puts Kicker::Options.parser.help
       exit
     end
   end
-  
+
   def validate_paths_exist!
     paths.each do |path|
       unless File.exist?(path)
@@ -55,28 +62,27 @@ class Kicker #:nodoc:
       end
     end
   end
-  
+
   def run_watch_dog!
     dirs = @paths.map { |path| File.directory?(path) ? path : File.dirname(path) }
     watch_dog = Kicker::FSEvents.start_watching(dirs, :latency => self.class.latency) do |events|
       process events
     end
-    
     trap('INT') do
       log "Exiting ..."
       watch_dog.stop
       exit
     end
   end
-  
+
   def run_startup_chain
     startup_chain.call([], false)
   end
-  
+
   def finished_processing!
     @last_event_processed_at = Time.now
   end
-  
+
   def process(events)
     unless (files = changed_files(events)).empty?
       Utils.should_clear_screen = true
@@ -84,25 +90,25 @@ class Kicker #:nodoc:
       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).sort[2..-1].map { |f| File.join(dir, f) }
   rescue Errno::ENOENT
     []
   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

data/lib/kicker/callback_chain.rb

@@ -2,7 +2,7 @@ class Kicker
   class CallbackChain < Array #:nodoc:
     alias_method :append_callback,  :push
     alias_method :prepend_callback, :unshift
-    
+
     def call(files, stop_when_empty = true)
       each do |callback|
         break if stop_when_empty and files.empty?
@@ -10,50 +10,50 @@ class Kicker
       end
     end
   end
-  
+
   class << self
     attr_writer :startup_chain
     def startup_chain
       @startup_chain ||= CallbackChain.new
     end
-    
+
     attr_writer :pre_process_chain
     def pre_process_chain
       @pre_process_chain ||= CallbackChain.new
     end
-    
+
     attr_writer :process_chain
     def process_chain
       @process_chain ||= CallbackChain.new
     end
-    
+
     attr_writer :post_process_chain
     def post_process_chain
       @post_process_chain ||= CallbackChain.new
     end
-    
+
     attr_writer :full_chain
     def full_chain
       @full_chain ||= CallbackChain.new([pre_process_chain, process_chain, post_process_chain])
     end
   end
-  
+
   def startup_chain
     self.class.startup_chain
   end
-  
+
   def pre_process_chain
     self.class.pre_process_chain
   end
-  
+
   def process_chain
     self.class.process_chain
   end
-  
+
   def post_process_chain
     self.class.post_process_chain
   end
-  
+
   def full_chain
     self.class.full_chain
   end
@@ -68,7 +68,7 @@ module Kernel
   def startup(callback = nil, &block)
     Kicker.startup_chain.append_callback(block ? block : callback)
   end
-  
+
   # Adds a handler to the pre_process chain. This chain is ran before the
   # process chain and is processed from first to last.
   #
@@ -76,7 +76,7 @@ module Kernel
   def pre_process(callback = nil, &block)
     Kicker.pre_process_chain.append_callback(block ? block : callback)
   end
-  
+
   # Adds a handler to the process chain. This chain is ran in between the
   # pre_process and post_process chains. It is processed from first to last.
   #
@@ -84,7 +84,7 @@ module Kernel
   def process(callback = nil, &block)
     Kicker.process_chain.append_callback(block ? block : callback)
   end
-  
+
   # Adds a handler to the post_process chain. This chain is ran after the
   # process chain and is processed from last to first.
   #

data/lib/kicker/core_ext.rb

@@ -35,4 +35,4 @@ class Kicker
   end
 end
 
-Array.send(:include, Kicker::ArrayExt)
+Array.send(:include, Kicker::ArrayExt)

data/lib/kicker/fsevents.rb

@@ -6,11 +6,11 @@ class Kicker
   class FSEvents
     class FSEvent
       attr_reader :path
-      
+
       def initialize(path)
         @path = path
       end
-      
+
       def files
         Dir.glob("#{File.expand_path(path)}/*").map do |filename|
           begin
@@ -21,14 +21,16 @@ class Kicker
         end.compact.sort.reverse.map { |_, filename| filename }
       end
     end
-    
+
     def self.start_watching(paths, options={}, &block)
       listener = Listen.to(*(paths.dup << options))
       listener.change do |modified, added, removed|
         files = modified + added + removed
         directories = files.map { |file| File.dirname(file) }.uniq
         yield directories.map { |directory| Kicker::FSEvents::FSEvent.new(directory) }
-      end.start
+      end
+      listener.start
+      listener
     end
   end
 end

data/lib/kicker/job.rb

@@ -0,0 +1,57 @@
+class Kicker
+  class Job
+    def self.attr_with_default(name, merge_hash = false, &default)
+      # If `nil` this returns the `default`, unless explicitely set to `nil` by
+      # the user.
+      define_method(name) do
+        if instance_variable_get("@#{name}_assigned")
+          if assigned_value = instance_variable_get("@#{name}")
+            merge_hash ? instance_eval(&default).merge(assigned_value) : assigned_value
+          end
+        else
+          instance_eval(&default)
+        end
+      end
+      define_method("#{name}=") do |value|
+        instance_variable_set("@#{name}_assigned", true)
+        instance_variable_set("@#{name}", value)
+      end
+    end
+
+    attr_accessor :command, :exit_code, :output
+
+    def initialize(attributes)
+      @exit_code = 0
+      @output = ''
+      attributes.each { |k,v| send("#{k}=", v) }
+    end
+
+    def success?
+      exit_code == 0
+    end
+
+    attr_with_default(:print_before) do
+      "Executing: #{command}"
+    end
+
+    attr_with_default(:print_after) do
+      # Show all output if it wasn't shown before and the command fails.
+      "\n#{output}\n\n" if Kicker.silent? && !success?
+    end
+
+    # TODO default titles??
+
+    attr_with_default(:notify_before, true) do
+      { :title => "Kicker: Executing", :message => command }
+    end
+
+    attr_with_default(:notify_after, true)  do
+      message = Kicker.silent? ? "" : output
+      if success?
+        { :title => "Kicker: Success", :message => message }
+      else
+        { :title => "Kicker: Failed (#{exit_code})", :message => message }
+      end
+    end
+  end
+end

data/lib/kicker/notification.rb

@@ -1,37 +1,26 @@
+require 'notify'
+
 class Kicker
   module Notification #:nodoc:
-    vendor = File.expand_path('../../../vendor', __FILE__)
-    TERMINAL_NOTIFICATION_BIN = File.join(vendor, 'terminal-notifier_v1.0/terminal-notifier.app/Contents/MacOS/terminal-notifier')
+    TITLE = 'Kicker'
 
     class << self
       attr_accessor :use, :app_bundle_identifier
       alias_method :use?, :use
 
-      def usable?
-        @usable ||= `uname`.strip == 'Darwin' && `sw_vers -productVersion`.strip >= '10.8'
-      end
-
-      def change_occured(status)
-        notify('Kicker: Executing', status.command)
-      end
-
-      def result(status)
-        status.success? ? succeeded(status) : failed(status)
-      end
+      def notify(options)
+        return unless use?
 
-      def succeeded(status)
-        body = Kicker.silent? ? '' : status.output
-        notify('Kicker: Success', body)
-      end
+        unless message = options.delete(:message)
+          raise "A notification requires a `:message'"
+        end
 
-      def failed(status)
-        message = "Kicker: Failed (#{status.exit_code})"
-        body = Kicker.silent? ? '' : status.output
-        notify(message, body)
-      end
+        options = {
+          :group    => Dir.pwd,
+          :activate => app_bundle_identifier
+        }.merge(options)
 
-      def notify(title, message)
-        `'#{TERMINAL_NOTIFICATION_BIN}' #{Dir.pwd} '#{title}' '#{message}' '#{app_bundle_identifier}'`
+        Notify.notify(TITLE, message, options)
       end
     end
   end

data/lib/kicker/options.rb

@@ -3,79 +3,83 @@ require 'optparse'
 class Kicker
   class << self
     attr_accessor :latency, :paths, :silent, :quiet, :clear_console
-    
+
     def silent?
       @silent
     end
-    
+
     def quiet?
       @quiet
     end
-    
+
     def clear_console?
       @clear_console
     end
+
+
+    def osx?
+      RUBY_PLATFORM.downcase.include?("darwin")
+    end
   end
-  
+
   self.latency = 1
   self.paths = %w{ . }
   self.silent = false
   self.quiet = false
   self.clear_console = false
-  
+
   module Options #:nodoc:
     DONT_SHOW_RECIPES = %w{ could_not_handle_file execute_cli_command dot_kick }
-    
+
     def self.recipes_for_display
       Kicker::Recipes.recipe_files.map { |f| File.basename(f, '.rb') } - DONT_SHOW_RECIPES
     end
-    
+
     def self.parser
       @parser ||= OptionParser.new do |opt|
         opt.banner =  "Usage: #{$0} [options] [paths to watch]"
         opt.separator " "
         opt.separator "  Available recipes: #{recipes_for_display.join(", ")}."
         opt.separator " "
-        
+
         opt.on('-v', 'Print the Kicker version') do
-          puts VERSION
+          puts Kicker::VERSION
           exit
         end
 
         opt.on('-s', '--silent', 'Keep output to a minimum.') do |silent|
           Kicker.silent = true
         end
-        
+
         opt.on('-q', '--quiet', "Quiet output. Don't print timestamps when logging.") do |quiet|
           Kicker.silent = Kicker.quiet = true
         end
-        
+
         opt.on('-c', '--clear', "Clear console before each run.") do |clear|
           Kicker.clear_console = true
         end
-        
-        if Notification.usable?
-          opt.on('--[no-]notification', 'Whether or not to send user notifications (on Mac OS X). Defaults to enabled.') do |notifications|
-            Notification.use = notifications
-          end
-          
+
+
+        opt.on('--[no-]notification', 'Whether or not to send user notifications (on Mac OS X). Defaults to enabled.') do |notifications|
+          Notification.use = notifications
+        end
+
+        if Kicker.osx?
           opt.on('--activate-app [BUNDLE ID]', "The application to activate when a notification is clicked. Defaults to `com.apple.Terminal'.") do |bundle_id|
             Kicker::Notification.app_bundle_identifier = bundle_id
           end
-        else
-          Kicker::Notification.use = false
         end
-        
+
         opt.on('-l', '--latency [FLOAT]', "The time to collect file change events before acting on them. Defaults to #{Kicker.latency} second.") do |latency|
           Kicker.latency = Float(latency)
         end
-        
+
         opt.on('-r', '--recipe [NAME]', 'A named recipe to load.') do |name|
           recipe(name)
         end
       end
     end
-    
+
     def self.parse(argv)
       parser.parse!(argv)
       Kicker.paths = argv unless argv.empty?