lather 1.4.0

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+=== 1.4.0 / 2009-06-22
+
+* Release as a Gem.
+* Switch to MiniTest.
+* Switch to new Hoe.

data/Manifest.txt

@@ -0,0 +1,11 @@
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+bin/lather
+lib/lather.rb
+lib/lather/cli.rb
+lib/lather/watcher.rb
+lib/rake/lathertask.rb
+test/test_cli.rb
+test/test_watcher.rb

data/README.rdoc

@@ -0,0 +1,117 @@
+= Lather
+
+* http://github.com/jbarnette/lather
+
+== Description
+
+Lather is an easy way to watch files and do something when they
+change. By default, it checks for changes every second.
+
+== Examples
+
+=== From the Command Line
+
+The <tt>lather</tt> command-line tool lets you quickly track changes
+to a set of files.
+
+    $ lather 'test/**/*_test.rb'
+
+By default, <tt>lather</tt> will print a message each time a file
+matching your spec changes. <tt>**</tt> 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 "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
+
+=== From a Rakefile
+
+    require "rake/lathertask"
+
+    Rake::LatherTask.new "lib/**/*.rb" do |l|
+      l.target = :something
+      l.globs << "ext/**/*.{c,h}"
+    end
+
+This creates a <tt>lather</tt> task, which will call the
+<tt>target</tt> task any time the <tt>globs</tt> change. The block is
+optional: <tt>target</tt> defaults to <tt>:test</tt>.
+
+If <tt>target</tt> is set to an *instance* of <tt>Rake::TestTask</tt>,
+some special behavior is enabled: Lather will add the test task's file
+list to <tt>globs</tt>, and will set the <tt>TEST</tt> environment
+variable to the list of tests that need to be run.
+
+    require "rake/testtask"
+    require "rake/lathertask"
+
+    test = Rake::TestTask.new do |t|
+      t.libs << "test"
+      t.pattern = "test/**/*_test.rb"
+    end
+
+    Rake::LatherTask.new "lib/**/*.rb", :target => test
+
+The heuristic is really simple: If <tt>lib/foo.rb</tt> changes, any
+test whose path contains `foo` will be run. There's no tracking of
+failures or single test runs. If you want more than this, you should
+be using Autotest.
+
+== Installation
+
+    $ gem install lather
+
+== TODO
+
+* A way to get at the list of changed files in a <tt>-r</tt> command.
+
+* Some default exclude (like backup/editor files, <tt>.svn</tt>,
+  <tt>.git</tt>) patterns, and an easy way to add new ones.
+
+* A <tt>--sleep <secs></tt> switch for the command-line tool.
+
+== Thanks
+
+Lather owes a huge debt to Ryan Davis' ZenTest library, specifically
+<tt>autotest</tt>. Use it. See also Mike Clark and Geoffrey
+Grosenbach's <tt>rstakeout</tt>, and a bunch of similar I've
+forgotten.
+
+== License
+
+Copyright 2009 John Barnette (jbarnette@rubyforge.org)
+
+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,65 @@
+require "rubygems"
+require "hoe"
+
+Hoe.spec "lather" do
+  developer "John Barnette", "jbarnette@rubyforge.org"
+
+  self.extra_rdoc_files = FileList["*.rdoc"]
+  self.history_file     = "CHANGELOG.rdoc"
+  self.readme_file      = "README.rdoc"
+  self.testlib          = :minitest
+end
+
+# require "rubygems/specification"
+# require "rake/testtask"
+
+# require "./lib/lather"
+# require "./lib/rake/lathertask"
+
+# desc "Straighten up"
+# task :clean do
+#   rm_rf "*.gem"
+# end
+
+# namespace :gem do
+#   LATHER = 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
+
+#   gemspec = file "#{LATHER.name}.gemspec" => LATHER.files do |file|
+#     File.open(file.name, "w") do |f|
+#       f.puts LATHER.to_ruby
+#     end
+#   end
+
+#   gemfile = file "#{LATHER.name}-#{LATHER.version}.gem" => gemspec do |file|
+#     sh "gem build #{file.prerequisites.first}"
+#   end
+
+#   desc "Build and install the gem"
+#   task :install => [gemfile, :clean] do
+#     sh "sudo gem install #{LATHER.name}-#{LATHER.version}.gem"
+#   end
+# end
+
+# test = Rake::TestTask.new do |t|
+#   t.libs      << "test"
+#   t.ruby_opts << "-rhelper"
+#   t.pattern    = "test/**/*_test.rb"
+# end
+
+# task :default => :test
+# Rake::LatherTask.new "lib/**/*.rb", :target => test

data/bin/lather

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

data/lib/lather.rb

@@ -0,0 +1,5 @@
+require "lather/watcher"
+
+module Lather
+  VERSION = "1.4.0"
+end

