rb-fsevent 0.4.0 → 0.4.1

data/README.rdoc

@@ -5,7 +5,7 @@ Very simple & usable Mac OSX FSEvents API
 - RubyCocoa not required!
 - Signals are working
 - Tested on MRI 1.8.6, 1.8.7 & 1.9.2
-- Tested on JRuby 1.6.0 RC3, with experimental (but sufficient) extconf/mkmf support
+- Tested on JRuby-head, with experimental (but sufficient) extconf/mkmf support
 
 == Install
 
@@ -80,6 +80,8 @@ The :latency parameter determines how long the service should wait after the fir
 
 Setting a higher latency value allows for more effective temporal coalescing, resulting in fewer callbacks and greater overall efficiency... at the cost of apparent responsiveness. Setting this to a reasonably high value (and NOT setting :no_defer) is particularly well suited for background, daemon, or batch processing applications.
 
+Implementation note: It appears that FSEvents will only coalesce events from a maximum of 32 distinct subpaths, making the above completely accurate only when events are to fewer than 32 subpaths. Creating 300 files in one directory, for example, or 30 files in 10 subdirectories, but not 300 files within 300 subdirectories. In the latter case, you may receive 31 callbacks in one go after the latency period. As this appears to be an implementation detail, the number could potentially differ across OS revisions. It is entirely possible that this number is somehow configurable, but I have not yet discovered an accepted method of doing so.
+
 === NoDefer
 
 The :no_defer option changes the behavior of the latency parameter completely. Rather than waiting for $latency period of time before sending along events in an attempt to coalesce a potential deluge ahead of time, that first event is sent along to the client immediately and is followed by a $latency period of silence before sending along any additional events that occurred within that period.
@@ -90,7 +92,7 @@ This behavior is particularly useful for interactive applications where that fee
 
 The :watch_root option allows for catching the scenario where you start watching "~/src/demo_project" and either it is later renamed to "~/src/awesome_sauce_3000" or the path changes in such a manner that the original directory is now at "~/clients/foo/iteration4/demo_project".
 
-Unfortunately, while this behavior is somewhat supported in the fsevent_watch binary built as part of this project, support for passing across detailed metadata is not (yet). As a result, you would not receive the appropriate RootChanged event and be able to react appropriately. Also, since the C code doesn't open watched directories and retain that file descriptor as part of path-specific callback metadata, we are unable to to issue an F_GETPATH fcntl() to determine the directory's new path.
+Unfortunately, while this behavior is somewhat supported in the fsevent_watch binary built as part of this project, support for passing across detailed metadata is not (yet). As a result, you would not receive the appropriate RootChanged event and be able to react appropriately. Also, since the C code doesn't open watched directories and retain that file descriptor as part of path-specific callback metadata, we are unable to issue an F_GETPATH fcntl() to determine the directory's new path.
 
 Please do not use this option until proper support is added in an upcoming (planned) release.
 
@@ -104,7 +106,7 @@ WARNING: passing in 0 as the parameter to :since_when will return events for eve
 
 == Debugging output
 
-If the gem is installed with the environment variable FWDEBUG set to the string "true", then fsevent_watch will be built with its various DEBUG sections defined, and the output to STDERR is truly verbose (and hopefully helpful debugging your application and not just fsevent_watch itself):
+If the gem is installed with the environment variable FWDEBUG set to the string "true", then fsevent_watch will be built with its various DEBUG sections defined, and the output to STDERR is truly verbose (and hopefully helpful in debugging your application and not just fsevent_watch itself). If enough people find this to be directly useful when developing code that makes use of rb-fsevent, then it wouldn't be hard to clean this up and make it a feature enabled by a commandline argument instead. Until somebody files an issue, however, I will assume otherwise.
 
     append_path called for: /tmp/moo/cow/
       resolved path to: /private/tmp/moo/cow
@@ -230,17 +232,27 @@ If the gem is installed with the environment variable FWDEBUG set to the string
 
 == Note about FFI
 
-rb-fsevent doesn't use {ruby-ffi}[http://github.com/ffi/ffi] anymore because it sadly doesn't allow to catch Signals, you can see the code in {ffi branch}[http://github.com/thibaudgg/rb-fsevent/tree/ffi].
+rb-fsevent doesn't use {ruby-ffi}[http://github.com/ffi/ffi] anymore because it sadly doesn't allow for catching Signals. You can still see the code in the {ffi branch}[http://github.com/thibaudgg/rb-fsevent/tree/ffi].
 
 == Development
 
 - Source hosted at {GitHub}[http://github.com/thibaudgg/rb-fsevent]
 - Report issues/Questions/Feature requests on {GitHub Issues}[http://github.com/thibaudgg/rb-fsevent/issues]
 
-Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change
-you make.
+Pull requests are quite welcome! Please ensure that your commits are in a topic branch for each individual changeset than can be reasonably isolated. It is also important to ensure that your changes are well tested... whether that means new tests, modified tests, or fixing a scenario where the existing tests currently fail. If you have rvm and the required rubies currently installed, we have a helper task for running the testsuite in all of them:
+
+    rake spec:portability
+
+The list of tested RVM targets is currently:
+
+    %w[1.8.6 1.8.7 1.9.2 jruby-head]
+
+Development note: As of my last attempt to do so, jruby-head's cext support will NOT compile, as-is, using xcode 4.0.1. Simply editing the makefile to point -isysroot to '/' rather than depend on an SDK specific environment and switching the minimum OS to 10.6 was enough to get past this. Making these changes within the context of an RVM installed ruby, however, requires creating a patch and then informing rvm that it needs to apply this patch pre-build.
+
+If you have xcode4, and jruby-head has not yet been fixed to allow unmodified compilation, then it's perfectly understandable and acceptable to just remove jruby-head as a testing target. This is especially true considering that it requires an unreleased version of JRuby to begin with.
 
 == Authors
 
 - {Thibaud Guillaume-Gentil}[http://github.com/thibaudgg]
 - {Travis Tilley}[http://github.com/ttilley]
+

data/ext/extconf.rb

@@ -5,6 +5,13 @@ create_makefile('none')
 if `uname -s`.chomp != 'Darwin'
   puts "Warning! Only Darwin (Mac OS X) systems are supported, nothing will be compiled"
 else
+  begin
+    xcode_path = %x[xcode-select -print-path].to_s.strip!
+  rescue Errno::ENOENT
+  end
+
+  raise "Could not find a suitable Xcode installation" unless xcode_path
+
   gem_root       = File.expand_path(File.join('..'))
   darwin_version = `uname -r`.to_i
   sdk_version    = { 9 => '10.5', 10 => '10.6', 11 => '10.7' }[darwin_version]
@@ -12,7 +19,7 @@ else
   raise "Only Darwin systems greater than 8 (Mac OS X 10.5+) are supported" unless sdk_version
 
   core_flags = %W{
-    -isysroot /Developer/SDKs/MacOSX#{sdk_version}.sdk
+    -isysroot #{xcode_path}/SDKs/MacOSX#{sdk_version}.sdk
     -mmacosx-version-min=#{sdk_version} -mdynamic-no-pic -std=gnu99
   }
 

data/lib/rb-fsevent/version.rb

@@ -1,3 +1,3 @@
 class FSEvent
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,83 +1,60 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rb-fsevent
-version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 0
-  version: 0.4.0
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Thibaud Guillaume-Gentil
 - Travis Tilley
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-09 00:00:00 +01:00
+date: 2011-07-06 00:00:00.000000000 +02:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152430220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 0
-        - 10
+      - !ruby/object:Gem::Version
         version: 1.0.10
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152430220
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152429140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 5
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: guard-rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2152429140
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2152427640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 0
-        - 1
-        - 9
+      - !ruby/object:Gem::Version
         version: 0.1.9
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *2152427640
 description: FSEvents API with Signals catching (without RubyCocoa)
-email: 
+email:
 - thibaud@thibaud.me
 - ttilley@gmail.com
 executables: []
-
-extensions: 
+extensions:
 - ext/extconf.rb
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/rb-fsevent/fsevent.rb
 - lib/rb-fsevent/version.rb
 - lib/rb-fsevent.rb
@@ -88,36 +65,32 @@ files:
 has_rdoc: true
 homepage: http://rubygems.org/gems/rb-fsevent
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -3134696196885608875
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -3134696196885608875
 requirements: []
-
 rubyforge_project: rb-fsevent
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Very simple & usable FSEvents API
 test_files: []
-