kicker 3.0.0pre1 → 3.0.0pre2

data/lib/kicker/recipes.rb

@@ -1,6 +1,3 @@
-RECIPES_DIR      = File.expand_path('../recipes', __FILE__)
-USER_RECIPES_DIR = File.expand_path('~/.kick')
-
 module Kernel
   # If only given a <tt>name</tt>, the specified recipe will be loaded. For
   # instance, the following, in a <tt>.kick</tt> file, will load the Rails
@@ -25,6 +22,12 @@ end
 
 class Kicker
   module Recipes #:nodoc:
+    RECIPES_DIR      = Pathname.new('../recipes').expand_path(__FILE__)
+    USER_RECIPES_DIR = Pathname.new('~/.kick').expand_path
+    CURRENT_RECIPES_DIR = Pathname.pwd.join('.kick').expand_path
+
+    RECIPES_DIRS = [RECIPES_DIR, USER_RECIPES_DIR, CURRENT_RECIPES_DIR]
+
     class << self
       def reset!
         @recipes = nil
@@ -33,33 +36,33 @@ class Kicker
         load_recipe :could_not_handle_file
         load_recipe :dot_kick
       end
-      
+
       def recipes
         @recipes ||= {}
       end
-      
+
       def recipe_filename(name)
         [
           USER_RECIPES_DIR,
           RECIPES_DIR
         ].each do |directory|
-          filename = File.join(directory, "#{name}.rb")
-          return filename if File.exist?(filename)
+          filename = directory.join("#{name}.rb")
+          return filename if filename.exist?
         end
       end
-      
+
       def recipe_names
-        recipe_files.map { |filename| File.basename(filename, '.rb').to_sym }
+        recipe_files.map { |filename| filename.basename('.rb').to_s.to_sym }
       end
-      
+
       def recipe_files
-        Dir.glob(File.join(RECIPES_DIR, '*.rb')) + Dir.glob(File.join(USER_RECIPES_DIR, '*.rb'))
+        RECIPES_DIRS.map{|dir| Pathname.glob(dir.join('*.rb')) }.flatten.uniq.map(&:expand_path)
       end
-      
+
       def define_recipe(name, &block)
         recipes[name] = block
       end
-      
+
       def load_recipe(name)
         if recipe_names.include?(name)
           load recipe_filename(name)
@@ -67,7 +70,7 @@ class Kicker
           raise LoadError, "Can't load recipe `#{name}', it doesn't exist on disk. Loadable recipes are: #{recipe_names[0..-2].join(', ')}, and #{recipe_names[-1]}"
         end
       end
-      
+
       def activate_recipe(name)
         unless recipes.has_key?(name)
           load_recipe(name)
@@ -78,7 +81,7 @@ class Kicker
           raise ArgumentError, "Can't activate the recipe `#{name}' because it hasn't been defined yet."
         end
       end
-      
+
       # See Kernel#recipe for more information about the usage.
       def recipe(name, &block)
         name = name.to_sym
@@ -89,7 +92,7 @@ class Kicker
         end
       end
     end
-    
+
     reset!
   end
 end

data/lib/kicker/recipes/could_not_handle_file.rb

@@ -4,4 +4,4 @@ post_process do |files|
     log("Could not handle: #{files.join(', ')}")
     log('')
   end
-end
+end

data/lib/kicker/recipes/dot_kick.rb

@@ -4,32 +4,32 @@ module ReloadDotKick #:nodoc
       @features_before_dot_kick = $LOADED_FEATURES.dup
       @chains_before_dot_kick = Kicker.full_chain.map { |c| c.dup }
     end
-    
+
     def call(files)
       reset! if files.delete('.kick')
     end
-    
+
     def use?
       File.exist?('.kick')
     end
-    
+
     def load!
       load '.kick'
     end
-    
+
     def reset!
       remove_loaded_features!
       reset_chains!
       load!
     end
-    
+
     def reset_chains!
       Kicker.full_chain = nil
-      
+
       chains = @chains_before_dot_kick.map { |c| c.dup }
       Kicker.pre_process_chain, Kicker.process_chain, Kicker.post_process_chain = *chains
     end
-    
+
     def remove_loaded_features!
       ($LOADED_FEATURES - @features_before_dot_kick).each do |feat|
         $LOADED_FEATURES.delete(feat)
@@ -44,4 +44,4 @@ if ReloadDotKick.use?
     ReloadDotKick.save_state
     ReloadDotKick.load!
   end
-end
+end

data/lib/kicker/recipes/execute_cli_command.rb

@@ -3,7 +3,7 @@ options.on('-e', '--execute [COMMAND]', 'The command to execute.') do |command|
     files.clear
     execute "sh -c #{command.inspect}"
   end
-  
+
   startup callback
   pre_process callback
 end

data/lib/kicker/recipes/ignore.rb

@@ -7,11 +7,11 @@ module Ignore
   def self.call(files) #:nodoc:
     files.reject! { |file| ignores.any? { |ignore| file =~ ignore } }
   end
-  
+
   def self.ignores #:nodoc:
     @ignores ||= []
   end
-  
+
   def self.ignore(regexp_or_string) #:nodoc:
     ignores << (regexp_or_string.is_a?(Regexp) ? regexp_or_string : /^#{regexp_or_string}$/)
   end
@@ -33,9 +33,9 @@ end
 
 recipe :ignore do
   pre_process Ignore
-  
+
   ignore("tmp")
   ignore(/\w+\.log/)
   ignore(/\.(svn|git)\//)
   ignore("svn-commit.tmp")
-end
+end

data/lib/kicker/recipes/jstest.rb

@@ -7,4 +7,4 @@ recipe :jstest do
     end
     execute "jstest #{test_files.join(' ')}" unless test_files.empty?
   end
-end
+end

data/lib/kicker/recipes/rails.rb

@@ -6,7 +6,7 @@ class Kicker::Recipes::Rails < Kicker::Recipes::Ruby
     %w{ test_type runner_bin test_cases_root test_options }.each do |delegate|
       define_method(delegate) { Kicker::Recipes::Ruby.send(delegate) }
     end
-    
+
     # Maps +type+, for instance `models', to a test directory.
     def type_to_test_dir(type)
       if test_type == 'test'
@@ -43,7 +43,7 @@ class Kicker::Recipes::Rails < Kicker::Recipes::Ruby
       end
     end
   end
-  
+
   # Returns an array of all tests related to the given model.
   def tests_for_model(model)
     if test_type == 'test'
@@ -60,37 +60,37 @@ class Kicker::Recipes::Rails < Kicker::Recipes::Ruby
       }
     end.map { |f| test_file f }
   end
-  
+
   def handle!
     @tests.concat(@files.take_and_map do |file|
       case file
       # Run all functional tests when routes.rb is saved
       when 'config/routes.rb'
         Kicker::Recipes::Rails.all_controller_tests
-      
+
       # Match lib/*
       when /^(lib\/.+)\.rb$/
         test_file($1)
-      
+
       # Map fixtures to their related tests
       when %r{^#{test_cases_root}/fixtures/(\w+)\.yml$}
         tests_for_model($1)
-      
+
       # Match any file in app/ and map it to a test file
       when %r{^app/(\w+)([\w/]*)/([\w\.]+)\.\w+$}
         type, namespace, file = $1, $2, $3
-        
+
         if dir = Kicker::Recipes::Rails.type_to_test_dir(type)
           if type == "views"
             namespace = namespace.split('/')[1..-1]
             file = "#{namespace.pop}_controller"
           end
-          
+
           test_file File.join(dir, namespace, file)
         end
       end
     end)
-    
+
     # And let the Ruby handler match other stuff.
     super
   end
@@ -99,9 +99,9 @@ end
 recipe :rails do
   require 'rubygems' rescue LoadError
   require 'active_support/inflector'
-  
+
   process Kicker::Recipes::Rails
-  
+
   # When changing the schema, prepare the test database.
   process do |files|
     execute 'rake db:test:prepare' if files.delete('db/schema.rb')

data/lib/kicker/recipes/ruby.rb

@@ -2,19 +2,19 @@ class Kicker::Recipes::Ruby
   class << self
     # Assigns the type of tests to run. Eg: `test' or `spec'.
     attr_writer :test_type
-    
+
     # Returns the type of tests to run. Eg: `test' or `spec'.
     #
     # Defaults to `test' if no `spec' directory exists.
     def test_type
       @test_type ||= File.exist?('spec') ? 'spec' : 'test'
     end
-    
+
     # Assigns the ruby command to run the tests with. Eg: `ruby19' or `specrb'.
     #
     # This can be set from the command line with the `-b' or `--ruby' options.
     attr_writer :runner_bin
-    
+
     # Returns the ruby command to run the tests with. Eg: `ruby' or `spec'.
     #
     # Defaults to `ruby' if test_type is `test' and `spec' if test_type is
@@ -22,33 +22,33 @@ class Kicker::Recipes::Ruby
     def runner_bin
       @runner_bin ||= test_type == 'test' ? 'ruby' : 'rspec'
     end
-    
+
     # Assigns the root directory of where test cases will be looked up.
     attr_writer :test_cases_root
-    
+
     # Returns the root directory of where test cases will be looked up.
     #
     # Defaults to the value of test_type. Eg: `test' or `spec'.
     def test_cases_root
       @test_cases_root ||= test_type
     end
-    
+
     attr_writer :test_options #:nodoc:
-    
+
     # Assigns extra options that are to be passed on to the runner_bin.
     #
     #   Ruby.test_options << '-I ./lib/foo'
     def test_options
       @test_options ||= []
     end
-    
+
     def reset!
       @test_type = nil
       @runner_bin = nil
       @test_cases_root = nil
       @test_options = nil
     end
-    
+
     def runner_command(*parts)
       parts.map do |part|
         case part
@@ -59,63 +59,63 @@ class Kicker::Recipes::Ruby
         end
       end.compact.join(' ')
     end
-    
+
     # Runs the given tests, if there are any, with the method defined by
     # test_type. If test_type is `test' the run_with_test_runner method is
     # used. The same applies when test_type is `spec'.
     def run_tests(tests)
       send("run_with_#{test_type}_runner", tests) unless tests.empty?
     end
-    
+
     def test_runner_command(tests)
       tests_without_ext = tests.map { |f| f[0,f.size-3] }
       runner_command(runner_bin, %w{ -I. } + test_options, '-r', tests_without_ext.join(' -r '), "-e ''")
     end
-    
+
     # Runs the given tests with `ruby' as unit-test tests.
     def run_with_test_runner(tests)
       execute(test_runner_command(tests))
     end
-    
+
     def spec_runner_command(tests)
       runner_command(runner_bin, test_options, tests)
     end
-    
+
     # Runs the given tests with `spec' as RSpec tests.
     def run_with_spec_runner(tests)
       execute(spec_runner_command(tests))
     end
   end
-  
+
   def self.call(files) #:nodoc:
     handler = new(files)
     handler.handle!
     run_tests(handler.tests)
   end
-  
+
   # The list of collected tests.
   attr_reader :tests
-  
+
   def initialize(files) #:nodoc:
     @files = files
     @tests = []
   end
-  
+
   # A shortcut to Ruby.test_type.
   def test_type
     self.class.test_type
   end
-  
+
   # A shortcut to Ruby.runner_bin.
   def runner_bin
     self.class.runner_bin
   end
-  
+
   # A shortcut to Ruby.test_cases_root.
   def test_cases_root
     self.class.test_cases_root
   end
-  
+
   # Returns the file for +name+ if it exists.
   #
   #   test_file('foo') # => "test/foo_test.rb"
@@ -125,7 +125,7 @@ class Kicker::Recipes::Ruby
     file = File.join(test_cases_root, "#{name}_#{test_type}.rb")
     file if File.exist?(file)
   end
-  
+
   # This method is called to collect tests. Override this if you're subclassing
   # and make sure to call +super+.
   def handle!
@@ -134,7 +134,7 @@ class Kicker::Recipes::Ruby
       # Match any ruby test file
       when /^#{test_cases_root}\/.+_#{test_type}\.rb$/
         file
-      
+
       # A file such as ./lib/namespace/foo.rb is mapped to:
       # * ./test/namespace/foo_test.rb
       # * ./test/foo_test.rb

data/lib/kicker/utils.rb

@@ -1,36 +1,32 @@
 require 'shellwords' if RUBY_VERSION >= "1.9"
 
 class Kicker
-  Status = Struct.new(:command, :exit_code, :output) do
-    def success?
-      exit_code == 0
-    end
-  end
-
   module Utils #:nodoc:
     extend self
 
     attr_accessor :should_clear_screen
     alias_method :should_clear_screen?, :should_clear_screen
 
-    def perform_work(command)
-      @last_command = command
-      status = Status.new(command, 0, '')
-      will_execute_command(status)
-      yield status
-      did_execute_command(status)
-      status
-    end
-
-    def execute(command)
-      perform_work(command) do |status|
-        _execute(status)
-        yield status if block_given?
+    def perform_work(command_or_options)
+      if command_or_options.is_a?(Hash)
+        options = command_or_options
+      elsif command_or_options.is_a?(String)
+        options = { :command => command_or_options }
+      else
+        raise ArgumentError, "Should be a string or a hash."
       end
+      job = Job.new(options)
+      will_execute_command(job)
+      yield job
+      did_execute_command(job)
+      job
     end
 
-    def last_command
-      @last_command
+    def execute(command_or_options)
+      perform_work(command_or_options) do |job|
+        _execute(job)
+        yield job if block_given?
+      end
     end
 
     def log(message)
@@ -41,14 +37,6 @@ class Kicker
         puts "#{now.strftime('%H:%M:%S')}.#{now.usec.to_s[0,2]} | #{message}"
       end
     end
-    
-    def last_command_succeeded?
-      $?.success?
-    end
-    
-    def last_command_status
-      $?.exitstatus
-    end
 
     def clear_console!
       puts(CLEAR) if Kicker.clear_console?
@@ -58,22 +46,22 @@ class Kicker
 
     CLEAR = "\e[H\e[2J"
 
-    def _execute(status)
+    def _execute(job)
       silent = Kicker.silent?
       unless silent
         puts
         sync_before, $stdout.sync = $stdout.sync, true
       end
       output = ""
-      popen(status.command) do |io|
+      popen(job.command) do |io|
         while str = io.read(1)
           output << str
           $stdout.print str unless silent
         end
       end
-      status.output = output.strip
-      status.exit_code = last_command_status
-      status
+      job.output = output.strip
+      job.exit_code = $?.exitstatus
+      job
     ensure
       unless silent
         $stdout.sync = sync_before
@@ -90,19 +78,30 @@ class Kicker
         IO.popen("#{command} 2>&1", &block)
       end
     end
-    
-    def will_execute_command(status)
+
+    def will_execute_command(job)
       puts(CLEAR) if Kicker.clear_console? && should_clear_screen?
       @should_clear_screen = false
 
-      log "Executing: #{status.command}"
-      Notification.change_occured(status) if Notification.use? && !Kicker.silent?
+      if message = job.print_before
+        log(message)
+      end
+
+      if notification = job.notify_before
+        Notification.notify(notification)
+      end
     end
-    
-    def did_execute_command(status)
-      puts("\n#{status.output}\n\n") if Kicker.silent? && !status.success?
-      log(status.success? ? "Success" : "Failed (#{status.exit_code})")
-      Notification.result(status) if Notification.use?
+
+    def did_execute_command(job)
+      if message = job.print_after
+        puts(message)
+      end
+
+      log(job.success? ? "Success" : "Failed (#{job.exit_code})")
+
+      if notification = job.notify_after
+        Notification.notify(notification)
+      end
     end
   end
 end
@@ -112,22 +111,17 @@ module Kernel
   def log(message)
     Kicker::Utils.log(message)
   end
-  
+
   # When you perform some work (like shelling out a command to run without
   # using +execute+) you need to call this method, with a block in which you
   # perform your work, which will take care of logging the work appropriately.
   def perform_work(command, &block)
     Kicker::Utils.perform_work(command, &block)
   end
-  
+
   # Executes the +command+, logs the output, and optionally sends user
   # notifications on Mac OS X (10.8 or higher).
   def execute(command, &block)
     Kicker::Utils.execute(command, &block)
   end
-  
-  # Returns the last executed command.
-  def last_command
-    Kicker::Utils.last_command
-  end
 end