rstake 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.rvmrc
+*~

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rico Sta. Cruz
+
+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.md

@@ -0,0 +1,28 @@
+RStake
+======
+
+Watches a list of files for changes.
+Heavily inspired by the original RStakeout by topfunky.
+
+Installation
+------------
+
+    gem install rstake
+
+Usage
+-----
+
+Type 'rstake' for more information on usage.
+
+Examples:
+
+    # Watch Ruby files for changes, then run a test when needed.
+    rstake "rake test" **/**/*.rb
+
+    # Automatically compile CSS files using Less.
+    rstake "lessc {}" css/*.less
+
+Tips
+----
+
+ - Install Growl and growlnotify if you're on OSX.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rstake"
+    gem.summary = "Watch a directory for changes."
+    gem.description = "Watches a list of files for changes, and executes a given command when any changes are detected."
+    gem.email = "rico@sinefunc.com"
+    gem.homepage = "http://github.com/sinefunc/rstake"
+    gem.authors = ["Rico Sta. Cruz", "Sinefunc, Iinc."]
+    gem.add_dependency "growl", ">= 1.0.3"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/rstake

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'ostruct'
+require 'optparse'
+
+require File.join(File.dirname(__FILE__), %w[.. lib rstake])
+
+options = { :sleep_time => 1, :async => false, :no_growl => false }
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [options] <command> <filespec>+\n\n" +
+                "  Watches a list of files <filespec>, and executes <command> if any changes\n" +
+                "  are detected.\n\n"+
+                "  <command> is the command to be executed. If '%f' is found in the command,\n" +
+                "  it will be replaced by the filenames that changed. <filespec> can be list\n" +
+                "  of filenames or globs.\n\n" +
+                "Options:\n"
+  opts.on("-t", "--sleep-time T", Integer, "time to sleep after each loop iteration") do |t|
+    options[:sleep_time] = t
+  end
+  opts.on("-a", "--async", "asynchronous mode (allow simultaneous runs)") do |v|
+    options[:async] = v
+  end
+  opts.on("--no-growl", "disable Growl notifications") do |v|
+    options[:no_growl] = true
+  end
+end
+parser.parse!
+
+if ARGV.size < 2
+  cmd = File.basename($0)
+  puts parser
+  puts ""
+  puts "Examples:"
+  puts ""
+  puts "    # Runs a test for any changes in any of the Ruby files."
+  puts "    #{cmd} \"rake test\" **/**/*.rb"
+  puts ""
+  puts "    # Automatically compile CSS files using Less."
+  puts "    #{cmd} \"lessc %f\" css/*.less"
+  puts ""
+  exit
+end
+
+app = RStake::App.new(ARGV[0], ARGV[1..-1], options)
+app.notifiers << RStake::PrintNotifier.new
+unless !options[:no_growl]
+  if RStake.const_defined?(:GrowlNotifier)
+    app.notifiers << RStake::GrowlNotifier.new
+  else
+    puts "Type `sudo gem install growl` to enable growl notifications."
+  end
+end
+
+app.run!

data/lib/rstake.rb

@@ -0,0 +1,12 @@
+module RStake
+  PREFIX = File.join(File.dirname(__FILE__), 'rstake')
+  autoload :App,           "#{PREFIX}/app"
+  autoload :PrintNotifier, "#{PREFIX}/print_notifier"
+  autoload :Watcher,       "#{PREFIX}/watcher"
+end
+
+begin
+  require "#{RStake::PREFIX}/growl_notifier"
+rescue LoadError
+  # No growl
+end

data/lib/rstake/app.rb

@@ -0,0 +1,55 @@
+module RStake
+  class App
+    attr_accessor :notifiers
+
+    def initialize(command, files, options={})
+      require 'shellwords'
+
+      @command   = command
+      @files     = Watcher.new(files)
+      @notifiers = Array.new
+      @options   = options
+    end
+
+    def notify(msg, *args)
+      @notifiers.each { |n| n.send(msg, *args)  if n.respond_to?(msg) }
+    end
+
+    # Runs a command
+    def exec(*a)
+      @options[:async] ? fork { _exec(*a) } : _exec(*a)
+    end
+
+    def run!
+      notify :on_start, :count => @files.size
+
+      trap("INT") { notify :on_exit; exit }
+
+      loop do
+        sleep @options[:sleep_time]
+        changes = @files.last_change
+        exec changes  if changes.any?
+      end
+    end
+
+  private
+
+    # Delegate function of exec
+    def _exec(files)
+      @id     = (@id || 0) + 1
+      command = @command.gsub('%f', files.shelljoin)
+      options = { :id => @id, :files => files, :command => command }
+
+      notify :on_change, options
+      notify :on_exec,   options
+
+      system command
+
+      if $?.to_i > 0
+        notify :on_fail, options.merge(:error => $?)
+      else
+        notify :on_success, options
+      end
+    end
+  end
+end

data/lib/rstake/growl_notifier.rb

@@ -0,0 +1,31 @@
+module RStake
+  class GrowlNotifier
+    def initialize
+      require 'growl'
+    end
+
+    def on_start(options={})
+      Growl.notify_info "Waiting for changes on #{options[:count]} files.",
+                        :title => "Watching changes"
+    end
+
+    def on_change(options={})
+      Growl.notify "#{options[:files].join("\n")}\n\nRunning...",
+                   :title      => "#{options[:files].size} files changed",
+                   #:sticky     => true,
+                   :identifier => "g#{options[:id]}"
+    end
+
+    def on_fail(options={})
+      Growl.notify_error "The command exited with error #{options[:error].to_i}.",
+                          :title      => "Failed",
+                          :identifier => "g#{options[:id]}"
+    end
+
+    def on_success(options={})
+      Growl.notify_ok "The command ran successfully.",
+                      :title      => "Success!",
+                      :identifier => "g#{options[:id]}"
+    end
+  end
+end

data/lib/rstake/print_notifier.rb

@@ -0,0 +1,43 @@
+module RStake
+  class PrintNotifier
+    def on_start(options={})
+      msg "Watching #{options[:count]} files, ^C to abort."
+    end
+
+    def on_fail(options={})
+      msg_error "Done with errors; exited with #{options[:error]}."
+      msg "Still watching..."
+    end
+
+    def on_success(options={})
+      msg "Done. Still watching..."
+    end
+
+    def on_exit(options={})
+      puts ''
+      msg "Ctrl+C. That's all folks!"
+    end
+
+    def on_change(options={})
+      msg "Changed #{options[:files].size} files (#{options[:files].join(', ')})"
+    end
+
+    def on_exec(options={})
+      msg_command options[:command]
+    end
+
+  protected
+    def msg(message, glyph='***', color_1=32, color_2=33)
+      # 30 grey, 32 green, 31 red, 33 yellow
+      warn "\033[1;#{color_1}m#{glyph}\033[1;#{color_2}m #{message}\033[0m"
+    end
+
+    def msg_command(message)
+      msg message, '  >', 32, 30
+    end
+
+    def msg_error(message)
+      msg message, '***', 31, 31
+    end
+  end
+end

data/lib/rstake/watcher.rb

@@ -0,0 +1,36 @@
+module RStake
+  # Watches a list of files for changes.
+  #
+  # Common usage:
+  #
+  #     w = Watcher.new([file1, file2])
+  #     w.last_change
+  #
+  class Watcher
+    def initialize(files)
+      @files = files
+      @times = mtimes
+    end
+
+    # Returns an array of filenames that have been changed since it
+    # was last called.
+    def last_change
+      new_times = mtimes
+      ret = new_times.select { |k, v| @times[k] != v }
+      @times = new_times
+      ret.keys
+    end
+
+    # Returns a hash with filenames as keys, and their mtimes as values.
+    def mtimes
+      @files.inject({}) do |hash, g|
+        Dir[g].each { |file| hash[file] = File.mtime(file) }
+        hash
+      end
+    end
+
+    def size
+      @files.size
+    end
+  end
+end

data/rstake.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rstake}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rico Sta. Cruz", "Sinefunc, Iinc."]
+  s.date = %q{2010-11-17}
+  s.default_executable = %q{rstake}
+  s.description = %q{Watches a list of files for changes, and executes a given command when any changes are detected.}
+  s.email = %q{rico@sinefunc.com}
+  s.executables = ["rstake"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bin/rstake",
+     "lib/rstake.rb",
+     "lib/rstake/app.rb",
+     "lib/rstake/growl_notifier.rb",
+     "lib/rstake/print_notifier.rb",
+     "lib/rstake/watcher.rb",
+     "rstake.gemspec"
+  ]
+  s.homepage = %q{http://github.com/sinefunc/rstake}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Watch a directory for changes.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<growl>, [">= 1.0.3"])
+    else
+      s.add_dependency(%q<growl>, [">= 1.0.3"])
+    end
+  else
+    s.add_dependency(%q<growl>, [">= 1.0.3"])
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: rstake
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rico Sta. Cruz
+- Sinefunc, Iinc.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-17 00:00:00 +08:00
+default_executable: rstake
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: growl
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id001
+description: Watches a list of files for changes, and executes a given command when any changes are detected.
+email: rico@sinefunc.com
+executables: 
+- rstake
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/rstake
+- lib/rstake.rb
+- lib/rstake/app.rb
+- lib/rstake/growl_notifier.rb
+- lib/rstake/print_notifier.rb
+- lib/rstake/watcher.rb
+- rstake.gemspec
+has_rdoc: true
+homepage: http://github.com/sinefunc/rstake
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Watch a directory for changes.
+test_files: []
+