filewatcher 0.1.5 → 0.1.8

data/README.rdoc

@@ -1,6 +1,6 @@
 = Filewatcher
 
-Simple file watcher. Monitors changes in files by polling files.
+Simple file watcher. Monitors changes in files by polling.
 
 = Command line utility
 
@@ -12,16 +12,47 @@ Where
    filename: filename(s) to scan.
    shell command: shell command to execute when file changes on disk.
 
-Examples:
-   filewatcher "myfile" "echo 'myfile has changed'"
-   filewathcer -i 2 "*.rb ../src/*.rb" "ruby run_tests.rb"
+= Examples:
+
+Run the echo command when the file myfile is changed:
+
+   $ filewatcher "myfile" "echo 'myfile has changed'"
+
+Run the ruby script when it is changed:
+
+   $ filewatcher -e ruby-script.rb
+
+Works with ruby, perl, python and awk by detecting file extensions.
+
+At 2 seconds intervall check all files matching *.rb and ../src/*.rb, and run "ruby run_tests.rb".
+
+   $ filewatcher -i 2 "*.rb ../src/*.rb" "ruby run_tests.rb"
+
+= Globbing
+
+Print a list of all files matching *.css at start and the:
+
+   $ filewatcher -l *.css
+
+= Available enviroment variables
+
+The environment variable $FILENAME is available in the command. On unix like systems the command
+has to be enclosed in single quotes. To run node whenever a javascript file is update:
+
+   $ filewatcher *.js 'node $FILENAME'
+
+The environment variables $FILEPATH and $FILEDIR is also available.
 
 Options:
-  --interval, -i <f>:   Interval to scan filesystem. Defaults to 0.5 seconds.
+  --interval, -i <f>:   Interval to scan filesystem. Defaults to 0.5 seconds. (Default: 0.5)
+          --exec, -e:   Execute file as a script when file is updated.
+   --recurse, -r <s>:   Recurse into the directory, watching everything matching 'expression'
+   --include, -n <s>:   Include files (default: *)
+   --exclude, -x <s>:   Exclude file(s) matching (default: "")
+          --list, -l:   Print name of files being watched
        --version, -v:   Print version and exit
           --help, -h:   Show this message
 
-
 = Install
 
   sudo gem install filewatcher
@@ -54,6 +85,9 @@ To check for changes more often than once every second:
     puts "Updated " + filename
   end
 
+= TODO
+
+The Ruby API is fairly well tested but the command line program is buggy at the time beeing.
 
 = Credits
 
@@ -61,6 +95,8 @@ Code inspired by Tom Lieber's blogg posting: http://alltom.com/pages/detecting-f
 
 Find method by c00lrguy: http://snippets.dzone.com/posts/show/5457
 
+Globbing by Kristoffer Roupé https://github.com/kitofr
+
 == Note on Patches/Pull Requests
 
 * Fork the project.
@@ -74,4 +110,4 @@ Find method by c00lrguy: http://snippets.dzone.com/posts/show/5457
 
 == Copyright
 
-Copyright (c) 2011 Thomas Flemming. See LICENSE for details.
+Copyright (c) 2011 - 2013 Thomas Flemming. See LICENSE for details.

data/Rakefile

@@ -43,7 +43,7 @@ task :test => :check_dependencies
 
 task :default => :test
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.8

data/bin/filewatcher

@@ -2,9 +2,10 @@
 require 'rubygems'
 require 'filewatcher'
 require 'trollop'
+require 'pathname'
 
 options = Trollop::options do
-  version "filewatcher, version 0.1.4 by Thomas Flemming 2011"
+  version "filewatcher, version 0.1.8 by Thomas Flemming 2011"
   banner <<-EOS
 Filewatcher scans filesystem and execute shell commands when files changes.
 
@@ -16,33 +17,54 @@ Where
 
 Examples:
    filewatcher "myfile" "echo 'myfile has changed'"
-   filewathcer -i 2 "*.rb ../src/*.rb" "ruby run_tests.rb"
+   filewatcher -i 2 "*.rb ../src/*.rb" "ruby run_tests.rb"
 
 Options:
 EOS
 
   opt :interval, "Interval to scan filesystem. Defaults to 0.5 seconds.", :short => 'i', :type => :float, :default => 0.5
-  opt :run, "Run file as a program when file is updated.", :short => 'r', :type => :boolean, :default => false
+  opt :exec, "Execute file as a script when file is updated.", :short => 'e', :type => :boolean, :default => false
+  opt :recurse, "Recurse into the directory, watching everything matching 'expression'", :short => 'r', :type => :string
+  opt :include, "Include files", :type => :string, :default => "*"
+  opt :exclude, "Exclude file(s) matching", :type => :string, :default => ""
+  opt :list, "Print name of files being watched"
 end
 
-Trollop::die "must have one or two arguments" if(ARGV.size == 0 or ARGV.size > 2)
+Trollop::die "must have at least one argument" if(ARGV.size == 0)
 
 files = []
-ARGV[0].split(/\s+/).each do |arg|
-  Dir.glob(arg).each do |file|
-    files << file
-  end
+ARGV[0...-1].each do |a|
+  files << a
+end
+
+if(ARGV.length == 1)
+  files << ARGV[0]
+end
+
+if(options[:recurse])
+  base = File.join(options[:recurse], "**")
+  inc = Dir.glob(File.join(base, options[:include]))
+  exc = Dir.glob(File.join(base, options[:exclude]))
+  files = inc - exc
+end
+
+if(options[:list])
+  puts "watching:", files.inspect
 end
 
 runners = {".py" => "python", ".rb" => "ruby", ".pl" => "perl", ".awk" => "awk"}
 
 FileWatcher.new(files).watch(options[:interval]) do |filename|
-  if(options[:run])
+  if(options[:exec])
     extension = filename[/(\.[^\.]*)/,0]
     runner = runners[extension].to_s
     system(runner + " " + filename)
-  elsif(ARGV[1])then
-    system(ARGV[1])
+  elsif(ARGV[-1])then
+    path = Pathname.new(filename)
+    ENV['FILENAME'] = path.to_s
+    ENV['FILEPATH'] = path.realpath.to_s
+    ENV['FILEDIR'] = path.parent.realpath.to_s
+    system(ARGV[-1])
   else
     puts "file updated: " + filename
   end

data/test/test_filewatcher.rb

@@ -1,3 +1,4 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '.'))
 require 'helper'
 
 class TestFilewatcher < Test::Unit::TestCase
@@ -14,7 +15,6 @@ class TestFilewatcher < Test::Unit::TestCase
 
   end
 
-
 #   should "should detect changes in files" do
 
 #     @pid = fork do
@@ -36,4 +36,3 @@ class TestFilewatcher < Test::Unit::TestCase
 #   end
 
 end
-

metadata

@@ -1,58 +1,47 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: filewatcher
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 5
-  version: 0.1.5
+version: !ruby/object:Gem::Version
+  version: 0.1.8
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Thomas Flemming
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-24 00:00:00 +02:00
-default_executable: filewatcher
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: thoughtbot-shoulda
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: &70212885464580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: trollop
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 16
-        - 2
+  version_requirements: *70212885464580
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: &70212885464060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.16.2
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *70212885464060
 description: Detect changes in files.
 email: thomas.flemming@gmail.com
-executables: 
+executables:
 - filewatcher
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
+files:
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -61,35 +50,28 @@ files:
 - lib/filewatcher.rb
 - test/helper.rb
 - test/test_filewatcher.rb
-has_rdoc: true
 homepage: http://github.com/thomasfl/filewatcher
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Simple filewatcher.
 test_files: []
-