file-monitor 0.1.0 → 0.1.1

data/README.md

@@ -1,7 +1,7 @@
 Ruby File Monitor
 =================
 
-Ruby File Monitor is a easy way to watch the directories and files, do anything when them changed. It's base on [rb-inotify](https://github.com/nex3/rb-inotify), So it only works in inotify supported system such as Linux.
+Ruby File Monitor is a easy way to watch the directories and files, do anything when them changed. Use for situation like Auto refresh webpage, Auto execute unit tests, Auto compile CoffeeScript, Haml and so on. It's base on [rb-inotify](https://github.com/nex3/rb-inotify), So it only works in inotify supported system such as Linux.
 
 Requirements
 ------------
@@ -29,6 +29,9 @@ Features
 
     To avoid run the check methods too quickly, for example, when delete 20 files at the same time, if without Events Buffer will run the check methods 20 times. the frequency of file-monitor is 0.2 second
 
+5. High Performance
+
+    For Ruby File Monitor use inotify library, so it's very fast, even watching thousands of directories.
 
 Installation
 ------------
@@ -91,6 +94,30 @@ Usage
 
 If block exists, the check method will be ignored.
 
+### Filter mode
+
+    #!/usr/bin/env ruby
+    # coding: utf-8
+    # File: examples/use-filter.rb
+
+    require 'file-monitor.rb'
+
+    m = FileMonitor.new('.')
+    m.filter_dirs {
+      disallow /\.git|\.svn/
+    }
+
+    # record .rb files only
+    m.filter_files {
+      disallow  /.*/
+      allow /\.rb$/
+    }
+      
+    m.run do|events|
+      puts events.size()
+      puts "do something"
+    end
+
 Examples
 --------
 ### Auto F5

data/examples/use-filter.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+# File: examples/use-filter.rb
+
+require 'rubygems'
+
+lib_dir = File.join File.dirname(__FILE__), '../lib'
+$:.unshift lib_dir unless $:.include? lib_dir
+
+require 'file-monitor.rb'
+
+m = FileMonitor.new('.')
+m.filter_dirs {
+  disallow /\.git|\.svn/
+}
+
+# record .rb files only
+m.filter_files {
+  disallow  /.*/
+  allow /\.rb$/
+}
+  
+m.run do|events|
+  puts events.size()
+  puts "do something"
+end
+

data/lib/file-monitor.rb

@@ -3,44 +3,92 @@
 
 require 'rb-inotify'
 
-class FileMonitor
-  # the ignored list
-  attr_accessor :ignored_dirs, :ignored_files
+class FileMonitorFilter
+  def initialize
+    @patterns = []
+  end
+
+  def ignored?(path)
+    status = :allow
+    for mode, pattern in @patterns
+      if path =~ pattern
+        status = mode
+      end
+    end
+    return status == :disallow
+  end
+  
+  alias_method :disallow?, :ignored?
+
+  def disallow(pattern)
+    @patterns << [:disallow, pattern]
+  end
+
+  def allow(pattern)
+    @patterns << [:allow, pattern]
+  end
+
+  def reset
+    @patterns = []
+  end
+end
 
+class FileMonitor
   # do the action every @frequency second, to avoid check too frequently
   attr_accessor :frequency
 
-  def initialize(project_dir)
+  def initialize(project_dir = '.')
     @notifier    = INotify::Notifier.new
     @project_dir = project_dir
 
     @events      = []
     @ignores     = []
     @frequency   = 0.2
+
+    @filters = {
+      :files => FileMonitorFilter.new,
+      :dirs => FileMonitorFilter.new 
+    }
   end
 
-  def ignored?(path, pattern)
-    for ignore in Array(pattern)
-      if path =~ ignore
-        return true
-      end
-    end
-    return false
+  # Compatible to old ignored_dirs and ignored_files mode
+  def ignore_dirs(path)
+    self.ignored_dirs= path
+  end
+
+  def ignore_files(pattern)
+    self.ignored_files = pattern
+  end
+
+  def ignored_dirs=(pattern)
+    @filters[:dirs].disallow pattern
+  end
+
+  def ignored_files=(pattern)
+    @filters[:files].disallow pattern
+  end
+
+  # New Filter mode
+  def filter(type, &block)
+    @filters[type].instance_eval &block
+  end
+
+  def filter_files(&block)
+    filter :files, &block
+  end
+
+  def filter_dirs(&block)
+    filter :dirs, &block
   end
 
   def ignored_dir?(path)
-    ignored? path, @ignored_dirs
+    @filters[:dirs].ignored? path
   end
 
   def ignored_file?(path)
-    ignored? path, @ignored_files
+    @filters[:files].ignored? path
   end
 
-  # TODO combine events maybe it's not nesscary
-  # moved_from + moved_to = rename
-  # create + delete       = delete
-  # delete + create       = modify
-  # rename + delete       = delete
   def push_event event
     @events << event
   end
@@ -61,22 +109,23 @@ class FileMonitor
       # + created or moved_to
       # - deleted or moved_from
       # # modified
+      # 'stop watching' ignored
       info = ''
-      if flags.include? :moved_from
+      flag = flags[0]
+      flag = :moved_from if flags.include? :moved_from
+      flag = :moved_to   if flags.include? :moved_to
+
+      case flag
+      when :moved_from, :delete
         info += '-'
-      elsif flags.include? :moved_to
+      when :moved_to, :create
         info += '+'
+      when :modify
+        info += '#'
+      when :ignored
+        info += 'stop watching'
       else
-        case flags[0]
-        when :create
-          info += '+'
-        when :modify
-          info += '#'
-        when :delete
-          info += '-'
-        when :ignored
-          info += 'stop watching'
-        end
+        info += 'unknown ' + flags.to_s
       end
 
       if ignored_file?(event.absolute_name)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - JiangMiao
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-13 00:00:00 +08:00
+date: 2011-10-16 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,7 @@ files:
 - lib/file-monitor.rb
 - examples/use-block.rb
 - examples/use-inherit.rb
+- examples/use-filter.rb
 - examples/f5.rb
 - README.md
 has_rdoc: true