ruby-fsevent 0.1.0 → 0.2.0

data/History.md

@@ -0,0 +1,21 @@
+History
+=======
+
+0.2.0 2009-10-23
+----------------
+
+**enhancements**
+
+- No More Forking! The event loop used to fork to ensure signal handlers would be observed.
+  A custom signal handling solution has replaced the need to fork.
+- The Event listener can now be stopped and restarted using FSEvent#stop and FSEvent#restart
+
+**deprecations**
+
+- FSEvent#run now FSEvent#start
+
+
+0.1.0 2009-10-15
+----------------
+- Listen for events using OSX's FSEvents API
+

data/Rakefile

@@ -12,7 +12,8 @@ begin
     gem.email = "sandro.turriate@gmail.com"
     gem.homepage = "http://github.com/sandro/ruby-fsevent"
     gem.authors = ["Sandro Turriate"]
-    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "rspec", '>=1.2.8'
+    gem.require_paths = %w(lib ext)
     gem.extensions << 'ext/extconf.rb'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
@@ -37,6 +38,10 @@ task :spec => :check_dependencies
 
 task :default => :spec
 
+task :make do
+  system "cd ext && ruby extconf.rb && make"
+end
+
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   if File.exist?('VERSION')

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/examples/print_changes.rb

@@ -1,11 +1,13 @@
-require File.dirname(__FILE__) + '/../ext/fsevent'
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../ext')
+require 'fsevent'
 
 class PrintChange < FSEvent
   def on_change(directories)
     puts "Detected change in: #{directories.inspect}"
   end
 
-  def run
+  def start
     puts "watching #{registered_directories.join(", ")} for changes"
     super
   end
@@ -14,4 +16,4 @@ end
 printer = PrintChange.new
 printer.latency = 0.2
 printer.watch_directories %W(#{Dir.pwd} /tmp)
-printer.run
+printer.start

data/examples/restart.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../ext')
+require 'fsevent'
+
+class Restart < FSEvent
+  def on_change(directories)
+    puts "Detected change in: #{directories.inspect}"
+    unless @restarted
+      self.stop
+      @restarted = true
+      self.watch_directories "#{Dir.pwd}/spec"
+      self.start
+    end
+  end
+
+  def start
+    puts "watching #{registered_directories.join(", ")} for changes"
+    super
+  end
+end
+
+Signal.trap("INT"){ puts "\nCustom INT handler called."; exit }
+
+restarter = Restart.new
+restarter.watch_directories "#{Dir.pwd}/examples"
+restarter.start

data/ext/fsevent.c

@@ -10,6 +10,8 @@
  * http://github.com/alandipert/fswatch
 */
 
+FSEventStreamRef stream;
+VALUE fsevent_class;
 
 void callback(
   ConstFSEventStreamRef streamRef,
@@ -54,7 +56,6 @@ void watch_directory(VALUE self) {
   context.release = NULL;
   context.copyDescription = NULL;
 
-  FSEventStreamRef stream;
   stream = FSEventStreamCreate(NULL,
     &callback,
     &context,
@@ -89,36 +90,58 @@ static VALUE t_watch_directories(VALUE self, VALUE directories) {
   return rb_registered_directories;
 }
 
-int pid, status;
-static VALUE t_run(VALUE self) {
+static VALUE t_start(VALUE self) {
   VALUE rb_registered_directories = rb_iv_get(self, "@registered_directories");
   Check_Type(rb_registered_directories, T_ARRAY);
-  if (pid = fork()) {
-    wait(&status);
+
+  watch_directory(self);
+  return self;
+}
+
+static VALUE t_stop(VALUE self) {
+  FSEventStreamStop(stream);
+  FSEventStreamInvalidate(stream);
+  FSEventStreamRelease(stream);
+  CFRunLoopStop(CFRunLoopGetCurrent());
+  return self;
+}
+
+static VALUE t_restart(VALUE self) {
+  t_stop(self);
+  watch_directory(self);
+  return self;
+}
+
+void delegate_signal_to_ruby(int signal) {
+  VALUE signal_mod = rb_const_get(rb_cObject, rb_intern("Signal"));
+  if (rb_funcall(signal_mod, rb_intern("handles?"), 1, INT2FIX(signal)) == Qtrue) {
+    rb_funcall(signal_mod, rb_intern("handle"), 1, INT2FIX(signal));
   }
   else {
-    watch_directory(self);
+    ruby_default_signal(signal);
   }
-  return self;
 }
 
-void kill_watcher() {
-  if (pid) {
-    kill(pid, SIGKILL);
-    printf("\n");
+void register_signal_delegation() {
+  int i;
+  for(i = 0; i < 33; i++) { // Signal.list.values.size yields 32 different signals
+    (void) signal(i, delegate_signal_to_ruby);
   }
 }
 
-VALUE fsevent_class;
 void Init_fsevent() {
+  rb_require("fsevent/signal_ext");
+
   fsevent_class = rb_define_class("FSEvent", rb_cObject);
   rb_define_method(fsevent_class, "initialize", t_init, 0);
   rb_define_method(fsevent_class, "on_change", t_on_change, 1);
   rb_define_method(fsevent_class, "watch_directories", t_watch_directories, 1);
-  rb_define_method(fsevent_class, "run", t_run, 0);
+  rb_define_method(fsevent_class, "start", t_start, 0);
+  rb_define_method(fsevent_class, "stop", t_stop, 0);
+  rb_define_method(fsevent_class, "restart", t_restart, 0);
 
   rb_define_attr(fsevent_class, "latency", 1, 1);
   rb_define_attr(fsevent_class, "registered_directories", 1, 1);
 
-  atexit(kill_watcher);
+  register_signal_delegation();
 }

data/lib/fsevent/signal_ext.rb

@@ -0,0 +1,48 @@
+module Signal
+  class << self
+    alias trap_without_custom_handlers trap
+
+    def handlers
+      @handlers ||= {}
+    end
+
+    def trap(signal, &block)
+      handlers[int_for_signal(signal)] = block
+    end
+
+    def handles?(signal)
+      handlers.has_key? int_for_signal(signal)
+    end
+
+    def handle(signal)
+      if handler = handlers[int_for_signal(signal)]
+        handler.call
+      end
+    end
+
+    protected
+
+    def int_for_signal(signal)
+      error_msg = "Check Signal.list for a list of valid signals."
+      case signal
+      when Numeric
+        list.values.include?(signal) ? signal : raise(ArgumentError, "Invalid signal number. #{error_msg}")
+      when String
+        signal = signal.upcase
+        list.keys.include?(signal) ? list[signal] : raise(ArgumentError, "Invalid signal identifier. #{error_msg}")
+      else
+        raise ArgumentError, error_msg
+      end
+    end
+  end
+end
+
+module Kernel
+  def self.trap(signal, &block)
+    Signal.trap(signal, &block)
+  end
+end
+
+def trap(signal, &block)
+  Signal.trap(signal, &block)
+end

data/ruby-fsevent.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-fsevent}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sandro Turriate"]
-  s.date = %q{2009-10-15}
+  s.date = %q{2009-10-24}
   s.description = %q{
     A native extension exposing the OS X FSEvent API. Register directories you want to watch and a callback will fire whenever a change occurs in the registered directories.
     }
@@ -21,26 +21,32 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".gitignore",
+     "History.md",
      "LICENSE",
      "README.md",
      "Rakefile",
      "VERSION",
      "examples/print_changes.rb",
+     "examples/restart.rb",
      "ext/extconf.rb",
      "ext/fsevent.c",
+     "lib/fsevent/signal_ext.rb",
      "ruby-fsevent.gemspec",
      "spec/fsevent_spec.rb",
+     "spec/signal_ext_spec.rb",
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/sandro/ruby-fsevent}
   s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
+  s.require_paths = ["lib", "ext"]
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{A native extension exposing the OS X FSEvent API.}
   s.test_files = [
     "spec/fsevent_spec.rb",
+     "spec/signal_ext_spec.rb",
      "spec/spec_helper.rb",
-     "examples/print_changes.rb"
+     "examples/print_changes.rb",
+     "examples/restart.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -48,11 +54,11 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.8"])
     else
-      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.8"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.8"])
   end
 end

data/spec/fsevent_spec.rb

@@ -26,6 +26,8 @@ describe FSEvent do
 
   describe "API" do
     it { should respond_to(:on_change) }
-    it { should respond_to(:run) }
+    it { should respond_to(:start) }
+    it { should respond_to(:stop) }
+    it { should respond_to(:restart) }
   end
 end

data/spec/signal_ext_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Signal do
+  describe "#trap" do
+    it "captures the block argument as the signal handler" do
+      Signal.trap(2) { :int }
+      Signal.handlers[2].call.should == :int
+    end
+
+    it "converts the signal name into an integer when storing the handler" do
+      Signal.trap('INT')
+      Signal.handlers.should include(Signal.list['INT'])
+    end
+
+    it "allows lowercase signal names" do
+      Signal.trap('int')
+      Signal.handlers.should include(Signal.list['INT'])
+    end
+
+    it "does not allow unknown signal names" do
+      expect {
+        Signal.trap('interrupt')
+      }.to raise_error(ArgumentError)
+    end
+
+    it "does not allow unknown signal numbers" do
+      expect {
+        Signal.trap(12111211221)
+      }.to raise_error(ArgumentError)
+    end
+
+    it "does not allow unknown data types" do
+      expect {
+        Signal.trap(['int'])
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#handles?" do
+    it "returns true when a handler is registered for the signal" do
+      Signal.trap('INT')
+      Signal.handles?('INT').should be_true
+    end
+
+    it "returns false when no handler was registered for the signal" do
+      Signal.handles?('EXIT').should be_false
+    end
+  end
+
+  describe "#handle" do
+    it "does not raise when trying to call a non-existant handler" do
+      expect do
+        Signal.handle('EXIT')
+      end.should_not raise_error
+    end
+
+    it "calls the handler" do
+      Signal.trap('INT') { :int }
+      Signal.handle('INT').should == :int
+    end
+  end
+end
+
+describe Kernel do
+  it "delegates .trap to Signal" do
+    Signal.should_receive(:trap).with('INT')
+    Kernel.trap('INT')
+  end
+end
+
+context "global" do
+  it "delegates .trap to Signal" do
+    Signal.should_receive(:trap).with('INT')
+    trap('INT')
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'ext'))
+$:.unshift(File.dirname(__FILE__) + '/../ext')
+$:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'fsevent'
+require 'fsevent/signal_ext'
 require 'spec/autorun'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-fsevent
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sandro Turriate
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-15 00:00:00 -04:00
+date: 2009-10-24 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.2.8
     version: 
 description: "\n    A native extension exposing the OS X FSEvent API. Register directories you want to watch and a callback will fire whenever a change occurs in the registered directories.\n    "
 email: sandro.turriate@gmail.com
@@ -33,15 +33,19 @@ extra_rdoc_files:
 - README.md
 files: 
 - .gitignore
+- History.md
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
 - examples/print_changes.rb
+- examples/restart.rb
 - ext/extconf.rb
 - ext/fsevent.c
+- lib/fsevent/signal_ext.rb
 - ruby-fsevent.gemspec
 - spec/fsevent_spec.rb
+- spec/signal_ext_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/sandro/ruby-fsevent
@@ -52,6 +56,7 @@ rdoc_options:
 - --charset=UTF-8
 require_paths: 
 - lib
+- ext
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
@@ -73,5 +78,7 @@ specification_version: 3
 summary: A native extension exposing the OS X FSEvent API.
 test_files: 
 - spec/fsevent_spec.rb
+- spec/signal_ext_spec.rb
 - spec/spec_helper.rb
 - examples/print_changes.rb
+- examples/restart.rb