jbarnette-lather 1.0.1

data/README.markdown

@@ -0,0 +1,87 @@
+# Lather
+
+Lather is an easy way to watch files and do something when they
+change. By default, it checks for changes every second.
+
+## From the Command Line
+
+The `lather` command-line tool lets you quickly track changes to a set
+of files.
+
+    $ lather 'test/**/*_test.rb'
+
+By default, `lather` will print a message each time a file matching
+your spec changes. `**` is supported for recursive globbing, but make
+sure to escape/quote the glob so your shell doesn't expand it.
+
+You can also run a command every time something changes:
+
+    $ lather -r 'rake test' '{lib,test}/**/*.rb'
+
+## From Code
+
+    require "rubygems"
+    require "lather"
+    
+    watcher = Lather::Watcher.new "**/*.rb" do |changed|
+      puts "Files changed: #{changed.join(' ')}"
+    end
+    
+    watcher.go!
+
+If you want to mess with the polling interval:
+
+    # :sleep is in seconds
+    Lather::Watcher.new "*.rb", :sleep => 5
+
+## Installing
+
+    $ [sudo] gem install jbarnette-lather -s http://gems.github.com
+
+## Hacking
+
+**The tests aren't working right this second. Check back in a bit.**
+Make sure you have minitest installed. `rake lather` will watch `lib`
+and `test` and re-run the tests when something changes. If you're
+looking for something to work on, think about these:
+
+  * A `:force => true` option for `Lather::Watcher` so it'll call the
+  change proc with all matched files when it first starts.
+  
+  * A way to get at the list of changed files in a `-r` command.
+
+  * Some default exclude (like backup/editor files, `.svn`, `.git`)
+  patterns, and an easy way to add new ones.
+
+  * A `--sleep <secs>` switch for the command-line tool.
+
+## Thanks
+
+Lather owes a huge debt to [Ryan Davis'][ryan] [ZenTest][zt],
+specifically `autotest`. Use it. It'll change your life.
+
+[ryan]: http://blog.zenspider.com
+[zt]: http://www.zenspider.com/ZSS/Products/ZenTest
+
+## License
+
+Copyright 2009 John Barnette [jbarnette@gmail.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/Rakefile

@@ -0,0 +1,46 @@
+require "rubygems"
+require "rubygems/specification"
+
+require "./lib/lather"
+
+namespace :gem do
+  desc "Update the gemspec."
+  task :spec do
+    spec = Gem::Specification.new do |s|
+      s.name         = "lather"
+      s.version      = Lather::VERSION
+      s.platform     = Gem::Platform::RUBY
+      s.has_rdoc     = false
+      s.summary      = "Lather rinses and repeats."
+      s.description  = s.summary
+      s.author       = "John Barnette"
+      s.email        = "jbarnette@gmail.com"
+      s.homepage     = "http://github.com/jbarnette/lather"
+      s.require_path = "lib"
+      s.bindir       = "bin"
+      s.executables  = %w(lather)
+
+      s.files = %w(Rakefile README.markdown) + Dir["{bin,lib,test}/**/*"]
+    end
+
+    File.open("#{spec.name}.gemspec", "w") do |f|
+      f.puts spec.to_ruby
+    end
+  end
+end
+
+desc "Run tests."
+task :test do
+  testify
+end
+
+desc "Rinse, repeat."
+task :lather do
+  Lather::Watcher.new("{lib,test}/**/*.rb") { testify }.go!
+end
+
+def testify
+  puts `ruby -Ilib:test #{Dir['test/**/*_test.rb'].join(' ')}`
+end
+
+task :default => :test

data/bin/lather

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby -w
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/lather")
+require "lather/cli"
+
+trap("INT") { puts; exit 1 }
+Lather::Cli.new.go! ARGV

data/lib/lather.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) ||
+  $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "lather/version"
+require "lather/watcher"

data/lib/lather/cli.rb

@@ -0,0 +1,70 @@
+require "optparse"
+
+require "lather/watcher"
+require "lather/version"
+
+module Lather
+  class Cli
+    def initialize
+      @command = nil
+      @globs = []
+      @verbose = false
+
+      @options = OptionParser.new do |o|
+        o.banner = "#$0 [-hVv] [-r <cmd>] <globs...>"
+        o.separator ""
+
+        o.on "--help", "-h", "-?", "Shows help." do
+          exit help!
+        end
+
+        o.on "--verbose", "-v", "Talks your ear off." do
+          @verbose = true
+        end
+
+        o.on "--version", "-V", "Prints #{Lather::VERSION}." do
+          puts Lather::VERSION
+          exit
+        end
+
+        o.on "--rinse [cmd]", "--run", "-r", "Runs when things change." do |cmd|
+          @command = cmd
+        end
+
+        o.separator ""
+      end
+    end
+
+    def parse! args
+      @options.parse! args
+      @globs.concat args
+      exit help! if @globs.empty?
+    end
+
+    def go! args
+      parse! args
+
+      watcher = Lather::Watcher.new @globs do |files|
+        if @command
+          system @command
+        else
+          puts "Changed: #{files.join(" ")}"
+        end
+      end
+
+      verbose "Watching: #{watcher.files.keys.sort.join(" ")}"
+      watcher.go!
+    end
+
+    private
+
+    def verbose *args
+      puts args.join(" ") if @verbose
+    end
+
+    def help!
+      puts @options
+      1 # process exit code
+    end
+  end
+end

data/lib/lather/version.rb

@@ -0,0 +1,3 @@
+module Lather
+  VERSION = "1.0.1"
+end

data/lib/lather/watcher.rb

@@ -0,0 +1,49 @@
+module Lather
+  class Watcher
+    attr_reader :files
+
+    def initialize *globs, &callback
+      raise ArgumentError, "need a callback" unless block_given?
+      @callback = callback
+
+      @options = { :sleep => 1 }
+      @options.merge!(globs.pop) if globs.last.is_a? Hash
+
+      @globs = globs
+      @files = find_files
+    end
+
+    def go!
+      @timestamp = Time.now
+
+      loop do
+        unless (changed = update_files_and_timestamp).empty?
+          @callback[changed]
+        end
+
+        Kernel.sleep @options[:sleep]
+      end
+    end
+
+    private
+
+    def update_files_and_timestamp
+      @files = find_files
+      updated = @files.keys.select { |k| @files[k] > @timestamp }
+      @timestamp = @files.values.max
+
+      updated
+    end
+
+    def find_files
+      files = {}
+
+      @globs.flatten.collect { |g| Dir[g] }.flatten.each do |file|
+        # silently skip stat failures: file deleted, etc.
+        files[file] = File.stat(file).mtime rescue next
+      end
+
+      files
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,4 @@
+require "rubygems"
+require "minitest/autorun"
+
+require "lather"

data/test/lather/cli_test.rb

@@ -0,0 +1,29 @@
+require "helper"
+require "lather/cli"
+
+module Lather
+  class CliTest < MiniTest::Unit::TestCase
+    def setup
+      @cli = Lather::Cli.new
+      def @cli.exit *args; throw :exit end
+    end
+
+    def parse! *args
+      capture_io do
+        catch(:exit) { @cli.parse! args }
+      end
+    end
+
+    def test_empty_invocation_prints_help
+      out, err = parse!
+      assert_match /Shows help/, out
+    end
+
+    def test_V_option_prints_version
+      %w(-V --version).each do |flag|
+        out, err = parse! flag
+        assert_equal Lather::VERSION, out.chomp
+      end
+    end
+  end
+end

data/test/lather/watcher_test.rb

@@ -0,0 +1,11 @@
+require "helper"
+
+module Lather
+  class WatcherTest < MiniTest::Unit::TestCase
+    def test_initialize_complains_without_a_callback
+      assert_raise ArgumentError do
+        Lather::Watcher.new
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: jbarnette-lather
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- John Barnette
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-28 00:00:00 -08:00
+default_executable: lather
+dependencies: []
+
+description: Lather rinses and repeats.
+email: jbarnette@gmail.com
+executables: 
+- lather
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.markdown
+- bin/lather
+- lib/lather
+- lib/lather/cli.rb
+- lib/lather/version.rb
+- lib/lather/watcher.rb
+- lib/lather.rb
+- test/helper.rb
+- test/lather
+- test/lather/cli_test.rb
+- test/lather/watcher_test.rb
+has_rdoc: false
+homepage: http://github.com/jbarnette/lather
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Lather rinses and repeats.
+test_files: []
+