tenderlove-meow 2.1.0.20081101124146

data/.autotest

@@ -0,0 +1,3 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+
+require 'meow/autotest'

data/CHANGELOG.rdoc

@@ -0,0 +1,36 @@
+=== 2.1.0
+
+* 2 Minor enhancements
+
+  * Autotest integration.  Just add this to your .autotest file:
+      require 'meow/autotest'
+  * The icon option now takes a string which is assumed to be the path to an
+    icon.
+
+
+=== 2.0.0
+
+* 1 Major enhancement
+
+  * Run and stop methods have been removed (Thanks David Billskog!)
+
+* 3 Bugfixes
+
+  * Updated Ruby/Cocoa syntax conventions
+  * Fixed a typo with "sticky" options
+  * Updated copyright
+
+=== 1.1.0 / 2008-06-13
+
+* 3 major enhancements
+
+  * Added click callbacks so that Meow can be notified of clicks.
+  * Added Meow.run() to block and wait for clicks
+  * Meow.import_image() returns an image suitable for icon use
+
+=== 1.0.0 / 2008-06-05
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,16 @@
+.autotest
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+icons/fail.png
+icons/initialize.jpeg
+icons/pass.png
+lib/meow.rb
+lib/meow/autotest.rb
+lib/meow/notifier.rb
+meow.gemspec
+test/assets/aaron.jpeg
+test/helper.rb
+test/test_meow.rb
+vendor/hoe.rb

data/README.rdoc

@@ -0,0 +1,64 @@
+= meow
+
+* http://meow.rubyforge.org/
+
+== DESCRIPTION:
+
+Send Growl notifications via Ruby.
+
+== SYNOPSIS:
+
+  meep = Meow.new('Meow Test')
+  meep.notify('Title', 'Description')
+
+  ## Handle clicks
+  meep.notify('Click Me', 'Do it!') do
+    puts "I got clicked!"
+  end
+  Meow.start  # Start blocks
+
+== REQUIREMENTS:
+
+* Growl: http://growl.info
+
+== INSTALL:
+
+* install Growl: http://growl.info
+* sudo gem install meow
+
+== THANKS:
+
+Thanks to the Growl team!  This code is heavily based on their ruby example.
+Thanks to Satoshi for the click code from Lime Chat.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008:
+
+* {Aaron Patterson}[http://tenderlovemaking.com]
+* Evan Phoenix
+* Eric Hodel
+* Justin Palmer
+* Satoshi Nakagawa
+* David Billskog
+
+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,24 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require './vendor/hoe.rb'
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'meow'
+
+HOE = Hoe.new('meow', Meow::VERSION) do |p|
+  p.readme  = 'README.rdoc'
+  p.history = 'CHANGELOG.rdoc'
+  p.developer('Aaron Patterson', 'aaronp@rubyforge.org')
+end
+
+namespace :gem do
+  task :spec do
+    File.open("#{HOE.name}.gemspec", 'w') do |f|
+      HOE.spec.version = "#{HOE.version}.#{Time.now.strftime("%Y%m%d%H%M%S")}"
+      f.write(HOE.spec.to_ruby)
+    end
+  end
+end
+
+# vim: syntax=Ruby

data/lib/meow.rb

@@ -0,0 +1,183 @@
+require 'osx/cocoa'
+require 'meow/notifier'
+
+class Meow
+  VERSION = '2.1.0'
+  PRIORITIES = {  :very_low   => -2,
+                  :moderate   => -1,
+                  :normal     =>  0,
+                  :high       =>  1,
+                  :emergency  =>  2,
+  }
+
+  GROWL_IS_READY = "Lend Me Some Sugar; I Am Your Neighbor!"
+  GROWL_NOTIFICATION_CLICKED = "GrowlClicked!"
+  GROWL_NOTIFICATION_TIMED_OUT = "GrowlTimedOut!"
+  GROWL_KEY_CLICKED_CONTEXT = "ClickedContext"
+
+  # This sets up shared state properly that Cocoa uses.
+  @@application = OSX::NSApplication.sharedApplication
+
+  # Holds blocks waiting for clicks
+  @@callbacks = Notifier.new
+  @@callbacks.setup
+
+  # The thread that is responsible for catching native callbacks.
+  @@background_runner = nil
+
+  class << self
+    ###
+    # Send a message in one call.
+    #
+    # Example:
+    #   Meow.notify('Meow', 'Title', 'Description', :priority => :very_high)
+    def notify(name, title, description, opts = {})
+      new(name).notify(title, description, opts)
+    end
+
+    ##
+    # Convert +image+ to an NSImage that displays nicely in growl. If
+    # +image+ is a String, it's assumed to be the path to an image
+    # on disk and is loaded.
+    def import_image(image, size=128)
+      if image.kind_of? String
+        image = OSX::NSImage.alloc.initWithContentsOfFile image
+      end
+
+      return image if image.size.width.to_i == 128
+
+      new_image = OSX::NSImage.alloc.initWithSize(OSX.NSMakeSize(size, size))
+      new_image.lockFocus
+      image.drawInRect_fromRect_operation_fraction(
+        OSX.NSMakeRect(0, 0, size, size),
+        OSX.NSMakeRect(0, 0, image.size.width, image.size.height),
+        OSX::NSCompositeSourceOver, 1.0)
+      new_image.unlockFocus
+
+      return new_image
+    end
+  end
+
+  attr_accessor :name, :note_type, :icon
+
+  ###
+  # Create a new Meow object.
+  #
+  # * +name+ is the application name.
+  # * +note_type+ is the type of note you send.
+  # * +icon+ is the icon displayed in the notification.
+  #
+  # Example:
+  #   note = Meow.new('My Application')
+  def initialize(name, note_type = 'Note', icon = OSX::NSWorkspace.sharedWorkspace.iconForFileType('rb'))
+    @name       = name
+    @icon       = icon
+    @note_type  = note_type
+    @registered = []
+
+    @pid = OSX::NSProcessInfo.processInfo.processIdentifier
+
+    # The notification name to look for when someone clicks on a notify bubble
+    # or the bubble is timed out.
+    @clicked_name = "#{name}-#{@pid}-#{GROWL_NOTIFICATION_CLICKED}"
+    @timeout_name = "#{name}-#{@pid}-#{GROWL_NOTIFICATION_TIMED_OUT}"
+
+    notify_center = OSX::NSDistributedNotificationCenter.defaultCenter
+    notify_center.objc_send(:addObserver, @@callbacks,
+                            :selector, "clicked:",
+                            :name, @clicked_name,
+                            :object, nil)
+    notify_center.objc_send(:addObserver, @@callbacks,
+                            :selector, "timeout:",
+                            :name, @timeout_name,
+                            :object, nil)
+
+    start_runner unless @@background_runner
+  end
+
+  ###
+  # Send a notification to growl.
+  #
+  # * +title+ will be the title of the message.
+  # * +description+ is the description of the message
+  # * +opts+ is a hash of options.
+  # * +block+ is an optional block passed to +notify+. The block
+  #   is called when someone clicks on the growl bubble.
+  #
+  # Possible values for +opts+ are:
+  # * :priority   => Set the note priority
+  # * :icon       => Override the current icon
+  # * :note_type  => Override the current note type
+  #
+  # See Meow::PRIORITIES for the possible priorities.
+  #
+  # Example:
+  #   note.notify('title', 'description', :priority => :very_low)
+  def notify(title, description, opts = {}, &block)
+    opts = {
+      :icon       => icon,
+      :sticky     => false,
+      :note_type  => note_type,
+      :priority   => 0
+    }.merge(opts)
+
+    register(opts[:note_type]) unless @registered.include?(opts[:note_type])
+    opts[:icon] = Meow.import_image(opts[:icon]) if opts[:icon].is_a?(String)
+
+    notification = {
+      :ApplicationName   => name,
+      :ApplicationPID    => @pid,
+      :NotificationName  => opts[:note_type],
+      :NotificationTitle => title,
+      :NotificationDescription => description,
+      :NotificationIcon  => opts[:icon].TIFFRepresentation(),
+      :NotificationPriority => opts[:priority].to_i
+    }
+
+    notification[:NotificationAppIcon] = opts[:app_icon].TIFFRepresentation if opts[:app_icon]
+    notification[:NotificationSticky] = OSX::NSNumber.numberWithBool(true) if opts[:sticky]
+
+    notify_center = OSX::NSDistributedNotificationCenter.defaultCenter
+
+    if block
+      notification[:NotificationClickContext] = @@callbacks.add(block)
+    end
+
+    notify_center.postNotificationName_object_userInfo_deliverImmediately('GrowlNotification', nil, notification, true)
+  end
+
+  private
+
+  def register(types, default_types = nil)
+    types = [types].flatten
+    default_types ||= types
+
+    @registered = [@registered, types, default_types].flatten.uniq
+
+    dictionary = {
+      :ApplicationName       => name,
+      :AllNotifications      => types,
+      :DefaultNotifications  => default_types,
+      :ApplicationIcon       => icon.TIFFRepresentation
+    }
+    
+    notify_center = OSX::NSDistributedNotificationCenter.defaultCenter
+    notify_center.postNotificationName_object_userInfo_deliverImmediately_('GrowlApplicationRegistrationNotification', nil, dictionary, true)
+  end
+
+  # Hides the infinite callback loop in the background so that it will not
+  # stop the flow of the application.
+  def start_runner
+    @@background_runner = Thread.new do
+      sleep 0.1
+      OSX::NSApp.run
+    end
+    at_exit do
+      loop do
+        sleep 1
+        OSX::NSApplication.sharedApplication.terminate(@@application) if @@callbacks.empty?
+      end
+    end
+  end
+
+end

data/lib/meow/autotest.rb

@@ -0,0 +1,44 @@
+require 'meow'
+
+class Meow
+  class Autotest
+    @icon_dirs = [File.expand_path(
+      File.join(File.dirname(__FILE__), '..', '..', 'icons')
+    )]
+
+    @@meow = Meow.new('Meow Autotest')
+
+    class << self
+      attr_accessor :icon_dirs
+
+      def icon_for action
+        @icon_dirs.reverse.each do |dir|
+          file = Dir[File.join(dir,'**')].find { |name| name =~ /#{action}/ }
+          return file if file
+        end
+      end
+    end
+
+    ::Autotest.add_hook :initialize do |at|
+      @@meow.notify "Autotest", 'started', { :icon => icon_for(:initialize) }
+    end
+
+    ::Autotest.add_hook :red do |at|
+      @@meow.notify "Autotest", "#{at.files_to_test.size} test are fail.",
+        { :icon => icon_for(:fail) }
+    end
+
+    ::Autotest.add_hook :green do |at|
+      if at.tainted
+        @@meow.notify "Autotest", "Tests pass!", { :icon => icon_for(:pass) }
+      end
+    end
+
+    ::Autotest.add_hook :all_good do |at|
+      if at.tainted
+        @@meow.notify "Autotest", "All tests pass!",
+          { :icon => icon_for(:pass) }
+      end
+    end
+  end
+end

data/lib/meow/notifier.rb

@@ -0,0 +1,36 @@
+class Meow
+  # addObserver can only be used with subclasses of NSObject, so we use this
+  # one.
+  class Notifier < OSX::NSObject
+    def setup
+      @callbacks = {}
+    end
+
+    def empty?
+      @callbacks.empty?
+    end
+
+    def add(prc)
+      pos = prc.object_id
+      @callbacks[pos] = prc
+      return pos
+    end
+
+    def clicked(notification)
+      if block = remove_callback(notification)
+        block.call 
+      end
+    end
+
+    def timeout(notification)
+      remove_callback(notification)
+    end
+
+    private
+
+    def remove_callback(notification)
+      idx = notification.userInfo[GROWL_KEY_CLICKED_CONTEXT].to_i
+      @callbacks.delete idx
+    end
+  end
+end

data/meow.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name = %q{meow}
+  s.version = "2.1.0.20081101124146"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Patterson"]
+  s.date = %q{2008-11-01}
+  s.description = %q{Send Growl notifications via Ruby.}
+  s.email = ["aaronp@rubyforge.org"]
+  s.extra_rdoc_files = ["Manifest.txt"]
+  s.files = [".autotest", "CHANGELOG.rdoc", "Manifest.txt", "README.rdoc", "Rakefile", "icons/fail.png", "icons/initialize.jpeg", "icons/pass.png", "lib/meow.rb", "lib/meow/autotest.rb", "lib/meow/notifier.rb", "meow.gemspec", "test/assets/aaron.jpeg", "test/helper.rb", "test/test_meow.rb", "vendor/hoe.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://meow.rubyforge.org/}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{meow}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Send Growl notifications via Ruby.}
+  s.test_files = ["test/test_meow.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+    else
+    end
+  else
+  end
+end