riot_notifier 0.0.6 → 0.0.7

data/.gitignore

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

data/README.rdoc

@@ -1,6 +1,7 @@
 = Notifier for testing framework riot.
 
-Notifies you about passes, errors, failures via $HOME/bin/notify_redgreen
+Notifies you about passes, errors, failures via custom notify libraries
+like libnotify.
 
 == Usage
 
@@ -9,42 +10,50 @@ Notifies you about passes, errors, failures via $HOME/bin/notify_redgreen
   require 'riot'
   require 'riot_notifier'
 
-  # Using notify-send (see below for wrapper script)
-  Riot.reporter = RiotNotifier::RedgreenNotifier
+  # Auto-detect in load order
+  Riot.reporter = RiotNotifier
 
-  # Using libnotify gem (ruby bindings using ffi)
-  # gem install libnotify
-  Riot.reporter = RiotNotifier::Libnotify
+=== Advanced usage
+
+  require 'riot'
+  require 'riot_notifier'
+
+  # Auto-detect in specified order notifier defined in RiotNotifier
+  Riot.reporter = RiotNotifier.try(:Libnotify, :RedgreenBinary)
+  Riot.reporter = RiotNotifier[:Libnotify, :RedgreenBinary] # sugar
 
-== notify_redgreen
+  # Use specific notifier class (libnotify)
+  Riot.reporter = RiotNotifier::Libnotify
 
-  Your $HOME/bin/notify_redgreen
+  # Use my own notifier
+  class MyOwn < ::RiotNotifier::Base
+    # override .notify and #usable?
+  end
 
-  #!/bin/sh
+  Riot.reporter = RiotNotifier[MyOwn] # try only this
+  Riot.reporter = RiotNotifier # try MyOwn first (auto-detection)
 
-  case "$1" in
-    red)
-      OPTIONS="-t 2500 -u critical -i /usr/share/icons/gnome/scalable/emotes/face-angry.svg :-("
-    ;;
-    green)
-      OPTIONS="-t 2000 -u normal -i /usr/share/icons/gnome/scalable/emblems/emblem-default.svg :-)"
-    ;;
-  esac
-  shift
+  # Use my own inline
+  Riot.reporter = Class.new(RiotNotifier::Base) do
+    def notify(color, msg)
+      MyFancyNotifierGem.notify(:color => color, :message => msg)
+    end
 
-  notify-send $OPTIONS "$*"
+    def self.usable?
+      require 'my_fancy_notifier_gem'
+      true
+    rescue LoadError
+      false
+    end
+  end
 
-== Install via gemcutter
+== Installation
 
-  gem install gemcutter
-  gem tumble
   gem install riot_notifier
 
 == Authors
 * Peter Suschlik
 
 == TODO
-* talk to DBUS directly (ruby-dbus?) instead of `notify-send` binary
 * riot's assertions support blocks! (like asserts_topic.equals { topic }). Use it!
-* Test Libnotify somehow
-* Autodetect notify class
+* Test auto-detection and Libnotify

data/Rakefile

@@ -1,31 +1,34 @@
 require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.name = "riot_notifier"
-  gem.summary = 'Simple notifier for riot'
-  gem.email = "peter-riot_notifier@suschlik.de"
-  gem.homepage = "http://github.com/splattael/riot_notifier"
-  gem.authors = ["Peter Suschlik"]
-
-  gem.has_rdoc = true
-  gem.extra_rdoc_files = [ "README.rdoc" ]
 
-  gem.add_dependency "riot", ">= 0.10.4"
-  gem.add_dependency "libnotify"
-
-  gem.test_files = Dir.glob('test/test_*.rb')
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "riot_notifier"
+    gem.summary = 'Simple notifier for riot'
+    gem.email = "peter-riot_notifier@suschlik.de"
+    gem.homepage = "http://github.com/splattael/riot_notifier"
+    gem.authors = ["Peter Suschlik"]
+
+    gem.has_rdoc = true
+    gem.extra_rdoc_files = [ "README.rdoc" ]
+
+    gem.add_dependency "riot", ">= 0.10.9"
+    gem.add_development_dependency "riot_notifier"
+    gem.add_development_dependency "libnotify"
+
+    gem.test_files = Dir.glob('test/test_*.rb')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-Jeweler::GemcutterTasks.new
-
 # Test
 require 'rake/testtask'
+desc 'Default: run unit tests.'
+task :default => :test
+task :test => :check_dependencies
+
 Rake::TestTask.new(:test) do |test|
   test.test_files = FileList.new('test/test_*.rb')
   test.libs << 'test'
@@ -33,6 +36,7 @@ Rake::TestTask.new(:test) do |test|
 end
 
 # RDoc
+require 'rake/rdoctask'
 Rake::RDocTask.new do |rd|
   rd.title = "Riot Notifier"
   rd.main = "README.rdoc"

data/VERSION

@@ -0,0 +1 @@
+0.0.7

data/lib/riot_notifier/base.rb

@@ -0,0 +1,59 @@
+# Base class for all specific notifiers.
+#
+# Each notifier should implement +notify+ and +usable?+.
+#
+# Note: Base is NOT usable.
+module RiotNotifier
+
+  class Base < ::Riot::DotMatrixReporter
+
+    def initialize(*args, &block)
+      raise "#{self.class} is NOT usable" unless self.class.usable?
+      super
+    end
+
+    # Notifies you about failures and errors.
+    # This methods should be overridden in order to define specific notifications libraries.
+    def notify(color, msg)
+      # override me
+    end
+
+    # Tests if this notifier is usable.
+    # Should contain some initialization code e.g. require 'libnotify'.
+    def self.usable?
+      # override
+      false
+    end
+
+    def self.inherited(notifier)
+      ::RiotNotifier.order.unshift notifier
+    end
+
+    # Override
+
+    def fail(desc, message)
+      super
+      notify(:red, "FAILURE: #{message}")
+    end
+
+    def error(desc, error)
+      super
+      notify(:red, "ERROR: #{error}")
+    end
+
+    def results(time_taken)
+      super
+      unless bad_results?
+        notify(:green, "%d passes, %d failures, %d errors in %s seconds" % [passes, failures, errors, ("%0.6f" % time_taken)])
+      end
+    end
+
+  private
+
+    def bad_results?
+      failures + errors > 0
+    end
+
+  end
+
+end

data/lib/riot_notifier/libnotify.rb

@@ -0,0 +1,34 @@
+# Notifies via libnotify.
+module RiotNotifier
+
+  class Libnotify < Base
+    OPTIONS = {
+      :green => {
+        :icon_path => "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg",
+        :timeout => 2.5,
+        :urgency => :normal,
+        :summary => ":-)"
+      },
+      :red => {
+        :icon_path => "/usr/share/icons/gnome/scalable/emotes/face-angry.svg",
+        :timeout => 2.5,
+        :urgency => :critical,
+        :summary => ":-("
+      }
+    }
+
+    def notify(color, msg)
+      options = OPTIONS[color] or raise "unknown color #{color}"
+
+      ::Libnotify.show(options.merge(:body => msg))
+    end
+
+    def self.usable?
+      require 'libnotify'
+      true
+    rescue LoadError
+      false
+    end
+  end
+
+end

data/lib/riot_notifier/module.rb

@@ -0,0 +1,45 @@
+# Notifies you about failures and errors in your riot tests!
+#
+# Usage:
+#   require 'riot'
+#   require 'riot_notifier'
+#
+#   # auto-detection
+#   Riot.reporter = RiotNotifier
+#   # try these first
+#   Riot.reporter = RiotNotifier[:RedgreenBinary, :Libnotify]
+#
+module RiotNotifier
+
+  def self.new(*args, &block)
+    notifier_class = notifier_classes.detect(&:usable?) || None
+    notifier_class.new(*args, &block)
+  end
+
+  def self.order
+    @order ||= []
+  end
+
+  def self.try(*order)
+    @order = order
+    self
+  end
+
+  class << self
+    alias [] try
+  end
+
+  def self.notifier_classes
+    order.map { |o| resolve_notifier_class(o) }.compact - [None]
+  end
+
+  def self.resolve_notifier_class(o)
+    case o
+    when Class; o
+    when Symbol, String; const_get(o)
+    else
+      nil
+    end
+  end
+
+end

data/lib/riot_notifier/none.rb

@@ -0,0 +1,14 @@
+# Doesn't notify at all. Is used as auto-detection fallback.
+module RiotNotifier
+
+  class None < Base
+    def notify(color, msg)
+      # noop
+    end
+
+    def self.usable?
+      true
+    end
+  end
+
+end

data/lib/riot_notifier/redgreen_binary.rb

@@ -0,0 +1,28 @@
+# Notifies via $HOME/bin/notify_redgreen (with notify-send)
+module RiotNotifier
+
+  class RedgreenBinary < Base
+    attr_reader :path
+    PATH = ENV['HOME'] + "/bin/notify_redgreen"
+
+    def initialize(path = PATH)
+      super()
+      @path = path
+    end
+
+    def notify(color, msg)
+      msg.gsub!(/</, '&lt;')
+      msg.gsub!(/"/, "\\\"")
+      exec "#{@path} #{color} \"#{msg}\""
+    end
+
+    def exec(*args)
+      Kernel.system(*args)
+    end
+
+    def self.usable?
+      File.exist?(PATH)
+    end
+  end
+
+end

data/lib/riot_notifier.rb

@@ -1,82 +1,14 @@
 require 'riot'
 
-module RiotNotifier
-  class Base < ::Riot::DotMatrixReporter
-    def notify(color, msg)
-      # overwrite me
-    end
+require 'riot_notifier/module'
+require 'riot_notifier/base'
 
-    def fail(desc, message)
-      super
-      say yellow("#{desc}: #{message}")
-      notify(:red, "FAILURE: #{message}")
-    end
+# Reverse load order!
 
-    def error(desc, error)
-      super
-      say red("#{desc}: #{error}")
-      notify(:red, "ERROR: #{error}")
-    end
+# Fallback
+require 'riot_notifier/none'
 
-    def results(time_taken)
-      super
-      unless bad_results?
-        notify(:green, "%d passes, %d failures, %d errors in %s seconds" % [passes, failures, errors, ("%0.6f" % time_taken)])
-      end
-    end
-
-  private
-
-    def bad_results?
-      failures + errors > 0
-    end
-  end
-
-  class Libnotify < Base
-    OPTIONS = {
-      :green => {
-        :icon_path => "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg",
-        :timeout => 2.5,
-        :urgency => :normal,
-        :summary => ":-)"
-      },
-      :red => {
-        :icon_path => "/usr/share/icons/gnome/scalable/emotes/face-angry.svg",
-        :timeout => 2.5,
-        :urgency => :critical,
-        :summary => ":-("
-      }
-    }
-
-    def initialize
-      require 'libnotify'
-      super()
-    end
-
-    def notify(color, msg)
-      options = OPTIONS[color] or raise "unknown color #{color}"
-
-      ::Libnotify.show(options.merge(:body => msg))
-    end
-  end
-
-  class RedgreenNotifier < Base
-    attr_reader :path
-    PATH = ENV['HOME'] + "/bin/notify_redgreen"
-    
-    def initialize(path = PATH)
-      super()
-      @path = path
-    end
-
-    def notify(color, msg)
-      msg.gsub!(/</, '&lt;')
-      msg.gsub!(/"/, "\\\"")
-      exec "#{@path} #{color} \"#{msg}\""
-    end
-
-    def exec(*args)
-      Kernel.system(*args)
-    end
-  end
-end
+# Custom notifiers - loading is important for auto-detection
+# LIFO!
+require 'riot_notifier/redgreen_binary'
+require 'riot_notifier/libnotify'

data/test/helper.rb

@@ -1,5 +1,18 @@
+require 'rubygems'
 require 'riot'
 
 require 'riot_notifier'
 
-Riot.reporter = RiotNotifier::Libnotify
+Riot.reporter = RiotNotifier
+
+module Riot
+  class Situation
+    # Create backtrace for this exception.
+    def bt!(error)
+      return error if error.backtrace
+      raise error
+    rescue error.class => e
+      e
+    end
+  end
+end

data/test/test_riot_notifier.rb

@@ -1,9 +1,8 @@
-require 'rubygems'
 
 require 'helper'
 require 'stringio'
 
-class MockNotifier < ::RiotNotifier::Base
+class MockNotifier < ::RiotNotifier::None
   def initialize
     super(StringIO.new)
   end
@@ -11,17 +10,23 @@ class MockNotifier < ::RiotNotifier::Base
   def notify(color, msg)
     [ color, msg ]
   end
+
+  ::RiotNotifier.order.delete(self)
 end
 
 context "RiotNotifier" do
   context "with MockNotifier" do
-    setup { MockNotifier.new }
+    setup do
+      reporter = MockNotifier.new
+      reporter.describe_context(Riot::Context.new("test") {})
+      reporter
+    end
 
-    asserts("displays failure in red") { topic.fail("desc", "failed") }.equals([:red, "FAILURE: failed"])
-    asserts("displays error in red") { topic.error("desc", "errored") }.equals([:red, "ERROR: errored"])
+    asserts("notifies failure in red") { topic.fail("desc", "failed") }.equals([:red, "FAILURE: failed"])
+    asserts("notifies error in red") { topic.error("desc", bt!(ArgumentError.new("errored"))) }.equals([:red, "ERROR: errored"])
     asserts("doesn't display results with bad results") do
       topic.report("desc", [:fail, "failure"])
-      topic.report("desc", [:error, "error"])
+      topic.report("desc", [:error, bt!(ArgumentError.new("error"))])
       topic.results(23.0)
     end.nil
 
@@ -35,9 +40,9 @@ context "RiotNotifier" do
     end
   end # with MockNotifier
 
-  context "with RedgreenNotifier" do
+  context "with RedgreenBinary" do
     setup do
-      Class.new(RiotNotifier::RedgreenNotifier) do
+      Class.new(RiotNotifier::RedgreenBinary) do
         def exec(string)
           string
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: riot_notifier
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Peter Suschlik
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-07 00:00:00 +01:00
+date: 2009-12-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,11 +20,21 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.10.4
+        version: 0.10.9
+    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: libnotify
-  type: :runtime
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -45,8 +55,13 @@ files:
 - .watchr
 - README.rdoc
 - Rakefile
-- VERSION.yml
+- VERSION
 - lib/riot_notifier.rb
+- lib/riot_notifier/base.rb
+- lib/riot_notifier/libnotify.rb
+- lib/riot_notifier/module.rb
+- lib/riot_notifier/none.rb
+- lib/riot_notifier/redgreen_binary.rb
 - test/helper.rb
 - test/test_riot_notifier.rb
 has_rdoc: true

data/VERSION.yml

@@ -1,5 +0,0 @@
---- 
-:major: 0
-:minor: 0
-:patch: 6
-:build: