filewatcher 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 580b8d90d111cb7706b3c3a4f587bbb44ef3589c
-  data.tar.gz: b91ab8f3512252cda8da5a6e137f6919857df4e8
+  metadata.gz: 822dcac9d604c0ba52d968e3bf92df44da1e1512
+  data.tar.gz: 6851bd0744d58eb1a9150c35fb27ace77f261793
 SHA512:
-  metadata.gz: a76f9a6b2153aae280c48357a32df976123da3c8f5f8a9e726812ab4a4b9cfe2292b2789b337da7b759d36b8962c373b7e372c27ce5fd5e8bfc891af8ceda307
-  data.tar.gz: 82e485c94aba35cae31403d8f9d043135bde656cd3a34b37b4d8abe31eed628bb74375b675ed027611b22b071aacb7f97cc73cd4aa513739b8c7d71e295a6364
+  metadata.gz: 173d5fc6f40ef6180110bf21169ab6b59f6f40a78cecad86bef0a21541e218febca5f13ed57247f4b0eb84ac08f1cbd2bbac89f6a4a25e61e9378e4f5ac70d21
+  data.tar.gz: 32a2ac8c557f68880771eb6423be097fca08b8eff914812361de881a3fe7f19342f2afc9e81f1051fe7d60c00825279405f81d9494ca2854c804654f860008f7

data/README.md

@@ -1,7 +1,10 @@
 Filewatcher
 ===========
 
