filewatcher 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,32 +1,64 @@
 = Filewatcher
 
-Simple file watcher. Detect detect changes in files.
+Simple file watcher. Monitors changes in files by polling files.
+
+= Command line utility
+
+
+Filewatcher scans filesystem and execute shell commands when files changes.
+
+Usage:
+   filewatcher [-i interval] "<filename>" "<shell command>"
+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"
+
+Options:
+  --interval, -i <f>:   Interval to scan filesystem. Defaults to 0.5 seconds.
+       --version, -v:   Print version and exit
+          --help, -h:   Show this message
+
+
+= Install
+
+  sudo gem install filewatcher
+
+= API
 
 Examples:
 
+Watch a list of files and directories:
+
   require 'filewatcher'
 
-  FileWatcher.new(["file1.txt", "file2.txt"]).watch do |filename|
+  FileWatcher.new(["lib/", "Rakefile"]).watch do |filename|
     puts "Updated " + filename
   end
 
-Watch directories and files:
+Print the names of files beeing watched before we begin:
 
-  FileWatcher.new(["./lib/", "Rakefile", "test"]).watch do |filename|
+  FileWatcher.new(["lib/"],"Watching files:").watch do |filename|
     puts "Updated " + filename
   end
+  => Watching files:
+  lib/filewatcher.rb
 
-Print a list of watched files to stdout out before watching files:
+To check for changes more often than once every second:
 
-  FileWatcher.new(["./lib/"],"Watching files.").watch do |filename|
+  FileWatcher.new(["README.rdoc"]).watch(0.5) do |filename|
     puts "Updated " + filename
   end
 
-To check for changes more often than once every second second:
 
-  FileWatcher.new(["./lib/"],"Watching files.").watch(0.5) do |filename|
-    puts "Updated " + filename
-  end
+= Credits
+
+Code inspired by Tom Lieber's blogg posting: http://alltom.com/pages/detecting-file-changes-with-ruby
+
+Find method by c00lrguy: http://snippets.dzone.com/posts/show/5457
 
 == Note on Patches/Pull Requests
 

data/Rakefile

@@ -6,9 +6,10 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "filewatcher"
     gem.summary = %Q{Simple filewatcher.}
-    gem.description = %Q{Detect detect changes in files.}
+    gem.description = %Q{Detect changes in files.}
     gem.email = "thomas.flemming@gmail.com"
     gem.homepage = "http://github.com/thomasfl/filewatcher"
+    gem.executables = ["filewatcher"]
     gem.authors = ["Thomas Flemming"]
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/bin/filewatcher

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'filewatcher'
+require 'trollop'
+
+options = Trollop::options do
+  version "filewatcher, version 0.1.1 by Thomas Flemming 2011"
+  banner <<-EOS
+Filewatcher scans filesystem and execute shell commands when files changes.
+
+Usage:
+   filewatcher [-i interval] "<filename>" "<shell command>"
+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"
+
+Options:
+EOS
+  opt :interval, "Interval to scan filesystem. Defaults to 0.5 seconds.", :short => 'i', :type => :float
+end
+
+Trollop::die "must have one or two arguments" if(ARGV.size == 0 or ARGV.size > 2)
+
+interval = 0.5
+if(options[:interval] > 0.0)then
+  interval = options[:interval]
+end
+
+files = []
+ARGV[0].split(/\s+/).each do |arg|
+  Dir.glob(arg).each do |file|
+    files << file
+  end
+end
+
+FileWatcher.new(files).watch(interval) do |filename|
+  if(ARGV[1])then
+    system(ARGV[1])
+  else
+    puts "file updated: " + filename
+  end
+end

data/lib/filewatcher.rb

@@ -1,3 +1,6 @@
+# Simple file watcher. Detect changes in files and directories.
+#
+# Issues: Currently doesn't monitor changes in directorynames
 class FileWatcher
 
   def initialize(filenames,print_filelist=false)

data/test/test_filewatcher.rb

@@ -4,7 +4,7 @@ class TestFilewatcher < Test::Unit::TestCase
 
   should "should detect directories and extract filenames" do
 
-    FileWatcher.new(["./test/"],"Watching files. Ctrl-C to abort.").watch(0.1) do |filename|
+    FileWatcher.new(["test/"],"Watching files. Ctrl-C to abort.").watch(0.1) do |filename|
       puts "updated: " + filename
     end
 

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: filewatcher
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Thomas Flemming
@@ -9,35 +15,38 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-25 00:00:00 +01:00
-default_executable: 
+date: 2011-01-19 00:00:00 +01:00
+default_executable: filewatcher
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
-description: Detect detect changes in files.
+  type: :development
+  version_requirements: *id001
+description: Detect changes in files.
 email: thomas.flemming@gmail.com
-executables: []
-
+executables: 
+- filewatcher
 extensions: []
 
 extra_rdoc_files: 
 - LICENSE
 - README.rdoc
 files: 
-- .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
+- bin/filewatcher
 - lib/filewatcher.rb
 - test/helper.rb
 - test/test_filewatcher.rb
@@ -46,26 +55,32 @@ homepage: http://github.com/thomasfl/filewatcher
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Simple filewatcher.

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC