ruby-inotify 1.0.0

data/.gitignore

@@ -0,0 +1 @@
+.project

data/COPYING

@@ -0,0 +1 @@
+You may use this extension under the same terms as ruby itself.

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ruby-inotify.gemspec
+gemspec

data/README.md

@@ -0,0 +1,6 @@
+Ruby Inotify
+============
+
+Linux specific, since inotify is as well. Now uses ffi!
+
+Look in `examples/` for a simple example.

data/Rakefile

@@ -0,0 +1,83 @@
+# Rakefile for project management (from chris2) -*-ruby-*-
+
+Project = 'project-template'
+
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+desc "Build and test"
+task :default => [:build, :test]
+
+desc "Do predistribution stuff"
+task :predist => [:chmod, :changelog, :doc]
+
+desc "Build"
+task :build do
+#ruby "ext/extconf.rb"
+#system "make"
+end
+
+task :test => :build
+
+desc "Run all the tests"
+Rake::TestTask.new do |t|
+  t.libs << "tests"
+  t.libs << "lib"
+  t.test_files = FileList['tests/test_*.rb']
+  t.verbose = true
+end
+
+desc "Make an archive as .tar.gz"
+task :dist => :test do
+  system "export DARCS_REPO=#{File.expand_path "."}; " +
+         "darcs dist -d #{Project}#{get_darcs_tree_version}"
+end
+
+desc "Make binaries executable"
+task :chmod do
+  Dir["bin/*"].each { |binary| File.chmod(0775, binary) }
+end
+
+desc "Generate a ChangeLog"
+task :changelog do
+  system "darcs changes --repo=#{ENV["DARCS_REPO"] || "."} >ChangeLog"
+end
+
+desc "Generate RDoc documentation"
+Rake::RDocTask.new(:doc) do |rdoc|
+  rdoc.options << '--line-numbers --inline-source'
+  rdoc.rdoc_dir = "rdoc"
+rdoc.rdoc_files.include("lib/**/*.rb", "lib/*.rb")
+end
+
+desc "Clean to distribution pristine"
+task :distclean do
+#system 'make distclean'
+end
+
+
+# Helper to retrieve the "revision number" of the darcs tree.
+def get_darcs_tree_version
+  return "" unless File.directory? "_darcs"
+
+  changes = `darcs changes`
+  count = 0
+  tag = "0.0"
+  
+  changes.each("\n\n") { |change|
+    head, title, desc = change.split("\n", 3)
+    
+    if title =~ /^ \*/
+      # Normal change.
+      count += 1
+    elsif title =~ /tagged (.*)/
+      # Tag. We look for these.
+      tag = $1
+      break
+    else
+      warn "Unparsable change: #{change}"
+    end
+  }
+
+  "-" + tag + "." + count.to_s
+end

data/examples/watcher.rb

@@ -0,0 +1,30 @@
+#!usr/bin/ruby
+
+require 'inotify'
+require 'find'
+
+i = Inotify.new
+
+t = Thread.new do
+	i.each_event do |ev|
+		p ev.name
+		p ev.mask
+	end
+end
+
+raise("Specify a directory") if !ARGV[0]
+
+Find.find(ARGV[0]) do |e| 
+	if ['.svn', 'CVS', 'RCS'].include? File.basename(e) or !File.directory? e
+		Find.prune
+	else
+		begin
+			puts "Adding #{e}"
+			i.add_watch(e, Inotify::CREATE | Inotify::DELETE | Inotify::MOVE)
+		rescue
+			puts "Skipping #{e}: #{$!}"
+		end
+	end
+end
+
+t.join

data/lib/inotify.rb

@@ -0,0 +1 @@
+require 'inotify/inotify_native'

data/lib/inotify/inotify_native.rb

@@ -0,0 +1,103 @@
+require 'rubygems'
+require 'ffi'
+
+  class Inotify
+
+    extend FFI::Library
+    ffi_lib FFI::Platform::LIBC
+    
+    MAX_NAME_SIZE = 4096
+    
+    ACCESS        = 0x00000001
+    MODIFY        = 0x00000002
+    ATTRIB        = 0x00000004
+    CLOSE_WRITE   = 0x00000008
+    CLOSE_NOWRITE = 0x00000010
+    OPEN          = 0x00000020
+    MOVED_FROM    = 0x00000040
+    MOVED_TO      = 0x00000080
+    CREATE        = 0x00000100
+    DELETE        = 0x00000200
+    DELETE_SELF   = 0x00000400
+    MOVE_SELF     = 0x00000800
+    # Events sent by the kernel.
+    UNMOUNT       = 0x00002000
+    Q_OVERFLOW    = 0x00004000
+    IGNORED       = 0x00008000
+    ONLYDIR       = 0x01000000
+    DONT_FOLLOW   = 0x02000000
+    MASK_ADD      = 0x20000000
+    # special flags
+    ISDIR         = 0x40000000
+    ONESHOT       = 0x80000000
+    # helper events
+    CLOSE      = (CLOSE_WRITE | CLOSE_NOWRITE)
+    MOVE       = (MOVED_FROM | MOVED_TO)
+    #All of the events
+    ALL_EVENTS = (ACCESS | MODIFY | ATTRIB | CLOSE_WRITE | \
+       CLOSE_NOWRITE | OPEN | MOVED_FROM | \
+       MOVED_TO | CREATE | DELETE | DELETE_SELF | MOVE_SELF)
+
+    attach_function :inotify_init, [], :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
+    attach_function :inotify_close, :close, [:int], :int
+    def initialize
+      @fd = self.inotify_init
+      @io = FFI::IO.for_fd(@fd)
+    end
+    def add_watch(string, uint32)
+      self.inotify_add_watch(@fd, string, uint32)
+    end
+    def rm_watch(uint32)
+      self.inotify_rm_watch(@fd, uint32)
+    end
+    def close
+      self.inotify_close(@fd)
+    end
+    def each_event
+      loop do
+        ready = IO.select([@io], nil, nil, nil)
+        yield self.read_event
+      end
+    end
+    def read_event
+      buf = FFI::Buffer.alloc_out(EventStruct.size + MAX_NAME_SIZE, 1, false)
+      ev = EventStruct.new(buf)
+      n = self.read(@fd, buf, buf.total)
+      Event.new(ev, buf)
+    end
+      
+    class EventStruct < FFI::Struct
+      layout(
+        :wd, :int,
+        :mask, :uint32,
+        :cookie, :uint32,
+        :len, :uint32)
+    end
+
+    class Event
+      def initialize(struct, buf)
+        @struct, @buf = struct, buf
+      end
+
+      define_method(:wd) { @struct[:wd] }
+      define_method(:mask) { @struct[:mask] }
+      define_method(:cookie) { @struct[:cookie] }
+      define_method(:len) { @struct[:len] }
+      def name
+        @struct[:len] > 0 ? @buf.get_string(16, @struct[:len]) : ''
+      end
+
+      def inspect
+        "<%s name=%s mask=%s wd=%s>" % [
+          self.class,
+          self.name,
+          self.mask,
+          self.wd
+        ]
+      end
+    end
+
+end

data/lib/inotify/version.rb

@@ -0,0 +1,3 @@
+module Inotify
+  VERSION = "1.0.0"
+end

data/ruby-inotify.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "inotify/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby-inotify"
+  s.version     = Inotify::VERSION
+  s.authors     = ["Aria Stewart", "Jon Raiford"]
+  s.email       = ["aredridel@nbtsc.org", "jon@raiford.org"]
+  s.homepage    = "http://dinhe.net/~aredridel/projects/ruby/ruby-inotify"
+  s.summary     = %q{Interface to Linux's Inotify (Ruby FFI version)}
+  s.description = %q{An interface to Linux's inotify, for watching updates to directories.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "ffi"
+end

data/tests/test_1.rb

@@ -0,0 +1,37 @@
+require 'test/unit'
+require 'inotify'
+
+class Test1 < Test::Unit::TestCase
+	def setup
+		@inotify = Inotify.new
+	end
+	def test1
+		assert_equal(Inotify, @inotify.class)
+	end
+	def test2
+		assert(@inotify.add_watch("/tmp", Inotify::CREATE))
+	end
+	def test3
+		wd = @inotify.add_watch("/tmp", Inotify::CREATE)
+		assert_equal(Fixnum, wd.class)
+		assert(@inotify.rm_watch(wd))
+	end
+	def test4
+		@inotify.add_watch("/tmp", Inotify::CREATE)
+		begin 
+			File.open(File.join("/tmp", "ruby-inotify-test-4"), 'w')
+			@inotify.each_event do |ev|
+				assert_equal(ev.class, Inotify::Event)
+				assert_equal(ev.inspect, "<Inotify::Event name=ruby-inotify-test-4 mask=256 wd=1>")
+				assert_equal(ev.name, "ruby-inotify-test-4")
+				assert_equal(ev.mask, Inotify::CREATE)
+				break
+			end
+		ensure
+			File.unlink(File.join("/tmp", "ruby-inotify-test-4"))
+		end
+	end
+	def teardown
+		@inotify.close
+	end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-inotify
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Aria Stewart
+- Jon Raiford
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: An interface to Linux's inotify, for watching updates to directories.
+email: 
+- aredridel@nbtsc.org
+- jon@raiford.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- COPYING
+- Gemfile
+- README.md
+- Rakefile
+- examples/watcher.rb
+- lib/inotify.rb
+- lib/inotify/inotify_native.rb
+- lib/inotify/version.rb
+- ruby-inotify.gemspec
+- tests/test_1.rb
+homepage: http://dinhe.net/~aredridel/projects/ruby/ruby-inotify
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Interface to Linux's Inotify (Ruby FFI version)
+test_files: []
+