1020

pending completion

Build # 1020

Build Type

Pull #545

travis-ci

Committed by

kiela

Commit Message

<a href="https://github.com/guard/guard/commit/d5dcb0fe9">Change Ruby version from 1.9.2 to 1.9.3

Support for Ruby 1.9.2 was removed from on Sep 17, 2013:
https://github.com/guard/guard/commit/</a><a class="double-link" href="https://github.com/guard/guard/commit/17f32f800">17f32f800</a>

Pull Request Pull Request #545: Change Ruby version from 1.9.2 to 1.9.3

Run Details

5244 of 5361 relevant lines covered (97.82%)

85.46 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.51

/lib/guard/notifier.rb

require 'yaml'
require 'rbconfig'
require 'pathname'

require 'guard/ui'
require 'guard/notifiers/emacs'
require 'guard/notifiers/file_notifier'
require 'guard/notifiers/gntp'
require 'guard/notifiers/growl_notify'
require 'guard/notifiers/growl'
require 'guard/notifiers/libnotify'
require 'guard/notifiers/notifysend'
require 'guard/notifiers/rb_notifu'
require 'guard/notifiers/terminal_notifier'
require 'guard/notifiers/terminal_title'
require 'guard/notifiers/tmux'

module Guard

  # The notifier handles sending messages to different notifiers. Currently the
  # following
  # libraries are supported:
  #
  # * Ruby GNTP
  # * Growl
  # * GrowlNotify
  # * Libnotify
  # * rb-notifu
  # * emacs
  # * Terminal Notifier
  # * Terminal Title
  # * Tmux
  #
  # Please see the documentation of each notifier for more information about
  # the requirements
  # and configuration possibilities.
  #
  # Guard knows four different notification types:
  #
  # * success
  # * pending
  # * failed
  # * notify
  #
  # The notification type selection is based on the image option that is
  # sent to {#notify}. Each image type has its own notification type, and
  # notifications with custom images goes all sent as type `notify`. The
  # `gntp` and `growl_notify` notifiers are able to register these types
  # at Growl and allows customization of each notification type.
  #
  # Guard can be configured to make use of more than one notifier at once.
  #
  # @see Guard::Dsl
  #
  module Notifier

    extend self

    # List of available notifiers, grouped by functionality
    NOTIFIERS = [
      {
        gntp: GNTP,
        growl: Growl,
        growl_notify: GrowlNotify,
        terminal_notifier: TerminalNotifier,
        libnotify: Libnotify,
        notifysend: NotifySend,
        notifu: Notifu
      },
      { emacs: Emacs },
      { tmux: Tmux },
      { terminal_title: TerminalTitle },
      { file: FileNotifier }
    ]

    def notifiers
      ENV['GUARD_NOTIFIERS'] ? YAML::load(ENV['GUARD_NOTIFIERS']) : []
    end

    def notifiers=(notifiers)
      ENV['GUARD_NOTIFIERS'] = YAML::dump(notifiers)
    end

    # Clear available notifications.
    #
    def clear_notifiers
      ENV['GUARD_NOTIFIERS'] = nil
    end

    # Turn notifications on. If no notifications are defined in the `Guardfile`
    # Guard auto detects the first available library.
    #
    # @param [Hash] options the turn_on options
    # @option options [Boolean] silent disable any logging
    #
    def turn_on(opts = {})
      _auto_detect_notification if notifiers.empty? && (!::Guard.options || ::Guard.options[:notify])

      if notifiers.empty?
        turn_off
      else
        notifiers.each do |notifier|
          notifier_class = _get_notifier_module(notifier[:name])
          ::Guard::UI.info "Guard is using #{ notifier_class.title } to send notifications." unless opts[:silent]

          notifier_class.turn_on if notifier_class.respond_to?(:turn_on)
        end

        ENV['GUARD_NOTIFY'] = 'true'
      end
    end

    # Turn notifications off.
    #
    def turn_off
      notifiers.each do |notifier|
        notifier_class = _get_notifier_module(notifier[:name])

        notifier_class.turn_off if notifier_class.respond_to?(:turn_off)
      end

      ENV['GUARD_NOTIFY'] = 'false'
    end

    # Toggle the system notifications on/off
    #
    def toggle
      if enabled?
        ::Guard::UI.info 'Turn off notifications'
        turn_off
      else
        turn_on
      end
    end

    # Test if the notifications are on.
    #
    # @return [Boolean] whether the notifications are on
    #
    def enabled?
      ENV['GUARD_NOTIFY'] == 'true'
    end

    # Add a notification library to be used.
    #
    # @param [Symbol] name the name of the notifier to use
    # @param [Hash] options the notifier options
    # @option options [String] silent disable any error message
    # @return [Boolean] if the notification could be added
    #
    def add_notifier(name, opts = {})
      return turn_off if name == :off

      notifier_class = _get_notifier_module(name)

      if notifier_class && notifier_class.available?(opts)
        self.notifiers = notifiers << { name: name, options: opts }
        true
      else
        false
      end
    end

    # Show a system notification with all configured notifiers.
    #
    # @param [String] message the message to show
    # @option opts [Symbol, String] image the image symbol or path to an image
    # @option opts [String] title the notification title
    #
    def notify(message, opts = {})
      return unless enabled?

      notifiers.each do |notifier|
        notifier = _get_notifier_module(notifier[:name]).new(notifier[:options])

        begin
          notifier.notify(message, opts.dup)
        rescue Exception => e
          ::Guard::UI.error "Error sending notification with #{ notifier.name }: #{ e.message }"
          ::Guard::UI.debug e.backtrace.join("\n")
        end
      end
    end

    private

    # Get the notifier module for the given name.
    #
    # @param [Symbol] name the notifier name
    # @return [Module] the notifier module
    #
    def _get_notifier_module(name)
      NOTIFIERS.each do |group|
        if notifier = group.find { |n, _| n == name }
          return notifier.last
        end
      end

      nil
    end

    # Auto detect the available notification library. This goes through
    # the list of supported notification gems and picks the first that
    # is available in each notification group.
    #
    def _auto_detect_notification
      self.notifiers = []
      available = nil

      NOTIFIERS.each do |group|
        notifier_added = group.find { |name, klass| add_notifier(name, silent: true) }
        available ||= notifier_added
      end

      ::Guard::UI.info('Guard could not detect any of the supported notification libraries.') unless available
    end
  end

end

1	require 'yaml'	5✔
2	require 'rbconfig'	5✔
3	require 'pathname'	5✔
4
5	require 'guard/ui'	5✔
6	require 'guard/notifiers/emacs'	5✔
7	require 'guard/notifiers/file_notifier'	5✔
8	require 'guard/notifiers/gntp'	5✔
9	require 'guard/notifiers/growl_notify'	5✔
10	require 'guard/notifiers/growl'	5✔
11	require 'guard/notifiers/libnotify'	5✔
12	require 'guard/notifiers/notifysend'	5✔
13	require 'guard/notifiers/rb_notifu'	5✔
14	require 'guard/notifiers/terminal_notifier'	5✔
15	require 'guard/notifiers/terminal_title'	5✔
16	require 'guard/notifiers/tmux'	5✔
17
18	module Guard	5✔
19
20	# The notifier handles sending messages to different notifiers. Currently the
21	# following
22	# libraries are supported:
23	#
24	# * Ruby GNTP
25	# * Growl
26	# * GrowlNotify
27	# * Libnotify
28	# * rb-notifu
29	# * emacs
30	# * Terminal Notifier
31	# * Terminal Title
32	# * Tmux
33	#
34	# Please see the documentation of each notifier for more information about
35	# the requirements
36	# and configuration possibilities.
37	#
38	# Guard knows four different notification types:
39	#
40	# * success
41	# * pending
42	# * failed
43	# * notify
44	#
45	# The notification type selection is based on the image option that is
46	# sent to {#notify}. Each image type has its own notification type, and
47	# notifications with custom images goes all sent as type `notify`. The
48	# `gntp` and `growl_notify` notifiers are able to register these types
49	# at Growl and allows customization of each notification type.
50	#
51	# Guard can be configured to make use of more than one notifier at once.
52	#
53	# @see Guard::Dsl
54	#
55	module Notifier	5✔
56
57	extend self	5✔
58
59	# List of available notifiers, grouped by functionality
60	NOTIFIERS = [	5✔
61	{
62	gntp: GNTP,	1 only rbx ✔
63	growl: Growl,	1 only rbx ✔
64	growl_notify: GrowlNotify,	1 only rbx ✔
65	terminal_notifier: TerminalNotifier,	1 only rbx ✔
66	libnotify: Libnotify,	1 only rbx ✔
67	notifysend: NotifySend,	1 only rbx ✔
68	notifu: Notifu	1 only rbx ✔
69	},	1 only rbx ✔
70	{ emacs: Emacs },	1 only rbx ✔
71	{ tmux: Tmux },	1 only rbx ✔
72	{ terminal_title: TerminalTitle },	1 only rbx ✔
73	{ file: FileNotifier }	1 only rbx ✔
74	]
75
76	def notifiers	5✔
77	ENV['GUARD_NOTIFIERS'] ? YAML::load(ENV['GUARD_NOTIFIERS']) : []	2,232✔
78	end
79
80	def notifiers=(notifiers)	5✔
81	ENV['GUARD_NOTIFIERS'] = YAML::dump(notifiers)	484✔
82	end
83
84	# Clear available notifications.
85	#
86	def clear_notifiers	5✔
87	ENV['GUARD_NOTIFIERS'] = nil	125✔
88	end
89
90	# Turn notifications on. If no notifications are defined in the `Guardfile`
91	# Guard auto detects the first available library.
92	#
93	# @param [Hash] options the turn_on options
94	# @option options [Boolean] silent disable any logging
95	#
96	def turn_on(opts = {})	209✔
97	_auto_detect_notification if notifiers.empty? && (!::Guard.options \|\| ::Guard.options[:notify])	823✔
98
99	if notifiers.empty?	846✔
100	turn_off	16 all except jruby-19mode ✔
101	else
102	notifiers.each do \|notifier\|	830✔
103	notifier_class = _get_notifier_module(notifier[:name])	894✔
104	::Guard::UI.info "Guard is using #{ notifier_class.title } to send notifications." unless opts[:silent]	945✔
105
106	notifier_class.turn_on if notifier_class.respond_to?(:turn_on)	892✔
107	end
108
109	ENV['GUARD_NOTIFY'] = 'true'	830✔
110	end
111	end
112
113	# Turn notifications off.
114	#
115	def turn_off	5✔
116	notifiers.each do \|notifier\|	246✔
117	notifier_class = _get_notifier_module(notifier[:name])	94✔
118
119	notifier_class.turn_off if notifier_class.respond_to?(:turn_off)	87✔
120	end
121
122	ENV['GUARD_NOTIFY'] = 'false'	246✔
123	end
124
125	# Toggle the system notifications on/off
126	#
127	def toggle	5✔
128	if enabled?	10✔
129	::Guard::UI.info 'Turn off notifications'	5✔
130	turn_off	5✔
131	else
132	turn_on	5✔
133	end
134	end
135
136	# Test if the notifications are on.
137	#
138	# @return [Boolean] whether the notifications are on
139	#
140	def enabled?	5✔
141	ENV['GUARD_NOTIFY'] == 'true'	130✔
142	end
143
144	# Add a notification library to be used.
145	#
146	# @param [Symbol] name the name of the notifier to use
147	# @param [Hash] options the notifier options
148	# @option options [String] silent disable any error message
149	# @return [Boolean] if the notification could be added
150	#
151	def add_notifier(name, opts = {})	6✔
152	return turn_off if name == :off	958✔
153
154	notifier_class = _get_notifier_module(name)	955✔
155
156	if notifier_class && notifier_class.available?(opts)	955✔
157	self.notifiers = notifiers << { name: name, options: opts }	101✔
158	true	101✔
159	else
160	false	854✔
161	end
162	end
163
164	# Show a system notification with all configured notifiers.
165	#
166	# @param [String] message the message to show
167	# @option opts [Symbol, String] image the image symbol or path to an image
168	# @option opts [String] title the notification title
169	#
170	def notify(message, opts = {})	5✔
171	return unless enabled?	24✔
172
173	notifiers.each do \|notifier\|	8✔
174	notifier = _get_notifier_module(notifier[:name]).new(notifier[:options])	13✔
175
176	begin	13✔
177	notifier.notify(message, opts.dup)	13✔
178	rescue Exception => e	×
179	::Guard::UI.error "Error sending notification with #{ notifier.name }: #{ e.message }"	×
180	::Guard::UI.debug e.backtrace.join("\n")	×
181	end	×
182	end
183	end
184
185	private	5✔
186
187	# Get the notifier module for the given name.
188	#
189	# @param [Symbol] name the notifier name
190	# @return [Module] the notifier module
191	#
192	def _get_notifier_module(name)	5✔
193	NOTIFIERS.each do \|group\|	1,416✔
194	if notifier = group.find { \|n, _\| n == name }	18,604✔
195	return notifier.last	1,889✔
196	end
197	end
198
199	nil	1 only rbx ✔
200	end
201
202	# Auto detect the available notification library. This goes through
203	# the list of supported notification gems and picks the first that
204	# is available in each notification group.
205	#
206	def _auto_detect_notification	5✔
207	self.notifiers = []	127✔
208	available = nil	127✔
209
210	NOTIFIERS.each do \|group\|	127✔
211	notifier_added = group.find { \|name, klass\| add_notifier(name, silent: true) }	1,817✔
212	available \|\|= notifier_added	635✔
213	end
214
215	::Guard::UI.info('Guard could not detect any of the supported notification libraries.') unless available	102✔
216	end
217	end
218
219	end	26 only rbx ✔

guard / guard / 1020

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous