fssm 0.1.4 → 0.2.0

data/VERSION.yml

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

data/fssm.gemspec

@@ -1,64 +1,64 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{fssm}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Travis Tilley"]
-  s.date = %q{2010-03-10}
+  s.date = %q{2010-11-13}
   s.description = %q{file system state monitor}
   s.email = %q{ttilley@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.markdown"
+    "README.markdown"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "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.rb",
-     "profile/prof-plain-pathname.html",
-     "profile/prof.html",
-     "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"
+    "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.rb",
+    "profile/prof-plain-pathname.html",
+    "profile/prof.html",
+    "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"
   ]
   s.homepage = %q{http://github.com/ttilley/fssm}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{file system state monitor}
   s.test_files = [
+    "spec/monitor_spec.rb",
     "spec/path_spec.rb",
-     "spec/spec_helper.rb",
-     "spec/root/file.rb"
+    "spec/root/file.rb",
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/fssm.rb

@@ -11,7 +11,8 @@ module FSSM
     end
 
     def monitor(*args, &block)
-      monitor = FSSM::Monitor.new
+      options = args[-1].is_a?(Hash) ? args.pop : {}
+      monitor = FSSM::Monitor.new(options)
       FSSM::Support.use_block(args.empty? ? monitor : monitor.path(*args), block)
 
       monitor.run

data/lib/fssm/monitor.rb

@@ -4,18 +4,14 @@ class FSSM::Monitor
     @backend = FSSM::Backends::Default.new
   end
 
-  def path(*args, &block)
-    path = FSSM::Path.new(*args)
-    FSSM::Support.use_block(path, block)
-
-    @backend.add_handler(FSSM::State::Directory.new(path))
+  def path(path=nil, glob=nil, &block)
+    path = create_path(path, glob, &block)
+    @backend.add_handler(FSSM::State::Directory.new(path, @options))
     path
   end
 
-  def file(*args, &block)
-    path = FSSM::Path.new(*args)
-    FSSM::Support.use_block(path, block)
-
+  def file(path=nil, glob=nil, &block)
+    path = create_path(path, glob, &block)
     @backend.add_handler(FSSM::State::File.new(path))
     path
   end
@@ -23,4 +19,12 @@ class FSSM::Monitor
   def run
     @backend.run
   end
+
+  private
+
+  def create_path(path, glob, &block)
+    path = FSSM::Path.new(path, glob, @options)
+    FSSM::Support.use_block(path, block)
+    path
+  end
 end

data/lib/fssm/path.rb

@@ -1,5 +1,6 @@
 class FSSM::Path
-  def initialize(path=nil, glob=nil, &block)
+  def initialize(path=nil, glob=nil, options={}, &block)
+    @options = options
     set_path(path || '.')
     set_glob(glob || '**/*')
     init_callbacks
@@ -26,16 +27,16 @@ class FSSM::Path
     set_glob(value)
   end
 
-  def create(callback_or_path=nil, &block)
-    callback_action(:create, (block_given? ? block : callback_or_path))
+  def create(*args, &block)
+    callback_action(:create, (block_given? ? block : args))
   end
 
-  def update(callback_or_path=nil, &block)
-    callback_action(:update, (block_given? ? block : callback_or_path))
+  def update(*args, &block)
+    callback_action(:update, (block_given? ? block : args))
   end
 
-  def delete(callback_or_path=nil, &block)
-    callback_action(:delete, (block_given? ? block : callback_or_path))
+  def delete(*args, &block)
+    callback_action(:delete, (block_given? ? block : args))
   end
 
   private
@@ -45,13 +46,13 @@ class FSSM::Path
     @callbacks = Hash.new(do_nothing)
   end
 
-  def callback_action(type, arg=nil)
-    if arg.is_a?(Proc)
-      set_callback(type, arg)
-    elsif arg.nil?
+  def callback_action(type, args=[])
+    if args.is_a?(Proc)
+      set_callback(type, args)
+    elsif args.empty?
       get_callback(type)
     else
-      run_callback(type, arg)
+      run_callback(type, args)
     end
   end
 
@@ -64,13 +65,14 @@ class FSSM::Path
     @callbacks[type]
   end
 
-  def run_callback(type, arg)
-    base, relative = split_path(arg)
+  def run_callback(type, args)
+    callback_args = split_path(args[0])
+    callback_args << args[1] if @options[:directories]
 
     begin
-      @callbacks[type].call(base, relative)
+      @callbacks[type].call(*callback_args)
     rescue Exception => e
-      raise FSSM::CallbackError, "#{type} - #{base.join(relative)}: #{e.message}", e.backtrace
+      raise FSSM::CallbackError, "#{type} - #{args[0]}: #{e.message}", e.backtrace
     end
   end
 

data/lib/fssm/state/directory.rb

@@ -2,8 +2,9 @@ module FSSM::State
   class Directory
     attr_reader :path
 
-    def initialize(path)
+    def initialize(path, options={})
       @path = path
+      @options = options
       @cache = FSSM::Tree::Cache.new
     end
 
@@ -20,24 +21,29 @@ module FSSM::State
     private
 
     def created(previous, current)
-      (current.keys - previous.keys).each {|created| @path.create(created)}
+      (current.keys - previous.keys).sort.each do |file|
+        @path.create(file, current[file][1])
+      end
     end
 
     def deleted(previous, current)
-      (previous.keys - current.keys).each {|deleted| @path.delete(deleted)}
+      (previous.keys - current.keys).sort.reverse.each do |file|
+        @path.delete(file, previous[file][1])
+      end
     end
 
     def modified(previous, current)
       (current.keys & previous.keys).each do |file|
-        @path.update(file) if (current[file] <=> previous[file]) != 0
+        current_data = current[file]
+        @path.update(file, current_data[1]) if (current_data[0] <=> previous[file][0]) != 0
       end
     end
 
     def recache(base)
       base = FSSM::Pathname.for(base)
-      previous = @cache.files
+      previous = cache_entries
       snapshot(base)
-      current = @cache.files
+      current = cache_entries
       [previous, current]
     end
 
@@ -53,5 +59,16 @@ module FSSM::State
       end
     end
 
+    def cache_entries
+      entries = tag_entries(@cache.files, :file)
+      entries.merge! tag_entries(@cache.directories, :directory) if @options[:directories]
+      entries
+    end
+
+    def tag_entries(entries, tag)
+      tagged_entries = {}
+      entries.each_pair { |fname, mtime| tagged_entries[fname] = [mtime, tag] }
+      tagged_entries
+    end
   end
 end

data/spec/monitor_spec.rb

@@ -0,0 +1,189 @@
+require "spec_helper"
+
+require "fileutils"
+require "tempfile"
+
+module FSSM::MonitorSpecHelpers
+  def create_tmp_dir
+    @tmp_dir = Dir.mktmpdir
+    FileUtils.cp_r File.join(File.dirname(__FILE__), 'root'), @tmp_dir
+    # Because git does not track empty directories, create one ourselves.
+    FileUtils.mkdir_p @tmp_dir + '/root/yawn'
+    @tmp_dir
+  end
+
+  def remove_tmp_dir
+    FileUtils.remove_entry_secure @tmp_dir
+  end
+
+  def create_handler(type)
+    lambda {|*args| @handler_results[type] << args}
+  end
+
+  def create_monitor(options={})
+    @handler_results = Hash.new {|hash, key| hash[key] = []}
+    @monitor = FSSM::Monitor.new(options)
+    @monitor.path(@tmp_dir) do |p|
+      p.create(&create_handler(:create))
+      p.update(&create_handler(:update))
+      p.delete(&create_handler(:delete))
+    end
+    sleep 1     # give time for monitor to preload
+  end
+
+  def run_monitor
+    thread = Thread.new {@monitor.run}
+    sleep 2     # give time for monitor to see changes
+    thread.kill
+  end
+end
+
+describe "The File System State Monitor" do
+  describe "monitor" do
+    include FSSM::MonitorSpecHelpers
+
+    before do
+      create_tmp_dir
+    end
+
+    after do
+      remove_tmp_dir
+    end
+
+    describe "with default options" do
+      before do
+        create_monitor
+      end
+
+      it "should call create callback upon file creation" do
+        file = @tmp_dir + "/newfile.rb"
+        File.exists?(file).should be_false
+        FileUtils.touch file
+        run_monitor
+        @handler_results[:create].should == [[@tmp_dir, 'newfile.rb']]
+      end
+
+      it "should call update callback upon file modification" do
+        FileUtils.touch @tmp_dir + '/root/file.rb'
+        run_monitor
+        @handler_results[:update].should == [[@tmp_dir, 'root/file.rb']]
+      end
+
+      it "should call delete callback upon file deletion" do
+        FileUtils.rm @tmp_dir + "/root/file.rb"
+        run_monitor
+        @handler_results[:delete].should == [[@tmp_dir, 'root/file.rb']]
+      end
+
+      it "should call create and delete callbacks upon file renaming in the same directory" do
+        FileUtils.mv @tmp_dir + "/root/file.rb", @tmp_dir + "/root/old_file.rb"
+        run_monitor
+        @handler_results[:create].should == [[@tmp_dir, 'root/old_file.rb']]
+        @handler_results[:delete].should == [[@tmp_dir, 'root/file.rb']]
+        @handler_results[:update].should == []
+      end
+
+      it "should call create and delete callbacks upon file moving to another directory" do
+        FileUtils.mv @tmp_dir + "/root/file.rb", @tmp_dir + "/old_file.rb"
+        run_monitor
+        @handler_results[:create].should == [[@tmp_dir, 'old_file.rb']]
+        @handler_results[:delete].should == [[@tmp_dir, 'root/file.rb']]
+        @handler_results[:update].should == []
+      end
+
+      it "should not call callbacks upon directory operations" do
+        FileUtils.mkdir @tmp_dir + "/another_yawn"
+        FileUtils.rmdir @tmp_dir + "/root/yawn"
+        run_monitor
+        @handler_results[:create].should == []
+        @handler_results[:delete].should == []
+      end
+    end
+
+    describe "when configured to consider files and directories" do
+      before do
+        create_monitor(:directories => true)
+      end
+
+      it "should call create callback upon directory creation" do
+        FileUtils.mkdir @tmp_dir + "/another_yawn"
+        run_monitor
+        @handler_results[:create].should == [[@tmp_dir, 'another_yawn', :directory]]
+      end
+
+      it "should call delete callback upon directory deletion" do
+        FileUtils.rmdir @tmp_dir + "/root/yawn"
+        run_monitor
+        @handler_results[:delete].should == [[@tmp_dir, 'root/yawn', :directory]]
+      end
+
+      it "should call create, update, and delete callbacks upon directory renaming in the same directory" do
+        FileUtils.mv @tmp_dir + "/root/yawn", @tmp_dir + "/root/old_yawn"
+        run_monitor
+        @handler_results[:create].should == [[@tmp_dir, 'root/old_yawn',  :directory]]
+        @handler_results[:delete].should == [[@tmp_dir, 'root/yawn',      :directory]]
+        @handler_results[:update].should == [[@tmp_dir, 'root',           :directory]]
+      end
+
+      it "should call create, update, and delete callbacks upon directory moving to another directory" do
+        FileUtils.mv @tmp_dir + "/root/yawn", @tmp_dir + "/old_yawn"
+        run_monitor
+        @handler_results[:create].should == [[@tmp_dir, 'old_yawn',   :directory]]
+        @handler_results[:delete].should == [[@tmp_dir, 'root/yawn',  :directory]]
+        @handler_results[:update].should == [[@tmp_dir, 'root',       :directory]]
+      end
+
+      it "should call create, update, and delete callbacks upon file renaming in the same directory" do
+        FileUtils.mv @tmp_dir + "/root/file.rb", @tmp_dir + "/root/old_file.rb"
+        run_monitor
+        @handler_results[:create].should == [[@tmp_dir, 'root/old_file.rb', :file]]
+        @handler_results[:delete].should == [[@tmp_dir, 'root/file.rb',     :file]]
+        @handler_results[:update].should == [[@tmp_dir, 'root',             :directory]]
+      end
+
+      it "should call create, update, and delete callbacks upon file moving to another directory" do
+        FileUtils.mv @tmp_dir + "/root/file.rb", @tmp_dir + "/old_file.rb"
+        run_monitor
+        @handler_results[:create].should == [[@tmp_dir, 'old_file.rb',  :file]]
+        @handler_results[:delete].should == [[@tmp_dir, 'root/file.rb', :file]]
+        @handler_results[:update].should == [[@tmp_dir, 'root',         :directory]]
+      end
+
+      it "should call delete callbacks upon directory structure deletion, in reverse order" do
+        FileUtils.rm_rf @tmp_dir + '/.'
+        run_monitor
+        @handler_results[:create].should == []
+        @handler_results[:delete].should == [
+            ['root/yawn',           :directory],
+            ['root/moo/cow.txt',    :file],
+            ['root/moo',            :directory],
+            ['root/file.yml',       :file],
+            ['root/file.rb',        :file],
+            ['root/file.css',       :file],
+            ['root/duck/quack.txt', :file],
+            ['root/duck',           :directory],
+            ['root',                :directory]
+          ].map {|(file, type)| [@tmp_dir, file, type]}
+        @handler_results[:update].should == []
+      end
+
+      it "should call create callbacks upon directory structure creation, in order" do
+        FileUtils.cp_r @tmp_dir + '/root/.', @tmp_dir + '/new_root'
+        run_monitor
+        @handler_results[:create].should == [
+            ['new_root',                :directory],
+            ['new_root/duck',           :directory],
+            ['new_root/duck/quack.txt', :file],
+            ['new_root/file.css',       :file],
+            ['new_root/file.rb',        :file],
+            ['new_root/file.yml',       :file],
+            ['new_root/moo',            :directory],
+            ['new_root/moo/cow.txt',    :file],
+            ['new_root/yawn',           :directory]
+          ].map {|(file, type)| [@tmp_dir, file, type]}
+        @handler_results[:delete].should == []
+        @handler_results[:update].should == []
+      end
+    end
+  end
+end

data/spec/path_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require "spec_helper"
 
 describe "The File System State Monitor" do
   describe "paths" do
@@ -27,6 +27,10 @@ describe "The File System State Monitor" do
       path.glob.should == ['**/*.yml']
     end
 
+    it "should accept an optional option parameter" do
+      lambda {FSSM::Path.new('.', '**/*.yml', :foo => :bar)}.should_not raise_error
+    end
+
     it "should default the glob to ['**/*']" do
       path = FSSM::Path.new
       path.glob.should == ['**/*']
@@ -35,21 +39,21 @@ describe "The File System State Monitor" do
     it "should accept a callback for update events" do
       path = FSSM::Path.new
       callback = lambda {|base, relative| return true}
-      path.update(callback)
+      path.update(&callback)
       (path.update).should == callback
     end
 
     it "should accept a callback for delete events" do
       path = FSSM::Path.new
       callback = lambda {|base, relative| return true}
-      path.delete(callback)
+      path.delete(&callback)
       (path.delete).should == callback
     end
 
     it "should accept a callback for create events" do
       path = FSSM::Path.new
       callback = lambda {|base, relative| return true}
-      path.create(callback)
+      path.create(&callback)
       (path.create).should == callback
     end
 
@@ -71,5 +75,22 @@ describe "The File System State Monitor" do
       path.create.call('', '').should == 'success'
     end
 
+    it "should pass file type to callbacks as the third argument if :directories option is used" do
+      path = FSSM::Path.new "#{@watch_root}", nil, :directories => true do
+        glob '**/*.yml'
+        update {|base, relative, type| [base, relative, type]}
+        delete {|base, relative, type| [base, relative, type]}
+        create {|base, relative, type| [base, relative, type]}
+      end
+
+      "#{path}".should == "#{@watch_root}"
+      path.glob.should == ['**/*.yml']
+      path.update.should be_a_kind_of(Proc)
+      path.delete.should be_a_kind_of(Proc)
+      path.create.should be_a_kind_of(Proc)
+      path.update.call('b', 'r', 't').should == ['b', 'r', 't']
+      path.delete.call('b', 'r', 't').should == ['b', 'r', 't']
+      path.create.call('b', 'r', 't').should == ['b', 'r', 't']
+    end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
     - 0
-    - 1
-    - 4
-  version: 0.1.4
+    - 2
+    - 0
+  version: 0.2.0
 platform: ruby
 authors: 
   - Travis Tilley
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-10 00:00:00 -05:00
+date: 2010-11-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -40,7 +40,6 @@ extra_rdoc_files:
   - README.markdown
 files: 
   - .document
-  - .gitignore
   - LICENSE
   - README.markdown
   - Rakefile
@@ -64,6 +63,7 @@ files:
   - profile/prof-pathname.rb
   - profile/prof-plain-pathname.html
   - profile/prof.html
+  - spec/monitor_spec.rb
   - spec/path_spec.rb
   - spec/root/duck/quack.txt
   - spec/root/file.css
@@ -76,8 +76,8 @@ homepage: http://github.com/ttilley/fssm
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-  - --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
   - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -102,6 +102,7 @@ signing_key:
 specification_version: 3
 summary: file system state monitor
 test_files: 
+  - spec/monitor_spec.rb
   - spec/path_spec.rb
-  - spec/spec_helper.rb
   - spec/root/file.rb
+  - spec/spec_helper.rb

data/.gitignore

@@ -1,9 +0,0 @@
-*.sw?
-.DS_Store
-.idea
-/*.gem
-coverage
-nbproject
-pkg
-rdoc
-