autotest-notification 2.1.0

data/bin/an-uninstall

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-5-11.
+#  Copyright (c) 2008. All rights reserved.
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require 'optparse'
+
+# NOTE: the option -p/--path= is given as an example, and should probably be replaced in your application.
+
+OPTIONS = {
+  :path     => '~'
+}
+MANDATORY_OPTIONS = %w(  )
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+This application is wonderful because...
+
+Usage: #{File.basename($0)} [options]
+
+Options are:
+BANNER
+  opts.separator ""
+  opts.on("-p", "--path=PATH", String,
+          "The root path for selecting files",
+          "Default: ~") { |path| OPTIONS[:path] = path}
+  opts.on("-h", "--help",
+          "Show this help message.") { puts opts; exit }
+  opts.parse!(ARGV)
+
+  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
+    puts opts; exit
+  end
+end
+
+path = OPTIONS[:path]
+
+autotest_file = File.expand_path(path) + "/.autotest"
+if File.exist?(autotest_file)
+  File.delete(autotest_file)
+  puts "\nYou no longer receive notifications of your tests."
+  puts "" # a blank line
+end

data/config/hoe.rb

@@ -0,0 +1,77 @@
+# coding: UTF-8
+
+require 'autotest_notification/version'
+
+AUTHOR = "Carlos Brando, Rodrigo Urubatan, Alexandre da Silva, Carlos Júnior, Davis Zanetti Cabral, Marcos Tapajós, Thiago Pradi, Ozéias Sant'ana, Samuel Flores, Diego Carrion, Ernesto Nakamura"
+EMAIL = "autotest-notification@carlosbrando.com"
+DESCRIPTION = "This gem set the autotest (ZenTest) to send messages to software as Growl, LibNotify, and Snarl, displaying a window with the results."
+GEM_NAME = 'autotest-notification' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = nil # 'autotestnotific' # The unix name for your project
+HOMEPATH = "http://github.com/carlosbrando/autotest-notification/"
+DOWNLOAD_PATH = "http://github.com/carlosbrando/autotest-notification/tarball/master"
+
+EXTRA_DEPENDENCIES = [
+  ['ZenTest', '>= 3.9.2']
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "carlosbrando"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = AutotestNotification::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'autotest_notification documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen ZenTest].each do |req_gem|
+  begin
+    require req_gem.downcase
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/autotest_notification.rb

@@ -0,0 +1,128 @@
+$:.unshift(File.dirname(__FILE__))
+
+module AutotestNotification
+  class Config
+
+    class << self
+      attr_reader :images_directory
+      attr_accessor :success_image, :fail_image, :pending_image, :expiration_in_seconds
+
+      def images_directory=(path)
+        @images_directory = File.expand_path(path)
+
+        @success_image = "#{@images_directory}/pass.png"
+        @fail_image    = "#{@images_directory}/fail.png"
+        @pending_image = "#{@images_directory}/pending.png"
+      end
+    end
+
+    self.images_directory = "#{File.dirname(__FILE__)}/../images/"
+
+    self.expiration_in_seconds = 3
+
+  end
+
+  Autotest.add_hook :ran_command do |at|
+    result = at.results.is_a?(Array) ? at.results.last : at.results.split("\n").last
+
+    if result
+      %w{ test assertion error example pending failure }.each { |x| instance_variable_set "@#{x}s", result[/(\d+) #{x}/, 1].to_i }
+
+      case result
+      when /test/
+        code = 31 if @failures > 0 || @errors > 0
+        msg  = unit_test_message(@tests, @assertions, @failures, @errors)
+      when /example/
+        code = (@failures > 0) ? 31 : (@pendings > 0) ? 33 : 32
+        msg  = rspec_message(@examples, @failures, @pendings)
+      else
+        code = 31
+        msg  = "1 exception occurred"
+        @failures = 1
+      end
+
+      if @failures > 0 || @errors > 0
+        notify "FAIL", msg, Config.fail_image, @tests + @examples, @failures + @errors, 2
+      elsif PENDING && @pendings > 0
+        notify "Pending", msg, Config.pending_image, @tests + @examples, @failures + @errors, 1
+      else
+        notify "Pass", msg, Config.success_image, @tests + @examples, 0, -2
+      end
+
+      puts "\e[#{code}m#{'=' * 80}\e[0m\n\n"
+    end
+  end
+
+  Autotest.add_hook :ran_features do |at|
+    results = at.results.is_a?(Array) ? at.results : at.results.split("\n")
+    if results
+      # How many scenarios and steps have passed, are pending, have failed or are undefined?
+      for result in results
+        next unless result =~ /^\d+ (scenario|step)/
+        scenario_or_step = $1
+        %w( scenario step passed pending failed undefined ).each do |x|
+          instance_variable_set "@#{scenario_or_step}_#{x}", result[/(\d+) #{x}/, 1].to_i
+        end
+      end
+
+      count = @scenario_scenario + @step_step
+      failed = @scenario_failed + @step_failed
+      pending = @scenario_pending + @step_pending + @scenario_undefined + @step_undefined
+
+      code = (failed > 0) ? 31 : (pending > 0) ? 33 : 32
+      msg = feature_message(@scenario_scenario, @scenario_pending + @scenario_undefined, @scenario_failed, @step_step, @step_pending + @step_undefined, @step_failed)
+
+      if @scenario_failed + @step_failed > 0
+        notify "FAIL", msg, Config.fail_image, count, failed, 2
+      elsif PENDING && pending > 0
+        notify "Pending", msg, Config.pending_image, count, failed, 1
+      else
+        notify "Pass", msg, Config.success_image, count, 0, -2
+      end
+      puts "\e[#{code}m#{'=' * 80}\e[0m\n\n"
+    end
+  end
+
+  class << self
+    def notify(title, msg, img = Config.success_image, total = 1, failures = 0, priority = 0)
+
+      img = Doom.image(total, failures) if DOOM_EDITION
+      img = Buuf.image(title.downcase) if BUUF
+
+      case RUBY_PLATFORM
+      when /linux/
+        Linux.notify(title, msg, img, total, failures, priority)
+      when /darwin/
+        Mac.notify(title, msg, img, total, failures, priority)
+      when /cygwin/
+        Cygwin.notify(title, msg, img, total, failures)
+      when /mswin/
+        Windows.notify(title, msg, img)
+      end
+    end
+
+    def pluralize(text, number)
+      "#{number} #{text}#{'s' if number != 1}"
+    end
+
+    def unit_test_message(tests, assertions, failures, errors)
+      "#{pluralize('test', tests)}, #{pluralize('assertion', assertions)}, #{pluralize('failure', failures)}, #{pluralize('error', errors)}"
+    end
+
+    def rspec_message(examples, failures, pendings)
+      "#{pluralize('example', examples)}, #{pluralize('failure', failures)}, #{pendings} pending"
+    end
+
+    def feature_message(scenarios, pending_scenarios, failed_scenarios, steps, pending_steps, failed_steps)
+      "#{pluralize('scenario', scenarios)}, #{pluralize('failure', failed_scenarios)}, #{pending_scenarios} pending\n" +
+      "#{pluralize('step', steps)}, #{pluralize('failure', failed_steps)}, #{pending_steps} pending"
+    end
+  end
+end
+
+%w{ linux mac windows cygwin doom buuf }.each { |x| require "autotest_notification/#{x}" }
+
+if RUBY_PLATFORM == 'java'
+  require 'java'
+  AutotestNotification.const_set :RUBY_PLATFORM, java.lang.System.getProperty('os.name').downcase
+end

data/lib/autotest_notification/buuf.rb

@@ -0,0 +1,9 @@
+module AutotestNotification
+  class Buuf
+    class << self
+      def image(notification)
+        "#{Config.images_directory}/buuf/#{notification}.png"
+      end
+    end
+  end
+end

data/lib/autotest_notification/cygwin.rb

@@ -0,0 +1,34 @@
+module AutotestNotification
+  class Cygwin
+    @last_test_failed = false
+
+    class << self
+      def notify(title, msg, img, total = 1, failures = 0)
+        img = get_image_path(img).strip
+        system "sncmd /m '#{title}' '#{msg}' '#{img}' /t #{Config.expiration_in_seconds}"
+        play(SUCCESS_SOUND) if AutotestNotification.const_defined?("SUCCESS_SOUND") && !SUCCESS_SOUND.empty? && failures == 0
+        play(FAILURE_SOUND) if AutotestNotification.const_defined?("FAILURE_SOUND") && !FAILURE_SOUND.empty? && failures > 0
+        say(total, failures) if DOOM_EDITION
+      end
+      
+      def get_image_path(img)
+        `cygpath -m #{img}`
+      end
+
+      def say(total, failures)
+        if failures > 0
+          Doom.play_sound(total, failures)
+          @last_test_failed = true
+        elsif @last_test_failed
+          Doom.play_sound(total, failures)
+          @last_test_failed = false
+        end
+      end
+
+      def play(sound_file)
+        system "cp #{sound_file} /dev/dsp"
+      end
+
+    end
+  end
+end

data/lib/autotest_notification/doom.rb

@@ -0,0 +1,27 @@
+module AutotestNotification  
+  class Doom
+    class << self
+      def image(total, failures)
+        "#{Config.images_directory}/doom/doom_#{percent(total, failures)}.png"
+      end
+
+      def play_sound(total, failures)
+        sound_file = "#{File.expand_path(File.dirname(__FILE__) + "/../../sounds/doom/")}/#{percent(total, failures)}.wav"
+
+        case RUBY_PLATFORM
+        when /darwin/
+          `#{File.expand_path(File.dirname(__FILE__) + "/../../bin/")}/playsound #{sound_file}`
+        when /linux/
+          system("/usr/bin/mplayer #{sound_file} > /dev/null 2> /dev/null")
+        when /cygwin/
+          system "cp #{sound_file} /dev/dsp"
+        end
+      end
+
+      private
+        def percent(total, failures)
+          percent = failures.zero? ? 0 : ((5 * failures) / total) + 1
+        end
+    end
+  end  
+end

data/lib/autotest_notification/linux.rb

@@ -0,0 +1,58 @@
+module AutotestNotification
+  class Linux
+    class << self
+
+      def notify(title, msg, img, total = 1, failures = 0, priority = 0)
+        Config.expiration_in_seconds = 0 if failures > 0 && STICKY
+
+        if has_notify?
+          notify_send(title, msg, img, priority)
+        elsif has_zenity?
+          zenity(title, msg, img)
+        elsif has_kdialog?
+          kdialog(title, msg, img)
+        end
+
+        say(total, failures) if SPEAKING
+      end
+
+      protected
+
+        def has_notify?
+          system "which notify-send > /dev/null 2>&1"
+        end
+      
+        def has_kdialog?
+          system "which kdialog > /dev/null 2>&1"
+        end
+      
+        def has_zenity?
+          system "which zenity > /dev/null 2>&1"
+        end
+        
+        def notify_send(title, msg, img, priority = 0)
+          urgency = priority > 1 ? 'critical' : priority < 0 ? 'low' : 'normal'
+          system "notify-send -t #{Config.expiration_in_seconds * 1000} -i #{img} -u #{urgency} '#{title}' '#{msg}'"
+        end
+
+        def kdialog(title, msg, img)
+          system "kdialog --title '#{title}' --passivepopup '<img src=\"#{img}\" align=\"middle\"> #{msg}' #{Config.expiration_in_seconds}"
+        end
+
+        def zenity(title, msg, img)
+          system "zenity --info --text='#{msg}' --title='#{title}'"
+        end
+
+        def say(total, failures)
+          if failures > 0
+            DOOM_EDITION ? Doom.play_sound(total, failures) : system("/usr/bin/espeak '#{failures} test#{'s' unless failures == 1} failed'")
+          else
+            DOOM_EDITION ? Doom.play_sound(total, failures) : system("/usr/bin/espeak 'All tests passed successfully'")
+          end
+        rescue
+          puts "You need the #{DOOM_EDITION ? 'mplayer' : 'espeak'} installed to hear the sounds."
+        end
+        
+    end
+  end
+end

data/lib/autotest_notification/mac.rb

@@ -0,0 +1,30 @@
+module AutotestNotification
+  class Mac
+    @last_test_failed = false
+
+    class << self
+      
+      def notify(title, msg, img, total = 1, failures = 0, priority = 0)
+        system "growlnotify -n autotest --image #{img} #{'-s ' if ((failures > 0) and STICKY)}-p #{priority} -m '#{msg}' -t #{title}"
+        play(SUCCESS_SOUND) if AutotestNotification.const_defined?("SUCCESS_SOUND") && !SUCCESS_SOUND.empty? && failures == 0
+        play(FAILURE_SOUND) if AutotestNotification.const_defined?("FAILURE_SOUND") && !FAILURE_SOUND.empty? && failures > 0
+        say(total, failures) if SPEAKING
+      end
+
+      def say(total, failures)
+        if failures > 0
+          DOOM_EDITION ? Doom.play_sound(total, failures) : system("say #{failures} test#{'s' unless failures == 1} failed.")
+          @last_test_failed = true
+        elsif @last_test_failed
+          DOOM_EDITION ? Doom.play_sound(total, failures) : system("say All tests passed successfully.")
+          @last_test_failed = false
+        end
+      end
+      
+      def play(sound_file)
+        `#{File.expand_path(File.dirname(__FILE__) + "/../../bin/")}/playsound #{sound_file}`
+      end
+      
+    end
+  end
+end