filewatcher 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 675a76cd6578899a746e89329be478bed350c571
-  data.tar.gz: ed6ad81fc1932e4898f8b5b917dfe4337eb69fb2
+  metadata.gz: 4e284fa33515d0d74bc7cf8ddc014678e14f3700
+  data.tar.gz: 55d15b651a1246f50f1982ceab55a51afb5c5477
 SHA512:
-  metadata.gz: 8408d2a878bf84b097f8a2b36aae9ecb0adfef11656f9f51b27530ddefcdc6520d5fa36f996afa0abae02da38d23c03caf51232d748380004b89e408419bf963
-  data.tar.gz: e1ee55b9f7a851cd9787dd6e4692ac686d693464fe240f818da02b062b0b35cbd04ced05103b878f3d7ee6fd1ff8bf2f4958272b47bb1871096c608287ad03e1
+  metadata.gz: 623df61d04ce2ab7b920d1718ddfbf7ac1791f617b17bac3e740a9b72235c9dabb0ea3824afe16cf07ac6d5e5391b4e41663c58701dcf465811c1e7c98044d4c
+  data.tar.gz: 4564616b0ecc6d8cdb781ea9d84790c2a60c3c89cb63f5cf915cefaf5810369b00e13c78fc3c2fee532a0d69b576d56666f252a19e542a11a129ae98dbe1d9c2

data/README.md

@@ -6,13 +6,9 @@ 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. Has no config files.
-When running filewatcher from the command line, you specify which files to monitor and what action
-to perform on updates.
+Lightweight filewatcher weighing less than 200 LoC. No dependencies or platform specific code. Works everywhere. Monitors changes in the filesystem by polling. Has no config files. When running filewatcher from the command line, you specify which files to monitor and what action to perform on updates.
 
-For example to search recursively for javascript files and run jshint when a file is
-updated, added, renamed or deleted:
+For example to search recursively for javascript files and run jshint when a file is updated, added, renamed or deleted:
 
 Linux/OSX:
 
@@ -60,7 +56,7 @@ In Linux/OSX:
 
 Place filenames or filenames in quotes to use ruby filename globbing instead
 of shell filename globbing. This will make filewatcher look for files in
-subdirectories too. To watch all javascript files in subdirectories:
+subdirectories too. To watch all javascript files in subdirectories in Windows:
 
     > filewatcher "**/*.js" "node %FILENAME%"
 
@@ -77,7 +73,7 @@ python, ruby, perl, php, javascript or awk script.
 Print a list of all files matching *.css first and then output the filename
 when a file is beeing updated by using the --list/-l option:
 
-    $ filewatcher -l *.css 'echo file: $FILENAME'
+    $ filewatcher -l '**/*.css' 'echo file: $FILENAME'
 
 Watch the "src" and "test" folders recursively, and run test when the
 filesystem gets updated:
@@ -93,7 +89,7 @@ The `--restart` option kills the command if it's still running when a filesystem
 
 The `--dontwait` option starts the command on startup without waiting for filesystem updates. To start a webserver and have it automatically restart when html files are updated:
 
-    $ filewatcher --restart --dontwait "*.html" "python -m SimpleHTTPServer"
+    $ filewatcher --restart --dontwait "**/*.html" "python -m SimpleHTTPServer"
 
 Available enviroment variables
 ------------------------------
@@ -104,17 +100,24 @@ node whenever a javascript file is updated:
 
     $ filewatcher *.js 'node $FILENAME'
 
-The environment variables $FILEPATH, $FILEDIR and $FSEVENT is also available.
+Environment variables available from the command string:
+
+    BASENAME           File basename.
+    FILENAME           Relative filename.
+    ABSOLUTE_FILENAME  Asolute filename.
+    RELATIVE_FILENAME  Same as FILENAME but starts with "./"
+    EVENT              Event type. Is either 'changed', 'delete' or 'new'.
+    DIRNAME            Absolute directory name.
 
 Command line options
 --------------------
 
 Useful command line options:
 
-            --list, -l:   Print name of files being watched on startup
+            --list, -l:   Print name of matching files on startup
          --restart, -r:   Run command in separate fork and kill it on filesystem updates
         --dontwait, -d:   Run the command before any filesystem updates
-         --spinner, -s:   Display an animated spinner
+         --spinner, -s:   Display an animated spinner while scanning
 
 Other command line options:
 
@@ -174,21 +177,17 @@ To detect if a file is updated, added or deleted:
       end
     end
 
