chjunior-autotest-notification 0.0.8

data/History.txt

@@ -0,0 +1,10 @@
+== 0.0.1 2008-05-11
+
+* 0.0.7:
+	* Added support to Windows.
+
+* 0.0.4:
+	* Added an-uninstall to remove the autotest hook.
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Carlos Brando
+
+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/Manifest.txt

@@ -0,0 +1,30 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/autotest_notification.rb
+lib/autotest_notification/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_autotest_notification.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb
+bin/an-install
+bin/an-uninstall
+images/pass.png
+images/fail.png
+autotest-notification.gemspec

data/PostInstall.txt

@@ -0,0 +1,9 @@
+
+For more information on autotest_notification, see http://github.com/carlosbrando/autotest-notification/
+
+To turn on the notifier you need to run the following command:
+  an-install
+
+To turn off:
+  an-uninstall
+

data/README.txt

@@ -0,0 +1,55 @@
+= The Autotest Notification Gem
+
+* http://www.nomedojogo.com/2008/05/12/autotest-notification-gem/
+
+== DESCRIPTION:
+
+This gem set the autotest (ZenTest) to send messages to software as Growl or LibNotify, displaying a window with the results.
+
+== FEATURES/PROBLEMS:
+
+* Running on Mac (Growl), Linux (LibNotify) and Windows (Snarl).
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+	$ sudo gem install carlosbrando-autotest-notification --source=http://gems.github.com
+	
+Run it:
+
+	$ an-install
+
+== Contributors
+
+* carlosbrando
+* simpsomboy
+* urubatan
+* chjunior
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/autotest-notification.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  s.name = %q{autotest-notification}
+  s.version = "0.0.8"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Carlos Brando", "Rodrigo Urubatan", "Alexandre da Silva", "Carlos Júnior"]
+  s.date = %q{2008-05-12}
+  s.description = %q{Set the autotest to display messages on the operating system using software such as Growl and LibNotify.}
+  s.email = ["eduardobrando@gmail.com"]
+  s.executables = ["an-install", "an-uninstall"]
+  s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.txt", "website/index.txt"]
+  s.files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.txt", "Rakefile", "config/hoe.rb", "config/requirements.rb", "lib/autotest_notification.rb", "lib/autotest_notification/version.rb", "script/console", "script/destroy", "script/generate", "script/txt2html", "setup.rb", "tasks/deployment.rake", "tasks/environment.rake", "tasks/website.rake", "test/test_autotest_notification.rb", "test/test_helper.rb", "website/index.html", "website/index.txt", "website/javascripts/rounded_corners_lite.inc.js", "website/stylesheets/screen.css", "website/template.html.erb", "bin/an-install", "bin/an-uninstall", "images/pass.png", "images/fail.png", "autotest-notification.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/carlosbrando/autotest-notification/}
+  s.post_install_message = %q{
+For more information on autotest_notification, see http://github.com/carlosbrando/autotest-notification/
+
+To turn on the notifier you need to run the following command:
+  an-install
+
+To turn off:
+  an-uninstall
+
+}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{}
+  s.rubygems_version = %q{1.1.1}
+  s.summary = %q{Set the autotest to display messages on the operating system using software such as Growl and LibNotify.}
+  s.test_files = ["test/test_autotest_notification.rb", "test/test_helper.rb"]
+end

data/bin/an-install

@@ -0,0 +1,50 @@
+#!/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'
+require 'ftools'
+
+# 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: ~") { |OPTIONS[: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]
+
+f = File.new(File.expand_path(path) + "/.autotest",  "w")
+f.write "# ~.autotest\n"
+f.write "require 'autotest_notification'"
+f.close
+puts "\nAs from now all tests will be notified automatically."
+puts "" # a blank line

data/bin/an-uninstall

@@ -0,0 +1,50 @@
+#!/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'
+require 'ftools'
+
+# 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: ~") { |OPTIONS[: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,73 @@
+require 'autotest_notification/version'
+
+AUTHOR = "Carlos Brando"
+EMAIL = "eduardobrando@gmail.com"
+DESCRIPTION = "Set the autotest to display messages on the operating system using software such as Growl and LibNotify."
+GEM_NAME = 'autotest-notification' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = '' # 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 = [
+#  ['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].each do |req_gem|
+  begin
+    require req_gem
+  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,90 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module AutotestNotification
+  FAIL    = -1
+  PENDING = 0
+  SUCCESS = 1
+
+  EXPIRATION_IN_SECONDS = 3
+
+  IMAGES_DIRECTORY = File.expand_path(File.dirname(__FILE__) + "/../images/")
+  SUCCESS_IMAGE    = "#{IMAGES_DIRECTORY}/pass.png"
+  FAIL_IMAGE       = "#{IMAGES_DIRECTORY}/fail.png"
+
+  Autotest.add_hook :ran_command do |at|
+    result = at.results.split("\n").last.to_s
+    if result
+
+      # Test::Unit
+      tests      = result =~ /(\d+) test/ ? $1.to_i : 0
+      assertions = result =~ /(\d+) assertion/ ? $1.to_i : 0
+      errors     = result =~ /(\d+) error/ ? $1.to_i : 0
+
+      # RSpec
+      examples   = result =~ /(\d+) example/ ? $1.to_i : 0
+      pendings   = result =~ /(\d+) pending/ ? $1.to_i : 0
+
+      # Shared
+      failures   = result =~ /(\d+) failure/ ? $1.to_i : 0
+
+      code = 32
+      msg = if result =~ /test/
+        code = 31 if failures > 0 || errors > 0
+        "#{pluralize('test', tests)}, #{pluralize('assertion', assertions)}, #{pluralize('failure', failures)}, #{pluralize('error', errors)}"
+      else
+        code = (failures > 0) ? 31 : (pendings > 0) ? 33 : 32
+        "#{pluralize('example', examples)}, #{pluralize('failure', failures)}, #{pendings} pending"
+      end
+
+      if failures > 0 || errors > 0
+        notify "FAIL", msg, FAIL_IMAGE, 2
+      else
+        notify "Pass", msg, SUCCESS_IMAGE
+      end
+
+      puts "\e[#{code}m#{'=' * 80}\e[0m\n\n"
+    end
+  end
+
+  class << self
+    def notify(title, msg, img = SUCCESS_IMAGE, pri = 0)
+      case RUBY_PLATFORM
+      when /linux/
+        has_notify?? notify_send(title, msg, img) : kdialog(title, msg, img)
+      when /darwin/
+        growl(title, msg, img, pri)
+      when /cygwin/
+        img = `cygpath -m #{img}`
+        snarl(title, msg, img.strip)
+      when /mswin/
+        snarl(title, msg, img)
+      end
+    end
+
+    def pluralize(text, number)
+      "#{number} #{text}#{'s' if number != 1}"
+    end
+
+    def growl(title, msg, img, pri = 0)
+      system "growlnotify -n autotest --image #{img} -p #{pri} -m #{msg.inspect} #{title}"
+    end
+
+    def notify_send(title, msg, img)
+      system "notify-send -t #{EXPIRATION_IN_SECONDS * 1000} -i #{img} '#{title}' '#{msg}'"
+    end
+
+    def kdialog(title, msg, img)
+      system "kdialog --title '#{title}' --passivepopup '#{msg}' #{EXPIRATION_IN_SECONDS}"
+    end
+
+    def has_notify?
+      system "which notify-send 2> /dev/null"
+    end
+
+    def snarl(title, msg, img)
+      message = "sncmd /m '#{title}' '#{msg}' '#{img}' /t #{EXPIRATION_IN_SECONDS}"
+      system message
+    end
+  end
+end