filewatch 0.0.3 → 0.1.1

data/lib/{inotify → filewatch/inotify}/emhandler.rb

@@ -1,7 +1,7 @@
-require "inotify/fd"
-require "inotify/namespace"
+require "filewatch/inotify/fd"
+require "filewatch/namespace"
 
-class Inotify::EMHandler < EventMachine::Connection
+class FileWatch::Inotify::EMHandler < EventMachine::Connection
   def initialize(inotify_fd, callback=nil)
     @inotify = inotify_fd
     @callback = callback

data/lib/{inotify → filewatch/inotify}/event.rb

@@ -1,8 +1,8 @@
-require "inotify/namespace"
-require "inotify/fd"
+require "filewatch/namespace"
+require "filewatch/inotify/fd"
 require "ffi"
 
-class Inotify::Event < FFI::Struct
+class FileWatch::Inotify::Event < FFI::Struct
   layout :wd, :int,
          :mask, :uint32,
          :cookie, :uint32,
@@ -21,16 +21,17 @@ class Inotify::Event < FFI::Struct
   end
 
   def self.from_stringpipeio(io)
-    # This fails in ruby 1.9.2 because it literally calls read(2) with
-    # 'self.size' as the byte size to read. This causes EINVAL 
-    # from inotify, documented thusly in inotify(7):
+    # I implemented a 'string pipe' IO because normal "buffered" IO reads
+    # on inotify fds fails in ruby 1.9.2 because it literally calls read(2)
+    # with 'self.size' as the byte size to read. This causes EINVAL from
+    # inotify, documented thusly in inotify(7):
     # 
     # """ The  behavior  when  the buffer given to read(2) is too small to
     #     return information about the next event depends on the  kernel
     #     version:  in  kernels  before  2.6.21, read(2) returns 0; since
     #     kernel 2.6.21, read(2) fails with the error EINVAL. """
     #
-    # Working around this will require implementing our own read buffering
+    # Working around this requires implementing our own read buffering
     # unless comeone clues me in on how to make ruby 1.9.2 read larger
     # blocks and actually do the nice buffered IO we've all come to
     # know and love.
@@ -66,7 +67,7 @@ class Inotify::Event < FFI::Struct
   end
 
   def actions
-    Inotify::FD::WATCH_BITS.reject do |key, bitmask| 
+    ::FileWatch::Inotify::FD::WATCH_BITS.reject do |key, bitmask| 
       self[:mask] & bitmask == 0 
     end.keys
   end

data/lib/{inotify → filewatch/inotify}/fd.rb

@@ -1,10 +1,10 @@
 require "rubygems"
 require "ffi"
-require "inotify/event"
-require "inotify/namespace"
-require "inotify/stringpipeio"
+require "filewatch/inotify/event"
+require "filewatch/namespace"
+require "filewatch/stringpipeio"
 
-class Inotify::FD
+class FileWatch::Inotify::FD
   include Enumerable
 
   module CInotify
@@ -47,13 +47,18 @@ class Inotify::FD
 
   attr_reader :fd
 
-  # Create a new Inotify::FD instance.
+  public
+  def self.can_watch?(filestat)
+    # TODO(sissel): implement.
+  end # def self.can_watch?
+
+  # Create a new FileWatch::Inotify::FD instance.
   # This is the main interface you want to use for watching
   # files, directories, etc.
   public
   def initialize
     @watches = {}
-    @buffer = Inotify::StringPipeIO.new
+    @buffer = FileWatch::StringPipeIO.new
 
     @fd = CInotify.inotify_init1(INOTIFY_NONBLOCK)
 
@@ -98,7 +103,7 @@ class Inotify::FD
   #  the linux man-pages project. http://www.kernel.org/doc/man-pages/ )
   #
   # Example:
-  #   fd = Inotify::FD.new
+  #   fd = FileWatch::Inotify::FD.new
   #   fd.watch("/tmp", :create, :delete)
   #   fd.watch("/var/log/messages", :modify)
   public
@@ -138,7 +143,7 @@ class Inotify::FD
     # TODO(sissel): Block with select.
     # Will have to use FFI to call select, too.
 
-    # We ahve to call libc's read(2) because JRuby/Java can't trivially
+    # We have to call libc's read(2) because JRuby/Java can't trivially
     # be told about existing file descriptors.
     loop do
       bytes = CInotify.read(@fd, @jruby_read_buffer, 4096)