data/lib/lather/cli.rb

@@ -0,0 +1,69 @@
+require "optparse"
+
+require "lather"
+
+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/watcher.rb

@@ -0,0 +1,52 @@
+module Lather
+  class Watcher
+    attr_reader :files
+    attr_reader :options
+
+    def initialize *globs, &callback
+      raise ArgumentError, "need a callback" unless block_given?
+      @callback = callback
+
+      @options = { :force => false, :sleep => 1 }
+      @options.merge!(globs.pop) if globs.last.is_a? Hash
+
+      @globs = globs.flatten
+      @files = find_files
+    end
+
+    def go!
+      @timestamp = Time.now
+
+      @callback[@files.keys] if @options[:force]
+
+      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.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/lib/rake/lathertask.rb

@@ -0,0 +1,103 @@
+require "rake"
+require "rake/tasklib"
+require "lather/watcher"
+
+module Rake
+
+  # Runs the <tt>target</tt> task any time a file matching one of the
+  # <tt>globs</tt> changes.
+
+  class LatherTask < TaskLib
+
+    # An array of globs to watch.
+
+    attr_accessor :globs
+
+    # A hash of options, most of which are passed on to
+    # <tt>Lather::Watcher</tt>.
+
+    attr_accessor :options
+
+    # The task to run when things change. Default is
+    # <tt>:test</tt>. If this is an instance of
+    # <tt>Rake::TestTask</tt>, the task's <tt>file_list</tt> will be
+    # added to <tt>globs</tt>, and the <tt>TEST</tt> environment
+    # variable will be set to a glob of changed tests before each
+    # invocation.
+
+    attr_accessor :target
+
+    def initialize *globs, &block
+      @options = Hash === globs.last ? globs.pop : {}
+      @globs   = globs
+      @target  = @options.delete(:target) || :test
+
+      @changed = case @target
+                 when Rake::TestTask then handle_rake_test_task
+                 else lambda {}
+                 end
+
+      yield self if block_given?
+
+      @target = Rake::Task[@target]
+
+      desc "Rinse and repeat"
+      task :lather do
+        watcher = Lather::Watcher.new @globs, @options do |changed|
+          begin
+            @changed[changed]
+            @target.invoke
+          rescue StandardError => e
+            raise e unless e.to_s =~ /^Command failed/
+          ensure
+            reenable @target
+          end
+        end
+
+        watcher.go!
+      end
+    end
+
+    # Get and set the block called each time a file matching one of
+    # the <tt>globs</tt> changes. Default is <tt>lambda {}</tt>.
+
+    def changed &block
+      return @changed unless block_given?
+      @changed = block
+    end
+
+    private
+
+    def reenable target
+      target.reenable
+      target.prerequisites.each { |p| reenable Rake::Task[p] }
+    end
+
+    # Special setup when <tt>target</tt> is a <tt>Rake::TestTask</tt>.
+
+    def handle_rake_test_task
+      test_task = @target
+      all_tests = test_task.file_list
+
+      @target = test_task.name
+      @globs << test_task.file_list
+      @options[:force] = true
+
+      lambda do |changed|
+        tests = all_tests & changed
+
+        basenames = (changed - tests).collect do |f|
+          File.basename(f).split(".").first
+        end
+
+        tests.concat all_tests.
+          select { |t| basenames.any? { |b| t =~ /#{b}/ } }
+
+        tests = all_tests.dup if tests.empty?
+
+        # Nice API, Rake::TestTask.
+        ENV["TEST"] = "{#{tests.uniq.join(',')}}"
+      end
+    end
+  end
+end

data/test/test_cli.rb

@@ -0,0 +1,29 @@
+require "minitest/autorun"
+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/test_watcher.rb

@@ -0,0 +1,12 @@
+require "minitest/autorun"
+require "lather/watcher"
+
+module Lather
+  class WatcherTest < MiniTest::Unit::TestCase
+    def test_initialize_complains_without_a_callback
+      assert_raises ArgumentError do
+        Lather::Watcher.new
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: lather
+version: !ruby/object:Gem::Version 
+  version: 1.4.0
+platform: ruby
+authors: 
+- John Barnette
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.0
+    version: 
+description: |-
+  Lather is an easy way to watch files and do something when they
+  change. By default, it checks for changes every second.
+email: 
+- jbarnette@rubyforge.org
+executables: 
+- lather
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/lather
+- lib/lather.rb
+- lib/lather/cli.rb
+- lib/lather/watcher.rb
+- lib/rake/lathertask.rb
+- test/test_cli.rb
+- test/test_watcher.rb
+has_rdoc: true
+homepage: http://github.com/jbarnette/lather
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: lather
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Lather is an easy way to watch files and do something when they change
+test_files: 
+- test/test_cli.rb
+- test/test_watcher.rb