-When a file is renamed it is detected as a deletion followed by a file addition.
+When a file is renamed it is detected as a new file followed by a file deletion.
 
-To check for changes more often than the default once every second:
+The API takes some of the same options as the command line interface. To watch all files recursively except files that matches *.rb, display a spinner and only wait for 0.1 seconds between each scan:
 
-    FileWatcher.new(["README.rdoc"]).watch(0.5) do |filename|
-      puts "Updated " + filename
+    FileWatcher.new('**/*.*', exclude: '**/*.rb', spinner: true, interval: 0.1).watch() do |filename|
+        puts filename
     end
 
-Print the names of the files found before watching files and folders:
+To do the same from the command line, use the same options:
 
-    FileWatcher.new(["lib/"],true).watch do |filename|
-      puts "Updated " + filename
-    end
-    => Watching files:
-    lib/filewatcher.rb
+    $ filewatcher '**/*.*' --exclude '**/*.rb' --spinner --interval 0.1 'echo $FILENAME'
 
 Use patterns to match filenames in current directory and subdirectories. The
 pattern is not a regular expression; instead it follows rules similar to shell
@@ -222,9 +221,25 @@ over the network)
     filewatcher.finalize   # Ensure all filesystem changes made prior to
                            # ending the watch are handled.
 
-The filewatcher library is just a single file with 147 LOC (including comments)
+If basename, relative filename or absolute filename is necessay use the stanard lib 'pathname' like this:
+
+    require 'pathname'
+
+    FileWatcher.new(["**/*.*"]).watch() do |filename|
+      path = Pathname.new(filename)
+      puys "Basename         : " + path.basename.to_s
+      puts "Relative filename: " + File.join(Pathname.new('.').to_s, path.to_s)
+      puts "Absolute filename: " + File.join(Pathname.new('.').realpath.to_s, path.to_s)
+    end
+
+The filewatcher library is a single file with 180 LOC (including comments)
 with no dependencies.
 
+Changelog
+---------
+0.5.3 Exclude files. More environment variables. Options in ruby api.
+0.5.2 Start, stop and finalize API.
+0.5.1 Kill and restart long running command with --restart option.
 
 Credits
 -------

data/Rakefile

@@ -7,4 +7,13 @@ task :default => :test
 desc "Run tests"
 task :test do
   sh "bacon -Ilib -Itest --automatic --quiet"
+  delete_list =
+    %w(test/fixtures/file3.txt
+       test/fixtures/file4.txt
+       test/fixtures/file5.txt
+       test/fixtures/file6.txt
+       test/fixtures/file7.txt)
+  delete_list.each do |file|
+    FileUtils.rm(file)
+  end
 end

data/bin/filewatcher

@@ -20,6 +20,10 @@ Examples:
    filewatcher "myfile" "echo 'myfile has changed'"
    filewatcher '*.rb' 'ruby $FILENAME'
    filewatcher '**/*.rb' 'ruby $FILENAME' # Watch subdirectories
+
+Other available environment variables are BASENAME, ABSOLUTE_FILENAME, 
+RELATIVE_FILENAME, EVENT and DIRNAME.
+
 Options:
 EOS
 
@@ -74,8 +78,20 @@ if(options[:restart])
   child_pid = nil
 end
 
+if(options[:exclude] != "")
+  options[:exclude] = split_files_void_escaped_whitespace(options[:exclude].split(" "))  
+end
+
 begin
-  fw = FileWatcher.new(files, options[:list], options[:dontwait], options[:spinner])
+  fw = FileWatcher.new(files, options)
+
+  if(options[:list])
+    puts 'Watching:'
+    fw.last_found_filenames.each do |filename|
+      puts " #{filename}"
+    end
+  end
+  
   fw.watch(options[:interval]) do |filename, event|
     cmd = nil
     if(options[:exec] and File.exist?(filename))
@@ -104,10 +120,16 @@ begin
     if(cmd)
       path = Pathname.new(filename)
       env = {
-        'FILENAME'=> path.to_s,
-        'FILEDIR' => File.join(Pathname.new('.').realpath.to_s, path.parent.to_s),
-        'FSEVENT' => event.to_s
+        'FILENAME' => filename,
+        'BASENAME' => path.basename.to_s,
+        'FILEDIR' => File.join(Pathname.new('.').realpath.to_s, path.parent.to_s), # Deprecated
+        'FSEVENT' => event.to_s, # Deprecated,
+        'EVENT' => event.to_s,
+        'DIRNAME' => File.join(Pathname.new('.').realpath.to_s, path.parent.to_s),
+        'ABSOLUTE_FILENAME' => File.join(Pathname.new('.').realpath.to_s, path.to_s),
+        'RELATIVE_FILENAME' => File.join(Pathname.new('.').to_s, path.to_s)
       }
