UnderpantsGnome-autotest-growl 0.1.2

data/History.txt

@@ -0,0 +1,5 @@
+== 0.1.0 2009-05-28
+
+* Initial release
+  * Growl notifications for Test::Unit, RSpec and Cucumber (workaround)
+  * Formerly part of autotest-mac which is now deprecated

data/Manifest.txt

@@ -0,0 +1,18 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+growl/growlnotify
+img/error.png
+img/failed.png
+img/passed.png
+img/pending.png
+lib/autotest/growl.rb
+script/console
+script/destroy
+script/generate
+spec/autotest-growl_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,24 @@
+
+  +--------------------------------------------------------------------------+
+  |                                                                          |
+  |   In order to use autotest-growl, the following line has to be added     |
+  |   to the top of ~/.autotest file:                                        |
+  |                                                                          |
+  |   require 'autotest/growl'                                               |
+  |                                                                          |
+  |   IMPORTANT: If you use ZenTest-4.0.0, this won't work. See the README   |
+  |   for further instructions.                                              | 
+  |                                                                          |
+  |   Make sure Growl is installed on your computer. Download it from:       |
+  |                                                                          |
+  |   http://growl.info                                                      |
+  |                                                                          |
+  |   If Growl notifications are not always displayed, take a look at the    |
+  |   README for help.                                                       |
+  |                                                                          |
+  |   For more information, feedback and bug submissions, please visit:      |
+  |                                                                          |
+  |   See http://www.bitcetera.com/products/autotest-growl                   |
+  |                                                                          |
+  +--------------------------------------------------------------------------+
+

data/README.rdoc

@@ -0,0 +1,138 @@
+= Autotest Growl
+
+* Homepage: http://www.bitcetera.com/products/autotest-growl
+* Issues and forum: https://forge.bitcetera.com/projects/show/autotest-growl
+
+== DESCRIPTION:
+
+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.
+
+=== Ruby 1.9.1 Note
+
+For the moment, autotest-growl doesn't seem to work on Ruby 1.9.1. This will
+change soon, however, it will take a few days as autotest itself is currently
+misbehaving - at least on my setup.
+
+== REQUIREMENTS:
+
+* Growl >= 1.1.4
+* ZenTest >= 4.0.0
+
+== INSTALL:
+
+Make sure Growl is installed on your computer. You can download it from:
+
+http://growl.info
+
+Now install the gem:
+
+  sudo gem install autotest-growl
+
+=== With ZenTest >4.0.0
+
+Add the following line to your ~/.autotest file:
+
+  require 'autotest/growl'
+
+=== With ZenTest 4.0.0
+
+ZenTest comes with a bundled Growl plugin which will be removed in the 
+near future. If you use ZenTest-4.0.0 or older, the above require won't do
+the trick, instead do the following:
+
+Find the full path to autotest-growl:
+
+  find /Library/Ruby /usr -name growl.rb | grep "gems/autotest"
+
+Then add the output of the above to your ~/.autotest file:
+
+  require '--PUT-OUTPUT-HERE--'
+
+== CONFIGURATION:
+
+=== Custom Icons
+
+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.
+
+=== Hide the Label
+
+If you prefer the Growl notifications not to show labels such as "LABEL:
+All tests have passed", add the following to your ~/.autotest:
+
+  Autotest::Growl::hide_label = true
+
+=== Don't clear the screen on each run
+
+  Autotest::Growl::clear_before_run = false
+
+=== Wrap the message on commas
+
+  Autotest::Growl::wrap_lines = true
+
+=== Try and make the message a little more readable
+
+Setting this true sets wrap_lines to false as they don't play nice together
+
+  Autotest::Growl::pretty_print = true
+
+== TROUBLESHOOTING:
+
+=== Missing Cucumber Notifications
+
+If you are using autotest-fsevent as well, the require statements are not
+ordered correctly. The require for autotest-fsevent must come after all
+other requires in your ~/.autotest.
+
+=== Unreliable Growl Notifications
+
+Under some circumstances, Growl notifications seem to be swallowed randomly.
+If this happens to you, try the following.
+
+Add this to your ~/.autotest:
+
+  Autotest::Growl::remote_notification = true
+  
+Now open "System Preferences -> Growl -> Network" and set the checkboxes
+"Listen for incoming notifications" and "Allow remote application 
+registration”. Try whether remote notifications work with the following
+test:
+
+  find /Library/Ruby /usr -name growlnotify -exec {} -H localhost -n autotest -m ok \;
+  
+If you get a NSPortTimeoutException, you should restart Growl and check
+whether a firewall is blocking the connection. Once the notification is 
+displayed, go back to the System Preferences and disable the checkbox
+"Allow remote application registration" 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,29 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+%w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/autotest/growl'
+
+$hoe = Hoe.new('autotest-growl', Autotest::Growl::VERSION) do |p|
+  p.developer('Sven Schwyn', 'ruby@bitcetera.com')
+  p.summary              = %q{Next generation Growl notification support for ZenTest's autotest.}
+  p.description          = %q{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 by means of a workaround.}
+  p.url                  = %q{http://www.bitcetera.com/products/autotest-growl}
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = File.read('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 }
+
+task :default => [:spec]

data/lib/autotest/growl.rb

@@ -0,0 +1,126 @@
+require 'rubygems'
+require 'autotest'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) ||
+    $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+##
+# Autotest::Growl
+#
+# == FEATUERS:
+# * Display autotest results as local or remote Growl notifications.
+# * Clean the terminal on every test cycle while maintaining scrollback.
+#
+# == SYNOPSIS:
+# ~/.autotest
+#   require 'autotest/growl'
+class Autotest
+  class Growl
+
+    VERSION  = '0.1.2'
+    GEM_PATH = File.expand_path(File.join(File.dirname(__FILE__), '../..'))
+
+    @label = ''
+    @run_scenarios = false
+    @@remote_notification = false
+    @@hide_label = false
+    @@clear_term = true
+    @@wrap_lines = false
+    @@pretty_print = false
+
+    ##
+    # Whether to use remote or local notificaton (default).
+    def self.remote_notification=(boolean)
+      @@remote_notification = boolean
+    end
+
+    ##
+    # Whether to display the label (default) or not.
+    def self.hide_label=(boolean)
+      @@hide_label = boolean
+    end
+
+    ##
+    # Whether to clear the terminal before each run (default) or not.
+    def self.clear_before_run=(boolean)
+      @@clear_term = boolean
+    end
+
+    ##
+    # Whether to wrap the message at the commas or not (default).
+    def self.wrap_lines=(boolean)
+      @@wrap_lines = boolean
+    end
+
+    ##
+    # Whether to try and make a more readable format or not (default).
+    def self.pretty_print=(boolean)
+      @@pretty_print = boolean
+    end
+
+    def self.pretty_print(msg)
+      out = ''
+      msg.split(/,\s?/).each do |line|
+        matches = line.match(/(\d+)\s(\w+)/)
+        str = "#{matches[1].rjust(6)} #{matches[2]}\n"
+        out << str
+      end
+      out
+    end
+
+    ##
+    # Display a message through Growl.
+    def self.growl title, message, icon, priority=0, stick=""
+      growl = File.join(GEM_PATH, 'growl', 'growlnotify')
+      image = File.join(ENV['HOME'], '.autotest-growl', "#{icon}.png")
+      image = File.join(GEM_PATH, 'img', "#{icon}.png") unless File.exists?(image)
+      message = message.gsub(/,\s?/, "\n") if @@wrap_lines && !@@pretty_print
+      message = pretty_print(message) if @@pretty_print
+
+      if @@remote_notification
+        system "#{growl} -H localhost -n autotest --image '#{image}' -p #{priority} -m \"#{message}\" '#{title}' #{stick}"
+      else
+        system "#{growl} -n autotest --image '#{image}' -p #{priority} -m \"#{message}\" '#{title}' #{stick}"
+      end
+    end
+
+    ##
+    # Set the label and clear the terminal.
+    Autotest.add_hook :run_command do
+      @label = (@@hide_label) ? ('') : (File.basename(Dir.pwd).upcase + ': ')
+      @run_scenarios = false
+      print "\n"*2 + '-'*80 + "\n"*2
+      print "\e[2J\e[f" if @@clear_term # 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|scenario|step)s?/).map {|s|
+        s.gsub(/(\e.*?m|\n)/, '')
+      }.join(" / ")
+
+      if gist == ''
+        growl @label + 'Cannot run specs/tests/scenarios', '', 'error', 2
+      else
+        case gist
+          when /[1-9]\d*\s+(failure|error)/
+            growl @label + 'Tests failed', gist, 'failed', 2
+          when /pending/
+            growl @label + 'Tests pending', gist, 'pending', -1
+          when /failed/
+            growl @label + 'Scenarios failed', gist, 'failed', 2
+          when /undefined/
+            growl @label + 'Scenarios undefined', gist, 'pending', -1
+          when /scenario|step/
+            growl @label + 'Scenarios passed', gist, 'passed', -2
+          else
+            growl @label + 'Tests passed', gist, 'passed', -2
+        end
+      end
+      false
+    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-growl.rb'}"
+puts "Loading autotest-growl 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-growl_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "handling results" do
+  before do
+    @at = Autotest.new
+    @atg = Autotest::Growl
+  end
+
+  describe "for Rspec" do
+    it "should show a passing growl" do
+      Autotest::Growl.should_receive(:growl).and_return('passed')
+      @at.results = ["10 examples, 0 failures"]
+      @at.hook(:ran_command)
+    end
+
+    it "should show a failing growl" do
+      Autotest::Growl.should_receive(:growl).and_return('passed')
+      @at.results = ["10 examples, 1 failures"]
+      @at.hook(:ran_command)
+    end
+
+    it "should show a pending growl" do
+      Autotest::Growl.should_receive(:growl).and_return('passed')
+      @at.results = ["10 examples, 0 failures, 1 pending"]
+      @at.hook(:ran_command)
+    end
+  end
+
+  describe "for Cucumber" do
+    # not sure what cucumber output looks like
+    # it "should show a passing growl" do
+    #   @at.results = ["10 examples, 0 failures"]
+    #   @at.hook(:ran_command)
+    # end
+    #
+    # it "should show a failing growl" do
+    #   @at.results = ["10 examples, 1 failures"]
+    #   @at.hook(:ran_command)
+    # end
+    #
+    # it "should show a pending growl" do
+    #   @at.results = ["10 examples, 0 failures, 1 pending"]
+    #   @at.hook(:ran_command)
+    # end
+  end
+
+  describe "for Test::Unit" do
+    it "should show a passing growl" do
+      Autotest::Growl.should_receive(:growl).and_return('passed')
+      @at.results = ["1 tests, 1 assertions, 0 failures, 0 errors"]
+      @at.hook(:ran_command)
+    end
+
+    it "should show a failing growl" do
+      Autotest::Growl.should_receive(:growl).twice.and_return('passed')
+      @at.results = ["1 tests, 1 assertions, 1 failures, 0 errors"]
+      @at.hook(:ran_command)
+      @at.results = ["1 tests, 1 assertions, 0 failures, 1 errors"]
+      @at.hook(:ran_command)
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'autotest/growl'
+
+class Autotest
+  class Growl
+    def self.growl(title, message, icon, priority=0, stick="")
+      icon
+    end
+  end
+end

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,128 @@
+--- !ruby/object:Gem::Specification 
+name: UnderpantsGnome-autotest-growl
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Sven Schwyn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-02 00:00:00 -07: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.3.0
+    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: 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 by means of a workaround.
+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
+- growl/growlnotify
+- img/error.png
+- img/failed.png
+- img/passed.png
+- img/pending.png
+- lib/autotest/growl.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/autotest-growl_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://www.bitcetera.com/products/autotest-growl
+post_install_message: |+
+  
+  +--------------------------------------------------------------------------+
+  |                                                                          |
+  |   In order to use autotest-growl, the following line has to be added     |
+  |   to the top of ~/.autotest file:                                        |
+  |                                                                          |
+  |   require 'autotest/growl'                                               |
+  |                                                                          |
+  |   IMPORTANT: If you use ZenTest-4.0.0, this won't work. See the README   |
+  |   for further instructions.                                              |
+  |                                                                          |
+  |   Make sure Growl is installed on your computer. Download it from:       |
+  |                                                                          |
+  |   http://growl.info                                                      |
+  |                                                                          |
+  |   If Growl notifications are not always displayed, take a look at the    |
+  |   README for help.                                                       |
+  |                                                                          |
+  |   For more information, feedback and bug submissions, please visit:      |
+  |                                                                          |
+  |   See http://www.bitcetera.com/products/autotest-growl                   |
+  |                                                                          |
+  +--------------------------------------------------------------------------+
+  
+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-growl
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Next generation Growl notification support for ZenTest's autotest.
+test_files: []
+