fnando-test_notifier 0.0.10

data/History.txt

@@ -0,0 +1,40 @@
+== 0.0.1 2007-10-11
+
+* 1 major enhancement:
+  * Initial release
+
+== 0.0.2 2007-10-17
+
+* Removed ANSI characters for playing nice with RedGreen
+
+== 0.0.3 2007-10-18
+
+* growlnotify wasn't working as expected
+
+== 0.0.4 2007-10-18
+
+* title was displayed incorrectly on growlnotify
+
+== 0.0.5 2007-10-18
+
+* bug fix
+
+== 0.0.6 2008-01-14
+
+* added support for both Test::Unit and RSpec, with or without Autotest
+
+== 0.0.7 2008-01-16
+
+* bug fix
+
+== 0.0.8 2008-01-18
+
+* bug fix
+
+== 0.0.9
+
+* minor fix: added freebsd pattern
+
+== 0.0.10
+
+* minor fix: fixed path for custom images

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Nando Vieira
+
+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.markdown

@@ -0,0 +1,95 @@
+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
+
+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. 
+This plugin works with Linux, Mac OS X and Windows. All you need to do is 
+install the specific notification library for your OS.
+
+Instead of displaying lots of notifications for each failure, I prefer to be 
+notified about the whole test result (you'll have to check your log 
+file anyway in order to clean up the failures/errors).
+
+INSTALLATION:
+-------------
+
+###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
+options "Listen for incoming notifications" and "Allow remote 
+application registration" on the Network tab.
+
+###Linux
+
+1) Install libnotify-bin ant its dependencies:
+	
+	aptitude install libnotify-bin
+
+###Windows
+
+1) Install Snarl: download from http://www.fullphat.net/
+2) Install ruby-snarl:
+
+	gem install ruby-snarl
+
+###All
+
+Then, install the gem:
+
+	git clone git://github.com/fnando/test_notifier.git
+	cd test_notifier
+	rake gem:install
+
+or
+
+	sudo gem install fnando-test_notifier --source=http://gems.github.com
+
+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`
+
+If you want to customize the images, create a directory at `~/.test_notifier`
+and save the images `none.png`, `passed.png`, `failure.png` and `error.png`.
+
+MAINTAINER
+----------
+ 
+* Nando Vieira ([http://simplesideias.com.br](http://simplesideias.com.br))
+
+LICENSE:
+--------
+
+(The MIT License)
+
+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,73 @@
+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.summary = "Display system notifications (dbus, growl and snarl) after running tests."
+  s.authors = ["Nando Vieira"]
+  s.email = ["fnando.vieira@gmail.com"]
+  s.homepage = "http://github.com/fnando/test_notifier"
+  s.description = "Display system notifications (dbus, growl and snarl) after \
+  running tests. It works on Mac OS X, Linux and Windows. Powerful when used \
+  with Autotest ZenTest gem for Rails apps."
+  s.has_rdoc = false
+  s.files = PKG_FILES
+	
+  s.add_dependency "rubigen"
+  s.requirements << "You'll need Growl (Mac OS X), Libnotify (Linux) or Snarl (Windows)"
+end
+
+namespace :gem do
+  # Thanks to the Merb project for this code.
+  desc "Update Github Gemspec"
+  task :update_gemspec do
+    skip_fields = %w(new_platform original_platform specification_version loaded required_ruby_version rubygems_version platform )
+    
+    result = "# WARNING : RAKE AUTO-GENERATED FILE. DO NOT MANUALLY EDIT!\n"
+    result << "# RUN : 'rake gem:update_gemspec'\n\n"
+    result << "Gem::Specification.new do |s|\n"
+    
+    spec.instance_variables.each do |ivar|
+      value = spec.instance_variable_get(ivar)
+      name  = ivar.split("@").last
+      value = Time.now if name == "date"
+      
+      next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
+      if name == "dependencies"
+        value.each do |d|
+          dep, *ver = d.to_s.split(" ")
+          result <<  "  s.add_dependency #{dep.inspect}, #{ver.join(" ").inspect.gsub(/[()]/, "").gsub(", runtime", "")}\n"
+        end
+      else
+        case value
+        when Array
+          value =  name != "files" ? value.inspect : value.inspect.split(",").join(",\n")
+        when FalseClass
+        when TrueClass
+        when Fixnum
+        when String
+          value = value.inspect
+        else
+          value = value.to_s.inspect
+        end
+        result << "  s.#{name} = #{value}\n"
+      end
+    end
+    
+    result << "end"
+    File.open(File.join(File.dirname(__FILE__), "#{spec.name}.gemspec"), "w"){|f| f << result}
+  end
+  
+  desc "Build gem"
+  task :build => [:update_gemspec] do
+    system "gem build #{spec.instance_variable_get('@name')}.gemspec"
+  end
+  
+  desc "Install gem"
+  task :install => [:update_gemspec, :build] do
+    system "sudo gem install #{spec.instance_variable_get('@name')}"
+  end
+end

data/lib/test_notifier/autotest.rb

@@ -0,0 +1,12 @@
+require 'test_notifier'
+
+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

data/lib/test_notifier/rspec.rb

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

data/lib/test_notifier/test_unit.rb

@@ -0,0 +1,16 @@
+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
+      content = @result.to_s
+      TestNotifier.notification_for_test_unit(content)
+    rescue
+    end
+  end
+end

data/lib/test_notifier.rb

@@ -0,0 +1,78 @@
+require 'snarl' if RUBY_PLATFORM =~ /mswin/
+
+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/
+  
+  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/
+      system("growlnotify -n test_notifier --image #{image} -p 2 -m \"#{message}\" -t \"#{title}\"")
+    elsif RUBY_PLATFORM =~ /mswin/
+      Snarl.show_message(title, message, image)
+    elsif RUBY_PLATFORM =~ /(linux|freebsd)/
+      system("notify-send -i #{image} #{title} \"#{message}\"")
+    end
+  end
+  
+  def self.rspec?(content)
+    (RSPEC_REGEX =~ content)
+  end
+  
+  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
+    
+    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
+    
+    message = "#{e} examples, #{f} failures, #{p} pending"
+    notify(image, title, message)
+  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
+    
+    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
+    end
+    
+    message = "#{t} tests, #{a} assertions, #{f} failures, #{e} errors"
+    notify(image, title, message)
+  end
+end

data/test_notifier.gemspec

@@ -0,0 +1,34 @@
+# WARNING : RAKE AUTO-GENERATED FILE. DO NOT MANUALLY EDIT!
+# 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"
+  s.has_rdoc = false
+  s.files = ["Rakefile",
+ "test_notifier.gemspec",
+ "History.txt",
+ "License.txt",
+ "README.markdown",
+ "TODO.txt",
+ "lib/test_notifier",
+ "lib/test_notifier/autotest.rb",
+ "lib/test_notifier/icons",
+ "lib/test_notifier/icons/error.png",
+ "lib/test_notifier/icons/failure.png",
+ "lib/test_notifier/icons/passed.png",
+ "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.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"
+  s.summary = "Display system notifications (dbus, growl and snarl) after running tests."
+  s.description = "Display system notifications (dbus, growl and snarl) after   running tests. It works on Mac OS X, Linux and Windows. Powerful when used   with Autotest ZenTest gem for Rails apps."
+  s.add_dependency "rubigen", ">= 0"
+  s.bindir = "bin"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: fnando-test_notifier
+version: !ruby/object:Gem::Version 
+  version: 0.0.10
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-27 11:24:55 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubigen
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Display system notifications (dbus, growl and snarl) after   running tests. It works on Mac OS X, Linux and Windows. Powerful when used   with Autotest ZenTest gem for Rails apps.
+email: 
+- fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- test_notifier.gemspec
+- History.txt
+- License.txt
+- README.markdown
+- TODO.txt
+- lib/test_notifier
+- lib/test_notifier/autotest.rb
+- lib/test_notifier/icons
+- lib/test_notifier/icons/error.png
+- lib/test_notifier/icons/failure.png
+- lib/test_notifier/icons/passed.png
+- lib/test_notifier/rspec.rb
+- lib/test_notifier/test_unit.rb
+- lib/test_notifier.rb
+has_rdoc: false
+homepage: http://github.com/fnando/test_notifier
+post_install_message: 
+rdoc_options: []
+
+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: 
+- You'll need Growl (Mac OS X), Libnotify (Linux) or Snarl (Windows)
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Display system notifications (dbus, growl and snarl) after running tests.
+test_files: []
+