fsevents 0.0.2 → 0.1.0

data/History.txt

@@ -1,3 +1,11 @@
+== 0.1.0 2008-06-30
+
+* 1 minor enhancement:
+  * Added optional cache mode for getting an Event's modified files. The old behavior is the mtime mode, which is default.
+  
+* 1 tiny enhancement:
+  * Now stripping trailing slashes from paths (for both Stream and Event objects)
+
 == 0.0.2 2008-06-17
 
 * 1 tiny enhancement:

data/lib/fsevents/event.rb

@@ -4,7 +4,7 @@ module FSEvents
     
     def initialize(id, path, stream)
       @id     = id
-      @path   = path
+      @path   = path.sub(%r%/$%, '')
       @stream = stream
     end
     
@@ -13,7 +13,21 @@ module FSEvents
     end
     
     def modified_files
-      files.select { |f|  File.mtime(f) >= stream.last_event }
+      case stream.mode
+      when :mtime
+        files.select { |f|  File.mtime(f) >= stream.last_event }
+      when :cache
+        cache = stream.dirs[path] || {}
+        
+        files.select do |f|
+          cached = cache[f]
+          
+          cached.nil? or
+          
+          File.mtime(f) != cached.mtime or
+          File.size(f)  != cached.size
+        end
+      end
     end
   end
 end

data/lib/fsevents/stream.rb

@@ -2,11 +2,13 @@ require 'fsevents/event'
 
 module FSEvents
   class Stream
-    attr_reader :stream, :last_event
+    attr_reader :stream, :mode, :last_event, :dirs
     attr_reader :allocator, :context, :paths, :since, :latency, :flags, :callback
     
     class StreamError < StandardError; end
     
+    MODES = [:mtime, :cache]
+    
     def initialize(*paths, &callback)
       raise ArgumentError, 'A callback block is required' if callback.nil?
       @callback = callback
@@ -14,11 +16,16 @@ module FSEvents
       options = {}
       options = paths.pop if paths.last.is_a?(Hash)
       
+      @mode = options[:mode] || :mtime
+      raise ArgumentError, "Mode '#{mode}' unknown" unless MODES.include?(@mode)
+      @dirs = {}
+      
       paths = Dir.pwd if paths.empty?
+      paths = [paths].flatten.collect { |path|  path.sub(%r%/$%, '') }
       
       @allocator = options[:allocator] || OSX::KCFAllocatorDefault
       @context   = options[:context]   || nil
-      @paths     = [paths].flatten
+      @paths     = paths
       @since     = options[:since]     || OSX::KFSEventStreamEventIdSinceNow
       @latency   = options[:latency]   || 1.0
       @flags     = options[:flags]     || 0
@@ -53,7 +60,20 @@ module FSEvents
     end
     
     def update_last_event
-      @last_event = Time.now
+      case mode
+      when :mtime
+        @last_event = Time.now
+      when :cache
+        cache_paths = paths.dup
+        cache_paths.each do |path|
+          dirs[path] = {}
+          Dir["#{path}/*"].each do |file|
+            stat = File::Stat.new(file)
+            dirs[path][file] = stat
+            cache_paths.push(file) if stat.directory?
+          end
+        end
+      end
     end
     
     def startup

data/lib/fsevents/version.rb

@@ -1,8 +1,8 @@
 module Fsevents #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY  = 2
+    MINOR = 1
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/event_spec.rb

@@ -34,6 +34,10 @@ describe FSEvents::Event do
       FSEvents::Event.new(@id, @path, @stream).path.should == @path
     end
     
+    it 'should strip a trailing / from the path' do
+      FSEvents::Event.new(@id, "#{@path}/", @stream).path.should == @path
+    end
+    
     it 'should store the stream' do
       FSEvents::Event.new(@id, @path, @stream).stream.should == @stream
     end
@@ -56,49 +60,147 @@ describe FSEvents::Event do
   describe 'listing modified files' do
     before :each do
       @now = Time.now
-      @stream.stubs(:last_event).returns(@now)
-      @files = Array.new(5) do |i|
-        file = stub("file #{i+1}")
-        File.stubs(:mtime).with(file).returns(@now + i - 2)
-        file
-      end
+      @files = Array.new(5) { |i|  stub("file #{i+1}") }
       @event.stubs(:files).returns(@files)
     end
-
-    it 'should get the file list' do
-      @event.expects(:files).returns(@files)
-      @event.modified_files
-    end
-
-    it 'should get the last event time from the stream' do
-      @stream.expects(:last_event).returns(@now)
+    
+    it 'should check the stream mode' do
+      @stream.expects(:mode)
       @event.modified_files
     end
-
-    it 'should return files modified after the last event time' do
-      expected_files = @files.values_at(3, 4)
-      modified_files = @event.modified_files
-
-      expected_files.each do |file|
-        modified_files.should include(file)
+    
+    describe 'when the stream mode is mtime' do
+      before :each do
+        @stream.stubs(:mode).returns(:mtime)
       end
-    end
-
-    it 'should return files modified at the last event time' do
-      expected_files = @files.values_at(2)
-      modified_files = @event.modified_files
-
-      expected_files.each do |file|
-        modified_files.should include(file)
+      
+      before :each do
+        @stream.stubs(:last_event).returns(@now)
+        @files.each_with_index do |file, i|
+          File.stubs(:mtime).with(file).returns(@now + i - 2)
+        end
+      end
+      
+      it 'should get the file list' do
+        @event.expects(:files).returns(@files)
+        @event.modified_files
+      end
+      
+      it 'should get the last event time from the stream' do
+        @stream.expects(:last_event).returns(@now)
+        @event.modified_files
+      end
+      
+      it 'should return files modified after the last event time' do
+        expected_files = @files.values_at(3, 4)
+        modified_files = @event.modified_files
+        
+        expected_files.each do |file|
+          modified_files.should include(file)
+        end
+      end
+      
+      it 'should return files modified at the last event time' do
+        expected_files = @files.values_at(2)
+        modified_files = @event.modified_files
+        
+        expected_files.each do |file|
+          modified_files.should include(file)
+        end
+      end
+      
+      it 'should not return files not modified after the last event time' do
+        unexpected_files = @files.values_at(0, 1)
+        modified_files = @event.modified_files
+        
+        unexpected_files.each do |file|
+          modified_files.should_not include(file)
+        end
       end
     end
-
-    it 'should not return files not modified after the last event time' do
-      unexpected_files = @files.values_at(0, 1)
-      modified_files = @event.modified_files
-
-      unexpected_files.each do |file|
-        modified_files.should_not include(file)
+    
+    describe 'when the stream mode is cache' do
+      before :each do
+        @stream.stubs(:mode).returns(:cache)
+      end
+      
+      before :each do
+        @dir_cache = { @path => {} }
+        @files.each_with_index do |file, i|
+          size  = 50 * (i + 1)
+          mtime = @now + i - 2
+          File.stubs(:size).with(file).returns(size)
+          File.stubs(:mtime).with(file).returns(mtime)
+          stat = stub("file #{i+1} stat", :mtime => mtime, :size => size)
+          @dir_cache[@path][file] = stat
+        end
+        @stream.stubs(:dirs).returns(@dir_cache)
+      end
+      
+      it 'should get the file list' do
+        @event.expects(:files).returns(@files)
+        @event.modified_files
+      end
+      
+      it 'should get the stream dir cache' do
+        @stream.expects(:dirs).returns(@dir_cache)
+        @event.modified_files
+      end
+      
+      it 'should get the dir cache for the event path' do
+        sub_cache = @dir_cache[@path]
+        @dir_cache.expects(:[]).with(@path).returns(sub_cache)
+        @event.modified_files
+      end
+      
+      it 'should return files that do not appear in the cache' do
+        expected_files = Array.new(2) { |i|  stub("new file #{i+1}") }
+        expected_files.each { |file|  @files.push(file) }
+        modified_files = @event.modified_files
+        
+        expected_files.each do |file|
+          modified_files.should include(file)
+        end
+      end
+      
+      it 'should return files with sizes that differ from the cache' do
+        @dir_cache[@path][@files[3]].stubs(:size).returns(3)
+        @dir_cache[@path][@files[4]].stubs(:size).returns(101)
+        expected_files = @files.values_at(3, 4)
+        modified_files = @event.modified_files
+        
+        expected_files.each do |file|
+          modified_files.should include(file)
+        end
+      end
+      
+      it 'should return files with mtimes that differ from the cache' do
+        @dir_cache[@path][@files[2]].stubs(:mtime).returns(@now - 234)
+        expected_files = @files.values_at(2)
+        modified_files = @event.modified_files
+        
+        expected_files.each do |file|
+          modified_files.should include(file)
+        end
+      end
+      
+      it 'should not return files not modified from the cache' do
+        unexpected_files = @files.values_at(0, 1)
+        modified_files = @event.modified_files
+        
+        unexpected_files.each do |file|
+          modified_files.should_not include(file)
+        end
+      end
+      
+      it 'should handle this path not yet cached' do
+        @dir_cache.delete(@path)
+        expected_files = @files
+        modified_files = @event.modified_files
+        
+        expected_files.each do |file|
+          modified_files.should include(file)
+        end
       end
     end
   end

data/spec/stream_spec.rb

@@ -50,6 +50,7 @@ describe FSEvents::Stream do
         [:allocator, :context, :since, :latency, :flags].each do |opt|
           @options[opt] = stub(opt.to_s)
         end
+        @options[:mode] = :cache
         @other_path = '/other/path'
       end
       
@@ -87,6 +88,10 @@ describe FSEvents::Stream do
         FSEvents::Stream.new(@options) {}.paths.should == [Dir.pwd]
       end
       
+      it 'should strip a trailing slash from the path' do
+        FSEvents::Stream.new("#{@path}/", "#{@other_path}/", @options) {}.paths.should == [@path, @other_path]
+      end
+      
       it "should store 'since' (event ID)" do
         FSEvents::Stream.new(@path, @options) {}.since.should == @options[:since]
       end
@@ -113,6 +118,19 @@ describe FSEvents::Stream do
         @options.delete(:flags)
         FSEvents::Stream.new(@path, @options) {}.flags.should == 0
       end
+      
+      it 'should store mode' do
+        FSEvents::Stream.new(@path, @options) {}.mode.should == @options[:mode]
+      end
+      
+      it 'should default mode to mtime' do
+        @options.delete(:mode)
+        FSEvents::Stream.new(@path, @options) {}.mode.should == :mtime
+      end
+      
+      it 'should not accept any mode other than mtime or cache' do
+        lambda { FSEvents::Stream.new(@path, @options.merge(:mode => :something_else)) {} }.should raise_error(ArgumentError)
+      end
     end
   end
   
@@ -272,7 +290,7 @@ describe FSEvents::Stream do
       
       it 'should extend the event array' do
         @args = @args_hash.values_at(*@callback_arg_order)
-        @callback.expects(:call).with { |events|  events.is_a?(EventArray) }
+        @callback.expects(:call).with(kind_of(EventArray))
         @proc.call(*@args)
       end
       
@@ -405,11 +423,101 @@ describe FSEvents::Stream do
   end
   
   describe 'updating its last event' do
-    it 'should store the last event time' do
-      now = Time.now
-      Time.stubs(:now).returns(now)
-      @stream.update_last_event
-      @stream.last_event.should == now
+    describe 'when mode is mtime' do
+      before :each do
+        @stream.stubs(:mode).returns(:mtime)
+      end
+      
+      it 'should store the last event time' do
+        now = Time.now
+        Time.stubs(:now).returns(now)
+        @stream.update_last_event
+        @stream.last_event.should == now
+      end
+    end
+    
+    describe 'when mode is cache' do
+      before :each do
+        @stream.stubs(:mode).returns(:cache)
+        @files = Array.new(5) { |i|  stub("file #{i+1}") }
+        @stats = Array.new(5) { |i|  stub("file #{i+1} stat", :directory? => false) }
+        
+        @files.zip(@stats).each do |file, stat|
+          File::Stat.stubs(:new).with(file).returns(stat)
+        end
+        
+        Dir.stubs(:[]).returns(@files)
+      end
+      
+      it 'should get the contents of its path' do
+        Dir.expects(:[]).with("#{@path}/*").returns([])
+        @stream.update_last_event
+      end
+      
+      it 'should get stat objects for the path contents' do
+        @files.zip(@stats).each do |file, stat|
+          File::Stat.expects(:new).with(file).returns(stat)
+        end
+        @stream.update_last_event
+      end
+      
+      it 'should cache the stat objects' do
+        @stream.update_last_event
+        
+        @files.zip(@stats).each do |file, stat|
+          @stream.dirs[@path][file].should == stat
+        end
+      end
+      
+      it 'should update already-existent cache entries' do
+        file = @files[3]
+        val  = @stats[3]
+        @stream.dirs[@path] = { file => 'some other val' }
+        
+        @stream.update_last_event
+        @stream.dirs[@path][file].should == val
+      end
+      
+      it 'should remove non-needed cache entries' do
+        file = 'some other file'
+        @stream.dirs[@path] = { file => 'some val' }
+        
+        @stream.update_last_event
+        @stream.dirs[@path].should_not have_key(file)
+      end
+      
+      it 'should handle multiple paths' do
+        other_path = '/other/path'
+        paths = [@path, other_path]
+        @stream.stubs(:paths).returns(paths)
+        
+        paths.each do |path|
+          Dir.expects(:[]).with("#{path}/*").returns([])
+        end
+        @stream.update_last_event
+      end
+      
+      it 'should see if there are any subdirectories' do
+        @stats.each { |stat|  stat.expects(:directory?) }
+        @stream.update_last_event
+      end
+      
+      it 'should cache subdirectories' do
+        subdir_path = '/sub/dir/path'
+        @files[3].stubs(:to_s).returns(subdir_path)
+        @stats[3].stubs(:directory?).returns(true)
+        Dir.expects(:[]).with("#{subdir_path}/*").returns([])
+        @stream.update_last_event
+      end
+      
+      it 'should not add cached subdirectories to the watched paths' do
+        subdir_path = '/sub/dir/path'
+        @files[3].stubs(:to_s).returns(subdir_path)
+        @stats[3].stubs(:directory?).returns(true)
+        Dir.stubs(:[]).with("#{subdir_path}/*").returns([])
+        @stream.update_last_event
+        @stream.paths.should_not include(@files[3])
+      end
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fsevents
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-17 00:00:00 -05:00
+date: 2008-06-30 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yomendel
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Simple, usable FSEvents API