growlnotifier 1.0.1 → 1.0.2

data/lib/growl.rb

@@ -2,7 +2,7 @@ require 'osx/cocoa'
 
 module Growl
   class Notifier < OSX::NSObject
-    VERSION = '1.0.1'
+    VERSION = '1.0.2'
     
     GROWL_IS_READY = "Lend Me Some Sugar; I Am Your Neighbor!"
     GROWL_NOTIFICATION_CLICKED = "GrowlClicked!"
@@ -27,6 +27,14 @@ module Growl
     attr_reader :application_name, :application_icon, :notifications, :default_notifications
     attr_accessor :delegate
     
+    # Set to +true+ if you want to receive delegate callback messages,
+    # <tt>growlNotifierClicked_context</tt> & <tt>growlNotifierTimedOut_context</tt>,
+    # without the need to specify a <tt>:click_context</tt>.
+    #
+    # The default is +false+, which means your application won't receive any delegate
+    # callback messages if the <tt>:click_context</tt> is omitted.
+    attr_accessor :always_callback
+    
     # Registers the applications metadata and the notifications, that your application might send, to Growl.
     # The +default_notifications+ are notifications that will be enabled by default, the regular +notifications+ are
     # optional and should be enabled by the user in the Growl system preferences.
@@ -55,6 +63,7 @@ module Growl
     # * +options+ : specifies a few optional options:
     #   * <tt>:sticky</tt> : indicates if the Grow notification should "stick" to the screen. Defaults to +false+.
     #   * <tt>:priority</tt> : sets the priority level of the Growl notification. Defaults to 0.
+    #   * <tt>:click_context</tt> : a string describing the context of the notification. This is send back to the delegate so you can check what kind of notification it was. If omitted, no delegate messages will be send. You can disable this behaviour by setting always_callback to +true+.
     #   * <tt>:icon</tt> : specifies the icon to be used in the Growl notification. Defaults to the registered +application_icon+, see register for more info.
     #
     # Simple example:
@@ -92,7 +101,7 @@ module Growl
         @callbacks[callback.object_id] = callback
         context[:callback_object_id] = callback.object_id.to_s
       end
-      dict[:NotificationClickContext] = context unless context.empty?
+      dict[:NotificationClickContext] = context if always_callback || !context.empty?
       
       notification_center.postNotificationName_object_userInfo_deliverImmediately(:GrowlNotification, nil, dict, true)
     end

data/test/growl_test.rb

@@ -97,7 +97,7 @@ describe "Growl::Notifier.sharedInstance" do
   
   before do
     set_variables!
-    
+    @instance.always_callback = false
     @pid = 54231
     OSX::NSProcessInfo.processInfo.stubs(:processIdentifier).returns(@pid)
   end
@@ -150,6 +150,23 @@ describe "Growl::Notifier.sharedInstance" do
     @instance.notify(@notifications.first, 'title', 'description')
   end
   
+  it "should use the applications name as the click context if always_callback is set to true" do
+    @instance.always_callback = true
+    
+    dict = {
+      :ApplicationName => @name,
+      :ApplicationPID => @pid,
+      :NotificationName => @notifications.first,
+      :NotificationTitle => 'title',
+      :NotificationDescription => 'description',
+      :NotificationPriority => 0,
+      :NotificationClickContext => {}
+    }
+    
+    @center.expects(:postNotificationName_object_userInfo_deliverImmediately).with(:GrowlNotification, nil, dict, true)
+    @instance.notify(@notifications.first, 'title', 'description')
+  end
+  
   it "should take a symbol instead of an integer to specify the priority level when sending a notification to Growl" do
     priority_table = { :very_low => -2, :moderate => -1, :normal => 0, :high => 1, :emergency => 2 }
     
@@ -191,8 +208,9 @@ describe "Growl::Notifier.sharedInstance" do
     @instance.onClicked(notification)
   end
   
-  it "should send a message to the delegate if a notification was clicked with nil as the context if none was specified" do
-    notification = stubbed_notification
+  it "should send a message to the delegate without a click_context if always_callback is enabled and no :click_context was specified" do
+    @instance.always_callback = true
+    notification = stubbed_notification({})
     assign_delegate.expects(:growlNotifierClicked_context).with(@instance, nil)
     @instance.onClicked(notification)
   end
@@ -221,13 +239,6 @@ describe "Growl::Notifier.sharedInstance" do
     @instance.onTimeout(notification)
   end
   
-  it "should send a message to the delegate if a notification times out with nil as the context in none was specified" do
-    notification = stubbed_notification
-    assign_delegate.expects(:growlNotifierTimedOut_context).with(@instance, nil)
-    
-    @instance.onTimeout(notification)
-  end
-  
   it "should not send a message to the delegate if a notification times out but the delegate doesn't respond to the delegate method" do
     assign_delegate
     @instance.onTimeout(stubbed_notification)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: growlnotifier
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Satoshi Nakagawa
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-04 00:00:00 +09:00
+date: 2008-11-21 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency