real-growl 0.4.2 → 0.5.1

data/README.md

@@ -1,12 +1,13 @@
 real-growl
+==========
 
 Description
-===========
+-----------
 
-A Growl notification library that uses native c bindings to interact with GrowlApplicationBridge rather than Growl's network API.
+A Growl notification library that uses native C bindings to interact with GrowlApplicationBridge rather than Growl's network API.
 
 Synopsis
-========
+--------
 
 ### rg
 
@@ -16,11 +17,11 @@ Synopsis
     >> rg("Google", ["Real", "Growl"], :icon => "http://www.google.com/logos/stpatricks_d4gwinner_eo09.gif")
     => nil
   
-    >> Kernel.rg_sticky = false
+    >> RealGrowl.sticky = false
     => false
-    >> Kernel.rg_priority = 3
+    >> RealGrowl.priority = 3
     => 3
-    >> Kernel.rg_icon = "/the/path/cool.png"
+    >> RealGrowl.icon = "/the/path/cool.png"
     => "/the/path/cool.png"
   
 ### Custom Application
@@ -37,24 +38,45 @@ Synopsis
     => true
 
 TODO
-====
+----
+
   * Add executable script
   * Enable growl callbacks
   
 Requirements
-============
+------------
 
 * MacOS X 10.5 > ??
 * Growl Framework - http://growl.info/downloads_developers.php
 
 INSTALL
-=======
+-------
 
 Download and install Growl.framework into either ~/Library/Frameworks or /Library/Frameworks
 gem install real-growl
 
+    $ # Download latest Growl SDK
+    $ # Copy Growl.framework under Frameworks
+    $ cp -r /Volumes/Growl\ 1.2.2\ SDK/Frameworks/Growl.framework /Library/Frameworks
+
 INSTALLATION HINTS
-==================
+------------------
 
 Make sure that the Growl.framework is either 32bit or the 64bit depending on the version of MacOS X
 installed and the kind of machine it is installed on.
+
+Executable Usage
+----------------
+
+Uses slop to easily call a Growl notification with options (http://github.com/injekt/slop).
+
+### Run
+
+    $ realgrowl 
+    $ realgrowl -t "New alert"
+    $ realgrowl -d "A new notification of something!" -t "New alert"
+
+Contributors
+-----------
+
+* basicxman (Growl Executable)

data/Rakefile

@@ -2,13 +2,15 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name = "real-growl"
-    s.summary = "Growl notification library that uses native c bindings."
+    s.summary = "Growl notification library that was built using native c bindings."
     s.description = "A Growl notification library that uses native c bindings to interact with GrowlApplicationBridge rather than Growl's network API."
     s.email = "dewind@atomicobject.com"
     s.authors = ["Justin DeWind"]
     s.files =  FileList["README.rdoc", "lib/**/*.rb", "Rakefile", "ext/**/*.h", "ext/**/*.c", "ext/**/*.m"]
     s.extensions = ["ext/extconf.rb"]
+    s.executables = ["realgrowl"]
     s.homepage = "http://github.com/dewind/real-growl"
+    s.add_dependency "slop"
   end
   
   Jeweler::GemcutterTasks.new

data/bin/realgrowl

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'real_growl'
+require 'slop'
+
+opts = Slop.parse do
+  on :s, :sticky,      :default => true
+  on :t, :title,       :optional => true, :default => "Alert"
+  on :d, :description, :optional => true, :default => "New Growl notification."
+  on :i, :icon,        :optional => true, :default => RealGrowl::icon
+  on :p, :priority,    :optional => true, :default => 0
+end
+
+args = {}
+opts.to_hash.each { |k, v| args[k.to_sym] = v }
+
+app = RealGrowl::Application.new(args[:title])
+app.notify args

data/lib/real_growl.rb

@@ -1,38 +1,53 @@
 require 'real_growl_api'
 require 'pp'
 
-module Kernel
-  class<<self
-    attr_accessor :rg_sticky, :rg_priority, :rg_icon
-  end
-  
-  def rg(*args)
-    Kernel.rg_priority ||= 0
-    Kernel.rg_sticky = true if Kernel.rg_sticky.nil?
-    icon = Kernel.rg_icon
-    click = nil
-    
-    @__growl_app ||= RealGrowl::Application.new("RealGrowl")
-    
-    if args.last.is_a?(Hash) and (args.last[:icon] or args.last[:click])
-      icon = args.last[:icon]
-      click = args.last[:click]
-      args.pop
-    end
+module RealGrowl    
+  module ClassMethods
+    attr_accessor :sticky, :priority, :icon
     
-    if RealGrowl.running?
-      notifications = args.map { |x| x.pretty_inspect }
-      notifications.each do |x|
-        @__growl_app.notify(
-          :title        => 'rg', 
-          :description  => x, 
-          :priority     => Kernel.rg_priority, 
-          :sticky       => Kernel.rg_sticky, 
-          :icon         => icon
-        )
+    def growl(*args)
+      self.priority ||= 0
+      self.sticky = true if self.sticky.nil?
+      icon = self.icon
+      click = nil
+
+      @__growl_app ||= RealGrowl::Application.new("RealGrowl")
+
+      if args.last.is_a?(Hash) and (args.last[:icon] or args.last[:click])
+        icon = args.last[:icon]
+        click = args.last[:click]
+        args.pop
+      end
+
+      if RealGrowl.running?
+        notifications = args.map { |x| x.pretty_inspect }
+        notifications.each do |x|
+          @__growl_app.notify(
+            :title        => 'rg', 
+            :description  => x, 
+            :priority     => self.priority, 
+            :sticky       => self.sticky, 
+            :icon         => icon
+          )
+        end
       end
+      nil
     end
-        
-    nil
   end
+  
+  module InstanceMethods
+    def rg(*args)
+      RealGrowl::growl(*args)
+    end
+  end
+  
+  def self.included(receiver)
+    receiver.send :include, InstanceMethods
+  end
+  
+  extend self::ClassMethods
+end
+
+class Object  
+  include RealGrowl
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: real-growl
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Justin DeWind
@@ -15,14 +15,27 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-22 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
+date: 2011-05-30 00:00:00 -04:00
+default_executable: realgrowl
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: slop
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: A Growl notification library that uses native c bindings to interact with GrowlApplicationBridge rather than Growl's network API.
 email: dewind@atomicobject.com
-executables: []
-
+executables: 
+- realgrowl
 extensions: 
 - ext/extconf.rb
 extra_rdoc_files: 
@@ -35,6 +48,7 @@ files:
 - ext/ruby_delegate.h
 - lib/real_growl.rb
 - README.md
+- bin/realgrowl
 - ext/extconf.rb
 has_rdoc: true
 homepage: http://github.com/dewind/real-growl
@@ -69,6 +83,6 @@ rubyforge_project:
 rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: Growl notification library that uses native c bindings.
+summary: Growl notification library that was built using native c bindings.
 test_files: []