test_notifier 0.2.1 → 0.3.0

data/README.rdoc

@@ -40,11 +40,17 @@ Then, install the gem with <tt>sudo gem install test_notifier</tt>
 
 If you're using Test::Unit you should add <tt>require "test_notifier/runner/test_unit"</tt> to your <tt>test_helper.rb</tt> file.
 
-If you're using RSpec you should add <tt>require "test_notifier/runner/spec"</tt> to your <tt>spec_helper.rb</tt> file. If you're using Rails 2, you need to add <tt>require "test_notifier/runner/rspec"</tt> instead.
+If you're using RSpec you should add <tt>require "test_notifier/runner/spec"</tt> to your <tt>spec_helper.rb</tt> file. If you're using RSpec 2, you need to add <tt>require "test_notifier/runner/rspec"</tt> instead.
 
 If you're using Autotest you should add <tt>require test_notifier/runner/autotest"</tt> to
 the file <tt>~/.autotest</tt>
 
+You can define your notifier.
+
+  TestNotifier.default_notifier = :growl
+
+The available notifiers are <tt>:growl</tt>, <tt>:kdialog</tt>, <tt>:knotify</tt>, <tt>:notify_send</tt>, <tt>:osd_cat</tt> and <tt>:snarl</tt>.
+
 == Maintainer
 
 * Nando Vieira - http://simplesideias.com.br

data/lib/test_notifier.rb

@@ -1,8 +1,13 @@
 module TestNotifier
   class << self
-    attr_accessor :__notifier
+    attr_accessor :__notifier__
+    attr_accessor :default_notifier
   end
 
+  extend self
+
+  class UnsupportedNotifierError < StandardError; end
+
   IMAGES = {
     :fail    => File.dirname(__FILE__) + "/../resources/fail.png",
     :error   => File.dirname(__FILE__) + "/../resources/error.png",
@@ -14,7 +19,7 @@ module TestNotifier
     :success => "Passed!"
   }
 
-  def self.notify(options)
+  def notify(options)
     options.merge!({
       :title => TITLES[options[:status]],
       :image => IMAGES[options[:status]]
@@ -23,14 +28,14 @@ module TestNotifier
     notifier.notify(options)
   end
 
-  def self.notifier
-    self.__notifier ||= begin
-      TestNotifier::Notifier.constants.sort.collect do |const|
-        self.__notifier = TestNotifier::Notifier.const_get(const)
-        break if self.__notifier.supported?
-      end
+  def notifier
+    self.__notifier__ ||= begin
+      notifier = nil
+      notifier = TestNotifier::Notifier.supported_notifier_from_name(default_notifier) if default_notifier
+      notifier = TestNotifier::Notifier.supported_notifiers.first unless notifier
 
-      self.__notifier
+      raise UnsupportedNotifierError, "You have no supported notifiers installed. Please read documentation." unless notifier
+      notifier
     end
   end
 

data/lib/test_notifier/notifier.rb

@@ -6,5 +6,33 @@ module TestNotifier
     autoload :Knotify,    "test_notifier/notifier/knotify"
     autoload :Kdialog,    "test_notifier/notifier/kdialog"
     autoload :NotifySend, "test_notifier/notifier/notify_send"
+
+    extend self
+
+    def notifiers
+      constants.collect do |name|
+        const_get(name)
+      end
+    end
+
+    def supported_notifiers
+      notifiers.select {|notifier| notifier.supported?}
+    end
+
+    def from_name(name)
+      notifier = const_get(classify(name.to_s))
+    rescue NameError
+      nil
+    end
+
+    def supported_notifier_from_name(name)
+      notifier = from_name(name)
+      notifier && notifier.supported? ? notifier : nil
+    end
+
+    private
+    def classify(string)
+      string.gsub(/_(.)/sm) { "#{$1.upcase}" }.gsub(/^(.)/) { "#{$1.upcase}" }
+    end
   end
 end

data/lib/test_notifier/version.rb

@@ -1,8 +1,8 @@
 module TestNotifier
   module Version
     MAJOR = 0
-    MINOR = 2
-    PATCH = 1
+    MINOR = 3
+    PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/test/notifier_test.rb

@@ -0,0 +1,39 @@
+require "test_helper"
+
+class TestNotifier::NotifierTest < Test::Unit::TestCase
+  def setup
+    unsupport_all_notifiers
+  end
+
+  test "retrieve list of supported notifiers" do
+    TestNotifier::Notifier::Snarl.expects(:supported?).returns(true)
+    TestNotifier::Notifier::Knotify.expects(:supported?).returns(true)
+
+    assert_equal 2, TestNotifier::Notifier.supported_notifiers.size
+  end
+
+  test "retrieve list of all notifiers" do
+    assert_equal 6, TestNotifier::Notifier.notifiers.size
+  end
+
+  test "return notifier by its name" do
+    assert_equal TestNotifier::Notifier::OsdCat, TestNotifier::Notifier.from_name(:osd_cat)
+    assert_equal TestNotifier::Notifier::NotifySend, TestNotifier::Notifier.from_name(:notify_send)
+    assert_equal TestNotifier::Notifier::Growl, TestNotifier::Notifier.from_name(:growl)
+  end
+
+  test "return notifier by its name when supported" do
+    TestNotifier::Notifier::Snarl.expects(:supported?).returns(true)
+
+    assert_equal TestNotifier::Notifier::Snarl, TestNotifier::Notifier.supported_notifier_from_name(:snarl)
+  end
+
+  test "return nil when have supported notifiers" do
+    assert_nil TestNotifier::Notifier.supported_notifier_from_name(:snarl)
+  end
+
+  test "return nil when an invalid notifier name is provided" do
+    assert_nil TestNotifier::Notifier.from_name(:invalid)
+    assert_nil TestNotifier::Notifier.supported_notifier_from_name(:invalid)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+gem "test-unit"
+require "test/unit"
+require "mocha"
+
+require "test_notifier"
+
+class Test::Unit::TestCase
+  private
+  def unsupport_all_notifiers
+    TestNotifier::Notifier.constants.each do |name|
+      notifier = TestNotifier::Notifier.const_get(name)
+      notifier.stubs(:supported?).returns(false)
+    end
+  end
+end

data/test/test_notifier_test.rb

@@ -0,0 +1,40 @@
+require "test_helper"
+
+class TestNotifierTest < Test::Unit::TestCase
+  def setup
+    TestNotifier.__notifier__ = nil
+    unsupport_all_notifiers
+  end
+
+  test "return default notifier when is set" do
+    TestNotifier.default_notifier = :osd_cat
+    TestNotifier::Notifier::OsdCat.expects(:supported?).returns(true)
+
+    assert_equal TestNotifier::Notifier::OsdCat, TestNotifier.notifier
+  end
+
+  test "return next available notifier when default notifier is not supported" do
+    TestNotifier.default_notifier = :osd_cat
+    TestNotifier::Notifier::Snarl.expects(:supported?).returns(true)
+
+    assert_equal TestNotifier::Notifier::Snarl, TestNotifier.notifier
+  end
+
+  test "raise error when there's no supported notifier" do
+    assert_raise TestNotifier::UnsupportedNotifierError do
+      TestNotifier.notifier
+    end
+  end
+
+  test "send notification to supported notifier" do
+    TestNotifier::Notifier::Snarl.expects(:supported?).returns(true)
+    TestNotifier::Notifier::Snarl.expects(:notify).with({
+      :status  => :fail,
+      :message => "You have failed!",
+      :title   => TestNotifier::TITLES[:fail],
+      :image   => TestNotifier::IMAGES[:fail]
+    })
+
+    TestNotifier.notify :status => :fail, :message => "You have failed!"
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: test_notifier
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Nando Vieira
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-22 00:00:00 -03:00
+date: 2010-08-27 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -53,6 +53,9 @@ files:
 - resources/fail.png
 - resources/register-growl.scpt
 - resources/success.png
+- test/notifier_test.rb
+- test/test_helper.rb
+- test/test_notifier_test.rb
 has_rdoc: true
 homepage: http://github.com/fnando/test_notifier
 licenses: []
@@ -87,5 +90,7 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Display system notifications (dbus, growl and snarl) after running tests.
-test_files: []
-
+test_files: 
+- test/notifier_test.rb
+- test/test_helper.rb
+- test/test_notifier_test.rb