libnotify 0.0.1 → 0.0.2

data/.gitignore

@@ -2,3 +2,4 @@ doc
 pkg
 coverage
 tags
+*.gemspec

data/.watchr

@@ -0,0 +1,21 @@
+
+def run(*args)
+  system "ruby -rubygems -Ilib:test #{args.join(' ')}"
+end
+
+def run_tests
+  system "rake test"
+end
+
+def underscore(file)
+  file.gsub('/', '_')
+end
+
+watch('test/test_.*\.rb')  {|md| run md[0] }
+watch('lib/(.*)\.rb')      {|md| run "test/test_#{underscore(md[1])}.rb" }
+watch('test/helper.rb')    { run_tests }
+
+run_tests
+
+Signal.trap("QUIT") { abort("\n") }
+Signal.trap("INT") { run_tests }

data/README.rdoc

@@ -6,19 +6,24 @@ Ruby binding for libnotify using FFI.
 
   require 'libnotify'
 
-  # Using a block
+  # Block syntax
   Libnotify.new do |notify|
     notify.summary = "world"
     notify.body = "hello"
-    notify.timeout = 1.5        # or 1000ms, nil, false
-    notify.urgency = :critical  # or :low, :normal, :critical
+    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.show!
   end
 
-  # Alternative syntax
+  # Hash syntax
   Libnotify.show(:body => "hello", :summary => "world", :timeout => 2.5)
 
+  # Mixed syntax
+  Libnotify.show(options) do |n|
+    n.timeout = 1.5     # overrides :timeout in options
+  end
+
 == Install via gemcutter
   gem install gemcutter
   gem tumble
@@ -29,4 +34,4 @@ Ruby binding for libnotify using FFI.
 
 == TODO
 
-* Tests!
+* Mock FFI calls

data/Rakefile

@@ -18,9 +18,11 @@ Jeweler::Tasks.new do |gem|
 
   gem.add_dependency "ffi"
 
-  #gem.add_development_dependency "riot", "= 0.10.4"
+  gem.add_development_dependency "riot"
+  gem.add_development_dependency "riot_notifier"
+  gem.add_development_dependency "rr"
 
-  #gem.test_files = Dir.glob('test/test_*.rb')
+  gem.test_files = Dir.glob('test/test_*.rb')
 end
 
 Jeweler::GemcutterTasks.new
@@ -31,8 +33,24 @@ Rake::TestTask.new(:test) do |test|
   test.test_files = FileList.new('test/test_*.rb')
   test.libs << 'test'
   test.verbose = true
+  #test.warning = true
 end
 
+namespace :test do
+  desc "Run all tests on multiple ruby versions (requires rvm)"
+  task(:portability) do
+    %w(1.8.6 1.8.7 1.9.1 1.9.2 ree jruby).each do |version|
+      system <<-BASH
+        bash -c 'source ~/.rvm/scripts/rvm;
+        rvm #{version};
+        echo "--------- ruby #{version} ----------\n";
+        rake -s test'
+      BASH
+    end
+  end
+end
+
+
 # RDoc
 Rake::RDocTask.new do |rd|
   rd.title = "Riot Notifier"

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/libnotify.rb

@@ -1,6 +1,3 @@
-
-
-require 'rubygems'
 require 'ffi'
 
 module Libnotify
@@ -31,10 +28,11 @@ module Libnotify
 
   class API
     include FFI
-    attr_accessor :name, :summary, :body, :icon_path, :timeout, :urgency
+    attr_reader :timeout
+    attr_accessor :summary, :body, :icon_path, :urgency
 
     def initialize(options = {}, &block)
-      self.summary = self.body = " "
+      self.summary = self.body = " " # Empty strings gives warnings...
       self.urgency = :normal
       self.timeout = nil
       options.each { |key, value| send("#{key}=", value) if respond_to?(key) }
@@ -47,9 +45,9 @@ module Libnotify
 
     def show!
       notify_init(self.class.to_s) or raise "notify_init failed"
-      notify = FFI.notify_notification_new(summary, body, icon_path, nil)
+      notify = notify_notification_new(summary, body, icon_path, nil)
       notify_notification_set_urgency(notify, urgency)
-      notify_notification_set_timeout(notify, timeout)
+      notify_notification_set_timeout(notify, timeout || -1)
       notify_notification_show(notify, nil)
     ensure
       notify_uninit
@@ -57,18 +55,18 @@ module Libnotify
 
     def timeout=(timeout)
       @timeout = case timeout
-      when NilClass, FalseClass
-        -1
       when Float
         (timeout * 1000).to_i
       when Fixnum
-        if timeout > 100 # assume miliseconds
+        if timeout >= 100 # assume miliseconds
           timeout
         else
           timeout * 1000
         end
+      when NilClass, FalseClass
+        nil
       else
-        timeout.to_i
+        timeout.to_s.to_i
       end
     end
   end
@@ -79,8 +77,8 @@ if $0 == __FILE__
   Libnotify.new do |notify|
     notify.summary = "world"
     notify.body = "hello"
-    notify.timeout = 1.5        # or 1000ms, nil, false
-    notify.urgency = :critical  # or :low, :normal, :critical
+    notify.timeout = 1.5        # 1.5 (sec), 1000 (ms), "2", nil, false
+    notify.urgency = :critical  # :low, :normal, :critical
     notify.icon_path = "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg"
     notify.show!
   end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'riot'
+require 'riot_notifier'
+
+require 'libnotify'
+
+Riot.reporter = RiotNotifier::Libnotify
+
+require 'rr'
+
+Riot::Situation.send :include, RR::Adapters::RRMethods

data/test/test_libnotify.rb

@@ -0,0 +1,72 @@
+require 'helper'
+
+context Libnotify do
+  setup { Libnotify }
+
+  asserts("responds to new").respond_to(:new)
+  asserts("responds to show").respond_to(:show)
+
+  asserts("#new calls API#new") do
+    mock(Libnotify::API).new(hash_including(:body => "test"))
+    Libnotify.new(:body => "test")
+    RR.verify
+  end
+  asserts("#show calls API#show") do
+    mock(Libnotify::API).show(hash_including(:body => "test"))
+    Libnotify.show(:body => "test")
+    RR.verify
+  end
+end
+
+context Libnotify::API do
+  setup { Libnotify::API }
+
+  context "without options and block" do
+    setup { topic.new }
+
+    asserts("summary is whitspaced") { topic.summary }.equals(" ")
+    asserts("body is whitspaced") { topic.body }.equals(" ")
+    asserts("urgency is :normal") { topic.urgency }.equals(:normal)
+    asserts("timeout is nil") { topic.timeout }.nil
+    asserts("icon_path is nil") { topic.icon_path }.nil
+  end
+
+  context "with options and block" do
+    setup do
+      topic.new(:summary => "hello", :body => "body", :invalid_option => 23) do |n|
+        n.body = "overwritten"
+        n.icon_path = "/path/to/icon"
+      end
+    end
+
+    asserts("summary is set") { topic.summary }.equals("hello")
+    asserts("body was overwritten by block") { topic.body }.equals("overwritten")
+    asserts("icon_path set") { topic.icon_path }.equals("/path/to/icon")
+  end
+
+  context "timeout=" do
+    setup { topic.new }
+
+    asserts("with float") { topic.timeout = 2.5; topic.timeout }.equals(2500)
+    asserts("with fixnum ms") { topic.timeout = 100; topic.timeout }.equals(100)
+    asserts("with fixnum ms") { topic.timeout = 101; topic.timeout }.equals(101)
+    asserts("with fixnum seconds") { topic.timeout = 1; topic.timeout }.equals(1000)
+    asserts("with fixnum seconds") { topic.timeout = 99; topic.timeout }.equals(99000)
+    asserts("with nil") { topic.timeout = nil; topic.timeout }.nil
+    asserts("with false") { topic.timeout = false; topic.timeout }.nil
+    asserts("with to_s.to_i") { topic.timeout = :"2 seconds"; topic.timeout }.equals(2)
+  end
+
+  # TODO mock this!
+  context "show!" do
+    setup { topic.new(:timeout => 1.0, :icon_path => "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg") }
+
+    [ :low, :normal, :critical ].each do |urgency|
+      asserts("with urgency #{urgency}") do
+        topic.summary = "#{RUBY_VERSION} at #{RUBY_PLATFORM}"
+        topic.body = defined?(RUBY_DESCRIPTION) ? RUBY_DESCRIPTION : '?'
+        topic.urgency = urgency; topic.show!
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: libnotify
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Peter Suschlik
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-06 00:00:00 +01:00
+date: 2009-12-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,36 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: riot_notifier
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rr
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: 
 email: peter-libnotify@suschlik.de
 executables: []
@@ -32,10 +62,13 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .gitignore
+- .watchr
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/libnotify.rb
+- test/helper.rb
+- test/test_libnotify.rb
 has_rdoc: true
 homepage: http://github.com/splattael/libnotify
 licenses: []
@@ -64,5 +97,5 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Ruby bindings for libnotify using FFI
-test_files: []
-
+test_files: 
+- test/test_libnotify.rb