meow 1.1.0 → 2.0.0

data/CHANGELOG.rdoc

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

data/README.rdoc

@@ -29,12 +29,20 @@ Send Growl notifications via Ruby.
 == 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, Evan Phoenix, Eric Hodel
+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

data/lib/meow.rb

@@ -2,7 +2,7 @@ require 'osx/cocoa'
 require 'meow/notifier'
 
 class Meow
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
   PRIORITIES = {  :very_low   => -2,
                   :moderate   => -1,
                   :normal     =>  0,
@@ -22,6 +22,9 @@ class Meow
   @@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.
@@ -53,19 +56,6 @@ class Meow
 
       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
@@ -79,7 +69,7 @@ class Meow
   #
   # Example:
   #   note = Meow.new('My Application')
-  def initialize(name, note_type = 'Note', icon = OSX::NSWorkspace.sharedWorkspace().iconForFileType_('rb'))
+  def initialize(name, note_type = 'Note', icon = OSX::NSWorkspace.sharedWorkspace.iconForFileType('rb'))
     @name       = name
     @icon       = icon
     @note_type  = note_type
@@ -87,14 +77,22 @@ class Meow
 
     @pid = OSX::NSProcessInfo.processInfo.processIdentifier
 
-    # The notification name to look for when someone clicks on a notify bubble.
-    @clicked_name = "#{name}-#{@pid}-GrowlClicked!"
+    # 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.addObserver_selector_name_object_ @@callbacks,
-                                                    "clicked:",
-                                                    @clicked_name,
-                                                    nil
+    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
 
   ###
@@ -136,7 +134,7 @@ class Meow
     }
 
     notification[:NotificationAppIcon] = opts[:app_icon].TIFFRepresentation if opts[:app_icon]
-    notification[:NotificationSticky] = OSX::NSNumber.numberWithBool_(true) if opts[:stick]
+    notification[:NotificationSticky] = OSX::NSNumber.numberWithBool(true) if opts[:sticky]
 
     notify_center = OSX::NSDistributedNotificationCenter.defaultCenter
 
@@ -144,8 +142,7 @@ class Meow
       notification[:NotificationClickContext] = @@callbacks.add(block)
     end
 
-    d = OSX::NSDictionary.dictionaryWithDictionary_(notification)
-    notify_center.postNotificationName_object_userInfo_deliverImmediately_('GrowlNotification', nil, d, true)
+    notify_center.postNotificationName_object_userInfo_deliverImmediately('GrowlNotification', nil, notification, true)
   end
 
   private
@@ -156,14 +153,30 @@ class Meow
 
     @registered = [@registered, types, default_types].flatten.uniq
 
-    dictionary = OSX::NSDictionary.dictionaryWithDictionary({
-      'ApplicationName'       => name,
-      'AllNotifications'      => OSX::NSArray.arrayWithArray(types),
-      'DefaultNotifications'  => OSX::NSArray.arrayWithArray(default_types),
-      'ApplicationIcon'       => icon.TIFFRepresentation
-    })
+    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/notifier.rb

@@ -6,6 +6,10 @@ class Meow
       @callbacks = {}
     end
 
+    def empty?
+      @callbacks.empty?
+    end
+
     def add(prc)
       pos = prc.object_id
       @callbacks[pos] = prc
@@ -13,14 +17,20 @@ class Meow
     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
+      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

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = %q{meow}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.specification_version = 2 if s.respond_to? :specification_version=
 

data/test/test_meow.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "helper"))
+require "timeout"
 
 class MeowTest < Test::Unit::TestCase
   ASSETS = File.expand_path(File.join(File.dirname(__FILE__), "assets"))
@@ -51,17 +52,34 @@ class MeowTest < Test::Unit::TestCase
     }
   end
 
+  def test_stickyness
+    block_called = false
+    meep = Meow.new('Meow Test')
+    meep.notify('Sticky Test', my_method_name + "\n(you should not close this by clicking the 'x')", :sticky => true) do
+      block_called = true
+    end
+    while !block_called do
+      sleep 1
+    end
+  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 + "\n(you should not close this by clicking the 'x')", :sticky => true) do
+      block_called = true
+    end
+    while !block_called do
+      sleep 1
+    end
+  end
+
+  def test_run_should_not_block
+    Timeout::timeout(1) do
       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!'
+      meep.notify('Non blocking test', my_method_name) do
+        #callback block
       end
-      Meow.run
-    }
-    assert block_called
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: meow
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Aaron Patterson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-17 00:00:00 -07:00
+date: 2008-08-13 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -57,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: meow
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Send Growl notifications via Ruby.