meow 1.0.0 → 1.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+=== 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

data/Manifest.txt

@@ -3,7 +3,9 @@ Manifest.txt
 README.rdoc
 Rakefile
 lib/meow.rb
+lib/meow/notifier.rb
 meow.gemspec
+test/assets/aaron.jpeg
 test/helper.rb
 test/test_meow.rb
 vendor/hoe.rb

data/README.rdoc

@@ -11,6 +11,12 @@ Send Growl notifications via Ruby.
   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
@@ -28,7 +34,7 @@ Thanks to the Growl team!  This code is heavily based on their ruby example.
 
 (The MIT License)
 
-Copyright (c) 2008 Aaron Patterson
+Copyright (c) 2008 Aaron Patterson, Evan Phoenix, Eric Hodel
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -2,7 +2,9 @@
 
 require 'rubygems'
 require './vendor/hoe.rb'
-require './lib/meow.rb'
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'meow'
 
 Hoe.new('meow', Meow::VERSION) do |p|
   p.readme  = 'README.rdoc'

data/lib/meow.rb

@@ -1,7 +1,8 @@
 require 'osx/cocoa'
+require 'meow/notifier'
 
 class Meow
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
   PRIORITIES = {  :very_low   => -2,
                   :moderate   => -1,
                   :normal     =>  0,
@@ -9,6 +10,18 @@ class Meow
                   :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
+
   class << self
     ###
     # Send a message in one call.
@@ -18,6 +31,41 @@ class Meow
     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
+
+    ##
+    # Call this if you have passed blocks to #notify. This blocks forever, but
+    # it's the only way to properly get events.
+    def run
+      OSX::NSApp.run
+    end
+
+    ##
+    # Call this to cause Meow to stop running.
+    def stop
+      OSX::NSApp.stop(nil)
+    end
   end
 
   attr_accessor :name, :note_type, :icon
@@ -36,6 +84,17 @@ class Meow
     @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.
+    @clicked_name = "#{name}-#{@pid}-GrowlClicked!"
+
+    notify_center = OSX::NSDistributedNotificationCenter.defaultCenter
+    notify_center.addObserver_selector_name_object_ @@callbacks,
+                                                    "clicked:",
+                                                    @clicked_name,
+                                                    nil
   end
 
   ###
@@ -44,6 +103,8 @@ class Meow
   # * +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
@@ -54,32 +115,36 @@ class Meow
   #
   # Example:
   #   note.notify('title', 'description', :priority => :very_low)
-  def notify(title, description, opts = {})
+  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])
 
     notification = {
-      'NotificationName'  => opts[:note_type],
-      'ApplicationName'   => name,
-      'NotificationTitle' => title,
-      'NotificationDescription' => description,
-      'NotificationIcon'  => opts[:icon].TIFFRepresentation(),
+      :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[:stick]
+    notification[:NotificationAppIcon] = opts[:app_icon].TIFFRepresentation if opts[:app_icon]
+    notification[:NotificationSticky] = OSX::NSNumber.numberWithBool_(true) if opts[:stick]
+
+    notify_center = OSX::NSDistributedNotificationCenter.defaultCenter
 
-    if opts[:priority]
-      notification['NotificationPriority'] = OSX::NSNumber.numberWithInt_(PRIORITIES[opts[:priority]])
+    if block
+      notification[:NotificationClickContext] = @@callbacks.add(block)
     end
 
     d = OSX::NSDictionary.dictionaryWithDictionary_(notification)
-    notify_center = OSX::NSDistributedNotificationCenter.defaultCenter
     notify_center.postNotificationName_object_userInfo_deliverImmediately_('GrowlNotification', nil, d, true)
   end
 
@@ -100,4 +165,5 @@ class Meow
     notify_center = OSX::NSDistributedNotificationCenter.defaultCenter
     notify_center.postNotificationName_object_userInfo_deliverImmediately_('GrowlApplicationRegistrationNotification', nil, dictionary, true)
   end
+
 end

data/lib/meow/notifier.rb

@@ -0,0 +1,26 @@
+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 add(prc)
+      pos = prc.object_id
+      @callbacks[pos] = prc
+      return pos
+    end
+
+    def clicked(notification)
+      idx = notification.userInfo[GROWL_KEY_CLICKED_CONTEXT].to_i
+      begin
+        if block = @callbacks[idx]
+          block.call
+        end
+      ensure
+        @callbacks.delete idx
+      end
+    end
+  end
+end

data/test/test_meow.rb

@@ -1,6 +1,12 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "helper"))
 
 class MeowTest < Test::Unit::TestCase
+  ASSETS = File.expand_path(File.join(File.dirname(__FILE__), "assets"))
+
+  def my_method_name
+    /`(.*?)'/.match(caller.first)[1]
+  end
+
   def test_initialize
     meep = nil
     assert_nothing_raised {
@@ -11,28 +17,51 @@ class MeowTest < Test::Unit::TestCase
 
   def test_meow_has_static_method
     assert_nothing_raised {
-      Meow.notify('Meow Test', 'Title', 'Description', :priority => :very_high)
+      Meow.notify('Meow Test', 'Title', my_method_name, :priority => :very_high)
     }
   end
 
   def test_meow_can_notify_with_type
     meep = Meow.new('Meow Test')
     assert_nothing_raised {
-      meep.notify('Title', 'Description', :type => 'Awesome')
+      meep.notify('Title', my_method_name, :type => 'Awesome')
     }
   end
 
   def test_meow_can_notify_with_priority
     meep = Meow.new('Meow Test')
     assert_nothing_raised {
-      meep.notify('Title', 'Description', :priority => :very_high)
+      meep.notify('Title', my_method_name, :priority => :very_high)
     }
   end
 
   def test_meow_can_notify_without_register
     meep = Meow.new('Meow Test')
     assert_nothing_raised {
-      meep.notify('Title', 'Description')
+      meep.notify('Title', my_method_name)
+    }
+  end
+
+  def test_import_image
+    icon = Meow.import_image(File.join(ASSETS, 'aaron.jpeg'))
+    assert_kind_of(OSX::NSImage, icon)
+    meep = Meow.new('Meow Test')
+    assert_nothing_raised {
+      meep.notify('Icon', my_method_name, :icon => icon)
+    }
+  end
+
+  def test_clicks_work
+    $RUBYCOCOA_SUPPRESS_EXCEPTION_LOGGING = true
+    block_called = false
+    assert_raises(RuntimeError) {
+      meep = Meow.new('Meow Test')
+      meep.notify('Click Here', my_method_name) do
+        block_called = true
+        raise 'I do not know how to get run to stop blocking!'
+      end
+      Meow.run
     }
+    assert block_called
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: meow
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Aaron Patterson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-06 00:00:00 -07:00
+date: 2008-06-17 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -28,7 +28,9 @@ files:
 - README.rdoc
 - Rakefile
 - lib/meow.rb
+- lib/meow/notifier.rb
 - meow.gemspec
+- test/assets/aaron.jpeg
 - test/helper.rb
 - test/test_meow.rb
 - vendor/hoe.rb