rb-inotify 0.2.1 → 0.3.0

data/README.md

@@ -39,12 +39,13 @@ and then continue on your merry way:
 
 Sometimes it's necessary to have finer control over the underlying IO operations
 than is provided by the simple callback API.
-The trick to this is that the notifier is a fully-functional IO object,
+The trick to this is that the \{INotify::Notifier#to_io Notifier#to_io} method
+returns a fully-functional IO object,
 with a file descriptor and everything.
 This means, for example, that it can be passed to `IO#select`:
 
      # Wait 10 seconds for an event then give up
-     if IO.select([notifier], [], [], 10)
+     if IO.select([notifier.to_io], [], [], 10)
        notifier.process
      end
 
@@ -53,7 +54,11 @@ It can even be used with EventMachine:
      require 'eventmachine'
 
      EM.run do
-       EM.watch notifier do
+       EM.watch notifier.to_io do
          notifier.process
        end
      end
+
+Unfortunately, this currently doesn't work under JRuby.
+JRuby currently doesn't use native file descriptors for the IO object,
+so we can't use the notifier's file descriptor as a stand-in.

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/rb-inotify/native.rb

@@ -21,7 +21,9 @@ module INotify
     end
 
     attach_function :inotify_init, [], :int
-    attach_function :inotify_add_watch, [:int, :string, :int], :int
-    attach_function :inotify_rm_watch, [:int, :int], :int
+    attach_function :inotify_add_watch, [:int, :string, :uint32], :int
+    attach_function :inotify_rm_watch, [:int, :uint32], :int
+
+    attach_function :read, [:int, :pointer, :size_t], :ssize_t
   end
 end

data/lib/rb-inotify/native/flags.rb

@@ -68,7 +68,7 @@ module INotify
       # Converts a list of flags to the bitmask that the C API expects.
       #
       # @param flags [Array<Symbol>]
-      # @return Fixnum
+      # @return [Fixnum]
       def self.to_mask(flags)
         flags.map {|flag| const_get("IN_#{flag.to_s.upcase}")}.
           inject(0) {|mask, flag| mask | flag}
@@ -76,7 +76,7 @@ module INotify
 
       # Converts a bitmask from the C API into a list of flags.
       #
-      # @return mask [Fixnum]
+      # @param mask [Fixnum]
       # @return [Array<Symbol>]
       def self.from_mask(mask)
         constants.select do |c|

data/lib/rb-inotify/notifier.rb

@@ -21,10 +21,7 @@ module INotify
   #
   #   # Nothing happens until you run the notifier!
   #   notifier.run
-  #
-  # Notifier is a subclass of IO with a fully-functional file descriptor,
-  # so it can be passed to functions like `#select`.
-  class Notifier < IO
+  class Notifier
     # A hash from {Watcher} ids to the instances themselves.
     #
     # @private
@@ -32,7 +29,8 @@ module INotify
     attr_reader :watchers
 
     # The underlying file descriptor for this notifier.
-    # This is a valid OS file descriptor, and can be used as such.
+    # This is a valid OS file descriptor, and can be used as such
+    # (except under JRuby -- see \{#to\_io}).
     #
     # @return [Fixnum]
     attr_reader :fd
@@ -44,7 +42,7 @@ module INotify
     def initialize
       @fd = Native.inotify_init
       @watchers = {}
-      return super(@fd) unless @fd < 0
+      return unless @fd < 0
 
       raise SystemCallError.new(
         "Failed to initialize inotify" +
@@ -57,6 +55,22 @@ module INotify
         FFI.errno)
     end
 
+    # Returns a Ruby IO object wrapping the underlying file descriptor.
+    # Since this file descriptor is fully functional (except under JRuby),
+    # this IO object can be used in any way a Ruby-created IO object can.
+    # This includes passing it to functions like `#select`.
+    #
+    # **This is not supported under JRuby**.
+    # JRuby currently doesn't use native file descriptors for the IO object,
+    # so we can't use this file descriptor as a stand-in.
+    #
+    # @return [IO] An IO object wrapping the file descriptor
+    # @raise [NotImplementedError] if this is being called in JRuby
+    def to_io
+      raise NotImplementedError.new("INotify::Notifier#to_io is not supported under JRuby") if RUBY_PLATFORM =~ /java/
+      IO.new(@fd)
+    end
+
     # Watches a file or directory for changes,
     # calling the callback when there are.
     # This is only activated once \{#process} or \{#run} is called.
@@ -153,7 +167,7 @@ module INotify
     # @see #process
     def run
       @stop = false
-      process until @stop || closed?
+      process until @stop
     end
 
     # Stop watching for filesystem events.
@@ -204,5 +218,26 @@ module INotify
       cookies.each {|c, evs| evs.each {|ev| ev.related.replace(evs - [ev]).freeze}}
       events
     end
+
+    private
+
+    # Same as IO#readpartial, or as close as we need.
+    def readpartial(size)
+      buffer = FFI::MemoryPointer.new(:char, size)
+      size_read = Native.read(fd, buffer, size)
+      return buffer.read_string(size_read) if size_read >= 0
+
+      raise SystemCallError.new("Error reading inotify events" +
+        case FFI.errno
+        when Errno::EAGAIN::Errno; ": no data available for non-blocking I/O"
+        when Errno::EBADF::Errno; ": invalid or closed file descriptor"
+        when Errno::EFAULT::Errno; ": invalid buffer"
+        when Errno::EINVAL::Errno; ": invalid file descriptor"
+        when Errno::EIO::Errno; ": I/O error"
+        when Errno::EISDIR::Errno; ": file descriptor is a directory"
+        else; ""
+        end,
+        FFI.errno)
+    end
   end
 end

data/rb-inotify.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{rb-inotify}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Weizenbaum"]
-  s.date = %q{2009-11-29}
+  s.date = %q{2009-12-26}
   s.description = %q{A Ruby wrapper for Linux's inotify, using FFI}
   s.email = %q{nex342@gmail.com}
   s.extra_rdoc_files = [
@@ -52,3 +52,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<yard>, [">= 0.4.0"])
   end
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rb-inotify
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Nathan Weizenbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-29 00:00:00 -08:00
+date: 2009-12-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency