kicker 3.0.0 → 4.0.0.p1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3f1b8e56a45f76314daaf713f764f37228d42b4
+  data.tar.gz: 4867e2dbf6f21d39ecd0f7367c6d87bb0b94a9d7
+SHA512:
+  metadata.gz: 1ed6e797ccff80a9a4cbd9d056ac6ae205907fef59c94b72c61c811576caa678df63b82eb043b657fe08e48438b24e5ea8e49eee62839cbc66ca5a97b2eecf2f
+  data.tar.gz: f23d431352c3eea377adee626ae6a76001151585e3a2a50d5f6203a2426a68fd79ebe65eff3781969bafa5ba4c6b351b9ecf033ef7ee9990c2f0a9f9f1b942df

data/COPYING

@@ -0,0 +1,20 @@
+Copyright (c)
+Eloy Duran <eloy.de.enige@gmail.com>
+Manfred Stienstra, Fingertips <manfred@fngtps.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.

data/README.rdoc

@@ -1,150 +0,0 @@
-= Kicker
-
-{<img src="https://secure.travis-ci.org/alloy/kicker.png" />}[http://travis-ci.org/alloy/kicker]
-
-A lean, agnostic, flexible file-change watcher.
-
-== Installation
-
-  $ gem install kicker -s http://gemcutter.org
-
-== 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.
-      -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')
-
-
-== 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:
-* Typical Ruby library.
-* Ruby on Rails, as aforementioned.
-* 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> folder or
-current working directory <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
-
-    Ruby.run_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. 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.
-
-To load recipes from your <tt>~/.kick</tt> file:
-
-  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.
-
-== Notifiers
-
-For platform specific notifications we use the notify gem. For supported
-backends see: https://github.com/jugyo/notify#feature.
-
-You select the notify backend by setting the NOTIFY environment variable.
-
-  gem install terminal-notifier
-  env NOTIFY=terminal-notifier kicker
-
-== Contributors
-
-* Manfred Stienstra (@manfred)
-* Cristi Balan (@evilchelu)
-* Damir Zekic (@sidonath)
-* Adam Keys (@therealadam)

data/bin/kicker

@@ -2,9 +2,7 @@
 
 if $0 == __FILE__
   $:.unshift File.expand_path('../../lib', __FILE__)
-  $:.unshift File.expand_path('../../vendor', __FILE__)
-  require 'rubygems'
 end
 
 require 'kicker'
-Kicker.run
+Kicker::CLI.run(ARGV)

data/lib/kicker.rb

@@ -1,123 +1,22 @@
-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'
-require 'kicker/recipes'
+require 'tidings'
+require 'kicker/core_ext/array'
 
-class Kicker #:nodoc:
-  def self.run(argv = ARGV)
-    Kicker::Options.parse(argv)
-    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
+class Kicker
+  autoload :CLI,          'kicker/cli'
+  autoload :Deprecated,   'kicker/deprecated'
+  autoload :Formatter,    'kicker/formatter'
+  autoload :OptionParser, 'kicker/option_parser'
+  autoload :Script,       'kicker/script'
+  autoload :VERSION,      'kicker/version'
+  autoload :Watcher,      'kicker/watcher'
 
-  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)
-        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 = 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
-      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).sort[2..-1].map { |f| File.join(dir, f) }
-  rescue Errno::ENOENT
-    []
-  end
+  extend Kicker::Formatter
 
-  def file_changed_since_last_event?(file)
-    File.mtime(file) > @last_event_processed_at
-  rescue Errno::ENOENT
-    false
+  def self.debug(*)
+    # By default we ignore all debugging information
   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
+  def self.version
+    Kicker::VERSION
   end
-end
+end

data/lib/kicker/cli.rb

@@ -0,0 +1,130 @@
+class Kicker
+  class CLI
+    def initialize(argv)
+      @options, @argv = Kicker::OptionParser.parse(argv)
+    end
+
+    def switches
+      @options.map(&:first)
+    end
+
+    def any_switch?(*test)
+      !(switches & test).empty?
+    end
+
+    def option_value(*switches)
+      @options.each do |key, value|
+        if switches.include?(key)
+          return value
+        end
+      end; nil
+    end
+
+    def osx?
+      RUBY_PLATFORM.downcase.include?("darwin")
+    end
+
+    def debug?
+      $DEBUG || any_switch?('d', 'debug')
+    end
+
+    def show_version?
+      any_switch?('v', 'version')
+    end
+
+    def show_usage?
+      any_switch?('h', 'help')
+    end
+
+    def show_version
+      puts Kicker::VERSION
+    end
+
+    def available_recipes_as_sentence
+      available = Kicker::Script.available_recipes
+      available[0..-2].join(', ') + ', and ' + available[-1]
+    end
+
+    def dump_options?
+      any_switch?('dump-options')
+    end
+
+    def dump_options
+      puts options.inspect
+    end
+
+    def show_usage
+      puts "Usage: #{$0} [options] [paths to watch]"
+      puts ""
+      puts "  Available recipes: #{available_recipes_as_sentence}."
+      puts ""
+      puts "OPTIONS"
+      puts ""
+      if osx?
+      puts " -a, --activate:  The application to activate when a notification is clicked. Defaults to `com.apple.Terminal'."
+      end
+      puts " -c, --clear:     Clear console before each run."
+      puts " -d, --debug:     Print debug messages for Kicker internals."
+      puts " -k, --kickfile:  Use a specific Kickfile."
+      puts " -l, --latency:   The time to collect events before acting on them. (float)."
+      puts " -n, --no-notify: Don't send notifications."
+      puts " -q, --quiet:     Quiet output. Don't print timestamps when logging."
+      puts " -r, --recipe:    Load named recipe."
+      puts " -s, --silent:    Don't output anything."
+      puts " -v, --version:   Print the Kicker version."
+    end
+
+    def verbosity
+      if any_switch?('s', 'silent')
+        :silent
+      elsif any_switch?('q', 'quiet')
+        :quiet
+      else
+        :regular
+      end
+    end
+
+    def kickfile
+      if path = option_value('k', 'kickfile')
+        File.absolute_path(path)
+      end
+    end
+
+    def recipes
+      @options.map do |switch, name|
+        if %w(r recipe).include?(switch)
+          name
+        end
+      end.compact
+    end
+
+    def options
+      {
+        activate: option_value('a', 'activate'),
+        clear_before_execute: any_switch?('c', 'clear'),
+        kickfile: kickfile,
+        notifications: !any_switch?('n', 'no-notify'),
+        recipes: recipes,
+        verbosity: verbosity
+      }
+    end
+
+    def run
+      if show_version?
+        show_version
+      elsif show_usage?
+        show_usage
+      elsif dump_options?
+        dump_options
+      else
+        require 'kicker/debug' if debug?
+        watcher = ::Kicker::Watcher.new(options)
+        watcher.run
+      end
+    end
+
+    def self.run(argv)
+      new(argv).run
+    end
+  end
+end