autotest-growl 0.1.1 → 0.1.2

data/History.txt

@@ -1,3 +1,10 @@
+== 0.1.2 2009-06-12
+
+* 3 major improvements
+  * Add priorities to notifications (Michael Moen)
+  * Add clear_terminal configuration option (Michael Moen)
+  * Add show_modified_files configuration option (Graham Savage)
+
 == 0.1.1 2009-06-02
 
 * 1 major improvement

data/Manifest.txt

@@ -7,6 +7,7 @@ autotest-growl.gemspec
 growl/growlnotify
 img/error.png
 img/failed.png
+img/info.png
 img/passed.png
 img/pending.png
 lib/autotest-growl.rb

data/PostInstall.txt

@@ -19,5 +19,5 @@ http://www.bitcetera.com/products/autotest-growl
 | ZenTest no longer  comes with  bundled Growl support and  therefore the |
 | require in your ~/.autotest must not  contain the absolute path to this |
 | gem anymore. Please update your ~/.autotest to contain the require line |
-| mentioned above.                                                        |
+| mentioned above. Make sure no ZenTest version <=4.0.0 is installed.     |
 +-------------------------------------------------------------------------+

data/README.rdoc

@@ -1,5 +1,6 @@
 = Autotest Growl
 
+* Author: Sven Schwyn (http://www.bitcetera.com)
 * Homepage: http://www.bitcetera.com/products/autotest-growl
 * Issues and forum: https://forge.bitcetera.com/projects/show/autotest-growl
 
@@ -9,9 +10,19 @@ This gem aims to improve support for Growl notification by ZenTest's autotest.
 It comes with a nice colored Ruby icon set and - for now - supports Cucumber 
 notifications by means of a workaround.
 
-Furthermore the terminal running autotest is cleared on every cycle. Don't
-worry though, it's still possible to scroll up to see the output of previous
-cycles.
+The priority of a notification is set according to the actual result so you
+can  configure Growl to style the notifications differently based on these
+priorities:
+
+* 2 for error or failed
+* 0 for info
+* -1 for pending or unknown
+* -2 for passed
+
+Furthermore the terminal running autotest is cleared on every cycle (unless
+configured otherwise). Don't worry though, it's still possible to scroll up
+to see the output of previous cycles - at least on the Terminal.app from
+Apple.
 
 === Ruby 1.9.1 Note
 
@@ -44,7 +55,14 @@ http://growl.info
 
 Using your own set of icons is pretty simple. Just create a directory
 ~/.autotest-growl, copy your icons there and name them passed.png,
-pending.png, failed.png and error.png.
+pending.png, failed.png, error.png and info.png.
+
+=== Don't Clear the Terminal
+
+Add the following to your ~/.autotest if you don't want the terminal to
+be cleared before running a test:
+
+  Autotest::Growl::clear_terminal = false
 
 === Hide the Label
 
@@ -53,8 +71,30 @@ All tests have passed", add the following to your ~/.autotest:
 
   Autotest::Growl::hide_label = true
 
+=== Show Modified Files
+
+Add the following to your ~/.autotest if you would like to receive a Growl
+notification listing the files modified before tests are re-run.
+
+  Autotest::Growl::show_modified_files = true
+
 == TROUBLESHOOTING:
 
+=== Loading the Plugin Seems to Fail
+
+Most likely you still have an old version of ZenTest <= 4.0.0 installed,
+check it with:
+
+  gem list ZenTest
+
+To uninstall a specific version (e.g. 4.0.0), type:
+
+  sudo gem uninstall ZenTest --version=4.0.0
+
+Or remove all outdated versions of all installed gems:
+
+  sudo gem cleanup
+
 === Missing Cucumber Notifications
 
 If you are using autotest-fsevent as well, the require statements are not
@@ -98,6 +138,13 @@ pull request:
 
 http://github.com/guides/fork-a-project-and-submit-your-modifications
 
+== CONTRIBUTIONS:
+
+Thanks to the following folks who have contributed to this project:
+
+* Michael Moen
+* Graham Savage
+
 == LICENSE:
 
 (The MIT License)

data/Rakefile

@@ -25,3 +25,5 @@ end
 
 require 'newgem/tasks'
 Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:spec]

data/lib/autotest-growl.rb

@@ -1,8 +1,10 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require File.dirname(__FILE__) + '/autotest/growl'
+
 module AutotestGrowl
 
-  VERSION  = '0.1.1'
+  VERSION  = '0.1.2'
 
 end

data/lib/autotest/growl.rb

@@ -15,8 +15,13 @@ module Autotest::Growl
 
   GEM_PATH = File.expand_path(File.join(File.dirname(__FILE__), '../..'))
 
+  @label = ''
+  @modified_files = []
+
   @@remote_notification = false
+  @@clear_terminal = true
   @@hide_label = false
+  @@show_modified_files = false
 
   ##
   # Whether to use remote or local notificaton (default).
@@ -24,12 +29,24 @@ module Autotest::Growl
     @@remote_notification = boolean
   end
 
+  ##
+  # Whether to clear the terminal before running tests (default) or not.
+  def self.clear_terminal=(boolean)
+    @@clear_terminal = boolean
+  end
+
   ##
   # Whether to display the label (default) or not.
   def self.hide_label=(boolean)
     @@hide_label = boolean
   end
 
+  ##
+  # Whether to display the modified files or not (default).
+  def self.show_modified_files=(boolean)
+    @@show_modified_files = boolean
+  end
+
   ##
   # Display a message through Growl.
   def self.growl title, message, icon, priority=0, stick=""
@@ -43,13 +60,25 @@ module Autotest::Growl
     end
   end
 
+  ##
+  # Display the modified files.
+  Autotest.add_hook :updated do |autotest, modified|
+    if @@show_modified_files
+      if modified != @last_modified
+        growl @label + 'Modifications detected.', modified.collect {|m| m[0]}.join(', '), 'info', 0
+        @last_modified = modified
+      end
+    end
+    false
+  end
+
   ##
   # Set the label and clear the terminal.
   Autotest.add_hook :run_command do
-    @label = (@@hide_label) ? ('') : (File.basename(Dir.pwd).upcase + ': ')
+    @label = File.basename(Dir.pwd).upcase + ': ' if !@@hide_label
     @run_scenarios = false
     print "\n"*2 + '-'*80 + "\n"*2
-    print "\e[2J\e[f"   # clear the terminal
+    print "\e[2J\e[f" if @@clear_terminal
     false
   end
 
@@ -58,15 +87,15 @@ module Autotest::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.', '', 'error'
+      growl @label + 'Cannot run tests.', '', 'error', 2
     else
       if gist =~ /[1-9]\d*\s+(failure|error)/
-        growl @label + 'Some tests have failed.', gist, 'failed'
+        growl @label + 'Some tests have failed.', gist, 'failed', 2
       elsif gist =~ /pending/
-        growl @label + 'Some tests are pending.', gist, 'pending'
+        growl @label + 'Some tests are pending.', gist, 'pending', -1
         @run_scenarios = true
       else
-        growl @label + 'All tests have passed.', gist, 'passed'
+        growl @label + 'All tests have passed.', gist, 'passed', -2
         @run_scenarios = true
       end
     end
@@ -78,14 +107,14 @@ module Autotest::Growl
     if @run_scenarios && !autotest.results.grep(/^\d+ scenario/).empty?
       gist = autotest.results.grep(/\d+\s+(scenario|step)s?/).map {|s| s.gsub(/(\e.*?m|\n)/, '') }.join(" / ")
       if gist == ''
-        growl @label + 'Cannot run scenarios.', '', 'error'
+        growl @label + 'Cannot run scenarios.', '', 'error', 2
       else
         if gist =~ /failed/
-          growl @label + 'Some scenarios have failed.', gist, 'failed'
+          growl @label + 'Some scenarios have failed.', gist, 'failed', 2
         elsif gist =~ /undefined/
-          growl @label + 'Some scenarios are undefined.', gist, 'pending'
+          growl @label + 'Some scenarios are undefined.', gist, 'pending', -1
         else
-          growl @label + 'All scenarios have passed.', gist, 'passed'
+          growl @label + 'All scenarios have passed.', gist, 'passed', -2
         end
       end
     end

data/spec/autotest-growl_spec.rb

@@ -1 +1,50 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "handling results" do
+  before do
+    @autotest = Autotest.new
+  end
+
+  describe "for RSpec" do
+    it "should show a passing Growl notification" do
+      Autotest::Growl.should_receive(:growl).and_return('passed')
+      @autotest.results = ["10 examples, 0 failures"]
+      @autotest.hook(:ran_command)
+    end
+
+    it "should show a failing Growl notification" do
+      Autotest::Growl.should_receive(:growl).and_return('passed')
+      @autotest.results = ["10 examples, 1 failures"]
+      @autotest.hook(:ran_command)
+    end
+
+    it "should show a pending Growl notification" do
+      Autotest::Growl.should_receive(:growl).and_return('passed')
+      @autotest.results = ["10 examples, 0 failures, 1 pending"]
+      @autotest.hook(:ran_command)
+    end
+  end
+
+  describe "for Test::Unit" do
+    it "should show a passing Growl notification" do
+      Autotest::Growl.should_receive(:growl).and_return('passed')
+      @autotest.results = ["1 tests, 1 assertions, 0 failures, 0 errors"]
+      @autotest.hook(:ran_command)
+    end
+
+    it "should show a failing Growl notification" do
+      Autotest::Growl.should_receive(:growl).twice.and_return('passed')
+      @autotest.results = ["1 tests, 1 assertions, 1 failures, 0 errors"]
+      @autotest.hook(:ran_command)
+      @autotest.results = ["1 tests, 1 assertions, 0 failures, 1 errors"]
+      @autotest.hook(:ran_command)
+    end
+  end
+
+  # FIXME: This is a temporary workaround until Cucumber is properly integrated!
+  describe "for Cucumber" do
+    it "should show a passing Growl notification"
+    it "should show a failing Growl notification"
+    it "should show a pending Growl notification"
+  end
+end

data/spec/spec_helper.rb

@@ -7,4 +7,10 @@ rescue LoadError
 end
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
-require 'autotest-growl'
+require 'autotest/growl'
+
+module Autotest::Growl
+  def self.growl(title, message, icon, priority=0, stick="")
+    icon
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: autotest-growl
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Sven Schwyn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-03 00:00:00 +02:00
+date: 2009-06-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,6 +64,7 @@ files:
 - growl/growlnotify
 - img/error.png
 - img/failed.png
+- img/info.png
 - img/passed.png
 - img/pending.png
 - lib/autotest-growl.rb
@@ -94,7 +95,7 @@ post_install_message: "\n\
   | ZenTest no longer  comes with  bundled Growl support and  therefore the |\n\
   | require in your ~/.autotest must not  contain the absolute path to this |\n\
   | gem anymore. Please update your ~/.autotest to contain the require line |\n\
-  | mentioned above.                                                        |\n\
+  | mentioned above. Make sure no ZenTest version <=4.0.0 is installed.     |\n\
   +-------------------------------------------------------------------------+\n\
   \e[0;30m\n"
 rdoc_options: