tin 1.0.0 → 1.0.1

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec
+
+task :build do
+	system "gem build tin.gemspec"
+end

data/lib/sn.rb

@@ -24,16 +24,14 @@ Tin is a simple interface to libnotify using Fiddle.
 
 Deprecated functions are not included in the those available through Sn.
 
-These function are also not included (for lack of a good implementation):
- * void notify_notification_set_hint(NotifyNotification *notification,
-        const char *key, GVariant *value);
- * void notify_notification_clear_hints(NotifyNotification *notification);
- * void notify_notification_set_image_from_pixbuf(
-        NotifyNotification *notification, GdkPixbuf *pixbuf);
- * void notify_notification_add_action(NotifyNotification *notification,
-        const char *action, const char *label, NotifyActionCallback callback,
-        gpointer user_data, GFreeFunc free_func);
- * void notify_notification_clear_actions(NotifyNotification *notification);
+These function are also not included:
+* notify_get_server_caps
+* notify_get_server_info
+* notify_notification_set_hint
+* notify_notification_clear_hints
+* notify_notification_set_image_from_pixbuf
+* notify_notification_add_action
+* notify_notification_clear_actions
 =end
 
 module Sn
@@ -42,30 +40,34 @@ module Sn
   # Mapping from keyword urgencies to the in values used by libnotify
   URGENCIES = {:low => 0, :normal => 1, :critical => 2}
 
+  # Mapping from keyword timeouts to the int values libnotify uses
+  TIMEOUTS = {:default => -1, :never => 0}
+
   # Uninitialize libnotify
   def self.stop
-    @notify[:uninit].call
+    @notify[:uninit].call if @notify[:is_initted].call == 1
   end
 
   # Setup the libnotify interface and initialize libnotify.
   def self.start(app_name)
     notify_cmd = {
         :init => {:arg => [TYPE_VOIDP], :ret => TYPE_INT},
-        :uninit => {:arg => [], :ret => TYPE_INT}
+        :uninit => {:arg => [], :ret => TYPE_INT},
+        :is_initted => {:arg => [], :ret => TYPE_INT},
+        :get_app_name => {:arg => [], :ret => TYPE_VOIDP},
+        :set_app_name => {:arg => [TYPE_VOIDP], :ret => TYPE_VOID}
     }
 
     notification_cmd = {
-      :new => {:arg => [TYPE_VOIDP, TYPE_VOIDP, TYPE_VOIDP],
-               :ret => TYPE_VOIDP},
-      :show => {:arg => [TYPE_VOIDP, TYPE_VOIDP], :ret => TYPE_INT},
-      :update => {:arg => [TYPE_VOIDP, TYPE_VOIDP, TYPE_VOIDP, TYPE_VOIDP],
-                  :ret => TYPE_INT},
+      :new => {:arg => [TYPE_VOIDP] * 3, :ret => TYPE_VOIDP},
+      :show => {:arg => [TYPE_VOIDP] * 2, :ret => TYPE_INT},
+      :update => {:arg => [TYPE_VOIDP] * 4, :ret => TYPE_INT},
       :set_urgency => {:arg => [TYPE_VOIDP, TYPE_INT], :ret => TYPE_VOID},
-      :close => {:arg => [TYPE_VOIDP, TYPE_VOIDP], :ret => TYPE_INT},
+      :close => {:arg => [TYPE_VOIDP] * 2, :ret => TYPE_INT},
       :get_closed_reason => {:arg => [TYPE_VOIDP], :ret => TYPE_INT},
-      :set_app_name => {:arg => [TYPE_VOIDP, TYPE_VOIDP], :ret => TYPE_VOID},
+      :set_app_name => {:arg => [TYPE_VOIDP] * 2, :ret => TYPE_VOID},
       :set_timeout => {:arg => [TYPE_VOIDP, TYPE_INT], :ret => TYPE_VOID},
-      :set_category => {:arg => [TYPE_VOIDP, TYPE_VOIDP], :ret => TYPE_VOID},
+      :set_category => {:arg => [TYPE_VOIDP] * 2, :ret => TYPE_VOID}
     }
 
     dl = DL.dlopen 'libnotify.so'
@@ -104,12 +106,21 @@ module Sn
     @notification[:show].call n, nil
   end
 
+  def self.app_name
+    NOTIFY[:get_app_name].call
+  end
+
+  def self.set_app_name(value=$0)
+    NOTIFY[:set_app_name].call value
+  end
+
   # This class manages an application notification.
   class Notification
     attr_reader :app_name, :category, :summary, :message, :urgency, :icon
+    attr_reader :timeout
 
     # Mapping from keyword timeouts to the int values libnotify uses
-    @@timeout_consts = {:default => -1, :never => 0}
+    @@timeout_consts = TIMEOUTS
 
     # +summary+:: the summary line generally displayed at the top of the
     # notification
@@ -167,7 +178,7 @@ module Sn
     end
 
     def category=(value)
-      @category = category
+      @category = value
       NOTIFICATION[:set_category].call @notification, @category
     end
 
@@ -175,16 +186,14 @@ module Sn
     # timeout can be specified as a number of milliseconds or using the keywords
     # +:default+ or +:never+.
     def timeout=(timeout=:default)
-      @timeout = @@timeout_consts[timeout] if @@timeout_consts.member?(timeout)
+      @timeout = TIMEOUTS.member?(timeout) ? TIMEOUTS[timeout] : timeout
       NOTIFICATION[:set_timeout].call @notification, @timeout
     end
 
     def urgency=(value)
-      @urgency = value
+      @urgency = URGENCIES[value]
       NOTIFICATION[:set_urgency].call @notification, URGENCIES[@urgency]
     end
   end
 end
 
-
-

data/spec/sn_spec.rb

@@ -0,0 +1,149 @@
+require 'fiddle'
+
+module Fiddle
+  class Function
+    attr_accessor :count
+
+    def initialize(lib, args, ret)
+      @count = 0
+      @lib = lib
+      @args = args
+      @ret = ret
+    end
+
+    def call(*args)
+      @count += 1
+      raise "Wrong # of args" unless @args.size == args.size
+    end
+  end
+end
+
+require 'sn'
+
+describe Sn, ".notify" do
+  it "should show a notification" do
+    Sn::NOTIFICATION[:new].count = 0
+    Sn::NOTIFICATION[:show].count = 0
+    Sn.notify "summary", "message", ""
+    Sn::NOTIFICATION[:new].count.should eq(1)
+    Sn::NOTIFICATION[:show].count.should eq(1)
+  end
+end
+
+describe Sn::Notification, ".show" do
+  it "should show a notification" do
+    Sn::NOTIFICATION[:show].count = 0
+    n = Sn::Notification.new "summary", "message", ""
+    n.show
+    Sn::NOTIFICATION[:show].count.should eq(1)
+  end
+end
+
+describe Sn::Notification, ".close" do
+  it "should close a notification" do
+    Sn::NOTIFICATION[:close].count = 0
+    n = Sn::Notification.new "summary", "message", ""
+    n.show
+    n.close
+    Sn::NOTIFICATION[:close].count.should eq(1)
+  end
+end
+
+describe Sn::Notification, ".summary=" do
+  it "should update a notification's summary" do
+    summary = "Stuff"
+    Sn::NOTIFICATION[:update].count = 0
+    n = Sn::Notification.new "summary", "message", ""
+    n.summary = summary
+    n.show
+    Sn::NOTIFICATION[:update].count.should eq(1)
+    n.summary.should eq(summary)
+  end
+end
+
+
+describe Sn::Notification, ".message=" do
+  it "should update a notification's message" do
+    message = "Stuff"
+    Sn::NOTIFICATION[:update].count = 0
+    n = Sn::Notification.new "summary", "message", ""
+    n.message = message
+    n.show
+    Sn::NOTIFICATION[:update].count.should eq(1)
+    n.message.should eq(message)
+  end
+end
+
+describe Sn::Notification, ".icon=" do
+  it "should update a notification's icon" do
+    icon = "refresh"
+    Sn::NOTIFICATION[:update].count = 0
+    n = Sn::Notification.new "summary", "message", ""
+    n.icon =icon 
+    n.show
+    Sn::NOTIFICATION[:update].count.should eq(1)
+    n.icon.should eq(icon)
+  end
+end
+
+describe Sn::Notification, ".category=" do
+  it "should set a notification's category" do
+    category = "Category"
+    Sn::NOTIFICATION[:set_category].count = 0
+    n = Sn::Notification.new "summary", "message", ""
+    n.category = category 
+    n.show
+    Sn::NOTIFICATION[:set_category].count.should eq(1)
+    n.category.should eq(category)
+  end
+end
+
+describe Sn::Notification, ".urgency=" do
+  it "should set a notification's urgency" do
+    Sn::NOTIFICATION[:set_urgency].count = 0
+    n = Sn::Notification.new "summary", "message", ""
+    n.urgency = :low
+    n.show
+    Sn::NOTIFICATION[:set_urgency].count.should eq(1)
+  end
+
+  it "should map keyword urgencies properly" do
+    n = Sn::Notification.new "summary", "message", ""
+    n.urgency = :low
+    n.urgency.should eq(Sn::URGENCIES[:low])
+    n.urgency = :normal
+    n.urgency.should eq(Sn::URGENCIES[:normal])
+    n.urgency = :critical
+    n.urgency.should eq(Sn::URGENCIES[:critical])
+  end
+end
+
+describe Sn::Notification, ".timeout=" do
+  it "should set a notification's timeout" do
+    Sn::NOTIFICATION[:set_timeout].count = 0
+    n = Sn::Notification.new "summary", "message", ""
+    n.timeout = 1023
+    n.show
+    Sn::NOTIFICATION[:set_timeout].count.should eq(1)
+    n.timeout.should eq(1023)
+  end
+
+  it "should map keyword timeout properly" do
+    n = Sn::Notification.new "summary", "message", ""
+    n.timeout = :default
+    n.timeout.should eq(Sn::TIMEOUTS[:default])
+    n.timeout = :never
+    n.timeout.should eq(Sn::TIMEOUTS[:never])
+  end
+end
+
+describe Sn::Notification, ".closed_reason" do
+  it "should get a notification's closing reason" do
+    Sn::NOTIFICATION[:get_closed_reason].count = 0
+    n = Sn::Notification.new "summary", "message", ""
+    n.show
+    n.close
+    n.closed_reason
+    Sn::NOTIFICATION[:get_closed_reason].count.should eq(1)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tin
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,47 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-21 00:00:00.000000000 Z
-dependencies: []
+date: 2012-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
 description: An incredibly simple interface to libnotify using Fiddle.
 email: baguthrie@sbcglobal.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- spec/sn_spec.rb
 - lib/sn.rb
 - README.md
 - Rakefile
@@ -40,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: tin
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Very simple libnotify access