Module: Autotest::Growl

Defined in:
lib/autotest/growl.rb

Overview

Autotest::Growl

FEATUERS:

  • Display autotest results as local or remote Growl notifications.

  • Clean the terminal on every test cycle while maintaining scrollback.

SYNOPSIS:

~/.autotest

require 'autotest/growl'

Constant Summary collapse

GEM_PATH = 
File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
@@remote_notification = 
false
@@one_notification_per_run = 
false
@@clear_terminal = 
true
@@hide_label = 
false
@@show_modified_files = 
false

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.clear_terminal=(boolean) ⇒ Object

Whether to clear the terminal before running tests (default) or not.



44
45
46
 
# File 'lib/autotest/growl.rb', line 44

def self.clear_terminal=(boolean)
  @@clear_terminal = boolean
end

.growl(title, message, icon, priority = 0, stick = "") ⇒ Object

Display a message through Growl.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/autotest/growl.rb', line 62

def self.growl(title, message, icon, priority=0, stick="")
  growl = File.join(GEM_PATH, 'growl', 'growlnotify')
  image = File.join(ENV['HOME'], '.autotest-growl', "#{icon}.png")
  image = File.join(GEM_PATH, 'img', "#{icon}.png") unless File.exists?(image)
  case RUBY_PLATFORM
  when /mswin/
    growl += '.com'
    system %(#{growl} #{message.inspect} /a:"Autotest" /r:"Autotest" /n:"Autotest" /i:"#{image}" /p:#{priority} /t:"#{title}")
  when /darwin/
    if @@remote_notification
      system %(#{growl} -H localhost -n Autotest --image '#{image}' -p #{priority} -m '#{message}' '#{title}' #{stick} &)
    else
      system %(#{growl} -w -n Autotest --image '#{image}' -p #{priority} -m '#{message}' '#{title}' #{stick} &)
    end
  else
    raise "#{RUBY_PLATFORM} is not supported by autotest-growl" 
  end
end

.hide_label=(boolean) ⇒ Object

Whether to display the label (default) or not.



50
51
52
 
# File 'lib/autotest/growl.rb', line 50

def self.hide_label=(boolean)
  @@hide_label = boolean
end

.one_notification_per_run=(boolean) ⇒ Object

Whether to limit the number of notifications per run to one or not (default).



38
39
40
 
# File 'lib/autotest/growl.rb', line 38

def self.one_notification_per_run=(boolean)
  @@one_notification_per_run = boolean
end

.remote_notification=(boolean) ⇒ Object

Whether to use remote or local notificaton (default).



32
33
34
 
# File 'lib/autotest/growl.rb', line 32

def self.remote_notification=(boolean)
  @@remote_notification = boolean
end

.show_modified_files=(boolean) ⇒ Object

Whether to display the modified files or not (default).



56
57
58
 
# File 'lib/autotest/growl.rb', line 56

def self.show_modified_files=(boolean)
  @@show_modified_files = boolean
end

Instance Method Details

#ran_command ⇒ Object

Parse the RSpec and Test::Unit results and send them to Growl.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/autotest/growl.rb', line 105

Autotest.add_hook :ran_command do |autotest|
  unless @@one_notification_per_run && @ran_tests
    result = Result.new(autotest)
    if result.exists?
      case result.framework
      when 'test-unit'        
        if result.has?('test-error')
          growl @label + 'Cannot run some unit tests.', "#{result.get('test-error')} in #{result.get('test')}", 'error', 2
        elsif result.has?('test-failed')
          growl @label + 'Some unit tests failed.', "#{result['test-failed']} of #{result.get('test-assertion')} in #{result.get('test')} failed", 'failed', 2
        else
          growl @label + 'All unit tests passed.', "#{result.get('test-assertion')} in #{result.get('test')}", 'passed', -2
        end
      when 'rspec'
        if result.has?('example-failed')
          growl @label + 'Some RSpec examples failed.', "#{result['example-failed']} of #{result.get('example')} failed", 'failed', 2
        elsif result.has?('example-pending')
          growl @label + 'Some RSpec examples are pending.', "#{result['example-pending']} of #{result.get('example')} pending", 'pending', -1
        else
          growl @label + 'All RSpec examples passed.', "#{result.get('example')}", 'passed', -2
        end
      end
    else
      growl @label + 'Could not run tests.', '', 'error', 2
    end
    @ran_test = true
  end
  false
end

#ran_features ⇒ Object

Parse the Cucumber results and sent them to Growl.



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/autotest/growl.rb', line 137

Autotest.add_hook :ran_features do |autotest|
  unless @@one_notification_per_run && @ran_features
    result = Result.new(autotest)
    if result.exists?
      case result.framework
      when 'cucumber'
        explanation = []
        if result.has?('scenario-undefined') || result.has?('step-undefined')
          explanation << "#{result['scenario-undefined']} of #{result.get('scenario')} not defined" if result['scenario-undefined']
          explanation << "#{result['step-undefined']} of #{result.get('step')} not defined" if result['step-undefined']
          growl @label + 'Some Cucumber scenarios are not defined.', "#{explanation.join("\n")}", 'pending', -1          
        elsif result.has?('scenario-failed') || result.has?('step-failed')
          explanation << "#{result['scenario-failed']} of #{result.get('scenario')} failed" if result['scenario-failed']
          explanation << "#{result['step-failed']} of #{result.get('step')} failed" if result['step-failed']
          growl @label + 'Some Cucumber scenarios failed.', "#{explanation.join("\n")}", 'failed', 2
        elsif result.has?('scenario-pending') || result.has?('step-pending')
          explanation << "#{result['scenario-pending']} of #{result.get('scenario')} pending" if result['scenario-pending']
          explanation << "#{result['step-pending']} of #{result.get('step')} pending" if result['step-pending']
          growl @label + 'Some Cucumber scenarios are pending.', "#{explanation.join("\n")}", 'pending', -1          
        else
          growl @label + 'All Cucumber features passed.', '', 'passed', -2
        end      
      end
    else
      growl @label + 'Could not run features.', '', 'error', 2
    end
    @ran_features = true
  end
  false
end

#run_command ⇒ Object

Set the label and clear the terminal.



96
97
98
99
100
101
 
# File 'lib/autotest/growl.rb', line 96

Autotest.add_hook :run_command do
  @label = File.basename(Dir.pwd).upcase + ': ' if !@@hide_label
  print "\n"*2 + '-'*80 + "\n"*2
  print "\e[2J\e[f" if @@clear_terminal
  false
end

#updated ⇒ Object

Display the modified files.



83
84
85
86
87
88
89
90
91
92
 
# File 'lib/autotest/growl.rb', line 83

Autotest.add_hook :updated do |autotest, modified|
  @ran_tests = @ran_features = false
  if @@show_modified_files
    if modified != @last_modified
      growl @label + 'Modifications detected.', modified.collect {|m| m[0]}.join(', '), 'info', 0
      @last_modified = modified
    end
  end
  false
end