fssm 0.2.3 → 0.2.4

data/README.markdown

@@ -53,3 +53,29 @@ This form doesn't enter the run loop automatically.
 	end
 
 	monitor.run
+
+Monitoring directories
+----------------------
+
+By default, FSSM monitors changes in files only. To enable monitoring of files and directories, pass option `directories => true` in a hash to the monitor. For example:
+
+	FSSM::Monitor.new(:directories => true)
+	FSSM.monitor(dir, file_glob, :directories => true)
+
+When directories are monitored, there's an additional third argument to the callbacks. Instead of
+
+	FSSM.monitor('/some/directory/', '**/*') do
+	  update {|base, relative|}
+	  delete {|base, relative|}
+	  create {|base, relative|}
+	end
+
+you get this:
+
+	FSSM.monitor('/some/directory/', '**/*', :directories => true) do
+	  update {|base, relative, type|}
+	  delete {|base, relative, type|}
+	  create {|base, relative, type|}
+	end
+
+The value of `type` argument is either `:file` or `:directory`.

data/VERSION.yml

@@ -1,5 +1,5 @@
---- 
+---
 :major: 0
 :minor: 2
-:patch: 3
-:build: 
+:patch: 4
+:build:

data/example.rb

@@ -1,5 +1,8 @@
 $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
+# for rb-inotify/rb-fsevent
+require 'rubygems'
+
 require 'fssm'
 
 FSSM.monitor('.', '**/*') do

data/fssm.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fssm}
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Travis Tilley"]
-  s.date = %q{2010-12-18}
+  s.date = %q{2011-01-15}
   s.description = %q{file system state monitor}
   s.email = %q{ttilley@gmail.com}
   s.extra_rdoc_files = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
     "lib/fssm/backends/fsevents.rb",
     "lib/fssm/backends/inotify.rb",
     "lib/fssm/backends/polling.rb",
+    "lib/fssm/backends/rbfsevent.rb",
     "lib/fssm/backends/rubycocoa/fsevents.rb",
     "lib/fssm/monitor.rb",
     "lib/fssm/path.rb",
@@ -54,7 +55,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = %q{http://github.com/ttilley/fssm}
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.4.2}
   s.summary = %q{file system state monitor}
   s.test_files = [
     "spec/count_down_latch.rb",
@@ -65,7 +66,6 @@ Gem::Specification.new do |s|
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/lib/fssm.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
 
 module FSSM
   FileNotFoundError = Class.new(StandardError)
+  FileNotRealError = Class.new(StandardError)
   CallbackError = Class.new(StandardError)
 
   class << self

data/lib/fssm/backends/rbfsevent.rb

@@ -0,0 +1,26 @@
+module FSSM::Backends
+  class RBFSEvent
+    def initialize
+      @fsevent = FSEvent.new
+    end
+
+    def add_handler(handler, preload=true)
+      @fsevent.watch handler.path.to_s do |paths|
+        paths.each do |path|
+          handler.refresh(path)
+        end
+      end
+
+      handler.refresh(nil, true) if preload
+    end
+
+    def run
+      begin
+        @fsevent.run
+      rescue Interrupt
+        @fsevent.stop
+      end
+    end
+
+  end
+end

data/lib/fssm/path.rb

@@ -84,6 +84,7 @@ class FSSM::Path
   def set_path(path)
     path = FSSM::Pathname.for(path)
     raise FSSM::FileNotFoundError, "No such file or directory - #{path}" unless path.exist?
+    raise FSSM::FileNotRealError, "Path is virtual - #{path}" if path.is_virtual?
     @path = path.expand_path
   end
 

data/lib/fssm/pathname.rb

@@ -5,6 +5,7 @@ require 'pathname'
 module FSSM
   class Pathname < ::Pathname
     ROOT = '/'.freeze
+    VIRTUAL_REGEX = /^file:([^!]*)!/
 
     class << self
       def for(path)
@@ -13,6 +14,10 @@ module FSSM
 
       alias :[] :glob
     end
+    
+    def is_virtual?
+      !!(VIRTUAL_REGEX =~ to_s)
+    end
 
     def segments
       path = to_s

data/lib/fssm/support.rb

@@ -2,15 +2,34 @@ require 'rbconfig'
 
 module FSSM::Support
   class << self
-    def backend
-      @@backend ||= case
+    def usable_backend
+      choice = case
         when mac? && !jruby? && carbon_core?
           'FSEvents'
+        when mac? && rb_fsevent?
+          'RBFSEvent'
         when linux? && rb_inotify?
           'Inotify'
         else
           'Polling'
+        end
+
+      if (mac? || linux?) && choice == 'Polling'
+        optimal = case
+          when mac?
+            'rb-fsevent'
+          when linux?
+            'rb-inotify'
+          end
+        STDERR.puts("FSSM: An optimized backend is available for this platform!")
+        STDERR.puts("    gem install #{optimal}")
       end
+
+      choice
+    end
+
+    def backend
+      @@backend ||= usable_backend
     end
 
     def jruby?
@@ -31,13 +50,21 @@ module FSSM::Support
         OSX.require_framework '/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework'
         true
       rescue LoadError
-        STDERR.puts("Warning: Unable to load CarbonCore. FSEvents will be unavailable.")
+        false
+      end
+    end
+
+    def rb_fsevent?
+      begin
+        require 'rb-fsevent'
+        true
+      rescue LoadError
         false
       end
     end
 
     def rb_inotify?
-      found = begin
+      begin
         require 'rb-inotify'
         if defined?(INotify::VERSION)
           version = INotify::VERSION
@@ -46,8 +73,6 @@ module FSSM::Support
       rescue LoadError
         false
       end
-      STDERR.puts("Warning: Unable to load rb-inotify >= 0.5.1. Inotify will be unavailable.") unless found
-      found
     end
 
     def use_block(context, block)

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification 
 name: fssm
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 3
-  version: 0.2.3
+  prerelease: 
+  version: 0.2.4
 platform: ruby
 authors: 
-- Travis Tilley
+  - Travis Tilley
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-12-18 00:00:00 -05:00
+date: 2011-01-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id001
 description: file system state monitor
 email: ttilley@gmail.com
 executables: []
@@ -37,43 +31,44 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
-- README.markdown
+  - LICENSE
+  - README.markdown
 files: 
-- .document
-- LICENSE
-- README.markdown
-- Rakefile
-- VERSION.yml
-- example.rb
-- fssm.gemspec
-- lib/fssm.rb
-- lib/fssm/backends/fsevents.rb
-- lib/fssm/backends/inotify.rb
-- lib/fssm/backends/polling.rb
-- lib/fssm/backends/rubycocoa/fsevents.rb
-- lib/fssm/monitor.rb
-- lib/fssm/path.rb
-- lib/fssm/pathname.rb
-- lib/fssm/state/directory.rb
-- lib/fssm/state/file.rb
-- lib/fssm/support.rb
-- lib/fssm/tree.rb
-- profile/prof-cache.rb
-- profile/prof-fssm-pathname.html
-- profile/prof-pathname-rubinius.rb
-- profile/prof-pathname.rb
-- profile/prof-plain-pathname.html
-- profile/prof.html
-- spec/count_down_latch.rb
-- spec/monitor_spec.rb
-- spec/path_spec.rb
-- spec/root/duck/quack.txt
-- spec/root/file.css
-- spec/root/file.rb
-- spec/root/file.yml
-- spec/root/moo/cow.txt
-- spec/spec_helper.rb
+  - .document
+  - LICENSE
+  - README.markdown
+  - Rakefile
+  - VERSION.yml
+  - example.rb
+  - fssm.gemspec
+  - lib/fssm.rb
+  - lib/fssm/backends/fsevents.rb
+  - lib/fssm/backends/inotify.rb
+  - lib/fssm/backends/polling.rb
+  - lib/fssm/backends/rbfsevent.rb
+  - lib/fssm/backends/rubycocoa/fsevents.rb
+  - lib/fssm/monitor.rb
+  - lib/fssm/path.rb
+  - lib/fssm/pathname.rb
+  - lib/fssm/state/directory.rb
+  - lib/fssm/state/file.rb
+  - lib/fssm/support.rb
+  - lib/fssm/tree.rb
+  - profile/prof-cache.rb
+  - profile/prof-fssm-pathname.html
+  - profile/prof-pathname-rubinius.rb
+  - profile/prof-pathname.rb
+  - profile/prof-plain-pathname.html
+  - profile/prof.html
+  - spec/count_down_latch.rb
+  - spec/monitor_spec.rb
+  - spec/path_spec.rb
+  - spec/root/duck/quack.txt
+  - spec/root/file.css
+  - spec/root/file.rb
+  - spec/root/file.yml
+  - spec/root/moo/cow.txt
+  - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/ttilley/fssm
 licenses: []
@@ -82,33 +77,29 @@ post_install_message:
 rdoc_options: []
 
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: file system state monitor
 test_files: 
-- spec/count_down_latch.rb
-- spec/monitor_spec.rb
-- spec/path_spec.rb
-- spec/root/file.rb
-- spec/spec_helper.rb
+  - spec/count_down_latch.rb
+  - spec/monitor_spec.rb
+  - spec/path_spec.rb
+  - spec/root/file.rb
+  - spec/spec_helper.rb