@@ -180,22 +185,24 @@ class Inotify::FD
   # If timeout is not given, this call blocks.
   # If a timeout occurs and no event was read, nil is returned.
   #
-  # Returns nil on timeout or an Inotify::Event on success.
-  public
+  # Returns nil on timeout or an FileWatch::Inotify::Event on success.
+  private
   def get(timeout_not_supported_yet=nil)
     # This big 'loop' is to support pop { |event| ... } shipping each available event.
     # It's not very rubyish (we should probably use Enumerable and such.
     if java?
-      jruby_read(timeout)
+      #jruby_read(timeout)
+      jruby_read
     else
-      normal_read(timeout)
+      #normal_read(timeout)
+      normal_read
     end
 
     # Recover any previous partial event.
     if @partial
       event = @partial.from_stringpipeio(@buffer)
     else
-      event = Inotify::Event.from_stringpipeio(@buffer)
+      event = FileWatch::Inotify::Event.from_stringpipeio(@buffer)
       return nil if event == nil
     end
 
@@ -210,7 +217,7 @@ class Inotify::FD
 
   # For Enumerable support
   # 
-  # Yields one Inotify::Event per iteration. If there are no more events
+  # Yields one FileWatch::Inotify::Event per iteration. If there are no more events
   # at the this time, then this method will end.
   public
   def each(&block)
@@ -237,8 +244,8 @@ class Inotify::FD
   public
   def subscribe(handler=nil, &block)
     if defined?(EventMachine) && EventMachine.reactor_running?
-      require "inotify/emhandler"
-      handler = Inotify::EMHandler if handler == nil
+      require "filewatch/inotify/emhandler"
+      handler = FileWatch::Inotify::EMHandler if handler == nil
       EventMachine::watch(@fd, handler, self, block)
     else
       loop do
@@ -254,4 +261,4 @@ class Inotify::FD
       end
     end
   end
-end # class Inotify::FD
+end # class FileWatch::Inotify::FD

data/lib/filewatch/namespace.rb

@@ -0,0 +1,3 @@
+module FileWatch
+  module Inotify ; end
+end

data/lib/{inotify → filewatch}/stringpipeio.rb

@@ -1,7 +1,7 @@
 require "rubygems"
-require "inotify/namespace"
+require "filewatch/namespace"
 
-class Inotify::StringPipeIO
+class FileWatch::StringPipeIO
   def initialize
     @buffer = ""
   end # def initialize

data/lib/filewatch/watch.rb

@@ -0,0 +1,25 @@
+require "filewatch/inotify/fd"
+require "filewatch/namespace"
+
+class FileWatch::Watch
+  # This class exists to wrap inotify, kqueue, periodic polling, etc,
+  # to provide you with a way to watch files and directories.
+  #
+  # For now, it only supports inotify.
+  def initialize
+    @inotify = FileWatch::Inotify::FD.new
+  end
+
+  public
+  def watch(path, *what_to_watch)
+    @inotify.watch(path, *what_to_watch)
+  end # def watch
+
+  def subscribe(handler=nil, &block)
+    @inotify.subscribe(handler, &block)
+  end
+
+  def each(&block)
+    @inotify.each(&block)
+  end # def each
+end # class FileWatch::Watch

metadata

@@ -1,21 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: filewatch
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors: 
-- Jordan Sissel
+  - Jordan Sissel
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 -08:00
+date: 2011-03-18 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -28,39 +23,34 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/inotify/namespace.rb
-- lib/inotify/emhandler.rb
-- lib/inotify/stringpipeio.rb
-- lib/inotify/fd.rb
-- lib/inotify/event.rb
+  - lib/filewatch/watch.rb
+  - lib/filewatch/namespace.rb
+  - lib/filewatch/stringpipeio.rb
+  - lib/filewatch/inotify/emhandler.rb
+  - lib/filewatch/inotify/fd.rb
+  - lib/filewatch/inotify/event.rb
 has_rdoc: true
-homepage: https://github.com/jordansissel/ruby-inotify-ffi
+homepage: https://github.com/jordansissel/ruby-filewatch
 licenses: []
 
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
-- lib
-- lib
+  - lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 requirements: []
 
 rubyforge_project: 

data/lib/inotify/namespace.rb

@@ -1,2 +0,0 @@
-module Inotify
-end