libnotify 0.0.5 → 0.1.0

data/README.rdoc

@@ -1,6 +1,10 @@
 = Libnotify
 
-Ruby binding for libnotify using FFI.
+Ruby bindings for libnotify using FFI.
+
+Source[http://github.com/splattael/libnotify] |
+RDoc[http://rdoc.info/projects/splattael/libnotify] |
+Metrics[http://getcaliper.com/caliper/project?repo=http%3A%2F%2Fgemcutter.org%2Fgems%2Flibnotify]
 
 == Usage
 
@@ -28,7 +32,7 @@ Ruby binding for libnotify using FFI.
 
   gem install libnotify
 
-You need libnotify. On Debian you can just do:
+You'll need libnotify. On Debian just type:
 
   apt-get install libnotify1
 
@@ -37,4 +41,6 @@ You need libnotify. On Debian you can just do:
 
 == TODO
 
-* Mock FFI calls
+* Empty strings give warnings (lib/libnotify.rb:46)
+* Simplify timeout= (lib/libnotify.rb:64)
+* Mock FFI calls with rrriot. (test/test_libnotify.rb:60)

data/Rakefile

@@ -60,3 +60,12 @@ desc "Find whitespace at line ends"
 task :eol do
   system "grep -nrE ' +$' *"
 end
+
+desc "Display TODOs"
+task :todo do
+  `grep -Inr TODO lib test`.each do |line|
+    line.scan(/^(.*?:.*?):\s*#\s*TODO\s*(.*)$/) do |(file, todo)|
+      puts "* #{todo} (#{file})"
+    end
+  end
+end

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.1.0

data/lib/libnotify.rb

@@ -1,5 +1,8 @@
 require 'ffi'
 
+# Ruby bindings for libnotify using FFI.
+#
+# See README.rdoc for usage examples.
 module Libnotify
 
   def self.new(*args, &block)
@@ -10,6 +13,7 @@ module Libnotify
     API.show(*args, &block)
   end
 
+  # Raw FFI bindings.
   module FFI
     extend ::FFI::Library
 
@@ -28,20 +32,23 @@ module Libnotify
 
   class API
     include FFI
+
     attr_reader :timeout
     attr_accessor :summary, :body, :icon_path, :urgency
 
     def initialize(options = {}, &block)
-      self.summary = self.body = " " # Empty strings gives warnings...
-      self.urgency = :normal
-      self.timeout = nil
+      set_defaults
       options.each { |key, value| send("#{key}=", value) if respond_to?(key) }
       yield(self) if block_given?
     end
 
-    def self.show(*args, &block)
-      new(*args, &block).show!
+    def set_defaults
+      # TODO Empty strings give warnings
+      self.summary = self.body = " "
+      self.urgency = :normal
+      self.timeout = nil
     end
+    private :set_defaults
 
     def show!
       notify_init(self.class.to_s) or raise "notify_init failed"
@@ -54,6 +61,7 @@ module Libnotify
     end
 
     def timeout=(timeout)
+      # TODO Simplify timeout=
       @timeout = case timeout
       when Float
         (timeout * 1000).to_i
@@ -69,19 +77,11 @@ module Libnotify
         timeout.to_s.to_i
       end
     end
-  end
 
-end
+    def self.show(*args, &block)
+      new(*args, &block).show!
+    end
 
-if $0 == __FILE__
-  Libnotify.new do |notify|
-    notify.summary = "world"
-    notify.body = "hello"
-    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
 
-  Libnotify.show(:body => "hello", :summary => "world", :timeout => 2.5)
 end

data/libnotify.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{libnotify}
-  s.version = "0.0.5"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Suschlik"]
@@ -16,12 +16,12 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".gitignore",
-     ".watchr",
      "README.rdoc",
      "Rakefile",
      "VERSION",
      "lib/libnotify.rb",
      "libnotify.gemspec",
+     "test.watchr",
      "test/helper.rb",
      "test/test_libnotify.rb"
   ]

data/test/test_libnotify.rb

@@ -57,7 +57,7 @@ context Libnotify::API do
     asserts("with to_s.to_i") { topic.timeout = :"2 seconds"; topic.timeout }.equals(2)
   end
 
-  # TODO mock this!
+  # TODO Mock FFI calls with rrriot.
   context "show!" do
     setup { topic.new(:timeout => 1.0, :icon_path => "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg") }
 

data/test.watchr

@@ -0,0 +1,15 @@
+#!/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
+end
+
+run_tests
+
+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 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: libnotify
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors: 
 - Peter Suschlik
@@ -62,12 +62,12 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .gitignore
-- .watchr
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/libnotify.rb
 - libnotify.gemspec
+- test.watchr
 - test/helper.rb
 - test/test_libnotify.rb
 has_rdoc: true

data/.watchr

@@ -1,21 +0,0 @@
-
-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 }