visionmedia-growl 0.0.5 → 0.0.6

data/Growl.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{growl}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   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-08}
+  s.date = %q{2009-04-09}
   s.description = %q{growlnotify bindings}
   s.email = %q{tj@vision-media.ca}
-  s.extra_rdoc_files = ["lib/growl/growl.rb", "lib/growl/version.rb", "lib/growl.rb", "README.rdoc", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
-  s.files = ["Growl.gemspec", "History.rdoc", "lib/growl/growl.rb", "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.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.has_rdoc = true
   s.homepage = %q{http://github.com/visionmedia/growl}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Growl", "--main", "README.rdoc"]

data/History.rdoc

@@ -1,4 +1,10 @@
 
+=== 0.0.6 / 2009-04-09
+
+* Added #notify_{ok,info,warning,error} and images
+* Added examples and updated docs
+* Refactored Growl::Base.switch
+
 === 0.0.5 / 2009-04-08
 
 * Now returning nil when trying to instantiate Growl when not installed

data/Manifest

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

data/README.rdoc

@@ -9,11 +9,11 @@ Ruby growlnotify 'bindings'.
   notification.message = 'Hello World'
   notification.sticky!
   notification.icon = :jpeg
-  notification.run
+  notification.run if Growl.installed?
 
   # OR
 
-  Growl {
+  Growl.notify {
     self.message = 'Hello World'
     self.icon = :jpeg
     sticky!
@@ -21,7 +21,7 @@ Ruby growlnotify 'bindings'.
 
   # OR
 
-  Growl do |n|
+  Growl.notify do |n|
     n.message = 'Hello World'
     n.icon = :jpeg
     n.stick!
@@ -29,15 +29,28 @@ Ruby growlnotify 'bindings'.
 
   # OR
 
-  Growl :message => 'Invoked via Growl with hash', :icon => 'jpeg', :title => 'Growl
+  Growl.notify 'Foo', :icon => :jpeg, :title => 'Growl'
+
+  # OR
+
+  include Growl
+  notify 'Email received', :sticky => true
+
+  #Convenience methods
+
+  notify_ok 'Deployment successful'
+  notify_info 'Email received'
+  notify_warning 'Merge required'
+  notify_error 'Failed to send email', :sticky => true
 
 == Features
 
-* Check availability with Growl#installed?
-* Check dependencies with Growl#version
+* Check availability with Growl.installed?
+* Check dependencies with Growl.version
 * Use images, icon paths, application icons, or file format icons
 * 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) 
 
 == License:

data/Todo.rdoc

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

data/examples/growl.rb

@@ -0,0 +1,30 @@
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'growl'
+
+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'

data/lib/growl/growl.rb

@@ -9,37 +9,69 @@ module Growl
   
   class Error < StandardError; end
   
+  ##
+  # Display a growl notification +message+, with +options+ 
+  # documented below. Alternatively a +block+ may be passed
+  # which is then instance evaluated or yielded to the block.
+  #
+  # This method is simply returns nil when growlnotify
+  # is not installed, as growl notifications should never
+  # be the only means of communication between your application
+  # and your user.
+  #
+  # === Examples
+  #    
+  #   Growl.notify 'Hello'
+  #   Growl.notify 'Hello', :title => 'TJ Says:', :sticky => true
+  #   Growl.notify { |n| n.message = 'Hello'; n.sticky! }
+  #   Growl.notify { self.message = 'Hello'; sticky! }
+  #
+  
+  def notify message = nil, options = {}, &block
+    return unless Growl.installed?
+    options.merge! :message => message if message
+    Growl.new(options, &block).run
+  end
+  module_function :notify
+  
   #--
-  # Singleton methods
+  # Generate notify_STATUS methods.
   #++
   
-  module_function
+  %w( ok info warning error ).each do |type|
+    define_method :"notify_#{type}" do |message, *args|
+      options = args.first || {}
+      image = File.join File.expand_path(File.dirname(__FILE__)), 'images', "#{type}.png"
+      notify message, options.merge(:image => image)
+    end
+    module_function :"notify_#{type}"
+  end
   
   ##
   # Execute +args+ against the binary.
   
-  def exec *args
+  def self.exec *args
     Kernel.system BIN, *args
   end
   
   ##
   # Return the version triple of the binary.
   
-  def version
+  def self.version
     @version ||= `#{BIN} --version`.split[1]
   end
   
   ##
   # Check if the binary is installed and accessable.
   
-  def installed?
-    !! version
+  def self.installed?
+    version
   end
   
   ##
   # Return an instance of Growl::Base or nil when not installed.
   
-  def new *args, &block
+  def self.new *args, &block
     return unless installed?
     Base.new *args, &block
   end
@@ -78,7 +110,7 @@ module Growl
       self.class.switches.each do |switch|
         if send(:"#{switch}?")
           args << "--#{switch}"
-          args << send(switch) if send(switch).is_a? String
+          args << send(switch).to_s if send(switch) && !(TrueClass === send(switch))
         end
       end
       Growl.exec *args
@@ -100,9 +132,8 @@ module Growl
     def self.switch name
       ivar = :"@#{name}"
       (@switches ||= []) << name
-      define_method(:"#{name}")  { instance_variable_get(ivar) }
-      define_method(:"#{name}=") { |value| instance_variable_set(ivar, value) }
-      define_method(:"#{name}?") { !! instance_variable_get(ivar) }
+      attr_accessor :"#{name}"
+      define_method(:"#{name}?") { instance_variable_get(ivar) }
       define_method(:"#{name}!") { instance_variable_set(ivar, true) }
     end
     
@@ -136,9 +167,4 @@ module Growl
 
   end
 
-end
-
-def Growl options = {}, &block
-  return unless Growl.installed?
-  Growl.new(options, &block).run
 end

data/lib/growl/version.rb

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

data/spec/growl_spec.rb

@@ -18,19 +18,27 @@ describe Growl do
     @growl.message = 'Hello World'
   end
   
-  describe "#Growl" do
+  describe "#notify" do
     it "should accept a block, running immediately after" do
-      Growl { |n| n.message = 'Invoked via Growl' }
+      Growl.notify { |n| n.message = 'Invoked via Growl' }.should be_true
     end
     
     it "should accept a hash" do
-      Growl :message => 'Invoked via Growl with hash', :icon => 'jpeg', :title => 'Growl'
+      Growl.notify('Invoked via Growl with hash', :icon => 'jpeg', :title => 'Growl').should be_true
     end
     
     it "should return nil when not installed" do
       Growl.stub!(:installed?).and_return(false)
       Growl.new.should be_nil
-      lambda { Growl :message => 'I should never show :)' }.should_not raise_error
+      lambda { Growl.notify 'I should never show :)' }.should_not raise_error
+    end
+  end
+  
+  %w( ok info warning error ).each do |type|
+    describe "#notify_#{type}" do
+      it "should display #{type} notifications" do
+        Growl.send(:"notify_#{type}", "Hello", :title => type).should be_true
+      end
     end
   end
   
@@ -73,7 +81,7 @@ describe Growl do
   describe "#appIcon" do
     it "should use an application for the icon" do
       @growl.appIcon = 'Safari'
-      @growl.message = 'Safari Icon'
+      @growl.message = 'Safari icon'
       @growl.run.should be_true
     end
   end
@@ -81,7 +89,7 @@ describe Growl do
   describe "#iconpath" do
     it "should use a path for the icon" do
       @growl.iconpath = fixture 'icon.icns'
-      @growl.message = 'Custom Icon'
+      @growl.message = 'Custom icon'
       @growl.run.should be_true
     end
   end
@@ -92,6 +100,12 @@ describe Growl do
       @growl.message = 'Jpeg Icon'
       @growl.run.should be_true
     end
+    
+    it "should allow symbols" do
+      @growl.icon = :jpeg
+      @growl.message = 'Jpeg icon with symbol'
+      @growl.run.should be_true
+    end
   end
   
   describe "#image" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-growl
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-08 00:00:00 -07:00
+date: 2009-04-09 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -21,6 +21,10 @@ extensions: []
 
 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
@@ -28,9 +32,14 @@ extra_rdoc_files:
 - tasks/gemspec.rake
 - tasks/spec.rake
 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