libnotify 0.4.0 → 0.5.0

data/Gemfile

@@ -4,6 +4,7 @@ gem "ffi", ">= 0.6.2"
 
 group :test do
   gem "jeweler"
+  gem "watchr"
   gem "riot", "= 0.11.2"
   gem "riot_notifier", "~> 0.4.0"
   gem "yard"

data/Gemfile.lock

@@ -23,6 +23,7 @@ GEM
     rubyforge (2.0.4)
       json_pure (>= 1.1.7)
     term-ansicolor (1.0.5)
+    watchr (0.7)
     yard (0.6.0)
 
 PLATFORMS
@@ -33,4 +34,5 @@ DEPENDENCIES
   jeweler
   riot (= 0.11.2)
   riot_notifier (~> 0.4.0)
+  watchr
   yard

data/README.rdoc

@@ -3,7 +3,9 @@
 Ruby bindings for libnotify using FFI.
 
 Source[http://github.com/splattael/libnotify] |
-RDoc[http://rdoc.info/projects/splattael/libnotify]
+RDoc[http://rdoc.info/github/splattael/libnotify/master/file/README.rdoc]
+
+http://github.com/splattael/libnotify/raw/master/libnotify.png
 
 == Usage
 
@@ -11,12 +13,12 @@ RDoc[http://rdoc.info/projects/splattael/libnotify]
 
   # Block syntax
   n = Libnotify.new do |notify|
-    notify.summary = "world"
-    notify.body = "hello"
-    notify.timeout = 1.5        # 1.5 (s), 1000 (ms), "2", nil, false
-    notify.urgency = :critical  # :low, :normal, :critical
-    notify.append = false       # default true - append onto existing notification
-    notify.icon_path = "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg"
+    notify.summary    = "hello"
+    notify.body       = "world"
+    notify.timeout    = 1.5         # 1.5 (s), 1000 (ms), "2", nil, false
+    notify.urgency    = :critical   # :low, :normal, :critical
+    notify.append     = false       # default true - append onto existing notification
+    notify.icon_path  = "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg"
   end
   n.show!
 
@@ -28,6 +30,11 @@ RDoc[http://rdoc.info/projects/splattael/libnotify]
     n.timeout = 1.5     # overrides :timeout in options
   end
 
+  # Icon path auto-detection
+  Libnotify.icon_dirs << "/usr/share/icons/gnome/*/"
+  Libnotify.show(:icon_path => "emblem-default.png")
+  Libnotify.show(:icon_path => :"emblem-default")
+
 == Installation
 
   gem install libnotify
@@ -38,9 +45,9 @@ You'll need libnotify. On Debian just type:
 
 == Testing
 
-  git co git://github.com/splattael/libnotify.git
+  git clone git://github.com/splattael/libnotify.git
   cd libnotify
-  gem install bundler
+  (gem install bundler)
   bundle install
   rake
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/libnotify.rb

@@ -13,14 +13,18 @@ module Libnotify
   #
   # @example Block syntax
   #   n = Libnotify.new do |notify|
-  #     notify.summary = "world"
-  #     notify.body = "hello"
-  #     notify.timeout = 1.5        # 1.5 (s), 1000 (ms), "2", nil, false
-  #     notify.urgency = :critical  # :low, :normal, :critical
-  #     notify.icon_path = "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg"
+  #     notify.summary    = "hello"
+  #     notify.body       = "world"
+  #     notify.timeout    = 1.5         # 1.5 (s), 1000 (ms), "2", nil, false
+  #     notify.urgency    = :critical   # :low, :normal, :critical
+  #     notify.append     = false       # default true - append onto existing notification
+  #     notify.icon_path  = "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg"
   #   end
   #   n.show!
   #
+  # @example Hash syntax
+  #   Libnotify.show(:body => "hello", :summary => "world", :timeout => 2.5)
+  #
   # @example Mixed syntax
   #   Libnotify.new(options) do |n|
   #     n.timeout = 1.5     # overrides :timeout in options
@@ -46,18 +50,6 @@ module Libnotify
 
   # Shows a notification. It takes the same +options+ as Libnotify.new.
   #
-  # @example Block syntax
-  #   Libnotify.show do |notify|
-  #     notify.summary = "world"
-  #     notify.body = "hello"
-  #     notify.timeout = 1.5        # 1.5 (s), 1000 (ms), "2", nil, false
-  #     notify.urgency = :critical  # :low, :normal, :critical
-  #     notify.icon_path = "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg"
-  #   end
-  #
-  # @example Hash syntax
-  #   Libnotify.show(:body => "hello", :summary => "world", :timeout => 2.5)
-  #
   # @see Libnotify.new
   def self.show(options={}, &block)
     API.show(options, &block)
@@ -85,8 +77,19 @@ module Libnotify
   class API
     include FFI
 
-    attr_reader :timeout
-    attr_accessor :summary, :body, :icon_path, :urgency, :append
+    attr_reader :timeout, :icon_path
+    attr_accessor :summary, :body, :urgency, :append
+
+    class << self
+      # List of globs to icons
+      attr_accessor :icon_dirs
+    end
+
+    self.icon_dirs = [
+      "/usr/share/icons/gnome/48x48/emblems",
+      "/usr/share/icons/gnome/256x256/emblems",
+      "/usr/share/icons/gnome/*/emblems"
+    ]
 
     # Creates a notification object.
     #
@@ -141,6 +144,32 @@ module Libnotify
       end
     end
 
+    # Sets icon path.
+    #
+    # Path can be absolute, relative (will be resolved) or an symbol.
+    #
+    # @todo document and refactor
+    def icon_path=(path)
+      case path
+      when /^\// # absolute
+        @icon_path = path
+      when String
+        # TODO refactor!
+        self.class.icon_dirs.map { |d| Dir[d] }.flatten.uniq.each do |dir|
+          full_path = File.join(dir, path)
+          if File.exist?(full_path)
+            @icon_path = full_path
+            return
+          end
+        end
+        @icon_path = path
+      when Symbol
+        self.icon_path = "#{path}.png"
+      else
+        @icon_path = nil
+      end
+    end
+
     # Creates and shows a notification. It's a shortcut for +Libnotify.new(options).show!+.
     #
     # @see Libnotify.show

data/libnotify.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{libnotify}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Suschlik"]
-  s.date = %q{2011-04-23}
+  s.date = %q{2011-05-05}
   s.email = %q{peter-libnotify@suschlik.de}
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "lib/libnotify.rb",
      "libnotify.gemspec",
+     "libnotify.png",
      "test.watchr",
      "test/helper.rb",
      "test/test_libnotify.rb"

data/test.watchr

@@ -1,15 +1,50 @@
 #!/usr/bin/env watchr
 
-begin
-  require File.join(ENV["HOME"], ".watchr.test.rb")
-rescue LoadError
-  warn "Unable to load #{File.join(ENV["HOME"], ".watchr.test.rb")}"
-  warn "You might try this: http://gist.github.com/raw/273574/8804dff44b104e9b8706826dc8882ed985b4fd13/.watchr.test.rb"
-  exit
+#!/usr/bin/env watchr
+
+def run(cmd)
+  puts(cmd)
+  system cmd
+end
+
+def run_test_file(file)
+  clear
+  run "ruby -rubygems -Ilib:test #{file}"
+end
+
+def run_tests
+  clear
+  run "rake"
+end
+
+def clear
+  system "clear"
+end
+
+def underscore(file)
+  file.gsub('/', '_')
+end
+
+@interrupted = false
+
+Signal.trap 'QUIT' do
+  run_tests
+end
+
+Signal.trap 'INT' do
+  if @interrupted then
+    abort("\n")
+  else
+    puts "Interrupt a second time to quit"
+    @interrupted = true
+    Kernel.sleep 1.5
+    # raise Interrupt, nil # let the run loop catch it
+    run_tests
+  end
 end
 
 run_tests
 
-watch('test/test_.*\.rb') {|md| run md[0] }
-watch('lib/(.*)\.rb') {|md| run "test/test_#{underscore(md[1])}.rb" }
+watch('test/test_.*\.rb') {|md| run_test_file md[0] }
+watch('lib/(.*)\.rb') {|md| run_test_file "test/test_#{underscore(md[1])}.rb" }
 watch('test/helper.rb') { run_tests }

data/test/test_libnotify.rb

@@ -58,10 +58,19 @@ context Libnotify::API do
     asserts("with to_s.to_i") { topic.timeout = :"2 seconds"; topic.timeout }.equals(2)
   end
 
+  context "icon_path=" do
+    setup { topic.new }
+
+    asserts("with absolute path") { topic.icon_path = "/some/path/image.jpg"; topic.icon_path }.equals("/some/path/image.jpg")
+    asserts("with invalid relative path") { topic.icon_path = "some-invalid-path.jpg"; topic.icon_path }.equals("some-invalid-path.jpg")
+    asserts("with relative path") { topic.icon_path = "emblem-favorite.png"; topic.icon_path }.equals("/usr/share/icons/gnome/48x48/emblems/emblem-favorite.png")
+    asserts("with symbol") { topic.icon_path = :"emblem-favorite"; topic.icon_path }.equals("/usr/share/icons/gnome/48x48/emblems/emblem-favorite.png")
+  end
+
   # TODO Mock FFI calls with rrriot.
   context "show!" do
     setup do
-      topic.new(:timeout => 1.0, :icon_path => "/usr/share/icons/gnome/48x48/emblems/emblem-favorite.png")
+      topic.new(:timeout => 1.0, :icon_path => :"emblem-favorite")
     end
 
     context "for real" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: libnotify
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Peter Suschlik
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-23 00:00:00 +02:00
+date: 2011-05-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,6 +96,7 @@ files:
 - VERSION
 - lib/libnotify.rb
 - libnotify.gemspec
+- libnotify.png
 - test.watchr
 - test/helper.rb
 - test/test_libnotify.rb