Module: Notifier

Extended by:
Notifier
Included in:
Notifier
Defined in:
lib/notifier.rb,
lib/notifier/hud.rb,
lib/notifier/snarl.rb,
lib/notifier/kdialog.rb,
lib/notifier/knotify.rb,
lib/notifier/osd_cat.rb,
lib/notifier/placebo.rb,
lib/notifier/version.rb,
lib/notifier/notify_send.rb,
lib/notifier/terminal_notifier.rb

Defined Under Namespace

Modules: Hud, Kdialog, Knotify, NotifySend, OsdCat, Placebo, Snarl, TerminalNotifier, Version

Class Attribute Summary collapse

Instance Method Summary collapse

Class Attribute Details

.default_notifierObject

Returns the value of attribute default_notifier.



25
26
27
# File 'lib/notifier.rb', line 25

def default_notifier
  @default_notifier
end

Instance Method Details

#from_name(name) ⇒ Object



53
54
55
56
57
# File 'lib/notifier.rb', line 53

def from_name(name)
  const_get(classify(name.to_s))
rescue StandardError
  nil
end

#notifierObject



32
33
34
35
# File 'lib/notifier.rb', line 32

def notifier
  supported_notifier_from_name(ENV.fetch("NOTIFIER", default_notifier)) ||
    supported_notifiers.first
end

#notifiersObject



41
42
43
44
45
46
47
# File 'lib/notifier.rb', line 41

def notifiers
  notifiers = constants.filter_map do |name|
    const_get(name) unless skip_constants.include?(name.to_s)
  end

  notifiers.sort_by(&:name) + [Placebo]
end

#notify(options) ⇒ Object



37
38
39
# File 'lib/notifier.rb', line 37

def notify(options)
  notifier.notify(options)
end

#os?(regex) ⇒ Boolean

Returns:

  • (Boolean)


64
65
66
# File 'lib/notifier.rb', line 64

def os?(regex)
  RUBY_PLATFORM =~ regex || RbConfig::CONFIG["host_os"] =~ regex
end

#skip_constantsObject



28
29
30
# File 'lib/notifier.rb', line 28

def skip_constants
  @skip_constants ||= %w[Placebo Adapters Version]
end

#supported_notifier_from_name(name) ⇒ Object



59
60
61
62
# File 'lib/notifier.rb', line 59

def supported_notifier_from_name(name)
  notifier = from_name(name)
  notifier&.supported? ? notifier : nil
end

#supported_notifiersObject



49
50
51
# File 'lib/notifier.rb', line 49

def supported_notifiers
  notifiers.select(&:supported?)
end