fsevents 0.0.1 → 0.0.2

data/History.txt

@@ -1,3 +1,8 @@
+== 0.0.2 2008-06-17
+
+* 1 tiny enhancement:
+  * Extending the events array with #files and #modified_files.
+
 == 0.0.1 2008-06-15
 
 * 1 major enhancement:

data/Manifest.txt

@@ -7,12 +7,15 @@ config/hoe.rb
 config/requirements.rb
 lib/fsevents.rb
 lib/fsevents/event.rb
+lib/fsevents/ext.rb
+lib/fsevents/ext/array.rb
 lib/fsevents/stream.rb
 lib/fsevents/version.rb
 script/console
 script/destroy
 script/generate
 setup.rb
+spec/event_array_spec.rb
 spec/event_spec.rb
 spec/fsevents_spec.rb
 spec/spec.opts

data/README.txt

@@ -39,9 +39,18 @@
       end
       stream.run
   
-   Try that and make some new files in /tmp. Exciting, isn't it?
-   
-   FSEvents::Stream.watch takes some options, most of which I fully admit I don't understand because I have little desire to read the documentation on FSEvents itself. One obvious option is latency, which the number of seconds to wait until an event is reported. A higher number allows FSEvents to bundle events.
+  Try that and make some new files in /tmp. Exciting, isn't it?
+  
+  And for the common case of wanting to process every modified file no matter which subdirectory it happens to be under, the events array is extended for your convenience.
+  
+      require 'fsevents'
+  
+      stream = FSEvents::Stream.watch('/tmp') do |events|
+        p events.modified_files
+      end
+      stream.run
+  
+  FSEvents::Stream.watch takes some options, most of which I fully admit I don't understand because I have little desire to read the documentation on FSEvents itself. One obvious option is latency, which the number of seconds to wait until an event is reported. A higher number allows FSEvents to bundle events.
    
       stream = FSEvents::Stream.watch('/tmp', :latency => 15) {}  # default is 1.0
       
@@ -72,7 +81,7 @@
   
       stream.stop
   
-  A stream can also be invalidated and release it.
+  A stream can also be invalidated and released.
   
       stream.invalidate
       
@@ -80,7 +89,6 @@
       
       stream.shutdown  # stops, invalidates, and releases the stream
   
-  
   From what I can tell, entering the run loop requires an interrupt to get back out. Bear that in mind.
   
 == REQUIREMENTS:

data/lib/fsevents.rb

@@ -4,6 +4,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'osx/foundation'
 OSX.require_framework '/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework'
 
+require 'fsevents/ext'
 require 'fsevents/stream'
 
 module FSEvents

data/lib/fsevents/ext.rb

@@ -0,0 +1 @@
+require 'fsevents/ext/array'

data/lib/fsevents/ext/array.rb

@@ -0,0 +1,9 @@
+module EventArray
+  def files
+    collect { |x|  x.files }.flatten
+  end
+  
+  def modified_files
+    collect { |x|  x.modified_files }.flatten
+  end
+end

data/lib/fsevents/stream.rb

@@ -34,6 +34,7 @@ module FSEvents
         paths.regard_as('*')
         
         events = []
+        events.extend(EventArray)
         event_count.times { |i|  events << Event.new(event_IDs[i], paths[i], self) }
         
         callback.call(events)

data/lib/fsevents/version.rb

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

data/spec/event_array_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe EventArray do
+  before :each do
+    @event_array = []
+    @event_array.extend(EventArray)
+  end
+  
+  it 'should return files' do
+    @event_array.should respond_to(:files)
+  end
+  
+  describe 'returning files' do
+    it 'should collect files from its events' do
+      events = Array.new(3) { stub('event', :files => Array.new(3) { stub('file') }) }
+      files = []
+      events.each do |event|
+        @event_array << event
+        files += event.files
+      end
+      
+      @event_array.files.should == files
+    end
+  end
+  
+  it 'should return modified files' do
+    @event_array.should respond_to(:modified_files)
+  end
+  
+  describe 'returning modified files' do
+    it 'should collect modified files from its events' do
+      events = Array.new(3) { stub('event', :modified_files => Array.new(3) { stub('file') }) }
+      files = []
+      events.each do |event|
+        @event_array << event
+        files += event.modified_files
+      end
+      
+      @event_array.modified_files.should == files
+    end
+  end
+end

data/spec/stream_spec.rb

@@ -270,6 +270,12 @@ describe FSEvents::Stream do
         @proc.call(*@args)
       end
       
+      it 'should extend the event array' do
+        @args = @args_hash.values_at(*@callback_arg_order)
+        @callback.expects(:call).with { |events|  events.is_a?(EventArray) }
+        @proc.call(*@args)
+      end
+      
       it "should update the stream's last event" do
         @stream.expects(:update_last_event)
         @proc.call(*@args)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fsevents
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-15 00:00:00 -05:00
+date: 2008-06-17 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -35,12 +35,15 @@ files:
 - config/requirements.rb
 - lib/fsevents.rb
 - lib/fsevents/event.rb
+- lib/fsevents/ext.rb
+- lib/fsevents/ext/array.rb
 - lib/fsevents/stream.rb
 - lib/fsevents/version.rb
 - script/console
 - script/destroy
 - script/generate
 - setup.rb
+- spec/event_array_spec.rb
 - spec/event_spec.rb
 - spec/fsevents_spec.rb
 - spec/spec.opts