-[![Build Status](https://secure.travis-ci.org/judofyr/temple.png?branch=master)](http://travis-ci.org/judofyr/temple) [![Dependency Status](https://gemnasium.com/judofyr/temple.png?travis)](https://gemnasium.com/judofyr/temple) [![Code Climate](https://codeclimate.com/github/judofyr/temple.png)](https://codeclimate.com/github/judofyr/temple)
+[![Gem Version](https://badge.fury.io/rb/filewatcher.svg)](http://badge.fury.io/rb/filewatcher)
+[![Build Status](https://secure.travis-ci.org/thomasfl/filewatcher.png?branch=master)](http://travis-ci.org/thomasfl/filewatcher)
+[![Dependency Status](https://gemnasium.com/thomasfl/filewatcher.png?travis)](https://gemnasium.com/thomasfl/filewatcher)
+[![Code Climate](https://codeclimate.com/github/thomasfl/filewatcher.png)](https://codeclimate.com/github/thomasfl/filewatcher)
 
 Lightweight filewatcher weighing less than 200 LoC. No dependencies or platform specific code.
 Works everywhere. Monitors changes in the filesystem by polling. No config files needed to run.
@@ -84,7 +87,6 @@ Command line options
 
     --interval, -i <f>:   Interval in seconds to scan filesystem. Defaults to 0.5 seconds.
             --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
@@ -102,6 +104,30 @@ Watch a list of files and directories:
       puts "Updated " + filename
     end
 
+Watch a single directory, for changes in all files and subdirectories:
+
+    FileWatcher.new("lib/").watch do |filename|
+      ...
+    end
+
+Notice that the previous is equivalent to the following:
+
+    FileWatcher.new("lib/**/*").watch do |filename|
+      ...
+    end
+
+Watch files and dirs in the given directory - and not in subdirectories:
+
+    FileWatcher.new("lib/*").watch do |filename|
+      ...
+    end
+
+Watch an absolute directory:
+
+    FileWatcher.new("/tmp/foo").watch do |filename|
+      ...
+    end
+
 To detect if a file is updated, added or deleted:
 
     FileWatcher.new(["README.rdoc"]).watch() do |filename, event|
@@ -143,16 +169,12 @@ for syntax.
 The filewatcher library is just a single file with 96 LOC (including comments)
 with no dependencies.
 
-TODO
-----
-
-Use thor in the command line utility.
-The Ruby API is fairly well tested but the command line program has been
-buggy.
 
 Credits
 -------
 
+Support for absolute and globbed paths by flbulgarelli: https://github.com/flbulgarelli
+
 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

data/Rakefile

@@ -6,24 +6,3 @@ task :default => :test
 task :test do
   sh "bacon -Ilib -Itest --automatic --quiet"
 end
-
-# begin
-#   require 'jeweler'
-#   Jeweler::Tasks.new do |gem|
-#     gem.name = "filewatcher"
-#     gem.summary = %Q{Simple filewatcher.}
-#     gem.description = %Q{Detect changes in filesystem.}
-#     gem.email = "thomas.flemming@gmail.com"
-#     gem.homepage = "http://github.com/thomasfl/filewatcher"
-#     gem.executables = ["filewatcher"]
-#     gem.authors = ["Thomas Flemming"]
-#     gem.add_dependency 'trollop', '~> 2.0'
-#     gem.licenses = ["MIT"]
-#   end
-# rescue LoadError
-#   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-# end
-
-# task :test => :check_dependencies
-
-# task :default => :test

data/bin/filewatcher

@@ -7,7 +7,7 @@ require 'pathname'
 options = Trollop::options do
   version "filewatcher, version #{FileWatcher.VERSION} by Thomas Flemming 2014"
   banner <<-EOS
-Filewatcher scans filesystem and execute shell commands when files changes.
+Filewatcher scans the filesystem and executes shell commands when files changes.
 
 Usage:
    filewatcher [-i interval] "<filenames>" "<shell commands>"
@@ -18,13 +18,12 @@ Where
 Examples:
    filewatcher "myfile" "echo 'myfile has changed'"
    filewatcher '*.rb' 'ruby $FILENAME'
-
+   filewatcher '**/*.rb' 'ruby $FILENAME' # Watch subdirectories
 Options:
 EOS
 
   opt :interval, "Interval to scan filesystem. Defaults to 0.5 seconds.", :short => 'i', :type => :float, :default => 0.5
   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"
@@ -41,13 +40,6 @@ 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
-
 def split_files_void_escaped_whitespace(files)
   splitted_filenames = []
   files.each do |name|
@@ -106,7 +98,7 @@ FileWatcher.new(files, options[:list]).watch(options[:interval]) do |filename, e
     when :changed
       print "file updated"
     when :delete
-      print "file eleted"
+      print "file deleted"
     when :new
       print "new file"
     else

data/lib/filewatcher.rb

@@ -3,8 +3,10 @@
 # Issues: Currently doesn't monitor changes in directorynames
 class FileWatcher
 
+  attr_accessor :filenames
+
   def self.VERSION
-    return '0.3.5'
+    return '0.3.6'
   end
 
   def initialize(unexpanded_filenames, print_filelist=false)
@@ -78,20 +80,19 @@ class FileWatcher
     if(!patterns.kind_of?Array)
       patterns = [patterns]
     end
-    filenames = []
-    patterns.each do |filename|
-      if(File.directory?(filename))
-        filenames = filenames + find(filename)
-      else
-        filenames = filenames + find('.', filename, true)
-      end
-    end
 
-    return filenames.uniq
+    patterns.map { |it| Dir[fulldepth(it)] }.flatten.uniq
   end
 
-  def find(dir, filename='*.*', subdirs=true)
-    Dir[ subdirs ? File.join(dir.split(/\\/), '**', filename) : File.join(dir.split(/\\/), filename) ]
+  private
+
+  def fulldepth(pattern)
+    if File.directory? pattern
+      "#{pattern}/**/*"
+    else
+      pattern
+    end
   end
 
+
 end

data/test/test_filewatcher.rb

@@ -3,8 +3,55 @@ require 'bacon'
 require 'fileutils'
 require File.expand_path("../lib/filewatcher.rb",File.dirname(__FILE__))
 
+
+
 describe FileWatcher do
 
+  fixtures =
+    %w(test/fixtures/file4.rb
+       test/fixtures/subdir/file6.rb
+       test/fixtures/subdir/file5.rb
+       test/fixtures/file2.txt
+       test/fixtures/file1.txt
+       test/fixtures/file3.rb)
+
+  explicit_relative_fixtures =  fixtures.map { |it| "./#{it}" }
+
+  subfolder = 'test/fixtures/new_sub_folder'
+
+  after do
+    FileUtils.rm_rf subfolder
+  end
+
+  def includes_all(elements)
+    lambda { |it| elements.all? { |element| it.include? element }}
+  end
+
+  it "should handle absolute paths with globs" do
+    filewatcher = FileWatcher.new(File.expand_path('test/fixtures/**/*'))
+
+    filewatcher.filenames.should.satisfy &includes_all(fixtures.map { |it| File.expand_path(it) })
+  end
+
+  it "should handle globs" do
+    filewatcher = FileWatcher.new('test/fixtures/**/*')
+
+    filewatcher.filenames.should.satisfy &includes_all(fixtures)
+  end
+
+
+  it "should handle explicit relative paths with globs" do
+    filewatcher = FileWatcher.new('./test/fixtures/**/*')
+
+    filewatcher.filenames.should.satisfy &includes_all(explicit_relative_fixtures)
+  end
+
+  it "should handle explicit relative paths" do
+    filewatcher = FileWatcher.new('./test/fixtures')
+
+    filewatcher.filenames.should.satisfy &includes_all(explicit_relative_fixtures)
+  end
+
   it "should detect file deletions" do
     filename = "test/fixtures/file1.txt"
     open(filename,"w") { |f| f.puts "content1" }
@@ -34,14 +81,21 @@ describe FileWatcher do
   end
 
   it "should detect new files in subfolders" do
-    subfolder = 'test/fixtures/new_sub_folder'
-    filewatcher = FileWatcher.new(["test/fixtures"])
-    filewatcher.filesystem_updated?.should.be.false
     FileUtils::mkdir_p subfolder
+
+    filewatcher = FileWatcher.new(["./test/fixtures"])
     filewatcher.filesystem_updated?.should.be.false
+
     open(subfolder + "/file.txt","w") { |f| f.puts "xyz" }
     filewatcher.filesystem_updated?.should.be.true
-    FileUtils.rm_rf subfolder
+  end
+
+  it "should detect new subfolders" do
+    filewatcher = FileWatcher.new(["test/fixtures"])
+    filewatcher.filesystem_updated?.should.be.false
+
+    FileUtils::mkdir_p subfolder
+    filewatcher.filesystem_updated?.should.be.true
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filewatcher
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Thomas Flemming
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-02 00:00:00.000000000 Z
+date: 2014-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -52,7 +52,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
-description: Detect changes in filesystem.
+description: Detect changes in filesystem. Works anywhere.
 email:
 - thomas.flemming@gmail.com
 executables: