carlosbrando-autotest-notification 1.7.2 → 1.7.3

data/History.txt

@@ -1,34 +1,29 @@
-== 1.7.0 2008-11-13
-
-* 1.7.0 - Nov 13, 2008
-	* Update to new newgem gem.
-
-* 1.6.0 - Oct 08, 2008
+1.6.0 - Oct 08, 2008
   * Buuf Edition - display Buuf icons by Mattahan [http://mattahan.deviantart.com] (samflores)
   * Added --sticky flag to an-install to keep notifications on screen in case of errors/failures or pending specs (samflores)
   * Pending notifications now have a priority different from Passed and Failled notifications, to allow set diff color with Growl (samflores)
 
-* 1.5.0 - Oct 02, 2008
+1.5.0 - Oct 02, 2008
 	* If an-install is run with --pending, shows a yellow warning when there are no errors/failures but there are pending specs. (lucasuyezu)
 
-* 1.4.0 - Jun 18, 2008
+1.4.0 - Jun 18, 2008
 	* Special Doom Edition for Linux (ozsantana)
 
-* 1.3.1 - Jun 18, 2008
+1.3.1 - Jun 18, 2008
 	* Added backup to old .autotest file (tchandy)
 
-* 1.3.0 - Jun 18, 2008
+1.3.0 - Jun 18, 2008
 	* Added Doom sounds.
 
-* 1.2.0 - Jun 17, 2008
+1.2.0 - Jun 17, 2008
 	* Special Doom Edition
 
-* 1.1.2
+1.1.2
 	* Refactoring code. 
 
 * 1.1.1 
 	* Changed to speak when passing the tests after a series of failures. Only in Mac.
-
+	
 * 1.1.0
 	* Now speaking in Linux too.
 
@@ -58,3 +53,6 @@
 
 * 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

@@ -1,11 +1,45 @@
+autotest-notification.gemspec
 History.txt
+License.txt
 Manifest.txt
 PostInstall.txt
-README.rdoc
+README.txt
 Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/autotest_notification.rb
+lib/autotest_notification/version.rb
+lib/autotest_notification/linux.rb
+lib/autotest_notification/windows.rb
+lib/autotest_notification/cygwin.rb
+lib/autotest_notification/mac.rb
+lib/autotest_notification/doom.rb
+lib/autotest_notification/buuf.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
+test/autotest_notification/test_cygwin.rb
+test/autotest_notification/test_linux.rb
+test/autotest_notification/test_windows.rb
+test/autotest_notification/test_mac.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
 bin/playsound
+images/pass.png
+images/fail.png
+images/pending.png
 images/buuf/fail.png
 images/buuf/pass.png
 images/buuf/pending.png
@@ -16,27 +50,10 @@ images/doom/doom_3.png
 images/doom/doom_4.png
 images/doom/doom_5.png
 images/doom/doom_6.png
-images/fail.png
-images/pass.png
-images/pending.png
-lib/an_install/cli.rb
-lib/an_uninstall/cli.rb
-lib/autotest_notification.rb
-script/console
-script/destroy
-script/generate
 sounds/doom/0.wav
 sounds/doom/1.wav
 sounds/doom/2.wav
 sounds/doom/3.wav
 sounds/doom/4.wav
 sounds/doom/5.wav
-sounds/doom/6.wav
-test/autotest_notification/test_cygwin.rb
-test/autotest_notification/test_linux.rb
-test/autotest_notification/test_mac.rb
-test/autotest_notification/test_windows.rb
-test/test_an-install_cli.rb
-test/test_an-uninstall_cli.rb
-test/test_autotest_notification.rb
-test/test_helper.rb
+sounds/doom/6.wav

data/README.txt

@@ -0,0 +1,138 @@
+= THE AUTOTEST NOTIFICATION GEM
+
+* http://github.com/carlosbrando/autotest-notification/
+
+
+== DESCRIPTION:
+
+This gem set the autotest (ZenTest) to send messages to software as Growl, LibNotify, and Snarl, displaying a window with the results.
+
+
+== REQUIREMENTS:
+
+Independent of operating system you are using, you must install the ZenTest:
+
+	$ gem install ZenTest
+
+
+* If you're using a Mac:
+    You need to have Growl and growlnotify installed on your machine.
+    
+    Download the Growl [http://growl.info/index.php] and install it like any other application on your Mac
+    
+    Then you must install the growlnotify.
+    
+    In your shell, cd to the directory on the Growl disk image containing growlnotify, and type ./install.sh.
+    That script will install growlnotify to /usr/local/bin and the manpage to /usr/local/man.
+
+    If you want to be notified with voice of the test results, when running an-install, pass a "-s" switch, when you do not want voices notifications anymore, just run it again without the "-s" switch.
+
+    
+* If you're using Windows (with cygwin):
+    You need to have Snarl and sncmd installed on your machine.
+    
+    Download Snarl [http://www.fullphat.net/] and install it like any other application on your machine.
+    
+    Then download sncmd [http://www.k23productions.com/download.php?view.105] open the zip file and place 
+    the executable from the zip in any directory in windows PATH (for example c:\windows).
+
+
+* If you're using Windows (without cygwin):
+    You need to have Snarl, diffutils and ruby-snarl installed on your machine.
+
+    Download Snarl [http://www.fullphat.net/] and install it like any other application on your machine.
+
+    Download DiffUtils for Windows [http://gnuwin32.sourceforge.net/packages/diffutils.htm] and follow the installation instructions on the site.
+    
+    Run in the command prompt:
+
+			$ gem install ruby-snarl
+    
+    After all that. You must update the environment variable PATH with the path to the bin of diffutils.
+    It's the price that was paid for using Windows (try cygwin).
+    
+    
+* If you're using Linux:
+    You need to have libnotify binaries installed.
+    
+    For ubuntu this means: sudo apt-get install libnotify-bin
+    
+    Other distributions may package it with other names, do a search for libnotify using your distribution package manager.
+    
+    If you use KDE and do not have libnotify-bin installed, it will try to use kdialog wich is part of KDE.
+    It also works if you have zenity installed.
+
+    If you want to be notified with voice of the test results, instal espeak [http://espeak.sourceforge.net/] too, it is not needed.
+    And when running an-install, pass a "-s" switch, when you do not want voices notifications anymore, just run it again without the "-s" switch.
+
+		To hear the sounds of Doom Edition, you need the mplayer [http://www.mplayerhq.hu/design7/dload.html] installed.
+
+
+== INSTALL:
+
+  $ sudo gem install carlosbrando-autotest-notification --source=http://gems.github.com
+  
+Run it to let the notifier in automatic mode:
+
+  $ an-install
+
+In Windows without cygwin, it's necessary to install in the directory of the project:
+  
+  $ an-install --path=C:\projects\my_project
+
+To turn off the notifier:
+  
+  $ an-uninstall
+
+
+== Special Doom Edition
+
+	$ an-install --doom --speaking
+
+== Buuf Edition - Display Buuf icons by Mattahan [http://mattahan.deviantart.com]
+
+	$ an-install --buuf
+
+== Showing a yellow warning image when there are no errors/failures but there are pending specs
+
+	$ an-install --pending
+
+== CONTRIBUTORS:
+
+* carlosbrando [http://www.nomedojogo.com]
+* simpsomboy [http://alexandredasilva.wordpress.com]
+* urubatan [http://www.urubatan.info]
+* chjunior [http://tas.milk-it.net]
+* daviscabral [http://blog.impactmedia.com.br]
+* tapajos [http://www.improveit.com.br/tapajos]
+* tchandy [http://tchandy.wordpress.com]
+* ozsantana [http://blog.iconcreative.net]
+* lucasuyezu [http://xucros.com]
+* samflores [http://www.thoughtsoverflow.com]
+* dcrec1 [http://www.mouseoverstudio.com/blog]
+* nuxlli [http://www.nuxlli.com.br]
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008
+
+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

@@ -1,28 +1,4 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/autotest_notification'
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('autotest-notification', AutotestNotification::VERSION) do |p|
-  p.developer('Carlos Brando', 'eduardobrando@gmail.com')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  p.rubyforge_name       = p.name # TODO this is default value
-  p.extra_deps         = [
-    ['ZenTest', '>= 3.9.2']
-  ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
-end
-
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# task :default => [:spec, :features]
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/autotest-notification.gemspec

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{autotest-notification}
+  s.version = "1.7.3"
+
+  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\303\272nior", "Davis Zanetti Cabral", "Marcos Tapaj\303\263s", "Thiago Pradi", "Oz\303\251ias Sant'ana", "Samuel Flores", "Diego Carrion"]
+  s.date = %q{2008-11-14}
+  s.description = %q{This gem set the autotest (ZenTest) to send messages to software as Growl, LibNotify, and Snarl, displaying a window with the results.}
+  s.email = ["autotest-notification@carlosbrando.com"]
+  s.executables = ["an-install", "an-uninstall", "playsound"]
+  s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.txt", "website/index.txt"]
+  s.files = ["autotest-notification.gemspec", "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", "lib/autotest_notification/linux.rb", "lib/autotest_notification/windows.rb", "lib/autotest_notification/cygwin.rb", "lib/autotest_notification/mac.rb", "lib/autotest_notification/doom.rb", "lib/autotest_notification/buuf.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", "test/autotest_notification/test_cygwin.rb", "test/autotest_notification/test_linux.rb", "test/autotest_notification/test_windows.rb", "test/autotest_notification/test_mac.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", "bin/playsound", "images/pass.png", "images/fail.png", "images/pending.png", "images/buuf/fail.png", "images/buuf/pass.png", "images/buuf/pending.png", "images/doom/doom_0.png", "images/doom/doom_1.png", "images/doom/doom_2.png", "images/doom/doom_3.png", "images/doom/doom_4.png", "images/doom/doom_5.png", "images/doom/doom_6.png", "sounds/doom/0.wav", "sounds/doom/1.wav", "sounds/doom/2.wav", "sounds/doom/3.wav", "sounds/doom/4.wav", "sounds/doom/5.wav", "sounds/doom/6.wav"]
+  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{autotest-notification}
+  s.rubygems_version = %q{1.3.0}
+  s.summary = %q{This gem set the autotest (ZenTest) to send messages to software as Growl, LibNotify, and Snarl, displaying a window with the results.}
+  s.test_files = ["test/autotest_notification/test_cygwin.rb", "test/autotest_notification/test_linux.rb", "test/autotest_notification/test_mac.rb", "test/autotest_notification/test_windows.rb", "test/test_autotest_notification.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ZenTest>, [">= 3.9.2"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<ZenTest>, [">= 3.9.2"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<ZenTest>, [">= 3.9.2"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/bin/an-install

@@ -1,10 +1,91 @@
 #!/usr/bin/env ruby
-#
-#  Created on 2008-11-14.
+# 
+#  Created on 2008-5-11.
 #  Copyright (c) 2008. All rights reserved.
 
-require File.expand_path(File.dirname(__FILE__) + "/../lib/autotest-notification")
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
 
-require "an_install/cli"
+require 'optparse'
+require 'ftools'
 
-AnInstall::CLI.execute(STDOUT, ARGV)
+# NOTE: the option -p/--path= is given as an example, and should probably be replaced in your application.
+
+OPTIONS = {
+  :path     => '~',
+  :speaking => false,
+  :doom => false,
+  :sticky => false,
+  :pending => false,
+  :buuf => false
+}
+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("-s", "--speaking",
+          "If a test failed, the computer will speak.",
+          "For all plataforms.") { |OPTIONS[:speaking]| OPTIONS[:speaking] = true }
+          
+  opts.on("-d", "--doom",
+          "Special Doom Edition.",
+          "Only for Mac.") { |OPTIONS[:doom]| OPTIONS[:doom] = true }
+  
+  opts.on("-b", "--buuf",
+          "Special Buuf Images.",
+          "For all platforms") { |OPTIONS[:buuf]| }
+          
+  opts.on("--pending",
+          "Shows a different image when there are no errors/failures",
+          "but there are pending specs. Only for Mac.") { |OPTIONS[:pending]| OPTIONS[:pending] = true }
+    
+  opts.on("--sticky",
+          "Keep notification on screen in case of errros/failures or pending specs.",
+          "Only for Mac.") { |OPTIONS[:sticky]| OPTIONS[:sticky] = true }
+
+  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_path = File.expand_path(path)
+
+if File.exists?("#{autotest_path}/.autotest")
+  puts "\nYou Already have a .autotest file, renamed to .autotest.backup"
+  FileUtils.cp "#{autotest_path}/.autotest", "#{autotest_path}/.autotest.backup"
+end
+
+f = File.new("#{autotest_path}/.autotest",  "w")
+f.write "# ~.autotest\n"
+f.write "require 'autotest_notification'\n"
+f.write("SPEAKING = #{OPTIONS[:speaking]}\n")
+f.write("DOOM_EDITION = #{OPTIONS[:doom]}\n")
+f.write("BUUF = #{OPTIONS[:buuf]}\n")
+f.write("PENDING = #{OPTIONS[:pending]}\n")
+f.write("STICKY = #{OPTIONS[:sticky]}\n")
+f.close
+
+puts "\nAs from now all tests will be notified automatically."
+puts "" # a blank line