fnando-test_notifier 0.0.10 → 0.1.0

data/README.markdown

@@ -1,13 +1,10 @@
-test_notifier
+test\_notifier
 =============
 
-* [http://github.com/fnando/test_notifier](http://github.com/fnando/test_notifier)
-
 DESCRIPTION:
 ------------
 
-Inspired by 
-http://railstips.org/2007/7/23/autotest-growl-pass-fail-notifications
+Inspired by <http://railstips.org/2007/7/23/autotest-growl-pass-fail-notifications>
 
 After using Growl notification, I decided to write my own plugin because I have
 to work on Ubuntu and Mac OS X and I missed the notification on my Linux box. 
@@ -21,28 +18,36 @@ file anyway in order to clean up the failures/errors).
 INSTALLATION:
 -------------
 
-###Mac OS X
+### Mac OS X
 
-1) Install Growl (http://growl.info/)
-2) Install the growlnotify script located on the "Extras" directory
-3) Open the Growl Preference Page (System > Growl) and activate the
+1. Install Growl (<http://growl.info/>)
+2. Install the growlnotify script located on the "Extras" directory
+3. Open the Growl Preference Page (System > Growl) and activate the
 options "Listen for incoming notifications" and "Allow remote 
 application registration" on the Network tab.
 
-###Linux
+### Linux
+
+If you're a linux guy, you can choose on of these methods:
 
-1) Install libnotify-bin ant its dependencies:
+1. Install libnotify-bin and its dependencies:
 	
-	aptitude install libnotify-bin
+	sudo aptitude install libnotify-bin
+
+2. Install xosd-bin
 
-###Windows
+    sudo aptitude install xosd-bin
+    
+3. KDE users don't need to install anything: test\_notifier will use `knotify`.
 
-1) Install Snarl: download from http://www.fullphat.net/
-2) Install ruby-snarl:
+### Windows
+
+1. Install Snarl: download from <http://www.fullphat.net/>
+2. Install ruby-snarl:
 
 	gem install ruby-snarl
 
-###All
+### All
 
 Then, install the gem:
 
@@ -58,7 +63,9 @@ USAGE:
 ------
 
 If you're using Test::Unit you should add `require "test_notifier/test_unit"`
+
 If you're using RSpec you should add `require "test_notifier/rspec"`
+
 If you're using Autotest you should add `require "test_notifier/autotest"` to
 the file `~/.autotest`
 
@@ -68,7 +75,12 @@ and save the images `none.png`, `passed.png`, `failure.png` and `error.png`.
 MAINTAINER
 ----------
  
