autotest-mac 0.1.0

data/History.txt

@@ -0,0 +1,7 @@
+== 0.1.0 2009-05-24
+
+* Initial release
+  * FSEvent instead of filesystem polling on Mac OS X 10.5 or higher
+  * Growl notifications
+  * Support for Cucumber by means of a workaround
+  * Exceptions for SCM and other meta directories

data/Manifest.txt

@@ -0,0 +1,18 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+fsevent/fsevent_sleep
+img/ruby_green.png
+img/ruby_grey.png
+img/ruby_red.png
+img/ruby_yellow.png
+lib/autotest-mac.rb
+script/console
+script/destroy
+script/generate
+spec/autotest-mac_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,24 @@
+
+In order to use autotest-mac, the following line has to be added to the top
+of your ~/.autotest file:
+
+require 'autotest-mac'
+
+Make sure Growl is installed on your computer. You can download it from:
+
+http://growl.info
+
+A glitch in Growl 1.1.4 on Mac OS X 10.5 randomly prevents some notifications
+from being displayed. A workaround is built into autotest-mac, however, you 
+have to perform some additional steps to make it work:
+
+Open “System Preferences -> Growl -> Network" and set the checkboxes "Listen 
+for incoming notifications" and "Allow remote application registration”. Once
+the first notification has been displayed, you can unset the latter checkbox
+again.
+
+For more information, feedback and bug submissions, please visit:
+
+See http://www.bitcetera.com/products/mac-autotest
+
+

data/README.rdoc

@@ -0,0 +1,96 @@
+= Autotest for Mac
+
+* Homepage: http://www.bitcetera.com/products/autotest-mac
+* Issues and forum: https://forge.bitcetera.com/projects/show/autotest-mac
+
+== DESCRIPTION:
+
+The autotest-mac gem contains a set of improvements for ZenTest's autotest 
+on Mac OS X. It's absolutely useless on any other platform.
+
+== FEATURES:
+
+=== FSEvent
+
+ZenTest's 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 Mac and if you are working on a portable computer, it will 
+drain your battery in no time. Apple has introduces FSEvent with Mac OS X 10.5 
+which is a very efficient way to have the operating system monitor file 
+alterations. This gem teaches autotest to use FSEvent and therefore be nice 
+to your Mac.
+
+=== Test/Scenario Results
+
+With autotest-mac the terminal running autotest is cleared on every cycle. You
+can, however, scroll up and see the output of previous cycles. Furthermore, 
+autotest-mac configures autotest to display test (RSpec and Test::Unit) and 
+scenario (Cubumber) results as Growl notifications, decorated with a cute set 
+of colored ruby icons.
+
+Please note that autotest does not yet fully support Cucumber and therefore 
+autotest-mac has to use a workaround which may cause issues if you are using 
+custom :waiting hooks.
+
+=== Exceptions
+
+The following directories are added as exceptions by mac-autotest and thus 
+won't be monitored:
+* .svn
+* .hg
+* .git
+* vendor
+
+== REQUIREMENTS:
+
+* Mac OS X >= 10.5 (for FSEvent instead of filesystem polling)
+* Growl
+* ZenTest >= 4.0.0
+
+== INSTALL:
+
+First install the gem:
+
+  sudo gem install autotest-mac
+
+Then add the following line to the top of your ~/.autotest file:
+
+  require 'autotest-mac'
+
+Make sure Growl is installed on your computer. You can download it from
+http://growl.info
+
+A glitch in Growl 1.1.4 on Mac OS X 10.5 randomly prevents some notifications
+from being displayed. A workaround is built into autotest-mac, however, you 
+have to perform some additional steps to make it work:
+
+Open “System Preferences -> Growl -> Network" and set the checkboxes "Listen 
+for incoming notifications" and "Allow remote application registration”. Once
+the first notification has been displayed, you can unset the latter checkbox
+again.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Sven Schwyn
+
+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/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+%w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/autotest-mac'
+
+$hoe = Hoe.new('autotest-mac', AutotestMac::VERSION) do |p|
+  p.developer('Sven Schwyn', 'ruby@bitcetera.com')
+  p.summary              = %q{Mac OS X only set of improvements for ZenTest's autotest.}
+  p.description          = %q{ZenTest's autotest relies on filesystem polling to detect modifications in source code files. This is both CPU expensive and unnecessary on Mac OS X 10.5 or higher which comes with the very efficient FSEvent core service for this purpose. This extension teaches autotest to use FSEvent and furthermore hooks autotest up to Growl for displaying the test results.}
+  p.url                  = %q{http://www.bitcetera.com/en/products/autotest-mac}
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt'
+  p.rubyforge_name       = p.name
+  p.extra_deps         = [
+    ['ZenTest','>= 4.0.0'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/autotest-mac.rb

@@ -0,0 +1,89 @@
+require 'autotest'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+unless RUBY_PLATFORM =~ /darwin/
+  puts "The autotest-mac gem is for Mac OS X only and thus useless on this platform."
+  exit 1
+end
+
+module AutotestMac
+
+  VERSION = '0.1.0'
+  GEM_DIR = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+  module Autotest::Growl
+
+    ##
+    # Display a message through Growl.
+    def self.growl title, message, color, priority=0, stick=""
+      icon = File.join(GEM_DIR, 'img', "ruby_#{color}.png")
+      system "growlnotify -H localhost -n autotest --image '#{icon}' -p #{priority} -m #{message.inspect} '#{title}' #{stick}"
+    end
+
+    ##
+    # Set the label and clear the terminal.
+    Autotest.add_hook :run_command do
+      @label = File.basename(Dir.pwd).upcase
+      @run_scenarios = false
+      print "\n"*2 + '-'*80 + "\n"*2
+      print "\e[2J\e[f"   # clear the terminal
+    end
+
+    ##
+    # Parse the test results and send them to Growl.
+    Autotest.add_hook :ran_command do |autotest|
+      gist = autotest.results.grep(/\d+\s+(example|test)s?/).map {|s| s.gsub(/(\e.*?m|\n)/, '') }.join(" / ")
+      if gist == ''
+        growl "#{@label} cannot run tests", '', 'grey'
+      else
+        if gist =~ /[1-9]\d*\s+(failure|error)/
+          growl "#{@label} fails some tests", "#{gist}", 'red'
+        elsif gist =~ /pending/
+          growl "#{@label} has pending tests", "#{gist}", 'yellow'
+          @run_scenarios = true
+        else
+          growl "#{@label} passes all tests", "#{gist}", 'green'
+          @run_scenarios = true
+        end
+      end
+    end
+
+    # FIXME: This is a temporary workaround until Cucumber is properly integrated!
+    Autotest.add_hook :waiting do |autotest|
+      if @run_scenarios
+        gist = autotest.results.grep(/\d+\s+(scenario|step)s?/).map {|s| s.gsub(/(\e.*?m|\n)/, '') }.join(" / ")
+        if gist == ''
+          growl "#{@label} cannot run scenarios", '', 'grey'
+        else
+          if gist =~ /failed/
+            growl "#{@label} fails some scenarios", "#{gist}", 'red'
+          elsif gist =~ /undefined/
+            growl "#{@label} has undefined scenarios", "#{gist}", 'yellow'
+          else
+            growl "#{@label} passes all scenarios", "#{gist}", 'green'
+          end
+        end
+      end
+    end
+
+  end
+
+  ##
+  # Add some exceptions
+  Autotest.add_hook :initialize do |autotest|
+      %w{.svn .hg .git vendor}.each {|exception| autotest.add_exception(exception) }
+  end
+
+  ##
+  # Use FSEvent if possible
+  Autotest.add_hook :waiting do |autotest|
+    if RUBY_PLATFORM.sub(/^.*?darwin(\d+)$/, '\1').to_i >= 9   # Darwin 9 alias Mac OS X 10.5 or above only
+      `#{File.join(GEM_DIR, 'fsevent', 'fsevent_sleep')} '#{Dir.pwd}' 2>&1`
+    else
+      puts "\nautotest-mac: FSEvent not available, falling back to filesystem polling."
+    end
+  end
+
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/autotest-mac.rb'}"
+puts "Loading autotest-mac gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/autotest-mac_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    # violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'autotest-mac'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: autotest-mac
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sven Schwyn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-26 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 4.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: ZenTest's autotest relies on filesystem polling to detect modifications in source code files. This is both CPU expensive and unnecessary on Mac OS X 10.5 or higher which comes with the very efficient FSEvent core service for this purpose. This extension teaches autotest to use FSEvent and furthermore hooks autotest up to Growl for displaying the test results.
+email: 
+- ruby@bitcetera.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- fsevent/fsevent_sleep
+- img/ruby_green.png
+- img/ruby_grey.png
+- img/ruby_red.png
+- img/ruby_yellow.png
+- lib/autotest-mac.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/autotest-mac_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://www.bitcetera.com/en/products/autotest-mac
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+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: autotest-mac
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: Mac OS X only set of improvements for ZenTest's autotest.
+test_files: []
+