autotest-mac 0.1.2 → 0.1.3

data/History.txt

@@ -1,3 +1,8 @@
+== 0.1.3 2009-05-28
+
+* Deprecation release
+  * Split into autotest-fsevent and autotest-growl
+
 == 0.1.2 2009-05-25
 
 * Bugfix release

data/Manifest.txt

@@ -3,11 +3,6 @@ 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

data/PostInstall.txt

@@ -1,30 +1,21 @@
 
   +--------------------------------------------------------------------------+
   |                                                                          |
-  |   In order to use autotest-mac, the following line has to be added to    |
-  |   the top of your ~/.autotest file:                                      |
+  |   Following the feedback from ZenTest devs and users, the autotest-mac   |
+  |   is now split in to separate gems which include some bugfixes and new   |
+  |   features:                                                              |
   |                                                                          |
-  |   require 'autotest-mac'                                                 |
+  |   * autotest-fsevent                                                     |
+  |   * autotest-growl                                                       |
   |                                                                          |
-  |   Make sure Growl is installed on your computer. Download it from:       |
+  |   Migration is easy, check out the README or the homepage for details:   |
   |                                                                          |
-  |   http://growl.info                                                      |
+  |   * http://www.bitcetera.com/products/autotest-mac                       |
+  |   * http://github.com/svoop/autotest-mac/tree/master                     |
   |                                                                          |
-  |   The growlnotify utility (located inside the Extras folder) must be     |
-  |   installed as well.                                                     |
-  |                                                                          |
-  |   A glitch in Growl 1.1.4 on Mac OS X 10.5 prevents notifications from   |
-  |   being displayed randomly. 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                     |
+  |   This final release of autotest-mac is just a message and doesn't do    |
+  |   anything besided writing deprecation warnings to the terminal. You     |
+  |   should remove it now in favor of it's improved offspring gems.         |
   |                                                                          |
   +--------------------------------------------------------------------------+
 

data/README.rdoc

@@ -1,104 +1,51 @@
 = Autotest Mac
 
-* Homepage: http://www.bitcetera.com/products/autotest-mac
-* Issues and forum: https://forge.bitcetera.com/projects/show/autotest-mac
+== SPLITUP:
 
-== DESCRIPTION:
+Following the feedback from ZenTest devs and users, I've split autotest-mac
+into two separate gems:
 
-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.
+=== autotest-fsevent
 
-== FEATURES:
+This gem teaches autotest to use FSEvent instead of filesystem polling.
 
-=== FSEvent
+http://www.bitcetera.com/products/autotest-mac
 
-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.
+=== autotest-growl
 
-Unlike other test runners for the Mac, autotest-mac does not replace but
-extend autotest and does *not* require RubyCocoa to be installed.
+Growl support bundled with ZenTest is scheduled to be removed in favor of
+this gem which comes with more features and nice icons.
 
-=== Test/Scenario Results
+http://www.bitcetera.com/products/autotest-growl
 
-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.
+== REMOVED:
 
-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.
+One feature didn't make it in neither of the two new gems.
 
 === Exceptions
 
-The following directories are added as exceptions by mac-autotest and thus 
-won't be monitored:
-* .git
-* .svn
-* .hg
-* .DS_Store
-* ._*
-* vendor
+Adding path exceptions to the gem wasn't such a good idea to begin with. It's
+better if you set them yourself and according to your needs in ~/.autotest. 
+Here is an example:
 
-== REQUIREMENTS:
+  Autotest.add_hook :initialize do |autotest|
+    %w{.git .svn .hg .DS_Store ._* vendor}.each {|exception| autotest.add_exception(exception) }
+    false
+  end
 
-* Mac OS X >= 10.5 (for FSEvent instead of filesystem polling)
-* Growl
-* ZenTest >= 4.0.0
+== UNINSTALL:
 
-== INSTALL:
+First uninstall the deprecated autotest-mac:
 
-First install the gem:
+  sudo gem uninstall autotest-mac
 
-  sudo gem install autotest-mac
-
-Then add the following line to the top of your ~/.autotest file:
+And remove the following line from your ~/.autotest:
 
   require 'autotest-mac'
 
-Make sure Growl is installed on your computer. You can download it from
-http://growl.info
-
-The growlnotify utility (located inside the Extras folder) must be installed
-as well.
-
-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:
+Then install it's offspring as described in the READMEs:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+* autotest-fsevent: http://github.com/svoop/autotest-fsevent/tree/master
+* autotest-growl: http://github.com/svoop/autotest-growl/tree/master
 
-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.
+And optionally except some paths as mentioned above.

data/Rakefile

@@ -4,8 +4,8 @@ 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.summary              = %q{Deprecated, use autotest-fsevent and autotest-growl instead.}
+  p.description          = %q{Deprecated, use autotest-fsevent and autotest-growl instead.}
   p.url                  = %q{http://www.bitcetera.com/products/autotest-mac}
   p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   p.post_install_message = File.read('PostInstall.txt')

data/lib/autotest-mac.rb

@@ -3,97 +3,15 @@ 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"
-  puts "this platform. Please uninstall it and try again."
-  exit 1
-end
-
 module AutotestMac
 
-  VERSION = '0.1.2'
-  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
-      false
-    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
-      false
-    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
-      false
-    end
-
-  end
-
-  module Autotest::Mac
-
-    ##
-    # Add some exceptions
-    Autotest.add_hook :initialize do |autotest|
-      %w{.git .svn .hg .DS_Store ._* vendor}.each {|exception| autotest.add_exception(exception) }
-      false
-    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
-      false
-    end
+  VERSION = '0.1.3'
 
-  end
+  puts
+  puts "DEPRECATION NOTE --------------------------------------------------"
+  puts "The autotest-mac gem has been deprecated in favor of it's offspring"
+  puts "autotest-fsevent and autotest-growl. For migration instructions see"
+  puts "http://www.bitcetera.com/products/autotest-mac"
+  puts
 
 end

data/spec/autotest-mac_spec.rb

@@ -1,11 +1 @@
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: autotest-mac
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Sven Schwyn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-27 00:00:00 +02:00
+date: 2009-05-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,7 +42,7 @@ dependencies:
       - !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.
+description: Deprecated, use autotest-fsevent and autotest-growl instead.
 email: 
 - ruby@bitcetera.com
 executables: []
@@ -60,11 +60,6 @@ files:
 - 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
@@ -77,7 +72,28 @@ has_rdoc: true
 homepage: http://www.bitcetera.com/products/autotest-mac
 licenses: []
 
-post_install_message: "\n  +--------------------------------------------------------------------------+\n  |                                                                          |\n  |   In order to use autotest-mac, the following line has to be added to    |\n  |   the top of your ~/.autotest file:                                      |\n  |                                                                          |\n  |   require 'autotest-mac'                                                 |\n  |                                                                          |\n  |   Make sure Growl is installed on your computer. Download it from:       |\n  |                                                                          |\n  |   http://growl.info                                                      |\n  |                                                                          |\n  |   The growlnotify utility (located inside the Extras folder) must be     |\n  |   installed as well.                                                     |\n  |                                                                          |\n  |   A glitch in Growl 1.1.4 on Mac OS X 10.5 prevents notifications from   |\n  |   being displayed randomly. A workaround is built into autotest-mac,     |\n  |   however, you have to perform some additional steps to make it work:    |\n  |                                                                          |\n  |   Open \xE2\x80\x9CSystem Preferences -> Growl -> Network\" and set the checkboxes   |\n  |   \"Listen for incoming notifications\" and \"Allow remote application      |\n  |   registration\xE2\x80\x9D. Once the first notification has been displayed, you     |\n  |   can unset the latter checkbox again.                                   |\n  |                                                                          |\n  |   For more information, feedback and bug submissions, please visit:      |\n  |                                                                          |\n  |   See http://www.bitcetera.com/products/mac-autotest                     |\n  |                                                                          |\n  +--------------------------------------------------------------------------+\n\n"
+post_install_message: |+
+  
+    +--------------------------------------------------------------------------+
+    |                                                                          |
+    |   Following the feedback from ZenTest devs and users, the autotest-mac   |
+    |   is now split in to separate gems which include some bugfixes and new   |
+    |   features:                                                              |
+    |                                                                          |
+    |   * autotest-fsevent                                                     |
+    |   * autotest-growl                                                       |
+    |                                                                          |
+    |   Migration is easy, check out the README or the homepage for details:   |
+    |                                                                          |
+    |   * http://www.bitcetera.com/products/autotest-mac                       |
+    |   * http://github.com/svoop/autotest-mac/tree/master                     |
+    |                                                                          |
+    |   This final release of autotest-mac is just a message and doesn't do    |
+    |   anything besided writing deprecation warnings to the terminal. You     |
+    |   should remove it now in favor of it's improved offspring gems.         |
+    |                                                                          |
+    +--------------------------------------------------------------------------+
+  
 rdoc_options: 
 - --main
 - README.rdoc
@@ -101,6 +117,6 @@ 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.
+summary: Deprecated, use autotest-fsevent and autotest-growl instead.
 test_files: []