+
       if(event != :delete)
         ENV['FILEPATH'] = path.realpath.to_s
       end

data/lib/filewatcher.rb

@@ -6,7 +6,7 @@ class FileWatcher
   attr_accessor :filenames
 
   def self.VERSION
-    return '0.5.2'
+    return '0.5.3'
   end
 
   def update_spinner(label)
@@ -15,26 +15,31 @@ class FileWatcher
     print "#{' ' * 30}\r#{label}  #{@spinner.rotate!.first}\r"
   end
 
-  def initialize(unexpanded_filenames, print_filelist=false, dontwait=false, show_spinner=false)
+  def initialize(unexpanded_filenames, *args)
+    if(args.first)
+      options = args.first
+    else
+      options = {}
+    end
     @unexpanded_filenames = unexpanded_filenames
+    @unexpanded_excluded_filenames = options[:exclude]
     @filenames = nil
     @stored_update = nil
     @keep_watching = false
     @pausing = false
     @last_snapshot = mtime_snapshot
     @end_snapshot = nil
-    @dontwait = dontwait
-    @show_spinner = show_spinner
-    puts 'Watching:' if print_filelist
-    @filenames.each do |filename|
-      raise 'File does not exist' unless File.exist?(filename)
-      puts filename if print_filelist
-    end
+    @dontwait = options[:dontwait]
+    @show_spinner = options[:spinner]
+    @interval = options[:interval]
   end
 
   def watch(sleep=0.5, &on_update)
     trap("SIGINT") {return }
     @sleep = sleep
+    if(@interval and @interval > 0)
+      @sleep = @interval
+    end    
     @stored_update = on_update
     @keep_watching = true
     if(@dontwait)
@@ -44,11 +49,11 @@ class FileWatcher
       @end_snapshot = mtime_snapshot if @pausing
       while @keep_watching && @pausing
         update_spinner('Pausing')
-        Kernel.sleep sleep
+        Kernel.sleep @sleep
       end
       while @keep_watching && !filesystem_updated? && !@pausing
         update_spinner('Watching')
-        Kernel.sleep sleep
+        Kernel.sleep @sleep
       end
       # test and null @updated_file to prevent yielding the last
       # file twice if @keep_watching has just been set to false
@@ -102,6 +107,19 @@ class FileWatcher
   def mtime_snapshot
     snapshot = {}
     @filenames = expand_directories(@unexpanded_filenames)
+
+    if(@unexpanded_excluded_filenames != nil and @unexpanded_excluded_filenames.size > 0)
+      # Remove files in the exclude filenames list
+      @filtered_filenames = []
+      @excluded_filenames = expand_directories(@unexpanded_excluded_filenames)
+      @filenames.each do |filename|
+        if(not(@excluded_filenames.include?(filename)))
+          @filtered_filenames << filename
+        end
+      end
+      @filenames = @filtered_filenames
+    end
+    
     @filenames.each do |filename|
       mtime = File.exist?(filename) ? File.stat(filename).mtime : Time.new(0)
       snapshot[filename] = mtime
@@ -138,6 +156,10 @@ class FileWatcher
     return false
   end
 
+  def last_found_filenames
+    @last_snapshot.keys
+  end
+
   def expand_directories(patterns)
     if(!patterns.kind_of?Array)
       patterns = [patterns]

data/test/test_filewatcher.rb

@@ -27,12 +27,22 @@ describe FileWatcher do
     lambda { |it| elements.all? { |element| it.include? element }}
   end
 
+  it "should exclude selected file patterns" do
+    filewatcher = FileWatcher.new(File.expand_path('test/fixtures/**/*'), exclude: [File.expand_path("test/fixtures/**/*.txt")])
+    filtered_fixtures =
+      %w(test/fixtures/file4.rb
+         test/fixtures/subdir/file6.rb
+         test/fixtures/subdir/file5.rb
+         test/fixtures/file3.rb)
+    filewatcher.filenames.should.satisfy &includes_all(filtered_fixtures.map { |it| File.expand_path(it) })
+  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/**/*')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filewatcher
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Thomas Flemming
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2015-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop