file-monitor 0.1.0

data/README.md

@@ -0,0 +1,142 @@
+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.
+
+Requirements
+------------
+
+Ruby >= 1.8.7
+
+Linux Kernel >= 2.6.13
+
+Features
+--------
+
+1. Auto watching recursively:
+
+    If make a new directory in the watched directory, the new directory will be watched automatically.
+
+2. Support Ignore Dirs: 
+
+    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:
+
+    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
+
+
+Installation
+------------
+Install from source
+    
+    git clone https://github.com/jiangmiao/ruby-file-monitor
+    cd ruby-file-monitor
+    gem build file-monitor.gemspec
+    gem install file-monitor-0.1.0.gem --user-install
+
+Install from gem server
+
+    gem install file-monitor
+
+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
+
+### Using inherit
+
+    #!/usr/bin/env ruby
+    # coding: utf-8
+    # File: examples/use-inherit.rb
+
+    require 'file-monitor'
+
+    class MyFileMonitor < FileMonitor
+      def check(events)
+        puts "#{events.size} events"
+        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.
+
+Examples
+--------
+### Auto F5
+
+Auto F5 will auto refresh the webpage in browser when any watched files changed. It's simple but very useful.
+
+f5.rb requires sinatra.
+
+#### Limitation:
+
+    1. The watched page MUST have </body> tag. 
+       f5.rb will insert script  before </body> to refresh the page 
+       when physical file changed.
+
+    2. Only support GET requests.
+
+#### Usage
+
+    Environment:
+    the website physical path is /var/www/foo
+    the host is www.foo.com
+    homepage is www.foo.com/index.html
+
+    start watching the directory
+    ruby examples/f5.rb /var/www/foo
+
+    open www.foo.com:4567/index.html in browser
+    you will see the page same as www.foo.com/index.html
+    do some changes on /var/www/foo/index.html then save the file.
+    or create or modify any file in /var/www/foo
+    www.foo.com/index.html will refresh automatically.
+
+### examples/use-block.rb
+
+    $ ruby examples/use-block.rb 
+    watching .
+    watching ./lib/
+    ignore ./.git/
+    watching ./examples/
+
+Edit and save README.md by gvim, examples/use-block outputs
+
+    +  ./4913
+    -  ./4913
+    -  ./README.md
+    +  ./README.md
+    #  ./README.md
+    5 events
+    do something

data/examples/f5.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'rubygems'
+
+lib_dir = File.join File.dirname(__FILE__), '../lib'
+$:.unshift lib_dir unless $:.include? lib_dir
+
+require 'file-monitor'
+require 'sinatra'
+require 'getoptlong'
+
+class AjaxF5 < FileMonitor
+  attr_reader :updated_at, :js
+  def initialize(dir)
+    super dir
+    @updated_at = Time.now.to_f
+    # ajax library from http://code.google.com/p/miniajax/
+    @js = <<EOT
+(function() {
+  var ajax;
+  function $(e){if(typeof e=='string')e=document.getElementById(e);return e};
+  function collect(a,f){var n=[];for(var i=0;i<a.length;i++){var v=f(a[i]);if(v!=null)n.push(v)}return n};
+
+  ajax={};
+  ajax.x=function(){try{return new ActiveXObject('Msxml2.XMLHTTP')}catch(e){try{return new ActiveXObject('Microsoft.XMLHTTP')}catch(e){return new XMLHttpRequest()}}};
+  ajax.serialize=function(f){var g=function(n){return f.getElementsByTagName(n)};var nv=function(e){if(e.name)return encodeURIComponent(e.name)+'='+encodeURIComponent(e.value);else return ''};var i=collect(g('input'),function(i){if((i.type!='radio'&&i.type!='checkbox')||i.checked)return nv(i)});var s=collect(g('select'),nv);var t=collect(g('textarea'),nv);return i.concat(s).concat(t).join('&');};
+  ajax.send=function(u,f,m,a){var x=ajax.x();x.open(m,u,true);x.onreadystatechange=function(){if(x.readyState==4)f(x.responseText)};if(m=='POST')x.setRequestHeader('Content-type','application/x-www-form-urlencoded');x.send(a)};
+  ajax.get=function(url,func){ajax.send(url,func,'GET')};
+  var now = Date.now();
+  function checkStatus() {
+    ajax.get("/f5_status", function(rt) {
+      if (now < parseFloat(rt)) {
+        location.reload(true);
+      }
+      setTimeout(checkStatus, 500);
+    });
+  }
+  checkStatus();
+})();
+EOT
+  end
+
+  # simple mark the last updated time
+  def check(events)
+    @updated_at = Time.now.to_f
+    puts "updated at #{@updated_at}"
+  end
+
+  def run
+    # use new thread to monitor the file
+    Thread.new do
+      begin
+        super
+      rescue
+        puts $!.message
+      end
+    end
+
+    f5 = self
+    set :logging, false
+    get '/f5_status' do
+      (f5.updated_at*1000).to_s
+    end
+
+    get '/f5.js' do
+      f5.js
+    end
+
+    get '*' do
+      host = env['SERVER_NAME']
+      path = env['REQUEST_PATH']
+      begin
+        data = open('http://' + host + path) {|f|
+          content_type f.meta['content-type']
+          f.read
+        }
+        data.gsub Regexp.new('</body>', Regexp::IGNORECASE), '<script type="text/javascript" src="/f5.js"></script></body>'
+      rescue
+        $!.message.match /\d+/
+          [$&.to_i, {}, '']
+      end
+    end
+  end
+end
+
+dir = ARGV[0] || '.'
+
+opts = GetoptLong.new(
+  [ '--help', '-h', GetoptLong::NO_ARGUMENT]
+)
+
+opts.each do|opt, arg|
+  case opt
+  when '--help'
+    puts 'ruby f5.rb [project-directory]'
+    exit
+  end
+end
+
+require 'sinatra'
+require 'open-uri'
+f5 = AjaxF5.new dir
+f5.ignored_dirs = /\.git|\.svn/
+f5.ignored_files = /\.sw.*|\~/
+f5.run

data/examples/use-block.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+# File: examples/use-block.rb
+
+require 'rubygems'
+
+lib_dir = File.join File.dirname(__FILE__), '../lib'
+$:.unshift lib_dir unless $:.include? lib_dir
+
+require 'file-monitor'
+
+dir = ARGV[0] || '.'
+m = FileMonitor.new(dir)
+# ignore any dirs end with .git on .svn
+m.ignored_dirs = /\.git|\.svn/
+
+# ignore any files end with .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

data/examples/use-inherit.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+# File: examples/use-inherit.rb
+
+require 'rubygems'
+
+lib_dir = File.join File.dirname(__FILE__), '../lib'
+$:.unshift lib_dir unless $:.include? lib_dir
+
+require 'file-monitor.rb'
+
+class MyFileMonitor < FileMonitor
+  def check(events)
+    puts "#{events.size} events"
+    puts "do something"
+  end
+end
+
+dir = ARGV[0] || '.'
+m = MyFileMonitor.new(dir)
+# ignore any dirs end with .git on .svn
+m.ignored_dirs = /\.git|\.svn/
+
+# ignore any files end with .swp or ~
+m.ignored_files = /\.swp|~/
+
+m.run

data/lib/file-monitor.rb

@@ -0,0 +1,146 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'rb-inotify'
+
+class FileMonitor
+  # the ignored list
+  attr_accessor :ignored_dirs, :ignored_files
+
+  # do the action every @frequency second, to avoid check too frequently
+  attr_accessor :frequency
+
+  def initialize(project_dir)
+    @notifier    = INotify::Notifier.new
+    @project_dir = project_dir
+
+    @events      = []
+    @ignores     = []
+    @frequency   = 0.2
+  end
+
+  def ignored?(path, pattern)
+    for ignore in Array(pattern)
+      if path =~ ignore
+        return true
+      end
+    end
+    return false
+  end
+
+  def ignored_dir?(path)
+    ignored? path, @ignored_dirs
+  end
+
+  def ignored_file?(path)
+    ignored? path, @ignored_files
+  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
+  
+  # Watch a directory
+  def watch(dir)
+    if ignored_dir?(dir)
+      puts "ignore #{dir}"
+      return false
+    else
+      puts "watching #{dir}"
+    end
+
+    @notifier.watch dir, :modify, :create, :move, :delete, :onlydir do|event|
+      flags = event.flags
+
+      # display event info
+      # + created or moved_to
+      # - deleted or moved_from
+      # # modified
+      info = ''
+      if flags.include? :moved_from
+        info += '-'
+      elsif flags.include? :moved_to
+        info += '+'
+      else
+        case flags[0]
+        when :create
+          info += '+'
+        when :modify
+          info += '#'
+        when :delete
+          info += '-'
+        when :ignored
+          info += 'stop watching'
+        end
+      end
+
+      if ignored_file?(event.absolute_name)
+        # the ignored info will not put currently
+        info += "i #{event.absolute_name}"
+        next
+      else
+        info += "  #{event.absolute_name}"
+        puts info
+      end
+
+      if flags.include? :isdir
+        if flags.include? :ignore?
+          @notifier.watchers.delete watcher.id
+        elsif flags.include? :create or flags.include? :move
+          watch_recursive event.absolute_name
+        else
+          push_event event
+        end
+      else
+        push_event event
+      end
+    end
+
+    return true
+  end
+
+  # Watch directory recursive
+  # use our recursive instead rb-inotify's :recursive to filter the directory
+  def watch_recursive(dir)
+    if watch dir
+      # if watch current directory succeeded, then continue watching the sub-directories
+      Dir.glob(File.join(dir, "*/"), File::FNM_DOTMATCH).each do|subdir|
+        name = File.basename(subdir)
+        next if name == ".." or name == "."
+        watch_recursive subdir
+      end
+    end
+  end
+
+  # check the events received
+  def check(events)
+    if !@check_warning_notified
+      puts "[NOTICE] Inherit from FileMonitor and override method check(events) or\n         use file_monitor_instance.run do|events| end to do anything when any file changes"
+      @check_warning_notified = true
+    end
+  end
+
+  # start watching
+  # if block given, check method will be ignored
+  def run(&block)
+    watch_recursive @project_dir
+
+    while true
+      if IO.select([@notifier.to_io], [], [], @frequency)
+        @notifier.process
+      elsif @events.size > 0
+        if block_given?
+          yield @events
+        else
+          check @events
+        end
+        @events = []
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: file-monitor
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- JiangMiao
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-13 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rb-inotify
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 8
+        version: 0.8.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rb-inotify
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 8
+        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.
+email: jiangfriend@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/file-monitor.rb
+- examples/use-block.rb
+- examples/use-inherit.rb
+- examples/f5.rb
+- README.md
+has_rdoc: true
+homepage: https://github.com/jiangmiao/ruby-file-monitor
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: file-monitor
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: File Monitor Library
+test_files: []
+