wake 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+doc/
+pkg/
+bk/
+.wiki
+.yardoc
+/*.gem

data/LICENSE

@@ -0,0 +1,44 @@
+Wake license:
+
+Copyright (c) 2010 Steven Parkes
+
+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.
+
+Watch license:
+
+Copyright © 2009 Martin Aumont (mynyml)
+
+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/Manifest

@@ -0,0 +1,30 @@
+.gitignore
+History.txt
+LICENSE
+Manifest
+README.rdoc
+Rakefile
+TODO.txt
+bin/wake
+docs.wk
+gem.wk
+lib/wake.rb
+lib/wake/controller.rb
+lib/wake/event_handlers/base.rb
+lib/wake/event_handlers/portable.rb
+lib/wake/event_handlers/unix.rb
+lib/wake/event_handlers/rev.rb
+lib/wake/event_handlers/em.rb
+lib/wake/script.rb
+manifest.wk
+specs.wk
+test/README
+test/event_handlers/test_base.rb
+test/event_handlers/test_portable.rb
+test/event_handlers/test_rev.rb
+test/event_handlers/test_em.rb
+test/test_controller.rb
+test/test_helper.rb
+test/test_script.rb
+test/test_wake.rb
+wake.gemspec

data/README.rdoc

@@ -0,0 +1,105 @@
+=== Summary
+
+The vision for wake is as a sort of rake/make like program, combined
+with the real-time filesystem "watching" aspect of autotest/autospec/watchr.
+
+Wake started out (and still is) mostly a fork of the watchr gem at
+http://github.com/mynyml/watchr.
+
+The are a number of differences now and they're expected to grow.
+
+It's been ported to EventMachine for file-events and has some
+extensions for how watches can be written.
+
+To install, you can clone the repo (http://github.com/smparkes/wake)
+or install the gem, <tt>wake</tt>. Note that for now, you'll need my
+copy of EventMachine (http://github.com/smparkes/eventmachine or the
+<tt>smparkes-eventmachine</tt> gem) for directory watches to work
+well. (These changes are in the process of getting pulled upstream.)
+
+== EventMachine
+
+Not much to say. It supports EM as well as Rev, though the Rev stuff
+will probably be dropped unles there's a compelling reason to keep
+it. The default is still Rev. To use EventMachine, after installing
+the EM gem, I just add
+
+     begin; require 'wake/event_handlers/em'; rescue LoadError; end
+
+to my <tt>Wakefile</tt>. It'll use the first required backend, or
+Rev if none are found (and Rev is installed).  There may be better ways to
+do this.
+
+=== Event processing extensions
+
+I made several changes to the way events are created/processed, mostly
+to make my <tt>Wakefile</tt> work:
+
+  #!/usr/bin/env wake
+
+  begin; require 'wake/event_handlers/em'; rescue LoadError; end
+
+  watch( %r(.*), :modified, lambda { |md| File.directory? md[0] } ) do |md|
+    raise Wake::Refresh
+  end
+
+  watch( %r((public/.*)\.haml$), [ :created, :modified ] ) do |md|
+    cmd = "rm -f #{md[1]}.html && haml -f html5 #{md[0]} #{md[1]}.html && chmod 444 #{md[1]}.html"
+    puts cmd
+    system cmd
+    if  $?.signaled? && $?.termsig == 2
+      Process.kill 2, 0
+    end
+  end
+
+  watch( %r((spec/.*[Ss]pec)\.(html|js)$), [ :load, :created, :modified ] ) do |md|
+    cmd = "jazrb #{md[0]}"
+    puts cmd
+    system cmd
+    if  $?.signaled? && $?.termsig == 2
+      Process.kill 2, 0
+    end
+  end
+
+The purpose of the first watch is to cause wake to refresh when
+directories change. This allows new files to be picked up.  The watch
+pattern matches all files in the current directory tree (though not
+<tt>.</tt> itself; probably should), and watches for
+<tt>:modified</tt> events. It adds an extra lambda that is processed
+while looking at file paths: only directories will get watches put on
+them. (Otherwise <tt>%r(.*)</tt> would put watches on every
+file/directory in the tree, which seems kinda bad.)
+
+The second watch looks for Haml files in my public directory and
+automatically converts them to HTML. These are static files, not
+served by an app server like Rails: even with static files, I hate
+writing raw HTML. The extension here is so that instead of a single event
+type, I can pass an array. In addition to the <tt>:modified</tt>,
+event, this will get called when wake notes that a new file of this
+type has appeared. (Note this works starting from wake's first pass;
+files created while wake wasn't running don't count).
+
+Then final watch looks for JavaScript and HTML spec files and runs
+them under jazrb (see http://github.com/smparkes/jazrb if
+interested). This case is similar to the previous but also adds the
+<tt>:load</tt> event. This event gets fired the first time a file is
+seen after wake starts. This allows wake to run all the specs when
+first started, similar to what autotest does.
+
+=== Recent Changes
+
+1. POC for batch events that occur within a time window
+
+1. Pass event type to callbacks
+
+1. Has some POC dependency detection. Needs to be formalized into an API and have a better backend.
+
+=== Things to do
+
+1. Move directory watch into wake itself
+
+1. Handle user interrupt processing more systematically
+
+1. Don't swallow config file error messages, particularly on reload. Is this still happening?
+
+1. Integrate with rake/make.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rake/rdoctask'
+begin
+  require 'yard'
+rescue LoadError, RuntimeError
+end
+
+desc "Generate rdoc documentation."
+Rake::RDocTask.new(:rdoc => 'rdoc', :clobber_rdoc => 'rdoc:clean', :rerdoc => 'rdoc:force') { |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.title    = "Wake"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('TODO.txt')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}
+
+if defined? YARD
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = %w( lib/**/*.rb )
+    t.options = %w( -o doc/yard --readme README.rdoc --files LICENSE,TODO.txt )
+  end
+end
+
+namespace(:test) do
+
+  desc "Run all tests"
+  task(:all) do
+    tests = Dir['test/**/test_*.rb'] - ['test/test_helper.rb']
+    cmd = "ruby -rubygems -Ilib -e'%w( #{tests.join(' ')} ).each {|file| require file }'"
+    puts cmd if ENV['VERBOSE']
+    system cmd
+  end
+
+  desc "Run all tests on multiple ruby versions (requires rvm with 1.8.6 and 1.8.7)"
+  task(:portability) do
+    versions = %w( 1.8.6  1.8.7 )
+    versions.each do |version|
+      system <<-BASH
+        bash -c 'source ~/.rvm/scripts/rvm;
+                 rvm use #{version};
+                 echo "--------- `ruby -v` ----------\n";
+                 rake -s test:all'
+      BASH
+    end
+  end
+end
+
+task :default => "test:all"

