autotest-inotify 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Eric A. Wollesen
+ 
+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.rdoc

@@ -0,0 +1,63 @@
+= Autotest Inotify
+
+* Author: Eric A. Wollesen (http://kill-0.com)
+* Homepage: http://kill-0.com/projects/autotest-inotify
+
+== DESCRIPTION:
+
+Autotest relies on filesystem polling to detect modifications in source code
+files. In other words: The filesytem is constantly being traversed which
+causes quite some load on both the CPU and the harddrive. This is not healthy
+for your machine and if you are working on a portable computer, it will drain
+your battery.  Linux offers libinotify which is a very efficient way to have
+the operating system monitor file alterations. This gem teaches autotest to
+use libinotify and therefore be nice to your machine.
+
+== REQUIREMENTS:
+
+* Linux
+* rb-inotify
+* autotest >= 4.2.4
+
+== INSTALL:
+
+First install the gem:
+
+  sudo gem install autotest-inotify
+
+Then add the following line *after all other requires* in your ~/.autotest
+file:
+
+  require 'autotest/inotify'
+
+== THANK YOU:
+
+Inspiration for this gem came from work done by Alban Peignier's[1], and Sven
+Schwyn[2]
+
+1. http://blog.tryphon.org/alban/archives/2007/10/26/inotify-support-for-autotest/
+2. http://www.bitcetera.com/en/techblog/2009/05/27/mac-friendly-autotest/
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Eric A. Wollesen
+
+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

data/lib/autotest/inotify.rb

@@ -0,0 +1,94 @@
+# Extend autotest with inotify goodness
+
+require "rubygems"
+require "autotest"
+require "rbconfig"
+require "rb-inotify"
+
+Autotest.add_hook :initialize do
+  include Autotest::Inotify
+  setup_inotify_if_running_linux
+end
+
+##
+# Autotest::Inofity
+#
+# == FEATURES:
+# * Use Linux's inotify instead of filesystem polling
+#
+# == SYNOPSIS:
+# Add the following to your ~/.autotest file:
+# require "autotest/inotify"
+module Autotest::Inotify
+
+  private
+
+  def setup_inotify_if_running_linux
+    if running_linux?
+      override_autotest_methods
+    end
+  end
+
+  def running_linux?
+    /linux/i === RbConfig::CONFIG["host_os"]
+  end
+
+  def override_autotest_methods
+    ::Autotest.class_eval do
+      remove_method :find_files_to_test
+      remove_method :wait_for_changes
+
+      def wait_for_changes
+        @changed_files = {}
+        hook :waiting
+        @notifier.process
+      end
+
+      def find_files_to_test(files=nil)
+        if first_time_run?
+          setup_inotify
+          select_all_tests
+        else
+          p @changed_files if $v
+          hook :updated, @changed_files
+          select_tests_for_changed_files
+        end
+        return Time.now
+      end
+    end
+  end
+
+  def first_time_run?
+    self.last_mtime.to_i.zero?
+  end
+
+  def setup_inotify
+    @notifier = INotify::Notifier.new
+    self.find_files.keys.each do |filename|
+      @notifier.watch(filename, :modify) do |event| 
+        handle_file_event(event)
+      end
+    end
+  end
+
+  def handle_file_event(event)
+    @changed_files[event.absolute_name] = Time.now
+  end
+
+  def select_all_tests
+    map_files_to_tests_for(find_files).each do |filename|
+      self.files_to_test[filename]
+    end
+  end
+
+  def map_files_to_tests_for(files)
+    files.map {|filename, mtime| test_files_for(filename)}.flatten.uniq
+  end
+
+  def select_tests_for_changed_files
+    map_files_to_tests_for(@changed_files).each do |filename|
+      self.files_to_test[filename]
+    end
+  end
+
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: autotest-inotify
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Eric Wollesen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 4.2.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rb-inotify
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Autotest relies on filesystem polling to detect modifications in source code files. This is expensive for the CPU, harddrive and battery - and unnecesary on Linux with libinotify installed. This gem teaches autotest how to use libinotify.
+email: ericw@kill-0.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/autotest/inotify.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://kill-0.com/projects/autotest-inotify
+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: Use libinotify (on Linux) instead of filesystem polling.
+test_files: []
+