file-monitor 0.1.1 → 0.1.2

data/README.md

@@ -17,19 +17,15 @@ Features
 
     If make a new directory in the watched directory, the new directory will be watched automatically.
 
-2. Support Ignore Dirs: 
+2. Support Filter:
 
-    Any directory matched Regexp pattern ignored_dirs will not be watched.
-
-3. Support Ignore Files:
-
-    Any files matched Regexp pattern ignored_files will not be recorded.
-
-4. Events Buffer Mechanism:
+    Support filter directories or files.
+ 
+3. Events Buffer Mechanism:
 
     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
+4. High Performance
 
     For Ruby File Monitor use inotify library, so it's very fast, even watching thousands of directories.
 
@@ -48,74 +44,32 @@ Install from gem server
 
 Usage
 -----
-### Using block
-
-    #!/usr/bin/env ruby
-    # coding: utf-8
-    # File: examples/use-block.rb
-
-    require 'file-monitor'
-
-    dir = ARGV[0] || '.'
-    m = FileMonitor.new(dir)
-
-    # ignore any dirs contains .git on .svn
-    m.ignored_dirs = /\.git|\.svn/
-
-    # ignore any files contains .swp or ~
-    m.ignored_files = /\.swp|~/
 
-    # the block's events contains all file modified infomation in last 0.2 second
-    m.run do|events|
-      puts "#{events.size} events"
-      puts "do something"
-    end
+    require 'rubygems'
 
-### Using inherit
+    # watch current working directory
+    FileMonitor.watch '.' do
 
-    #!/usr/bin/env ruby
-    # coding: utf-8
-    # File: examples/use-inherit.rb
+      # do not watch directory end with git or svn
+      # the last charactor '/' has been trimmed already
+      dirs {
+        disallow /git$|svn$/
+      }
 
-    require 'file-monitor'
+      # record ruby files only
+      # it equals files /\.rb$/
+      files {
+        disallow //
+        allow /\.rb$/
+      }
 
-    class MyFileMonitor < FileMonitor
-      def check(events)
-        puts "#{events.size} events"
+      # The commands will be runned when file changed
+      # the events contains all file modified infomation in last 0.2 second
+      exec {|events|
+        puts events.size()
         puts "do something"
-      end
-    end
-
-    dir = ARGV[0] || '.'
-    m = MyFileMonitor.new(dir)
-    m.ignored_dirs = /\.git|\.svn/
-    m.ignored_files = /\.swp|~/
-    m.run
-
-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
@@ -154,9 +108,9 @@ f5.rb requires sinatra.
 
     $ ruby examples/use-block.rb 
     watching .
-    watching ./lib/
-    ignore ./.git/
-    watching ./examples/
+    watching ./lib
+    ignore ./.git
+    watching ./examples
 
 Edit and save README.md by gvim, examples/use-block outputs
 

data/examples/use-block.rb

@@ -12,10 +12,16 @@ require 'file-monitor'
 dir = ARGV[0] || '.'
 m = FileMonitor.new(dir)
 # ignore any dirs end with .git on .svn
-m.ignored_dirs = /\.git|\.svn/
+# The alias of m.filter_dirs {
+#   disallow /\.git|\.svn/
+# }
+m.ignore_dirs /\.git|\.svn/
 
 # ignore any files end with .swp or ~
-m.ignored_files = /\.swp|~/
+# The alias of m.filter_files {
+#   disallow /\.swp|~/
+# }
+m.ignore_files /\.swp|~/
 
 # the block's events contains all file modified infomation in last 0.2 second
 m.run do|events|

data/examples/use-inherit.rb

@@ -19,9 +19,15 @@ end
 dir = ARGV[0] || '.'
 m = MyFileMonitor.new(dir)
 # ignore any dirs end with .git on .svn
-m.ignored_dirs = /\.git|\.svn/
+# The alias of m.filter_dirs {
+#   disallow /\.git|\.svn/
+# }
+m.ignore_dirs /\.git|\.svn/
 
 # ignore any files end with .swp or ~
-m.ignored_files = /\.swp|~/
+# The alias of m.filter_files {
+#   disallow /\.swp|~/
+# }
+m.ignore_files /\.swp|~/
 
 m.run

data/lib/file-monitor.rb

@@ -31,11 +31,27 @@ class FileMonitorFilter
   def reset
     @patterns = []
   end
+
+  alias_method :d, :disallow
+  alias_method :a, :allow
 end
 
 class FileMonitor
   # do the action every @frequency second, to avoid check too frequently
-  attr_accessor :frequency
+  def frequency=(frequency)
+    @frequency = frequency
+  end
+
+  def frequency(*args)
+    if args.size()
+      @frequency = args[0]
+    end
+    @frequency
+  end
+
+  def set_frequency(frequency)
+    @frequency = frequency
+  end
 
   def initialize(project_dir = '.')
     @notifier    = INotify::Notifier.new
@@ -69,19 +85,37 @@ class FileMonitor
   end
 
   # New Filter mode
-  def filter(type, &block)
-    @filters[type].instance_eval &block
+  def filter(type, args = [], &block)
+    @filters[type].reset()
+    if block_given?
+      if args.size() > 0
+        $stderr.puts "filter's params #{args.to_s} has been ignored for the block is given"
+      end
+      @filters[type].instance_eval &block
+    elsif args.size()
+      @filters[type].instance_eval do
+        disallow //
+        for arg in args
+          allow arg
+        end
+      end
+    else
+      raise 'filter needs params or block'
+    end
   end
 
-  def filter_files(&block)
-    filter :files, &block
+  def filter_files(*args, &block)
+    filter :files, args, &block
   end
 
-  def filter_dirs(&block)
-    filter :dirs, &block
+  def filter_dirs(*args, &block)
+    filter :dirs, args, &block
   end
 
   def ignored_dir?(path)
+    if path == '.'
+      return false
+    end
     @filters[:dirs].ignored? path
   end
 
@@ -92,9 +126,17 @@ class FileMonitor
   def push_event event
     @events << event
   end
+
+  def trim_dir(path)
+    if path =~ /(.*)\/$/
+      path = $1
+    end
+    path
+  end
   
   # Watch a directory
   def watch(dir)
+    dir = trim_dir(dir)
     if ignored_dir?(dir)
       puts "ignore #{dir}"
       return false
@@ -192,4 +234,19 @@ class FileMonitor
       end
     end
   end
+
+  alias_method :dirs, :filter_dirs
+  alias_method :files, :filter_files
+  alias_method :exec, :run
+
+  def self.create(dir = '.', &block)
+    m = FileMonitor.new(dir)
+    m.instance_eval &block
+    m
+  end
+
+  def self.watch(dir = '.', &block)
+    self.create(dir, &block)
+  end
+
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - JiangMiao
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-16 00:00:00 +08:00
+date: 2011-10-17 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +47,7 @@ dependencies:
         version: 0.8.8
   type: :development
   version_requirements: *id002
-description: Ruby File Monitor is a easy way to watch the directories and files, do anything when them changed.
+description: Ruby File Monitor is a easy way to watch the directories and files, execute commands when them changed.
 email: jiangfriend@gmail.com
 executables: []