real-growl 0.1.0

data/README.rdoc

@@ -0,0 +1,46 @@
+real-growl
+
+== DESCRIPTION:
+
+A Growl notification library that uses native c bindings to interact with GrowlApplicationBridge rather than Growl's network API.
+
+== SYNOPSIS:
+
+  >> require 'real_growl'
+  => true
+  >> rg("Check out", ["Real", "Growl"])
+  => nil
+  
+  >> Kernel.rg_sticky = false
+  => false
+  >> Kernel.rg_priority = 3
+  => 3
+  
+  >> my_own_application = RealGrowl::Application.new("AppName")
+  => #<RealGrowl::Application:0x1018eb6b8>
+  >> my_own_application.notify("Title", "Desc", 0, true)
+  
+  >> RealGrowl.installed?
+  => true
+  >> RealGrowl.running?
+  => true
+
+== TODO:
+  * Add executable script
+  * Allow for custom icons
+  * 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
+
+== 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.

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "real-growl"
+    s.summary = "Growl notification library that uses 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.homepage = "http://github.com/dewind/real-growl"
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/ext/extconf.rb

@@ -0,0 +1,22 @@
+# Loads mkmf which is used to make makefiles for Ruby extensions
+require 'mkmf'
+
+
+$CFLAGS << ' ' + "-ObjC"
+$LDFLAGS << ' ' + "-lobjc -framework Foundation -framework Growl"
+$objs = %w(ruby_delegate.o real_growl_api.o)
+
+def growl_framework_paths
+  ["/Library/Frameworks/Growl.framework", "#{ENV['HOME']}/Library/Growl.framework"]
+end
+
+if(growl_framework_paths.any? {|x| File.exists?(x)})
+  message("checking for framework Growl... yes\n")
+  if(have_library("objc"))
+    extension_name = 'real_growl_api'
+    dir_config(extension_name)
+    create_makefile(extension_name)
+  end
+else
+  message("checking for framework Growl... no\n")
+end

data/ext/real_growl_api.c

@@ -0,0 +1,84 @@
+#include "real_growl_api.h"
+
+VALUE rb_mRealGrowl;
+VALUE rb_cRealGrowlApplication;
+
+VALUE
+classMethod_installed(VALUE self) {
+  NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+  BOOL installed = [GrowlApplicationBridge isGrowlInstalled];
+  [pool release];
+  
+  if(installed) {
+    return Qtrue;
+  } else {
+    return Qfalse;
+  }
+}
+
+VALUE
+classMethod_running(VALUE self) {
+  NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+  BOOL running = [GrowlApplicationBridge isGrowlRunning];
+  [pool release];
+  
+  if(running) {
+    return Qtrue;
+  } else {
+    return Qfalse;
+  }
+}
+
+VALUE
+method_notify(VALUE self, VALUE title, VALUE description, VALUE priority, VALUE sticky) {
+  NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+  
+  BOOL nsSticky = (sticky == Qtrue) ? YES : NO;
+  NSString *nsTitle = [NSString stringWithCString:STR2CSTR(title) encoding: NSASCIIStringEncoding];
+  NSString *nsDescription = [NSString stringWithCString:STR2CSTR(description) encoding: NSASCIIStringEncoding];
+  [GrowlApplicationBridge notifyWithTitle: nsTitle description: nsDescription notificationName: REAL_GROWL_NOTIFICATION iconData: nil priority: NUM2INT(priority) isSticky:nsSticky clickContext:nil];
+  
+  [pool release];
+  
+  return Qnil;
+}
+
+VALUE 
+method_init(VALUE self, VALUE applicationName) {
+  NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+  id delegate = NULL;
+  
+  Data_Get_Struct(self, RubyDelegate, delegate);
+  
+  NSString *nsAppName = [NSString stringWithCString:STR2CSTR(applicationName) encoding: NSASCIIStringEncoding];
+  [delegate setApplicationName: nsAppName];
+  [GrowlApplicationBridge setGrowlDelegate: delegate];
+  
+  [pool release];
+  return self;
+}
+
+static void
+free_delegate(id delegate) {
+  [delegate release];
+}
+
+static VALUE
+alloc_delegate(VALUE klass) {
+  return Data_Wrap_Struct(klass, 0, free_delegate, [[RubyDelegate alloc] init]);  
+}
+
+
+void
+Init_real_growl_api() {
+  
+  rb_mRealGrowl = rb_define_module("RealGrowl");
+  rb_define_singleton_method(rb_mRealGrowl, "installed?", classMethod_installed, 0);
+  rb_define_singleton_method(rb_mRealGrowl, "running?", classMethod_running, 0);
+  
+  rb_cRealGrowlApplication = rb_define_class_under(rb_mRealGrowl, "Application", rb_cObject);
+  rb_define_alloc_func(rb_cRealGrowlApplication, alloc_delegate);
+  rb_define_method(rb_cRealGrowlApplication, "initialize", method_init, 1);
+  rb_define_method(rb_cRealGrowlApplication, "notify", method_notify, 4);  
+}
+

data/ext/real_growl_api.h

@@ -0,0 +1,5 @@
+#include "ruby_delegate.h"
+#include "ruby.h"
+#include <objc/runtime.h>
+#include <Growl/Growl.h>
+#include <Foundation/Foundation.h>

data/ext/ruby_delegate.h

@@ -0,0 +1,12 @@
+#include <Foundation/Foundation.h>
+#include <Growl/Growl.h>
+#define REAL_GROWL_NOTIFICATION XSTR("RealGrowlNotification")
+
+@interface RubyDelegate : NSObject<GrowlApplicationBridgeDelegate>
+{
+  NSString *applicationName;
+}
+
+-(NSDictionary *) registrationDictionaryForGrowl;
+@property(nonatomic, assign) NSString *applicationName;
+@end

data/ext/ruby_delegate.m

@@ -0,0 +1,14 @@
+#include "ruby_delegate.h"
+
+@implementation RubyDelegate
+@synthesize applicationName;
+
+-(NSDictionary *)registrationDictionaryForGrowl {
+  if(applicationName == nil) {
+    applicationName = @"RealGrowl";
+  }
+  NSArray *notifications = [NSArray arrayWithObject:REAL_GROWL_NOTIFICATION];
+  return [NSDictionary dictionaryWithObjectsAndKeys: [self applicationName], GROWL_APP_ID, [self applicationName], GROWL_APP_NAME, notifications, GROWL_NOTIFICATIONS_ALL, nil];
+}
+
+@end

data/lib/real_growl.rb

@@ -0,0 +1,22 @@
+require 'real_growl_api'
+require 'pp'
+
+module Kernel
+  class<<self
+    attr_accessor :rg_sticky, :rg_priority
+  end
+  
+  def rg(*args)
+    Kernel.rg_priority ||= 0
+    Kernel.rg_sticky = true if Kernel.rg_sticky.nil?
+    
+    @__growl_app ||= RealGrowl::Application.new("RealGrowl")
+    
+    notifications = args.map { |x| x.pretty_inspect }
+    notifications.each do |x|
+      @__growl_app.notify('rg', x, Kernel.rg_priority, Kernel.rg_sticky)
+    end
+    
+    nil
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: real-growl
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Justin DeWind
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-13 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+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: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- ext/real_growl_api.c
+- ext/real_growl_api.h
+- ext/ruby_delegate.h
+- ext/ruby_delegate.m
+- lib/real_growl.rb
+has_rdoc: true
+homepage: http://github.com/dewind/real-growl
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Growl notification library that uses native c bindings.
+test_files: []
+