ruby-fsevent 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+ext/Makefile
+ext/*.o
+ext/*.bundle
+ext/mkmf.log
+pkg/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Sandro Turriate
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+ruby-fsevent
+============
+
+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.
+
+I got tired of reinstalling RubyCocoa every time I installed a new version of
+Ruby just to rspactor working. Watchr has changed the game by allowing generic
+file handlers but I started waiting 4-5 seconds for an event to fire. With a
+generic, native interface to the FSEvent API we can harness the speed of
+FSEvents without depending on RubyCocoa.
+
+Demo
+----
+
+1. cd ext/
+2. ruby extconf.rb
+3. make
+4. cd ../
+5. ruby examples/print_changes.rb
+6. Notice that the examples directory and the /tmp directories are being monitored
+7. Make a change to either directory and watch the callback fire
+
+TODO
+----
+
+* Add ability to register a block as a callback handler, on_change would then
+call the block. This removes the need for subclassing.
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2009 Sandro Turriate. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruby-fsevent"
+    gem.summary = %Q{A native extension exposing the OS X FSEvent API.}
+    gem.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.
+    }
+    gem.email = "sandro.turriate@gmail.com"
+    gem.homepage = "http://github.com/sandro/ruby-fsevent"
+    gem.authors = ["Sandro Turriate"]
+    gem.add_development_dependency "rspec"
+    gem.extensions << 'ext/extconf.rb'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-fsevent #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/print_changes.rb

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

data/ext/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+with_ldflags("-framework CoreServices") do
+  create_makefile("fsevent")
+end

data/ext/fsevent.c

@@ -0,0 +1,124 @@
+#include <ruby.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <signal.h>
+#include <CoreServices/CoreServices.h>
+
+/*
+ * Thanks to fswatch.c for providing a starting point
+ * http://github.com/alandipert/fswatch
+*/
+
+
+void callback(
+  ConstFSEventStreamRef streamRef,
+  void *context,
+  size_t numEvents,
+  void *eventPaths,
+  const FSEventStreamEventFlags eventFlags[],
+  const FSEventStreamEventId eventIds[]
+) {
+  VALUE self = (VALUE)context;
+  int i;
+  char **paths = eventPaths;
+  VALUE rb_paths[numEvents];
+  for (i = 0; i < numEvents; i++) {
+    VALUE name = rb_str_new2(paths[i]);
+    rb_paths[i] = name;
+  }
+  rb_funcall(self, rb_intern("on_change"), 1, rb_ary_new4(numEvents, rb_paths));
+}
+
+void watch_directory(VALUE self) {
+  VALUE rb_registered_directories = rb_iv_get(self, "@registered_directories");
+  int i, dir_size;
+  dir_size = RARRAY(rb_registered_directories)->len;
+
+  VALUE *rb_dir_names = RARRAY(rb_registered_directories)->ptr;
+  CFStringRef dir_names[dir_size];
+  for (i = 0; i < dir_size; i++) {
+    dir_names[i] = CFStringCreateWithCString(NULL, (char *)RSTRING(rb_dir_names[i])->ptr, kCFStringEncodingUTF8);
+  }
+
+  CFArrayRef pathsToWatch = CFArrayCreate(NULL, (const void **)&dir_names, dir_size, NULL);
+
+
+  VALUE rb_latency = rb_iv_get(self, "@latency");
+  CFAbsoluteTime latency = NUM2DBL(rb_latency);
+
+  FSEventStreamContext context;
+  context.version = 0;
+  context.info = (VALUE *)self;
+  context.retain = NULL;
+  context.release = NULL;
+  context.copyDescription = NULL;
+
+  FSEventStreamRef stream;
+  stream = FSEventStreamCreate(NULL,
+    &callback,
+    &context,
+    pathsToWatch,
+    kFSEventStreamEventIdSinceNow,
+    latency,
+    kFSEventStreamCreateFlagNone
+  );
+
+  FSEventStreamScheduleWithRunLoop(stream, CFRunLoopGetCurrent(), kCFRunLoopDefaultMode);
+  FSEventStreamStart(stream);
+  CFRunLoopRun();
+}
+
+static VALUE t_init(VALUE self) {
+  rb_iv_set(self, "@latency", rb_float_new(0.5));
+  return self;
+}
+
+static VALUE t_on_change(VALUE self, VALUE original_directory_name) {
+  return Qnil;
+}
+
+static VALUE t_watch_directories(VALUE self, VALUE directories) {
+  if (TYPE(directories) == T_ARRAY) {
+    rb_iv_set(self, "@registered_directories", rb_ary_new4(RARRAY(directories)->len, RARRAY(directories)->ptr));
+  }
+  else {
+    rb_iv_set(self, "@registered_directories", rb_ary_new3(1, directories));
+  }
+  VALUE rb_registered_directories = rb_iv_get(self, "@registered_directories");
+  return rb_registered_directories;
+}
+
+int pid, status;
+static VALUE t_run(VALUE self) {
+  VALUE rb_registered_directories = rb_iv_get(self, "@registered_directories");
+  Check_Type(rb_registered_directories, T_ARRAY);
+  if (pid = fork()) {
+    wait(&status);
+  }
+  else {
+    watch_directory(self);
+  }
+  return self;
+}
+
+void kill_watcher() {
+  if (pid) {
+    kill(pid, SIGKILL);
+    printf("\n");
+  }
+}
+
+VALUE fsevent_class;
+void Init_fsevent() {
+  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_attr(fsevent_class, "latency", 1, 1);
+  rb_define_attr(fsevent_class, "registered_directories", 1, 1);
+
+  atexit(kill_watcher);
+}

data/ruby-fsevent.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-fsevent}
+  s.version = "0.1.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.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.
+    }
+  s.email = %q{sandro.turriate@gmail.com}
+  s.extensions = ["ext/extconf.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "examples/print_changes.rb",
+     "ext/extconf.rb",
+     "ext/fsevent.c",
+     "ruby-fsevent.gemspec",
+     "spec/fsevent_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.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/spec_helper.rb",
+     "examples/print_changes.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/spec/fsevent_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe FSEvent do
+  describe "accessors" do
+    it "reads and writes registered_directories" do
+      subject.registered_directories = %w(one two)
+      subject.registered_directories.should == %w(one two)
+    end
+
+    it "reads and writes latency" do
+      subject.latency = 1.5
+      subject.latency.should == 1.5
+    end
+  end
+
+  describe "#watch_directories" do
+    it "register a single directory" do
+      subject.watch_directories '/Users'
+      subject.registered_directories.should == ['/Users']
+    end
+    it "registers an array of directories" do
+      subject.watch_directories %w(/Users /tmp)
+      subject.registered_directories.should == %w(/Users /tmp)
+    end
+  end
+
+  describe "API" do
+    it { should respond_to(:on_change) }
+    it { should respond_to(:run) }
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-fsevent
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sandro Turriate
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    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
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- examples/print_changes.rb
+- ext/extconf.rb
+- ext/fsevent.c
+- ruby-fsevent.gemspec
+- spec/fsevent_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/sandro/ruby-fsevent
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A native extension exposing the OS X FSEvent API.
+test_files: 
+- spec/fsevent_spec.rb
+- spec/spec_helper.rb
+- examples/print_changes.rb