visionmedia-growl 0.0.6 → 1.0.2

data/History.rdoc

@@ -1,4 +1,19 @@
 
+=== 1.0.2 / 2009-04-19
+
+* Added new gemspec
+* Removed capitalized gemspec name causing build issues
+
+=== 1.0.1 / 2009-04-19
+
+* Changed url for ticketing system
+
+=== 1.0.0 / 2009-04-13
+
+* Added new examples
+* Added growlnotify install docs [#3]
+* Changed; Growl#notify now normalizes the :icon option key [#2] (checkout README)
+
 === 0.0.6 / 2009-04-09
 
 * Added #notify_{ok,info,warning,error} and images

data/Manifest

@@ -1,5 +1,5 @@
 examples/growl.rb
-Growl.gemspec
+growl.gemspec
 History.rdoc
 lib/growl/growl.rb
 lib/growl/images/error.png
@@ -18,4 +18,3 @@ spec/spec_helper.rb
 tasks/docs.rake
 tasks/gemspec.rake
 tasks/spec.rake
-Todo.rdoc

data/README.rdoc

@@ -36,13 +36,24 @@ Ruby growlnotify 'bindings'.
   include Growl
   notify 'Email received', :sticky => true
 
-  #Convenience methods
+  # Convenience methods
 
   notify_ok 'Deployment successful'
   notify_info 'Email received'
   notify_warning 'Merge required'
   notify_error 'Failed to send email', :sticky => true
 
+== Normaized Icons
+
+The :icon option key is automatically normalized when you use any of the Growl#notify
+methods, this removes the need to explicitly use :appIcon, :image, etc.
+
+  notify 'App icon', :icon => :Safari
+  notify 'Jpeg icon', :icon => :jpeg 
+  notify 'Image icon', :icon => 'path/to/image.png' 
+  notify 'Icns icon', :icon => 'path/to/icon.icns'
+  notify 'Path extname icon', :icon => 'foo.rb' 
+
 == Features
 
 * Check availability with Growl.installed?
@@ -51,7 +62,28 @@ Ruby growlnotify 'bindings'.
 * Sticky a notification making it appear until explicitly closed 
 * Set notification priority 
 * Convenience methods such as notify_ok, notify_warning, notify_error, and notify_info
-* Etc (consult growlnotify --help) 
+* Etc (consult growlnotify --help)
+
+== Installing growlnotify
+
+Visit http://growl.info/documentation.php for installation help. 
+
+== Known Issues
+
+It seems that growlnotify will essentially ignore or block excessive usage
+of the notifications at random. To prevent this you may need to do something like
+below if you are calling many in sequence:
+
+  notify 'Something'; sleep 0.2
+  notify_ok 'Updated'; sleep 0.2
+  notify_info 'You have new mail'; sleep 0.2
+  notify_warning 'Merged required'; sleep 0.2
+  notify_error 'Oh Noes!'; sleep 0.2
+
+== Contribute
+
+Fork / send a pull request or submit a ticket at:
+http://github.com/visionmedia/growl/issues
 
 == License:
 

data/examples/growl.rb

@@ -7,24 +7,13 @@ puts "growlnotify version #{Growl.version} installed"
 imagepath = File.dirname(__FILE__) + '/../spec/fixtures/image.png'
 iconpath = File.dirname(__FILE__) + '/../spec/fixtures/icon.icns'
 
-Growl.notify do |notification|
-  notification.sticky!
-  notification.title = 'Sticky'
-  notification.message = 'Im sticky'
-end
-
-Growl.notify do
-  sticky!
-  self.title = 'Image'
-  self.message = 'I have an image as an icon'
-  self.image = imagepath
-end
-
 include Growl
 
-notify 'Whoop', :appIcon => 'Safari'
-notify 'Image processing complete', :icon => :jpeg
-notify 'Kicks ass!', :title => 'Growl', :iconpath => iconpath
-notify_info 'New email received'
-notify_ok 'Deployment complete' 
-notify_error 'Deployment failure'
+notify_info 'New email received', :sticky => true, :title => 'Some app'; sleep 0.2
+notify_ok 'Deployment complete'                   ; sleep 0.2
+notify_error 'Deployment failure'                 ; sleep 0.2
+notify 'Safari icon', :icon => :Safari            ; sleep 0.2
+notify 'Jpeg icon', :icon => :jpeg                ; sleep 0.2
+notify 'Image icon', :icon => imagepath           ; sleep 0.2
+notify 'Icns icon', :icon => iconpath             ; sleep 0.2
+notify 'Path extname icon', :icon => 'foo.rb'     ; sleep 0.2

data/{Growl.gemspec → growl.gemspec}

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{growl}
-  s.version = "0.0.6"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-04-09}
+  s.date = %q{2009-04-19}
   s.description = %q{growlnotify bindings}
   s.email = %q{tj@vision-media.ca}
   s.extra_rdoc_files = ["lib/growl/growl.rb", "lib/growl/images/error.png", "lib/growl/images/info.png", "lib/growl/images/ok.png", "lib/growl/images/warning.png", "lib/growl/version.rb", "lib/growl.rb", "README.rdoc", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
-  s.files = ["examples/growl.rb", "Growl.gemspec", "History.rdoc", "lib/growl/growl.rb", "lib/growl/images/error.png", "lib/growl/images/info.png", "lib/growl/images/ok.png", "lib/growl/images/warning.png", "lib/growl/version.rb", "lib/growl.rb", "Manifest", "Rakefile", "README.rdoc", "spec/fixtures/icon.icns", "spec/fixtures/image.png", "spec/growl_spec.rb", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "Todo.rdoc", "growl.gemspec"]
+  s.files = ["examples/growl.rb", "growl.gemspec", "History.rdoc", "lib/growl/growl.rb", "lib/growl/images/error.png", "lib/growl/images/info.png", "lib/growl/images/ok.png", "lib/growl/images/warning.png", "lib/growl/version.rb", "lib/growl.rb", "Manifest", "Rakefile", "README.rdoc", "spec/fixtures/icon.icns", "spec/fixtures/image.png", "spec/growl_spec.rb", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/visionmedia/growl}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Growl", "--main", "README.rdoc"]

data/lib/growl/growl.rb

@@ -30,6 +30,7 @@ module Growl
   def notify message = nil, options = {}, &block
     return unless Growl.installed?
     options.merge! :message => message if message
+    Growl.normalize_icon! options
     Growl.new(options, &block).run
   end
   module_function :notify
@@ -76,6 +77,37 @@ module Growl
     Base.new *args, &block
   end
   
+  ##
+  # Normalize the icon option in +options+. This performs
+  # the following operations in order to allow for the :icon
+  # key to work with a variety of values:
+  #
+  # * path to an icon sets :iconpath
+  # * path to an image sets :image
+  # * capitalized word sets :appIcon
+  # * filename uses extname as :icon
+  # * otherwise treated as :icon
+  
+  def self.normalize_icon! options = {}
+    return unless options.include? :icon
+    icon = options.delete(:icon).to_s
+    if File.exists? icon
+      if File.extname(icon) == '.icns'
+        options[:iconpath] = icon
+      else
+        options[:image] = icon
+      end
+    else
+      if icon.capitalize == icon
+        options[:appIcon] = icon
+      elsif !(ext = File.extname(icon)).empty?
+        options[:icon] = ext[1..-1]
+      else
+        options[:icon] = icon
+      end
+    end
+  end
+  
   #--
   # Growl base
   #++
@@ -123,9 +155,9 @@ module Growl
     #
     #  switch :sticky
     #
-    #  @growl.sticky!
+    #  @growl.sticky!         # => true
     #  @growl.sticky?         # => true
-    #  @growl.sticky = false
+    #  @growl.sticky = false  # => false
     #  @growl.sticky?         # => false
     #
     

data/lib/growl/version.rb

@@ -1,4 +1,4 @@
 
 module Growl
-  VERSION = '0.0.6'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-growl
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 1.0.2
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-09 00:00:00 -07:00
+date: 2009-04-19 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -33,7 +33,7 @@ extra_rdoc_files:
 - tasks/spec.rake
 files: 
 - examples/growl.rb
-- Growl.gemspec
+- growl.gemspec
 - History.rdoc
 - lib/growl/growl.rb
 - lib/growl/images/error.png
@@ -52,8 +52,6 @@ files:
 - tasks/docs.rake
 - tasks/gemspec.rake
 - tasks/spec.rake
-- Todo.rdoc
-- growl.gemspec
 has_rdoc: true
 homepage: http://github.com/visionmedia/growl
 post_install_message: 

data/Todo.rdoc

@@ -1,15 +0,0 @@
-
-== Major:
-
-* Fix priority, and have constants
-* Switch aliases since appIcon is ... lame
-* Allow the icon switch to be an image, icon, or extension. This would be much more usable than --icon, --image, and --iconpath
-* Docs for installing growlnotify
-
-== Minor:
-
-* Nothing
-
-== Brainstorming:
-
-* Nothing