fssm 0.2.2 → 0.2.3

data/VERSION.yml

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

data/fssm.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fssm}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Travis Tilley"]
-  s.date = %q{2010-12-11}
+  s.date = %q{2010-12-18}
   s.description = %q{file system state monitor}
   s.email = %q{ttilley@gmail.com}
   s.extra_rdoc_files = [
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
     "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",
@@ -56,6 +57,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{file system state monitor}
   s.test_files = [
+    "spec/count_down_latch.rb",
     "spec/monitor_spec.rb",
     "spec/path_spec.rb",
     "spec/root/file.rb",

data/lib/fssm/state/file.rb

@@ -8,7 +8,7 @@ module FSSM::State
 
     def refresh(base=nil, skip_callbacks=false)
       base ||= @path.to_pathname
-      used_to_exist, @exists = @exists, base.exists?
+      used_to_exist, @exists = @exists, base.exist?
       # this handles bad symlinks without failing. why handle bad symlinks at
       # all? well, we could still be interested in their creation and deletion.
       old_mtime, @mtime = @mtime, base.symlink? ? Time.at(0) : base.mtime if @exists

data/spec/count_down_latch.rb

@@ -0,0 +1,151 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'thread'
+
+class CountDownLatch
+  attr_reader :count
+
+  def initialize(to)
+    @count = to.to_i
+    raise ArgumentError, "cannot count down from negative integer" unless @count >= 0
+    @lock = Mutex.new
+    @condition = ConditionVariable.new
+  end
+
+  def count_down
+    @lock.synchronize do
+      @count -= 1 if @count > 0
+      @condition.broadcast if @count == 0
+    end
+  end
+
+  def wait
+    @lock.synchronize do
+      @condition.wait(@lock) while @count > 0
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'test/unit'
+
+  class CountDownLatchTest < Test::Unit::TestCase
+    def test_requires_positive_count
+      assert_raise(ArgumentError) { CountDownLatch.new(-1) }
+    end
+
+    def test_basic_latch_usage
+      latch = CountDownLatch.new(1)
+      name = "foo"
+      Thread.new do
+        name = "bar"
+        latch.count_down
+      end
+      latch.wait
+      assert_equal(0, latch.count)
+      assert_equal("bar", name)
+    end
+
+    def test_basic_latch_usage_inverted
+      latch = CountDownLatch.new(1)
+      name = "foo"
+      Thread.new do
+        latch.wait
+        assert_equal(0, latch.count)
+        assert_equal("bar", name)
+      end
+      name = "bar"
+      latch.count_down
+    end
+
+    def test_count_down_from_zero_skips_wait
+      latch = CountDownLatch.new(0)
+      latch.wait
+      assert_equal(0, latch.count)
+    end
+
+    def test_count_down_twice_with_thread
+      latch = CountDownLatch.new(2)
+      name = "foo"
+      Thread.new do
+        latch.count_down
+        name = "bar"
+        latch.count_down
+      end
+      latch.wait
+      assert_equal(0, latch.count)
+      assert_equal("bar", name)
+    end
+
+    def test_count_down_twice_with_two_parallel_threads
+      latch = CountDownLatch.new(2)
+      name = "foo"
+      Thread.new { latch.count_down }
+      Thread.new do
+        name = "bar"
+        latch.count_down
+      end
+      latch.wait
+      assert_equal(0, latch.count)
+      assert_equal("bar", name)
+    end
+
+    def test_count_down_twice_with_two_chained_threads
+      latch = CountDownLatch.new(2)
+      name = "foo"
+      Thread.new do
+        latch.count_down
+        Thread.new do
+          name = "bar"
+          latch.count_down
+        end
+      end
+      latch.wait
+      assert_equal(0, latch.count)
+      assert_equal("bar", name)
+    end
+
+    def test_count_down_with_multiple_waiters
+      proceed_latch = CountDownLatch.new(2)
+      check_latch = CountDownLatch.new(2)
+      results = {}
+      Thread.new do
+        proceed_latch.wait
+        results[:first] = 1
+        check_latch.count_down
+      end
+      Thread.new do
+        proceed_latch.wait
+        results[:second] = 2
+        check_latch.count_down
+      end
+      assert_equal({}, results)
+      proceed_latch.count_down
+      proceed_latch.count_down
+      check_latch.wait
+      assert_equal(0, proceed_latch.count)
+      assert_equal(0, check_latch.count)
+      assert_equal({:first => 1, :second => 2}, results)
+    end
+
+    def test_interleaved_latches
+      change_1_latch = CountDownLatch.new(1)
+      check_latch = CountDownLatch.new(1)
+      change_2_latch = CountDownLatch.new(1)
+      name = "foo"
+      Thread.new do
+        name = "bar"
+        change_1_latch.count_down
+        check_latch.wait
+        name = "man"
+        change_2_latch.count_down
+      end
+      change_1_latch.wait
+      assert_equal("bar", name)
+      check_latch.count_down
+      change_2_latch.wait
+      assert_equal("man", name)
+    end
+  end
+end

data/spec/monitor_spec.rb

@@ -1,7 +1,8 @@
-require "spec_helper"
+require 'spec_helper'
 
-require "fileutils"
-require "tempfile"
+require 'count_down_latch'
+require 'fileutils'
+require 'tempfile'
 
 module FSSM::MonitorSpecHelpers
   def create_tmp_dir
@@ -16,24 +17,28 @@ module FSSM::MonitorSpecHelpers
     FileUtils.remove_entry_secure @tmp_dir
   end
 
-  def create_handler(type)
-    lambda {|*args| @handler_results[type] << args}
+  def create_handler(type, latch)
+    lambda do |*args|
+      @handler_results[type] << args
+      latch.count_down
+    end
   end
 
-  def create_monitor(options={})
+  def run_monitor(num_events_to_expect=0, options={})
+    event_latch = CountDownLatch.new(num_events_to_expect)
     @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))
+    thread = Thread.new do
+      monitor = FSSM::Monitor.new(options)
+      monitor.path(@tmp_dir) do |p|
+        p.create(&create_handler(:create, event_latch))
+        p.update(&create_handler(:update, event_latch))
+        p.delete(&create_handler(:delete, event_latch))
+      end
+      monitor.run
     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
+    sleep 1   # give time for monitor to start up
+    yield if block_given?
+    event_latch.wait
     thread.kill
   end
 end
@@ -51,136 +56,144 @@ describe "The File System State Monitor" do
     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
+        run_monitor(1) do
+          file = @tmp_dir + "/newfile.rb"
+          File.exists?(file).should be_false
+          FileUtils.touch file
+        end
         @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
+        run_monitor(1) do
+          FileUtils.touch @tmp_dir + '/root/file.rb'
+        end
         @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
+        run_monitor(1) do
+          FileUtils.rm @tmp_dir + "/root/file.rb"
+        end
         @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
+        run_monitor(2) do
+          FileUtils.mv @tmp_dir + "/root/file.rb", @tmp_dir + "/root/old_file.rb"
+        end
         @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
+        run_monitor(2) do
+          FileUtils.mv @tmp_dir + "/root/file.rb", @tmp_dir + "/old_file.rb"
+        end
         @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
+        run_monitor do
+          FileUtils.mkdir @tmp_dir + "/another_yawn"
+          FileUtils.rmdir @tmp_dir + "/root/yawn"
+        end
         @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
+        run_monitor(1, :directories => true) do
+          FileUtils.mkdir @tmp_dir + "/another_yawn"
+        end
         @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
+        run_monitor(1, :directories => true) do
+          FileUtils.rmdir @tmp_dir + "/root/yawn"
+        end
         @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
+        run_monitor(3, :directories => true) do
+          FileUtils.mv @tmp_dir + "/root/yawn", @tmp_dir + "/root/old_yawn"
+        end
         @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
+        run_monitor(3, :directories => true) do
+          FileUtils.mv @tmp_dir + "/root/yawn", @tmp_dir + "/old_yawn"
+        end
         @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
+        run_monitor(3, :directories => true) do
+          FileUtils.mv @tmp_dir + "/root/file.rb", @tmp_dir + "/root/old_file.rb"
+        end
         @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
+        run_monitor(3, :directories => true) do
+          FileUtils.mv @tmp_dir + "/root/file.rb", @tmp_dir + "/old_file.rb"
+        end
         @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
+        expected_delete_events = [
+          ['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]
+        ]
+        run_monitor(expected_delete_events.size, :directories => true) do
+          FileUtils.rm_rf @tmp_dir + '/.'
+        end
         @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[:delete].should == expected_delete_events.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]}
+        expected_create_events = [
+          ['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]
+        ]
+        run_monitor(expected_create_events.size, :directories => true) do
+          FileUtils.cp_r @tmp_dir + '/root/.', @tmp_dir + '/new_root'
+        end
+        @handler_results[:create].should == expected_create_events.map {|(file, type)| [@tmp_dir, file, type]}
         @handler_results[:delete].should == []
         @handler_results[:update].should == []
       end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: fssm
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Travis Tilley
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-11 00:00:00 -05:00
+date: 2010-12-18 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -67,6 +65,7 @@ files:
 - 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
@@ -89,7 +88,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -98,7 +96,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -110,6 +107,7 @@ 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