growl-glue 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-07-04
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/bin/growl_notify.sh
+lib/growl_glue/autotest.rb
+lib/growl_glue/commands.rb
+lib/growl_glue/config.rb
+lib/growl_glue/util.rb
+lib/growl_glue.rb
+lib/img/fail.png
+lib/img/ok.png

data/README.txt

@@ -0,0 +1,109 @@
+== DESCRIPTION:
+
+Simplifies Growl configuration for Autotest.
+
+== Autotest Features:
+
+* Easy configuration of growl notifications in ~/.autotest
+* Comes bundled with sample green/red images, or you can supply your own
+* Ability to specify OS X speech options (e.g. "Oh No!", if test failure)
+* RSpec support
+* Test::Unit support
+
+== Autotest Growl Integration:
+
+The Autotest growl configuration should happen in ~/.autotest. To get up and running very quickly with basic notifications + images:
+
+  require 'growl_glue'
+  GrowlGlue::Autotest.initialize
+
+  
+If you wish to customize, further, you simply need to supply your own block, to which the GrowlGlue configuration object will be passed:
+
+  require 'growl_glue'
+  GrowlGlue::Autotest.initialize do |config|
+    ...
+  end
+
+It is recommended that you use network notifications due to a bug in Growl on OS X 10.5. Inside of the Growl Preferences pane, on the Network tab, make sure the "Listen for incoming notifications" checkbox is checked, and then *restart Growl*.  Then configure GrowlGlue inside of the setup block:
+
+  config.notification :use_network_notifications => true
+
+OS X Speech:
+
+  config.say :success => "Great Job!", :failure => "WTF mate?"
+
+If you have *sndplay* compiled and in the path, you can have different sounds played based on test success or failure.  The "location" below is optional, as it defaults to "/System/Library/Sounds":
+
+  config.sound :success => "Glass.aiff"
+  config.sound :failure => "Basso.aiff"
+  config.sound :location => "/System/Library/Sounds/" (optional)
+
+GrowlGlue comes with success and error images it will use on test success and error, respectively.
+If you wish to supply your own, for example:
+
+  config.image :success => "~/Library/autotest/success.png"
+  config.image :failure => "~/Library/autotest/failure.png"
+
+By default, "Tests Passed" and "Tests Failed" will be used as the growl titles. You can supply your own, though:
+
+  config.title :success => "Love", :failure => "Hatred"
+
+As an example, this is what I normally use:
+
+  GrowlGlue::Autotest.initialize do |config|
+  
+    config.notification :use_network_notifications => true
+    config.title :success => "Love", :failure => "Hate"
+    config.say :failure => "Something is horribly wrong!"
+  
+  end
+
+
+== REQUIREMENTS:
+
+* Growl 1.1.4 (may work on previous versions but not tested)
+* Growlnotify Extra installed
+
+== OPTIONAL:
+
+* sndplay (for #sound notification)
+
+== INSTALL:
+
+* sudo gem install growl_glue -y
+* Download Growl from http://growl.info
+* After installing Growl, install the Growlnotify Extra included in the DMG
+* After Growl is installed, configure your ~/.autotest file as described above
+
+== BUGS / ISSUES:
+
+Please let me know (gluedtomyseat@gmail.com) if you encounter any issues.  You can also follow or fork development on the github project:
+
+http://github.com/oculardisaster/growl-glue/tree/master
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Nimble Technique, LLC
+
+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,16 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/growl_glue.rb'
+
+Hoe.new('growl-glue', GrowlGlue::VERSION) do |p|
+  # p.rubyforge_name = 'GrowlGluex' # if different than lowercase project name
+  p.developer('Collin VanDyck', 'gluedtomyseat@gmail.com')
+  p.remote_rdoc_dir = '' # Release to root
+  p.description = "Easy configuration of Growl + Autotest"
+  p.summary = "Easy configuration of Growl + Autotest"
+  
+end
+
+# vim: syntax=Ruby

data/lib/bin/growl_notify.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+# growlnotify leopard bug workaround
+list_args()
+{
+  for p in "$@"
+  do
+    if [ "${p:0:1}" == "-" ];then
+      echo -n "$p "
+    else
+      echo -n "\"$p\" "
+    fi
+  done
+}
+argstr=$(list_args "${@:$?}")
+echo "-H localhost $argstr" | xargs `which growlnotify`

data/lib/growl_glue/autotest.rb

@@ -0,0 +1,113 @@
+module GrowlGlue
+  class Autotest
+    [Util, Commands].each { |cls| extend cls }
+    
+    ERROR_PRI = 2
+    
+    def self.initialize
+      @config = Config.new
+      
+      @config.sound :location => "/System/Library/Sounds/"
+      @config.commands :safe_growlnotify => File.join(gem_home_dir, "lib", "bin", "growl_notify.sh")
+      
+      @config.image :failure => File.join(gem_home_dir, "lib", "img", "fail.png")
+      @config.image :success => File.join(gem_home_dir, "lib", "img", "ok.png")
+      
+      @config.title :success => "Tests Passed"
+      @config.title :failure => "Tests Failed"
+      
+      yield @config if block_given?
+      
+      add_hook
+    end
+    
+    private 
+    
+    def self.gem_home_dir
+      File.join File.dirname(__FILE__), "..", ".."
+    end
+
+    def self.add_hook
+      ::Autotest.add_hook :ran_command do |at|  
+        with([at.results].flatten.join("\n")) do |results|
+          process_results(results)
+        end
+      end  
+    end
+
+    def self.growl(title, msg, img=nil, pri=1, sticky="")
+      command = []
+      
+      if @config.option(:notification, :use_network_notifications)
+        command << @config.option(:commands, :safe_growlnotify)
+      else
+        command << "growlnotify"
+      end
+      command << "--image #{img}" if img
+      command << "-n autotest"
+      command << "-p #{pri}"
+      command << "-m #{msg.inspect}"
+      command << title
+      command << sticky
+      command.join(" ")
+    end
+
+    def self.say(msg)
+      if msg
+        "say '#{msg.gsub(/'/,"")}'"
+      end
+    end
+
+    def self.sndplay(sound)
+      location = @config.option :sound, :location
+      if sound and location
+        "sndplay #{location}/#{sound} > /dev/null 2>&1"
+      end
+    end
+
+    def self.notify(title, msg, img=nil, pri=1)
+      with_commands do |commands|
+        commands << growl(title, msg, img, pri)
+
+        if pri == ERROR_PRI
+          commands << say(@config.option(:say, :failure))
+          commands << sndplay(@config.option(:sound, :failure))
+        else
+          commands << say(@config.option(:say, :success))
+          commands << sndplay(@config.option(:sound, :success))
+        end
+      end
+    end
+
+    # handles rspec results
+    def self.rspec_results(results)
+      output = results.slice(/(\d+)\s+examples?,\s*(\d+)\s+failures?(,\s*(\d+)\s+pending)?/)  
+      if output  
+        if $~[2].to_i > 0  
+          notify @config.option(:title, :failure), "#{output}", @config.option(:image, :failure), 2  
+        else  
+          notify @config.option(:title, :success), "#{output}", @config.option(:image, :success)   
+        end  
+      end  
+    end
+
+    # handles test::unit results
+    def self.test_results(results)
+      output = results.slice(/(\d+)\s+tests?,\s*(\d+)\s+assertions?,\s*(\d+)\s+failures?,\s*(\d+)\s+errors?/)  
+      if output  
+        if (($~[3].to_i > 0) or ($~[4].to_i > 0))  
+          notify @config.option(:title, :failure), "#{output}",  @config.option(:image, :failure), 2  
+        else  
+          notify @config.option(:title, :success), "#{output}",  @config.option(:image, :success)   
+        end  
+      end  
+    end
+
+    def self.process_results(results)
+      rspec_results(results)
+      test_results(results)
+    end
+    
+    
+  end
+end

data/lib/growl_glue/commands.rb

@@ -0,0 +1,13 @@
+module GrowlGlue
+  module Commands
+    extend Util
+    
+    def with_commands
+      with([]) do |commands|
+        yield commands
+        commands.compact.each { |command| system(command) }
+      end
+    end
+    
+  end
+end

data/lib/growl_glue/config.rb

@@ -0,0 +1,29 @@
+module GrowlGlue
+  
+  class Config
+    attr_reader :options
+    
+    def initialize
+      @options={}
+    end
+
+    # returns a nested option value
+    def option(*keys)
+      option = @options
+      until keys.empty? or option.nil?
+        option = option[keys.shift]
+      end
+      option
+    end
+
+    def method_missing(name, *args, &block)
+      self.set_options(name, *args)
+    end
+    
+    def set_options(key, opts)
+      @options[key] ||= {}
+      @options[key].merge!(opts)
+    end
+  end
+  
+end

data/lib/growl_glue/util.rb

@@ -0,0 +1,10 @@
+module GrowlGlue
+  module Util
+    
+    def with(obj)
+      yield obj
+      obj
+    end
+    
+  end
+end

data/lib/growl_glue.rb

@@ -0,0 +1,8 @@
+%w(util commands config autotest).each do |file| 
+  require File.join(File.dirname(__FILE__), "growl_glue/#{file}.rb")
+end
+
+module GrowlGlue
+  VERSION = '1.0.0'
+  
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: growl-glue
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Collin VanDyck
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPDCCAiSgAwIBAgIBADANBgkqhkiG9w0BAQUFADBEMRYwFAYDVQQDDA1nbHVl
+  ZHRvbXlzZWF0MRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
+  FgNjb20wHhcNMDgwNzA1MTQxMDQ0WhcNMDkwNzA1MTQxMDQ0WjBEMRYwFAYDVQQD
+  DA1nbHVlZHRvbXlzZWF0MRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJ
+  k/IsZAEZFgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCxzsxS
+  Gbn4WqVr0ASyg1uLNePFDCItoIBO2aTOdPOqdYe3U7Fd2MiWjRy1Z7+vtgTGOw2t
+  AoyknDBba+Bydm3MB3I3KP6l71LZ5ZYmCQzPvgcFjWbQnJSG5ofROUM5zjZbVx3P
+  ochIBNVQlwXGDMCdT568KcWAkR5lUlrGl5IoTwezeT05d8k9xZlivP1tmMSMgMTg
+  DY+9ymQXpTxGiQ29Kc1APfQEgOR48HIS3uGaXXclsdYouA02Uj3Yv/z+yzKZI9UH
+  MQUiAcqXWc1wxYslYmztTEJGmAQ8nrkP1EJP3t2A62nLPaH1c+ouz48ujWRH4/tV
+  vpwvCwYvR54o2lZpAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0G
+  A1UdDgQWBBTgKbCB/wIXhLeePx2M+tvzr3XMvjANBgkqhkiG9w0BAQUFAAOCAQEA
+  pIU5PinqCLyUTisCNPvwwcz5mJQ1Z+OBLh4K4HGoZs2Tu3oNpEtKkNfgEiVTh3Dg
+  9BlFxVgAZZABNLrBKLkTlYtvjyYEIL3DFPU1Hh4sqAGTd67RXZ5Uen+ldO+bXYT8
+  IB+pt7uev+4hvCUROqRlWQcYVfxXlYpuH4pAYAKmx55x6jcp8mKlHb/CJ52hPEam
+  i6nPl4R+RQ/Qg5Q99OuWDww5Pt5xOY50sOrDD+momkdf1KHPiQix6zB3WCy2QUn+
+  AVD9HizuKv4ppv+434afNyHlctXAnJbVzCLwBIxjiaeUi2Wtbo+0NhccuFSXVCrR
+  jA8FHf4HdyRgbrpT6Mws7g==
+  -----END CERTIFICATE-----
+
+date: 2008-07-05 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: Easy configuration of Growl + Autotest
+email: 
+- gluedtomyseat@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/bin/growl_notify.sh
+- lib/growl_glue/autotest.rb
+- lib/growl_glue/commands.rb
+- lib/growl_glue/config.rb
+- lib/growl_glue/util.rb
+- lib/growl_glue.rb
+- lib/img/fail.png
+- lib/img/ok.png
+has_rdoc: true
+homepage: Simplifies Growl configuration for Autotest.
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: []
+
+rubyforge_project: growl-glue
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Easy configuration of Growl + Autotest
+test_files: []
+

metadata.gz.sig

@@ -0,0 +1,2 @@
+#|N�S.�28�p*�R����B��McFe���d���7o�����p���J�� aU>mf��
+Sy�v۸��'���g
�a��#���������Y�J�$"&�=��+Z4��t���$(�" �s�Vj5�ҙ���W