-* Nando Vieira ([http://simplesideias.com.br](http://simplesideias.com.br))
+* Nando Vieira (<http://simplesideias.com.br>)
+
+COLLABORATORS
+-------------
+
+* jeznet (<http://github.com/jeznet>)
 
 LICENSE:
 --------

data/Rakefile

@@ -1,11 +1,12 @@
-require 'rake'
+require "rubygems"
+require "rake"
 
 PKG_FILES = %w(Rakefile test_notifier.gemspec History.txt License.txt README.markdown TODO.txt) + 
   Dir["lib/**/*"]
 
 spec = Gem::Specification.new do |s|
   s.name = "test_notifier"
-  s.version = "0.0.10"
+  s.version = "0.1.0"
   s.summary = "Display system notifications (dbus, growl and snarl) after running tests."
   s.authors = ["Nando Vieira"]
   s.email = ["fnando.vieira@gmail.com"]
@@ -33,7 +34,7 @@ namespace :gem do
     spec.instance_variables.each do |ivar|
       value = spec.instance_variable_get(ivar)
       name  = ivar.split("@").last
-      value = Time.now if name == "date"
+      next if name == "date"
       
       next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
       if name == "dependencies"

data/lib/test_notifier.rb

@@ -1,5 +1,3 @@
-require 'snarl' if RUBY_PLATFORM =~ /mswin/
-
 module TestNotifier
   # create a .test_notifier at your home
   # directory and save the images as passed.png,
@@ -13,6 +11,8 @@ module TestNotifier
   RSPEC_REGEX = /(\d+) examples?, (\d+) failures?(, (\d+) pendings?)?/
   TEST_UNIT_REGEX = /(\d+)\stests,\s(\d+)\sassertions,\s(\d+)\sfailures,\s(\d+)\serrors/
   
+  GROWL_REGISTER_FILE = File.expand_path("~/.test_notifier-growl")
+  
   def self.notify(image, title, message)
     image ||= "none.png"
     
@@ -20,14 +20,56 @@ module TestNotifier
     image = File.exists?(custom_image) ? custom_image : File.join(File.dirname(__FILE__), "test_notifier", "icons", image)
 
     if RUBY_PLATFORM =~ /darwin/
-      system("growlnotify -n test_notifier --image #{image} -p 2 -m \"#{message}\" -t \"#{title}\"")
+      if `ps -Al | grep GrowlHelper` && `which growlnotify` && $? == 0
+        unless File.file?(GROWL_REGISTER_FILE)
+          script = File.dirname(__FILE__) + "/test_notifier/register-growl.scpt"
+          system "osascript #{script} > #{GROWL_REGISTER_FILE}"
+        end
+        
+        system("growlnotify -n test_notifier --image #{image} -p 2 -m \"#{message}\" -t \"#{title}\"")
+      else
+        puts "No compatible popup notification system installed."
+        puts "Try installing these:\n* growl"
+      end
     elsif RUBY_PLATFORM =~ /mswin/
-      Snarl.show_message(title, message, image)
+      begin
+        require 'snarl'
+      rescue LoadError
+        puts 'To be notified by a popup please install Snarl and a ruby gem "snarl".'
+      else
+        Snarl.show_message(title, message, image)
+      end
     elsif RUBY_PLATFORM =~ /(linux|freebsd)/
-      system("notify-send -i #{image} #{title} \"#{message}\"")
+      # if osd_cat is avaible
+      if `which osd_cat` && $? == 0
+        color = case image
+          when /#{PASSED_IMAGE}/
+            'green'
+          when /#{FAILURE_IMAGE}/
+            'orange'
+          when /#{ERROR_IMAGE}/
+            'red'
+        else
+          'white'
+        end
+        OsdCat.send "#{title} \n #{message}", color
+      # if dcop server is running
+      elsif `ps -Al | grep dcop` && $? == 0
+        def self.knotify title, msg
+          system "dcop knotify default notify " +
+               "eventname \'#{title}\' \'#{msg}\' '' '' 16 2"
+        end
+        knotify title, message
+      # if notify-send is avaible
+      elsif `which notify-send` && $? == 0
+        system("notify-send -i #{image} #{title} \"#{message}\"")
+      else
+        puts "No popup notification software installed."
+        puts "Try installing one of this:\n * osd_cat (apt-get install xosd-bin),\n * knotify (use KDE),\n * notify-send (apt-get install libnotify-bin)"
+      end
     end
   end
-  
+
   def self.rspec?(content)
     (RSPEC_REGEX =~ content)
   end
@@ -76,3 +118,26 @@ module TestNotifier
     notify(image, title, message)
   end
 end
+
+# Provides a method for popup notifications using osd_cat
+# Extracted from http://theadmin.org/articles/2008/2/10/fail-loudly-with-osd_cat-and-autotest
+module OsdCat
+  # TODO move this module to a separate file
+
+  # Use xlsfonts to find the different fonts
+  FONT = "-bitstream-charter-bold-r-normal--33-240-100-100-p-206-iso8859-1"
+
+  # Will display the message on the top of the screen centered, adjust these numbers to suit.
+  POSITION = "top"             # top|middle|bottom
+  POSITION_OFFSET = "0"         # Pixels from position to display (think CSS margin)
+  ALIGN = "center"             # left|right|center
+
+  def self.send msg, color='green'
+    osd_command = "echo #{msg.inspect} | osd_cat --font=#{FONT} --shadow=0 --pos=#{POSITION} -o #{POSITION_OFFSET} --delay=4 --outline=4 --align=#{ALIGN} -c #{color}"
+
+    # osd_cat blocks so start a new thread, otherwise Autotest will wait
+    Thread.new do
+      `#{osd_command}`
+    end
+  end
+end

data/test_notifier.gemspec

@@ -2,7 +2,6 @@
 # RUN : 'rake gem:update_gemspec'
 
 Gem::Specification.new do |s|
-  s.date = "Sat Sep 27 15:24:55 -0300 2008"
   s.authors = ["Nando Vieira"]
   s.require_paths = ["lib"]
   s.required_rubygems_version = ">= 0"
@@ -19,11 +18,12 @@ Gem::Specification.new do |s|
  "lib/test_notifier/icons/error.png",
  "lib/test_notifier/icons/failure.png",
  "lib/test_notifier/icons/passed.png",
+ "lib/test_notifier/register-growl.scpt",
  "lib/test_notifier/rspec.rb",
  "lib/test_notifier/test_unit.rb",
  "lib/test_notifier.rb"]
   s.email = ["fnando.vieira@gmail.com"]
-  s.version = "0.0.10"
+  s.version = "0.1.0"
   s.homepage = "http://github.com/fnando/test_notifier"
   s.requirements = ["You'll need Growl (Mac OS X), Libnotify (Linux) or Snarl (Windows)"]
   s.name = "test_notifier"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fnando-test_notifier
 version: !ruby/object:Gem::Version 
-  version: 0.0.10
+  version: 0.1.0
 platform: ruby
 authors: 
 - Nando Vieira
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-27 11:24:55 -07:00
+date: 2009-03-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rubigen
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -43,6 +44,7 @@ files:
 - lib/test_notifier/icons/error.png
 - lib/test_notifier/icons/failure.png
 - lib/test_notifier/icons/passed.png
+- lib/test_notifier/register-growl.scpt
 - lib/test_notifier/rspec.rb
 - lib/test_notifier/test_unit.rb
 - lib/test_notifier.rb