test_notifier 0.1.4 → 0.2.0

data/README.rdoc

@@ -17,7 +17,7 @@ file anyway in order to clean up the failures/errors).
 
 * Install Growl - http://growl.info/
 * Install the growlnotify script located on the "Extras" directory
-* Open the Growl Preference Page (System > Growl) and activate the options "Listen for incoming notifications" and "Allow remote application registration" on the Network tab.
+* Open the Growl Preference Panel (System > Growl) and activate "Listen for incoming notifications" and "Allow remote application registration" options on the Network tab.
 
 === Linux
 
@@ -38,16 +38,13 @@ Then, install the gem with <tt>sudo gem install test_notifier</tt>
 
 == Usage
 
-If you're using Test::Unit you should add <tt>require "test_notifier/test_unit"</tt>
+If you're using Test::Unit you should add <tt>require "test_notifier/runner/test_unit"</tt> to your <tt>test_helper.rb</tt> file.
 
-If you're using RSpec you should add <tt>require "test_notifier/rspec"</tt>
+If you're using RSpec you should add <tt>require "test_notifier/runner/spec"</tt> to your <tt>spec_helper.rb</tt> file. If you're using Rails 2, you need to add <tt>require "test_notifier/runner/rspec"</tt> instead.
 
-If you're using Autotest you should add <tt>require test_notifier/autotest"</tt> to
+If you're using Autotest you should add <tt>require test_notifier/runner/autotest"</tt> to
 the file <tt>~/.autotest</tt>
 
-If you want to customize the images, create a directory at <tt>~/.test_notifier</tt>
-and save the images <tt>none.png</tt>, <tt>passed.png<tt>, <tt>failure.png</tt> and <tt>error.png</tt>.
-
 == Maintainer
 
 * Nando Vieira - http://simplesideias.com.br

data/lib/test_notifier.rb

@@ -1,136 +1,39 @@
 module TestNotifier
-  # create a .test_notifier at your home
-  # directory and save the images as passed.png,
-  # failure.png and error.png for custom images
-  PASSED_IMAGE = "passed.png"
-  FAILURE_IMAGE = "failure.png"
-  ERROR_IMAGE = "error.png"
-  FAILURE_TITLE = "FAILED"
-  PASSED_TITLE = "Passed"
-
-  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")
-
-  HELP_HINT = "For more information see:\n" +
-             " * http://github.com/fnando/test_notifier (online)\n" +
-             " * #{File.dirname(__FILE__)}/README.markdown (offline)"
-
-  def self.notify(image, title, message)
-    image ||= "none.png"
-
-    custom_image = File.join(File.expand_path("~/.test_notifier"), image)
-    image = File.exists?(custom_image) ? custom_image : File.join(File.dirname(__FILE__), "test_notifier", "icons", image)
-
-    if RUBY_PLATFORM =~ /darwin/
-      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"
-        puts HELP_HINT
-      end
-    elsif RUBY_PLATFORM =~ /(mswin|mingw)/
-      begin
-        require 'snarl'
-      rescue LoadError
-        puts 'To be notified by a popup please install Snarl and a ruby gem "ruby-snarl".'
-        puts HELP_HINT
-      else
-        Snarl.show_message(title, message, image)
-      end
-    elsif RUBY_PLATFORM =~ /(linux|freebsd)/
-      # if osd_cat is avaible
-      if `which osd_cat` && $? == 0
-        require 'test_notifier/osd_cat'
-        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, message
-          system "dcop knotify default notify " +
-               "eventname \'#{title}\' \'#{message}\' '' '' 16 2"
-        end
-        knotify title, message
-      # if kdialog is available
-      elsif `which kdialog` && $? == 0
-        system("kdialog --title #{title} --passivepopup \"#{message}\" 5")
-      # 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" +
-             " * kdialog (use KDE4),\n" +
-             " * notify-send (apt-get install libnotify-bin)"
-        puts HELP_HINT
-      end
-    end
+  class << self
+    attr_accessor :__notifier
   end
 
-  def self.rspec?(content)
-    (RSPEC_REGEX =~ content)
-  end
+  IMAGES = {
+    :fail    => File.dirname(__FILE__) + "/../resources/fail.png",
+    :error   => File.dirname(__FILE__) + "/../resources/error.png",
+    :success => File.dirname(__FILE__) + "/../resources/success.png"
+  }
 
-  def self.notification_for_rspec(content)
-    matches, *output = *content.to_s.match(RSPEC_REGEX)
-    output = output.map {|i| i.to_i }
-    e, f, none, p = output
+  TITLES = {
+    :fail    => "Failed!",
+    :success => "Passed!"
+  }
 
-    if f > 0
-      # test has failed
-      title = FAILURE_TITLE
-      image = FAILURE_IMAGE
-    elsif e > 0
-      # everything's ok
-      title = PASSED_TITLE
-      image = PASSED_IMAGE
-    else
-      # no examples
-      return
-    end
+  def self.notify(options)
+    options.merge!({
+      :title => TITLES[options[:status]],
+      :image => IMAGES[options[:status]]
+    })
 
-    message = "#{e} examples, #{f} failures, #{p} pending"
-    notify(image, title, message)
+    notifier.notify(options)
   end
 
-  def self.notification_for_test_unit(content)
-    matches, *output = *content.to_s.match(TEST_UNIT_REGEX)
-    output = output.map {|i| i.to_i }
-    t, a, f, e = output
+  def self.notifier
+    self.__notifier ||= begin
+      TestNotifier::Notifier.constants.sort.collect do |const|
+        self.__notifier = TestNotifier::Notifier.const_get(const)
+        break if self.__notifier.supported?
+      end
 
-    if f > 0 || e > 0
-      # test has failed or raised an error
-      title = FAILURE_TITLE
-      image = e > 0 ? ERROR_IMAGE : FAILURE_IMAGE
-    elsif a > 0
-      # everything's ok
-      title = PASSED_TITLE
-      image = PASSED_IMAGE
-    else
-      # no assertions
-      return
+      self.__notifier
     end
-
-    message = "#{t} tests, #{a} assertions, #{f} failures, #{e} errors"
-    notify(image, title, message)
   end
-end
 
+  autoload :Notifier, "test_notifier/notifier"
+  autoload :Runner,   "test_notifier/runner"
+end

data/lib/test_notifier/autotest.rb

@@ -1,12 +1,7 @@
-require 'test_notifier'
+require "test_notifier/runner/autotest"
 
-Autotest.add_hook :ran_command do |at|
-  begin
-    content = at.results.to_s
-  
-    TestNotifier.rspec?(content) ? 
-      TestNotifier.notification_for_rspec(content) : 
-      TestNotifier.notification_for_test_unit(content)
-  rescue
-  end
-end
+warn <<-TXT
+[TestNotifier] Using `require "test_notifier/autotest"` is deprecated and
+will be removed in the future. Please update your `~/.autotest` file to use
+`require "test_notifier/runner/autotest"` instead.
+TXT

data/lib/test_notifier/notifier.rb

@@ -0,0 +1,10 @@
+module TestNotifier
+  module Notifier
+    autoload :Growl,      "test_notifier/notifier/growl"
+    autoload :Snarl,      "test_notifier/notifier/snarl"
+    autoload :OsdCat,     "test_notifier/notifier/osd_cat"
+    autoload :Knotify,    "test_notifier/notifier/knotify"
+    autoload :Kdialog,    "test_notifier/notifier/kdialog"
+    autoload :NotifySend, "test_notifier/notifier/notify_send"
+  end
+end

data/lib/test_notifier/notifier/growl.rb

@@ -0,0 +1,25 @@
+module TestNotifier
+  module Notifier
+    module Growl
+      extend self
+
+      SCRIPT = File.dirname(__FILE__) + "/../../../resources/register-growl.scpt"
+      FILE = File.expand_path("~/.test_notifier-growl")
+
+      def supported?
+        RUBY_PLATFORM =~ /darwin/ && `ps -Al | grep GrowlHelper` && `which growlnotify` && $? == 0
+      end
+
+      def notify(options)
+        Thread.new do
+          `growlnotify -n test_notifier --image #{options[:image]} -p 2 -m '#{options[:message]}' -t '#{options[:title]}'`
+        end
+      end
+
+      def register
+        return if File.file?(FILE)
+        system "osascript #{SCRIPT} > #{FILE}"
+      end
+    end
+  end
+end

data/lib/test_notifier/notifier/kdialog.rb

@@ -0,0 +1,17 @@
+module TestNotifier
+  module Notifier
+    module Kdialog
+      extend self
+
+      def supported?
+        RUBY_PLATFORM =~ /(linux|freebsd)/ && `which kdialog` && $? == 0
+      end
+
+      def notify(options)
+        Thread.new do
+          `kdialog --title #{options[:title]} --passivepopup \"#{options[:message]}\" 5`
+        end
+      end
+    end
+  end
+end

data/lib/test_notifier/notifier/knotify.rb

@@ -0,0 +1,17 @@
+module TestNotifier
+  module Notifier
+    module Knotify
+      extend self
+
+      def supported?
+        RUBY_PLATFORM =~ /(linux|freebsd)/ && `ps -Al | grep dcop` && $? == 0
+      end
+
+      def notify(options)
+        Thread.new do
+          `dcop knotify default notify eventname \'#{options[:title]}\' \'#{options[:message]}\' '' '' 16 2`
+        end
+      end
+    end
+  end
+end

data/lib/test_notifier/notifier/notify_send.rb

@@ -0,0 +1,17 @@
+module TestNotifier
+  module Notifier
+    module NotifySend
+      extend self
+
+      def supported?
+        RUBY_PLATFORM =~ /(linux|freebsd)/ && `which notify-send` && $? == 0
+      end
+
+      def notify(options)
+        Thread.new do
+          `notify-send -i #{options[:image]} #{options[:title]} \"#{options[:message]}\"`
+        end
+      end
+    end
+  end
+end

data/lib/test_notifier/notifier/osd_cat.rb

@@ -0,0 +1,26 @@
+module TestNotifier
+  module Notifier
+    module OsdCat
+      extend self
+
+      FONT = "-bitstream-charter-bold-r-normal--33-240-100-100-p-206-iso8859-1"
+      POSITION = "top"
+      POSITION_OFFSET = "0"
+      ALIGN = "center"
+      COLORS = {
+        :fail => "orange",
+        :success => "green"
+      }
+
+      def supported?
+        RUBY_PLATFORM =~ /(linux|freebsd)/ && `which osd_cat` && $? == 0
+      end
+
+      def notify(options)
+        Thread.new do
+          `echo #{options[:message].inspect} | osd_cat --font=#{FONT} --shadow=0 --pos=#{POSITION} -o #{POSITION_OFFSET} --delay=4 --outline=4 --align=#{ALIGN} -c #{COLORS[options[:status]]}`
+        end
+      end
+    end
+  end
+end

data/lib/test_notifier/notifier/snarl.rb

@@ -0,0 +1,22 @@
+module TestNotifier
+  module Notifier
+    module Snarl
+      extend self
+
+      def supported?
+        return false unless RUBY_PLATFORM =~ /(mswin|mingw)/
+
+        begin
+          require "snarl" unless defined?(Snarl)
+          true
+        rescue LoadError
+          false
+        end
+      end
+
+      def notify(options)
+        Snarl.show_message(options[:title], options[:message], options[:image])
+      end
+    end
+  end
+end

data/lib/test_notifier/rspec.rb

@@ -1,26 +1,11 @@
-require 'test_notifier'
-require 'spec/runner/formatter/base_text_formatter'
+if defined?(RSpec)
+  require "test_notifier/runner/rspec"
+else
+  require "test_notifier/runner/spec"
+end
 
-class Spec::Runner::Formatter::BaseTextFormatter
-  alias dump_summary_original dump_summary
-  
-  def dump_summary(duration, examples, failed, pending)
-    dump_summary_original(duration, examples, failed, pending)
-    
-    begin
-      return if examples == 0
-      
-      if failed > 0
-        title = TestNotifier::FAILURE_TITLE
-        image = TestNotifier::ERROR_IMAGE
-      else
-        title = TestNotifier::PASSED_TITLE
-        image = TestNotifier::PASSED_IMAGE
-      end
-      
-      message = "#{examples} examples, #{failed} failed, #{pending} pending"
-      TestNotifier::notify(image, title, message)
-    rescue
-    end
-  end
-end
+warn <<-TXT
+[TestNotifier] Using `require "test_notifier/rspec"` is deprecated and
+will be removed in the future. Please use `require "test_notifier/runner/spec"`
+or `require "test_notifier/runner/rspec"` for RSpec 2 instead.
+TXT

data/lib/test_notifier/runner.rb

@@ -0,0 +1,7 @@
+module TestNotifier
+  module Runner
+    autoload :RSpec,    "test_notifier/runner/rspec"
+    autoload :Spec,     "test_notifier/runner/spec"
+    autoload :TestUnit, "test_notifier/runner/test_unit"
+  end
+end

data/lib/test_notifier/runner/autotest.rb

@@ -0,0 +1,23 @@
+require "test_notifier"
+
+Autotest.add_hook :ran_command do |at|
+  begin
+    content = at.results.to_s
+    rspec_matches = content.match(/(\d+) examples?, (\d+) failures?(, (\d+) pendings?)?/)
+    test_unit_matches = content.match(/(\d+) tests, (\d+) assertions, (\d+) failures, (\d+) errors/)
+
+    if rspec_matches
+      _, examples, failures, pending = *rspec_matches
+      status = failures.to_i > 0 ? :fail : :success
+      message = "#{examples} examples, #{failures} failed, #{pending} pending"
+      TestNotifier.notify(:status => status, :message => message) unless examples.to_i.zero?
+    elsif test_unit_matches
+      _, tests, assertions, failures, errors = *test_unit_matches
+
+      status = failures.to_i > 0 ? :fail : :success
+      message = "#{tests} tests, #{assertions} assertions, #{failures} failures, #{errors} errors"
+      TestNotifier.notify(:status => status, :message => message) unless tests.to_i.zero?
+    end
+  rescue
+  end
+end

data/lib/test_notifier/runner/rspec.rb

@@ -0,0 +1,18 @@
+require "test_notifier"
+require "rspec/core/formatters/base_text_formatter"
+
+class RSpec::Core::Formatters::BaseTextFormatter
+  alias dump_summary_original dump_summary
+
+  def dump_summary(duration, examples, failed, pending)
+    dump_summary_original(duration, examples, failed, pending)
+
+    begin
+      return if examples == 0
+      status = failed > 0 ? :fail : :success
+      message = "#{examples} examples, #{failed} failed, #{pending} pending"
+      TestNotifier.notify(:status => status, :message => message)
+    rescue
+    end
+  end
+end

data/lib/test_notifier/runner/spec.rb

@@ -0,0 +1,18 @@
+require "test_notifier"
+require "spec/runner/formatter/base_text_formatter"
+
+class Spec::Runner::Formatter::BaseTextFormatter
+  alias dump_summary_original dump_summary
+
+  def dump_summary(duration, examples, failed, pending)
+    dump_summary_original(duration, examples, failed, pending)
+
+    begin
+      return if examples == 0
+      status = failed > 0 ? :fail : :success
+      message = "#{examples} examples, #{failed} failed, #{pending} pending"
+      TestNotifier.notify(:status => status, :message => message)
+    rescue
+    end
+  end
+end

data/lib/test_notifier/runner/test_unit.rb

@@ -0,0 +1,22 @@
+require "test_notifier"
+require "test/unit/ui/console/testrunner"
+
+class Test::Unit::UI::Console::TestRunner
+  alias finished_original finished
+
+  def finished(elapsed_time)
+    finished_original(elapsed_time)
+
+    begin
+      re = /(\d+) tests, (\d+) assertions, (\d+) failures, (\d+) errors/
+      _, tests, assertions, failures, errors = *@result.to_s.match(re)
+
+      return if tests.to_i == 0
+
+      status = (failures.to_i + errors.to_i) > 0 ? :fail : :success
+      message = "#{tests} tests, #{assertions} assertions, #{failures} failures, #{errors} errors"
+      TestNotifier.notify(:status => status, :message => message)
+    rescue
+    end
+  end
+end

data/lib/test_notifier/test_unit.rb

@@ -1,16 +1,6 @@
-require 'test_notifier'
-require 'test/unit/ui/console/testrunner'
+require "test_notifier/runner/test_unit"
 
-class Test::Unit::UI::Console::TestRunner
-  alias finished_original finished
-          
-  def finished(elapsed_time)
-    finished_original(elapsed_time)
-    
-    begin
-      content = @result.to_s
-      TestNotifier.notification_for_test_unit(content)
-    rescue
-    end
-  end
-end
+warn <<-TXT
+[TestNotifier] Using `require "test_notifier/test_unit"` is deprecated and
+will be removed in the future. Please use `require "test_notifier/runner/test_unit"` instead.
+TXT

data/lib/test_notifier/version.rb

@@ -0,0 +1,8 @@
+module TestNotifier
+  module Version
+    MAJOR = 0
+    MINOR = 2
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: test_notifier
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Nando Vieira
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-27 00:00:00 -03:00
+date: 2010-07-26 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -34,13 +35,24 @@ files:
 - README.rdoc
 - lib/test_notifier.rb
 - lib/test_notifier/autotest.rb
-- lib/test_notifier/icons/error.png
-- lib/test_notifier/icons/failure.png
-- lib/test_notifier/icons/passed.png
-- lib/test_notifier/osd_cat.rb
-- lib/test_notifier/register-growl.scpt
+- lib/test_notifier/notifier.rb
+- lib/test_notifier/notifier/growl.rb
+- lib/test_notifier/notifier/kdialog.rb
+- lib/test_notifier/notifier/knotify.rb
+- lib/test_notifier/notifier/notify_send.rb
+- lib/test_notifier/notifier/osd_cat.rb
+- lib/test_notifier/notifier/snarl.rb
 - lib/test_notifier/rspec.rb
+- lib/test_notifier/runner.rb
+- lib/test_notifier/runner/autotest.rb
+- lib/test_notifier/runner/rspec.rb
+- lib/test_notifier/runner/spec.rb
+- lib/test_notifier/runner/test_unit.rb
 - lib/test_notifier/test_unit.rb
+- lib/test_notifier/version.rb
+- resources/fail.png
+- resources/register-growl.scpt
+- resources/success.png
 has_rdoc: true
 homepage: http://github.com/fnando/test_notifier
 licenses: []
@@ -51,23 +63,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: 
-- You'll need Growl (Mac OS X), Libnotify (Linux) or Snarl (Windows)
+- You'll need Growl (Mac OS X), Libnotify, OSD or KDE (Linux) or Snarl (Windows)
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Display system notifications (dbus, growl and snarl) after running tests.

data/lib/test_notifier/osd_cat.rb

@@ -1,20 +0,0 @@
-# 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
-  # 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 message, color='green'
-    osd_command = "echo #{message.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