data/bin/wake

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+
+$VERBOSE = true
+
+require 'pathname'
+require 'optparse'
+
+require 'wake'
+
+module Wake
+  # Namespaced to avoid defining global methods
+  module Bin #:nodoc:
+    extend self
+
+    def usage
+      "Usage: wake [opts] [path/to/script]"
+    end
+
+    def version
+      "wake version: %s" % Wake::VERSION
+    end
+
+    # Find a partial path name in load path
+    #
+    # ===== Params
+    # path<Pathname>:: partial pathname
+    #
+    # ===== Returns
+    # <Pathname>::
+    #   absolute path of first occurence of partial path in load path, or nil if not found
+    #
+    def find_in_load_path(path)
+      dir = potentially_with_gem( path.basename('.wk') ) do
+        $LOAD_PATH.detect {|p| Pathname(p).join(path).exist? }
+      end
+      dir ? path.expand_path(dir) : nil
+    end
+
+    private
+
+    # If the block returns nil, requires gem <tt>name</tt> and tries running the
+    # block again. If all fails, returns nil
+    #
+    # ===== Params
+    # name<Pathname,String>:: name of gem to require
+    #
+    # ===== Returns
+    # block's value or nil if gem <tt>name</tt> doesn't exist
+    #
+    def potentially_with_gem(name)
+      yield || (require(name) && yield)
+    rescue LoadError
+      nil
+    end
+  end
+end
+
+opts = OptionParser.new do |opts|
+  opts.banner = Wake::Bin.usage
+
+  opts.on('-d', '--debug', "Print extra debug info while program runs") {
+    Wake.options.debug = true
+    begin
+      require 'ruby-debug'
+    rescue LoadError, RuntimeError
+    end
+  }
+
+  opts.on('-1', '--once', "Run load patterns and then exit") {
+    Wake.options.once = true
+  }
+
+  opts.on('-f', '--wakefile FILE', "use wakefile FILE") { |file|
+    Wake.options.wakefile = file
+  }
+
+  opts.on_tail('-h', '--help', "Print inline help") { puts opts; exit }
+  opts.on_tail('-v', '--version', "Print version" ) { puts Wake::Bin.version; exit }
+
+  opts.parse! ARGV
+end
+
+path = Wake.options.wakefile || "Wakefile"
+relative_path = Pathname( path ) rescue abort(Wake::Bin.usage)
+absolute_path = Wake::Bin.find_in_load_path(relative_path) or abort("no script found; file #{relative_path.to_s.inspect} is not in path.")
+
+Wake::Controller.new(Wake::Script.new(absolute_path)).run
+

data/docs.wk

@@ -0,0 +1,26 @@
+# Run me with:
+#
+#   $ wake -f docs.wk
+
+def run_rdoc
+  system('rake --silent rdoc')
+end
+
+def run_yard
+  print "\nUpdating yardocs... "
+  system('rake --silent yardoc')
+  print "done.\n"
+end
+
+def document
+  run_rdoc
+  run_yard
+end
+
+watch( 'lib/.*\.rb'  ) { document }
+watch( 'README.rdoc' ) { document }
+watch( 'TODO.txt'    ) { document }
+watch( 'LICENSE'     ) { document }
+
+
+# vim:ft=ruby

data/gem.wk

@@ -0,0 +1,32 @@
+# Run me with:
+#
+#   $ wake gem.wk
+
+# --------------------------------------------------
+# Convenience Methods
+# --------------------------------------------------
+def build(gemspec)
+  system "gem build %s" % gemspec
+  FileUtils.mv Dir['wake-*.gem'], 'pkg/'
+  puts
+end
+
+# --------------------------------------------------
+# Wake Rules
+# --------------------------------------------------
+watch( '^wake.gemspec$' ) { |m| build m[0] }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Building Gem ---\n\n"
+  build 'wake.gemspec'
+end
+
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }
+
+
+# vim:ft=ruby

data/lib/wake.rb

@@ -0,0 +1,109 @@
+require 'pathname'
+require 'rbconfig'
+
+# Agile development tool that monitors a directory recursively, and triggers a
+# user defined action whenever an observed file is modified. Its most typical
+# use is continuous testing.
+#
+# Usage:
+#
+#   # on command line, from project's root dir
+#   $ wake path/to/script
+#   # default script if none is given is Wakefile.
+#
+# See README for more details
+#
+module Wake
+  VERSION = '0.1.0'
+
+  autoload :Script,     'wake/script'
+  autoload :Controller, 'wake/controller'
+
+  module EventHandler
+    autoload :Base,     'wake/event_handlers/base'
+    autoload :Unix,     'wake/event_handlers/unix'
+    autoload :Portable, 'wake/event_handlers/portable'
+  end
+
+  class << self
+    # backwards compatibility
+    def version #:nodoc:
+      Wake::VERSION
+    end
+
+    # Options proxy.
+    #
+    # Currently supported options:
+    # * debug<Boolean> Debugging state. More verbose.
+    #
+    # ===== Examples
+    #
+    #   Wake.options.debug #=> false
+    #   Wake.options.debug = true
+    #
+    # ===== Returns
+    # options<Struct>:: options proxy.
+    #
+    #--
+    # On first use, initialize the options struct and default option values.
+    def options
+      @options ||= Struct.new(:debug,:once, :wakefile).new
+      @options.debug ||= false
+      @options.once.nil? and @options.once = false
+      @options
+    end
+
+    def options= arg
+      @options = arg
+    end
+
+    # Outputs formatted debug statement to stdout, only if ::options.debug is true
+    #
+    # ===== Examples
+    #
+    #   Wake.options.debug = true
+    #   Wake.debug('im in ur codes, notifayinin u')
+    #
+    # outputs: "[wake debug] im in ur codes, notifayinin u"
+    #
+    def debug(str)
+      puts "[wake debug] #{str}" if options.debug
+    end
+
+    # Detect current OS and return appropriate handler.
+    #
+    # ===== Examples
+    #
+    #   Config::CONFIG['host_os'] #=> 'linux-gnu'
+    #   Wake.handler #=> Wake::EventHandler::Unix
+    #
+    #   Config::CONFIG['host_os'] #=> 'cygwin'
+    #   Wake.handler #=> Wake::EventHandler::Portable
+    #
+    #   ENV['HANDLER'] #=> 'unix'
+    #   Wake.handler #=> Wake::EventHandler::Unix
+    #
+    #   ENV['HANDLER'] #=> 'portable'
+    #   Wake.handler #=> Wake::EventHandler::Portable
+    #
+    # ===== Returns
+    # handler<Class>:: handler class for current architecture
+    #
+    def handler
+      @handler ||=
+        case ENV['HANDLER'] || Config::CONFIG['host_os']
+          when /mswin|windows|cygwin/i
+            Wake::EventHandler::Portable
+          when /sunos|solaris|darwin|mach|osx|bsd|linux/i, 'unix'
+            Wake::EventHandler::Unix.default
+          else
+            Wake::EventHandler::Portable
+        end
+    end
+    
+    def handler= arg
+      @handler = arg
+    end
+
+  end
+end