growl 1.0.3

data/History.rdoc

@@ -0,0 +1,45 @@
+
+=== 1.0.3 / 2009-07-25
+
+* Fixed Growl.installed? returns false when binary cannot be found [#1]
+
+=== 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
+* 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
+
+=== 0.0.4 / 2009-04-08
+
+* We dont want visionmedia-Growl, shesh :p, fixed to lowercase
+
+=== 0.0.3 / 2009-04-08
+
+* Added #Growl hash support
+
+=== 0.0.2 / 2009-04-08
+
+* Github build me!!!
+
+=== 0.0.1 / 2009-04-08
+
+* Initial release

data/Manifest

@@ -0,0 +1,20 @@
+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

data/README.rdoc

@@ -0,0 +1,111 @@
+
+= Growl
+
+Ruby growlnotify 'bindings'.
+
+== Examples
+
+  notification = Growl.new
+  notification.message = 'Hello World'
+  notification.sticky!
+  notification.icon = :jpeg
+  notification.run if Growl.installed?
+
+  # OR
+
+  Growl.notify {
+    self.message = 'Hello World'
+    self.icon = :jpeg
+    sticky!
+  }
+
+  # OR
+
+  Growl.notify do |n|
+    n.message = 'Hello World'
+    n.icon = :jpeg
+    n.stick!
+  end
+
+  # OR
+
+  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
+
+== 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?
+* 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)
+
+== 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:
+
+(The MIT License)
+
+Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, an d/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,16 @@
+
+$:.unshift 'lib'
+require 'growl'
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new "growl", Growl::VERSION do |p|
+  p.author = "TJ Holowaychuk"
+  p.email = "tj@vision-media.ca"
+  p.summary = "growlnotify bindings"
+  p.url = "http://github.com/visionmedia/growl"
+  p.runtime_dependencies = []
+end
+
+Dir['tasks/**/*.rake'].sort.each { |f| load f }

data/examples/growl.rb

@@ -0,0 +1,19 @@
+
+$:.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'
+
+include Growl
+
+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

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{growl}
+  s.version = "1.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["TJ Holowaychuk"]
+  s.date = %q{2009-07-25}
+  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"]
+  s.homepage = %q{http://github.com/visionmedia/growl}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Growl", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{growl}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{growlnotify bindings}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/growl.rb

@@ -0,0 +1,25 @@
+#--
+# Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require 'growl/version'
+require 'growl/growl'

data/lib/growl/growl.rb

@@ -0,0 +1,202 @@
+
+module Growl
+  
+  BIN = 'growlnotify'
+  
+  #--
+  # Exceptions
+  #++
+  
+  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.normalize_icon! options
+    Growl.new(options, &block).run
+  end
+  module_function :notify
+  
+  #--
+  # Generate notify_STATUS methods.
+  #++
+  
+  %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 self.exec *args
+    Kernel.system BIN, *args
+  end
+  
+  ##
+  # Return the version triple of the binary.
+  
+  def self.version
+    @version ||= `#{BIN} --version`.split[1]
+  end
+  
+  ##
+  # Check if the binary is installed and accessable.
+  
+  def self.installed?
+    version rescue false
+  end
+  
+  ##
+  # Return an instance of Growl::Base or nil when not installed.
+  
+  def self.new *args, &block
+    return unless installed?
+    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
+  #++
+  
+  class Base
+    attr_reader :args
+    
+    ##
+    # Initialize with optional +block+, which is then
+    # instance evaled or yielded depending on the blocks arity.
+    
+    def initialize options = {}, &block
+      @args = []
+      if block_given?
+        if block.arity > 0
+          yield self
+        else
+          self.instance_eval &block
+        end
+      else
+        options.each do |key, value|
+          send :"#{key}=", value
+        end
+      end
+    end
+    
+    ##
+    # Run the notification, only --message is required.
+    
+    def run
+      raise Error, 'message required' unless message
+      self.class.switches.each do |switch|
+        if send(:"#{switch}?")
+          args << "--#{switch}"
+          args << send(switch).to_s if send(switch) && !(TrueClass === send(switch))
+        end
+      end
+      Growl.exec *args
+    end
+    
+    ##
+    # Define a switch +name+.
+    #
+    # === examples
+    #
+    #  switch :sticky
+    #
+    #  @growl.sticky!         # => true
+    #  @growl.sticky?         # => true
+    #  @growl.sticky = false  # => false
+    #  @growl.sticky?         # => false
+    #
+    
+    def self.switch name
+      ivar = :"@#{name}"
+      (@switches ||= []) << name
+      attr_accessor :"#{name}"
+      define_method(:"#{name}?") { instance_variable_get(ivar) }
+      define_method(:"#{name}!") { instance_variable_set(ivar, true) }
+    end
+    
+    ##
+    # Return array of available switch symbols.
+    
+    def self.switches
+      @switches
+    end
+    
+    #--
+    # Switches
+    #++
+    
+    switch :title
+    switch :message
+    switch :sticky
+    switch :name
+    switch :appIcon
+    switch :icon
+    switch :iconpath
+    switch :image
+    switch :priority
+    switch :identifier
+    switch :host
+    switch :password
+    switch :udp
+    switch :port
+    switch :auth
+    switch :crypt
+
+  end
+
+end

data/lib/growl/version.rb

@@ -0,0 +1,4 @@
+
+module Growl
+  VERSION = '1.0.3'
+end

data/spec/growl_spec.rb

@@ -0,0 +1,119 @@
+
+describe Growl do
+  
+  describe "#installed?" do
+    it "should check if growlnotify is available" do
+      Growl.should be_installed
+    end
+  end
+  
+  describe "#version" do
+    it "should return only the version triple" do
+      Growl.version.should match(/\d+\.\d+\.\d+/)
+    end
+  end
+  
+  before :each do
+    @growl = Growl.new
+    @growl.message = 'Hello World'
+  end
+  
+  describe "#notify" do
+    it "should accept a block, running immediately after" do
+      Growl.notify { |n| n.message = 'Invoked via Growl' }.should be_true
+    end
+    
+    it "should accept a hash" do
+      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.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
+  
+  describe "#run" do
+    it "should fail when no message is present" do
+      lambda { Growl.new.run }.should raise_error(Growl::Error, /message required/)
+    end
+    
+    it "should execute a growl notification" do
+      @growl.run.should be_true
+    end
+  end
+  
+  describe "#sticky!" do
+    it "should make a notification stick until explicitly closed" do
+      @growl.sticky = false
+      @growl.should_not be_sticky
+      @growl.sticky!
+      @growl.should be_sticky
+      @growl.message = 'Im Sticky'
+      @growl.run.should be_true
+    end
+  end
+  
+  describe "#name" do
+    it "should set the application name" do
+      @growl.name = 'Ruby'
+      @growl.run.should be_true
+    end
+  end
+  
+  describe "#title" do
+    it "should add a title" do
+      @growl.title = 'Im a title'
+      @growl.message = 'I am not a title'
+      @growl.run.should be_true
+    end
+  end
+  
+  describe "#appIcon" do
+    it "should use an application for the icon" do
+      @growl.appIcon = 'Safari'
+      @growl.message = 'Safari icon'
+      @growl.run.should be_true
+    end
+  end
+  
+  describe "#iconpath" do
+    it "should use a path for the icon" do
+      @growl.iconpath = fixture 'icon.icns'
+      @growl.message = 'Custom icon'
+      @growl.run.should be_true
+    end
+  end
+  
+  describe "#icon" do
+    it "should use an icon based on a file type" do
+      @growl.icon = 'jpeg'
+      @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
+    it "should use an image path for the 'icon'" do
+      @growl.image = fixture 'image.png'
+      @growl.message = 'Image as icon'
+      @growl.run.should be_true
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+
+require 'growl'
+
+def fixture path
+  File.expand_path File.join(File.dirname(__FILE__), 'fixtures', path)
+end

data/tasks/docs.rake

@@ -0,0 +1,13 @@
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/tasks/gemspec.rake

@@ -0,0 +1,3 @@
+
+desc 'Build gemspec file'
+task :gemspec => [:build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,25 @@
+
+require 'spec/rake/spectask'
+  
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+end
+  
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific specification verbosely (specify SPEC)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: growl
+version: !ruby/object:Gem::Version 
+  version: 1.0.3
+platform: ruby
+authors: 
+- TJ Holowaychuk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-25 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: growlnotify bindings
+email: tj@vision-media.ca
+executables: []
+
+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
+- tasks/docs.rake
+- 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
+- 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
+has_rdoc: true
+homepage: http://github.com/visionmedia/growl
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Growl
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: growl
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: growlnotify bindings
+test_files: []
+