autotest-growl 0.1.7 → 0.2.0

data/{History.txt → CHANGELOG.txt}

@@ -1,3 +1,13 @@
+== 0.2.0 2010-02-03
+
+* 3 major improvements
+  * Change dependency from "ZenTest" to lightweight "autotest"
+  * Add support for more platforms (Martin Vielsmaier)
+  * Add support for bundled icon sets
+* 2 minor improvements
+  * Update README for development to reflect changes on Github
+  * New icon set "ampelmaennchen"
+
 == 0.1.7 2009-10-09
 
 * 2 minor improvements

data/LICENSE

@@ -0,0 +1,20 @@
+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/README.rdoc

@@ -6,28 +6,21 @@
 
 == 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.
-
-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, undefined or unknown
-* -2 for passed
+This gem aims to improve support for Growl notifications by autotest. It
+comes  with a nice and colorful icon sets and supports several testing
+frameworks on different platforms.
 
 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.
+to see the output of previous cycles - at least when using the Terminal.app
+bundled with Mac OS X.
 
 == REQUIREMENTS:
 
-* Growl >= 1.1.5 (Mac OS X) or >= 2.0b18 (Windows) 
-* ZenTest >= 4.1.3
+* autotest >= 4.2.4
+* Growl >= 1.1.5 on Mac OS X   -or-
+* Growl for Windows >= 2.0b18 on Windows   -or-
+* libnotify >= 0.4.5 on Linux
 
 == INSTALL:
 
@@ -39,20 +32,62 @@ Then add the following line to your ~/.autotest file:
 
   require 'autotest/growl'
 
-Make sure Growl is installed on your computer. You can download it from:
+Growl must be installed on your computer. You can download it from:
 
 Mac OS X: http://growl.info
 Windows:  http://growlforwindows.com
 
+On Linux you can use libnotify instead, however, some of the features 
+won't work. The binary notify-send must be in your PATH:
+
+Linux:    http://www.galago-project.org
+
+If you like this gem, please consider to recommend me on Working with
+Rails, thank you!
+
+http://workingwithrails.com/recommendation/new/person/11706-sven-schwyn
+
+== UPDATE FROM 0.1.X
+
+As of version 0.2.0 autotest-growl no longer requires the ZenTest gem but
+the lighter and improved autotest gem. To update do the following: 
+
+  sudo gem uninstall ZenTest
+  sudo gem update autotest-growl
+
+And only if you need all the functionality of ZenTest:
+
+  sudo gem install zentest-without-autotest
+
 == CONFIGURATION:
 
-=== Custom Icons
+=== Priorities
+
+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, undefined or unknown
+* -2 for passed
+
+=== Icons
+
+Two icon sets are bundled with this gem:
+
+* ruby (default): The original Ruby logo dressed in traffic light colors.
+* ampelmaennchen: The famous traffic light man from the now extinct GDR.
 
-Using your own set of icons is pretty simple. Images should be named as
+To choose an icon set, add the following to your ~/.autotest:
+
+  Autotest::Growl::image_dir = 'ampelmaennchen'
+
+Using your own icon set is pretty simple. Images should be named as
 follows: passed.png, pending.png, failed.png, error.png and info.png.
 
 Place these images in a directory of your choosing and specify its
-location in your ~/.autotest:
+location in your ~/.autotest, example:
 
   Autotest::Growl::image_dir = File.join(ENV['HOME'], '.autotest-growl')
 
@@ -88,18 +123,8 @@ notification listing the files modified before tests are re-run.
 
 === 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
+The reason may be ZenTest which must not be installed. See "Update from 
+0.1.X" for more on this.
 
 === Unreliable Growl Notifications on Mac OS X
 
@@ -122,17 +147,20 @@ 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.
 
-== DEVELOPMENT:
+=== No Notifications on Mac OS X 10.5
 
-You can install the bleeding-edge version as follows:
+If you are still on Leopard and notifications don't work for you, get your
+hands dirty and remove the "-n Autotest" argument from growl.rb. Make sure
+you submit a bug or comment on a related and existing bug, too. 
+
+== DEVELOPMENT:
 
-  sudo gem uninstall autotest-growl
-  sudo gem install svoop-autotest-growl --source http://gems.github.com
+You can install the bleeding edge version as follows:
 
-Bleeding-edge gems contain a fourth version digit group (e.g. the .8 in 
-0.1.5.8) to make sure Github builds the gem whenever new code is committed.
-If there is no fourth version digit group, the edge version is identical
-to the stable version from Rubyforge.
+  git clone git://github.com/svoop/autotest-growl.git
+  cd autotest-growl
+  rake build
+  sudo rake install
 
 Please submit issues on:
 
@@ -152,6 +180,7 @@ Thanks to the following folks who have contributed to this project:
 * Karl O'Keeffe
 * Konstantin Haase
 * J. Edward Dewyea
+* Martin Vielsmaier
 
 == LICENSE:
 

data/lib/autotest/growl.rb

@@ -26,7 +26,7 @@ module Autotest::Growl
   @@clear_terminal = true
   @@hide_label = false
   @@show_modified_files = false
-  @@image_dir = File.join(GEM_PATH, 'img')
+  @@image_dir = File.join(GEM_PATH, 'img', 'ruby')
 
   ##
   # Whether to use remote or local notificaton (default).
@@ -61,7 +61,11 @@ module Autotest::Growl
   ##
   # Directory where notification icons can be found
   def self.image_dir=(path)
-    @@image_dir = path
+    if File.directory?(File.join(GEM_PATH, 'img', path))
+      @@image_dir = File.join(GEM_PATH, 'img', path)
+    else
+      @@image_dir = path
+    end
   end
 
   ##
@@ -69,16 +73,20 @@ module Autotest::Growl
   def self.growl(title, message, icon, priority=0, stick="")
     growl = File.join(GEM_PATH, 'growl', 'growlnotify')
     image = File.join(@@image_dir, "#{icon}.png")
-    case RUBY_PLATFORM
-    when /mswin/
+    platform = RUBY_PLATFORM
+    platform = Java::java.lang.System.getProperty("os.name") if platform =~ /java/i   # see http://lopica.sourceforge.net/os.html
+    case platform
+    when /mswin|windows/i
       growl += '.com'
       system %(#{growl} #{message.inspect} /a:"Autotest" /r:"Autotest" /n:"Autotest" /i:"#{image}" /p:#{priority} /t:"#{title}")
-    when /darwin/
+    when /darwin|mac os/i
       options = "-w -n Autotest --image '#{image}' -p #{priority} -m '#{message}' '#{title}' #{stick}"
       options << " -H localhost" if @@remote_notification
       system %(#{growl} #{options} &)
+    when /linux|bsd/i
+      system %(notify-send "#{title}" "#{message}" -i #{image} -t 5000)
     else
-      raise "#{RUBY_PLATFORM} is not supported by autotest-growl" 
+      raise "#{platform} is not supported by autotest-growl" 
     end
   end
 

data/lib/autotest/result.rb

@@ -61,4 +61,4 @@ class Result
     
   end
 
-end
+end

data/spec/autotest-growl_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "handling results" do
   before do
@@ -12,7 +12,6 @@ describe "handling results" do
       @autotest.results = ["10 examples, 0 failures"]
       @autotest.hook(:ran_command)
     end
-
     it "should show a 'failed' notification" do
       Autotest::Growl.should_receive(:growl).and_return('failed')
       @autotest.results = ["10 examples, 1 failures"]

data/spec/spec_helper.rb

@@ -1,16 +1,14 @@
-begin
-  require 'spec'
-rescue LoadError
-  require 'rubygems' unless ENV['NO_RUBYGEMS']
-  gem 'rspec'
-  require 'spec'
-end
-
-$:.unshift(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'autotest/growl'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+end
 
 module Autotest::Growl
   def self.growl(title, message, icon, priority=0, stick="")
     icon
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: autotest-growl
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sven Schwyn
@@ -9,64 +9,56 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-09 00:00:00 +02:00
+date: 2010-02-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: ZenTest
-  type: :runtime
+  name: rspec
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 4.1.3
+        version: 1.3.0
     version: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
+  name: autotest
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
+        version: 4.2.4
     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
+description: This gem aims to improve support for Growl notifications by autotest.
+email: ruby@bitcetera.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
-files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
+- LICENSE
 - README.rdoc
-- Rakefile
-- autotest-growl.gemspec
+files: 
+- CHANGELOG.txt
 - growl/growlnotify
 - growl/growlnotify.com
-- img/error.png
-- img/failed.png
-- img/info.png
-- img/passed.png
-- img/pending.png
-- lib/autotest-growl.rb
+- img/ampelmaennchen/error.png
+- img/ampelmaennchen/failed.png
+- img/ampelmaennchen/info.png
+- img/ampelmaennchen/passed.png
+- img/ampelmaennchen/pending.png
+- img/ruby/error.png
+- img/ruby/failed.png
+- img/ruby/info.png
+- img/ruby/passed.png
+- img/ruby/pending.png
 - lib/autotest/growl.rb
 - lib/autotest/result.rb
-- script/console
-- script/destroy
-- script/generate
-- spec/autotest-growl_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- tasks/rspec.rake
+- LICENSE
+- README.rdoc
 has_rdoc: true
 homepage: http://www.bitcetera.com/products/autotest-growl
 licenses: []
@@ -75,17 +67,26 @@ post_install_message: "\n\
   \e[1;32mIn order to use autotest-growl, the following line has to be added to your\n\
   ~/.autotest file:\n\n\
   require 'autotest/growl'\n\n\
-  Make sure Growl is installed on your computer. Download it from:\n\n\
-  http://growl.info (Mac OS X)\n\
-  http://growlforwindows.com (Windows)\n\n\
+  Make sure the notification service installed on your computer:\n\n\
+  http://growl.info (Growl for Mac OS X)\n\
+  http://growlforwindows.com (Growl for Windows)\n\
+  http://www.galago-project.org (libnotify for Linux)\n\n\
   If Growl notifications are not always displayed, take a look at the README\n\
   for assistance.\n\n\
   For more information, feedback and bug submissions, please visit:\n\n\
-  http://www.bitcetera.com/products/autotest-growl\n\
+  http://www.bitcetera.com/products/autotest-growl\n\n\
+  If you like this gem, please consider to recommend me on Working with\n\
+  Rails, thank you!\n\n\
+  http://workingwithrails.com/recommendation/new/person/11706-sven-schwyn\n\n\
+  +-------------------------------------------------------------------------+\n\
+  | READ THIS IF YOU ARE UPGRADING FROM 0.1.X                               |\n\
+  | As of 0.2.0 this gem no longer depends on the rather heavy ZenTest gem  |\n\
+  | but the more lightweight autotest gem. You MUST uninstall ZenTest now!  |\n\
+  | Please refer to the README in case you need more ZenTest functionality. |\n\
+  +-------------------------------------------------------------------------+\n\
   \e[0m\n"
 rdoc_options: 
-- --main
-- README.rdoc
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -102,10 +103,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: autotest-growl
+rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Next generation Growl notification support for ZenTest's autotest.
-test_files: []
-
+summary: Growl notification support for autotest.
+test_files: 
+- spec/autotest-growl_spec.rb
+- spec/spec_helper.rb

data/Manifest.txt

@@ -1,23 +0,0 @@
-History.txt
-Manifest.txt
-PostInstall.txt
-README.rdoc
-Rakefile
-autotest-growl.gemspec
-growl/growlnotify
-growl/growlnotify.com
-img/error.png
-img/failed.png
-img/info.png
-img/passed.png
-img/pending.png
-lib/autotest-growl.rb
-lib/autotest/growl.rb
-lib/autotest/result.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

@@ -1,16 +0,0 @@
-In order to use autotest-growl, the following line has to be added to your
-~/.autotest file:
-
-require 'autotest/growl'
-
-Make sure Growl is installed on your computer. Download it from:
-
-http://growl.info (Mac OS X)
-http://growlforwindows.com (Windows)
-
-If Growl notifications are not always displayed, take a look at the README
-for assistance.
-
-For more information, feedback and bug submissions, please visit:
-
-http://www.bitcetera.com/products/autotest-growl

data/Rakefile

@@ -1,26 +0,0 @@
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require './lib/autotest-growl'
-
-Hoe.plugin :newgem
-# Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
-
-$hoe = Hoe.spec 'autotest-growl' do
-  self.developer              'Sven Schwyn', 'ruby@bitcetera.com'
-  self.summary              = %q{Next generation Growl notification support for ZenTest's autotest.}
-  self.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.}
-  self.url                  = %q{http://www.bitcetera.com/products/autotest-growl}
-  self.post_install_message = "\n\e[1;32m" + File.read('PostInstall.txt') + "\e[0m\n"
-  self.rubyforge_name       = self.name
-  self.extra_deps           = [
-                                ['ZenTest','>= 4.1.3'],
-                              ]
-end
-
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-task :default => [:spec]

data/autotest-growl.gemspec

@@ -1,55 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{autotest-growl}
-  s.version = "0.1.7"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Sven Schwyn"]
-  s.date = %q{2009-10-09}
-  s.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.}
-  s.email = ["ruby@bitcetera.com"]
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt"]
-  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "autotest-growl.gemspec", "growl/growlnotify", "growl/growlnotify.com", "img/error.png", "img/failed.png", "img/info.png", "img/passed.png", "img/pending.png", "lib/autotest-growl.rb", "lib/autotest/growl.rb", "lib/autotest/result.rb", "script/console", "script/destroy", "script/generate", "spec/autotest-growl_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake"]
-  s.homepage = %q{http://www.bitcetera.com/products/autotest-growl}
-  s.post_install_message = %q{
-In order to use autotest-growl, the following line has to be added to your
-~/.autotest file:
-
-require 'autotest/growl'
-
-Make sure Growl is installed on your computer. Download it from:
-
-http://growl.info (Mac OS X)
-http://growlforwindows.com (Windows)
-
-If Growl notifications are not always displayed, take a look at the README
-for assistance.
-
-For more information, feedback and bug submissions, please visit:
-
-http://www.bitcetera.com/products/autotest-growl
-
-}
-  s.rdoc_options = ["--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{autotest-growl}
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Next generation Growl notification support for ZenTest's autotest.}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<ZenTest>, [">= 4.1.3"])
-      s.add_development_dependency(%q<hoe>, [">= 2.3.3"])
-    else
-      s.add_dependency(%q<ZenTest>, [">= 4.1.3"])
-      s.add_dependency(%q<hoe>, [">= 2.3.3"])
-    end
-  else
-    s.add_dependency(%q<ZenTest>, [">= 4.1.3"])
-    s.add_dependency(%q<hoe>, [">= 2.3.3"])
-  end
-end

data/lib/autotest-growl.rb

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

data/script/console

@@ -1,10 +0,0 @@
-#!/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

@@ -1,14 +0,0 @@
-#!/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

@@ -1,14 +0,0 @@
-#!/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/spec.opts

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

data/tasks/rspec.rake

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