guard-srb 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. checksums.yaml +7 -0
  2. data/.rubocop.yml +37 -0
  3. data/.tool-versions +1 -0
  4. data/CHANGELOG.md +5 -0
  5. data/CODE_OF_CONDUCT.md +84 -0
  6. data/Gemfile +14 -0
  7. data/Gemfile.lock +125 -0
  8. data/Guardfile +16 -0
  9. data/LICENSE.txt +21 -0
  10. data/README.md +92 -0
  11. data/Rakefile +18 -0
  12. data/lib/guard/srb/runner.rb +70 -0
  13. data/lib/guard/srb/templates/Guardfile +3 -0
  14. data/lib/guard/srb/version.rb +8 -0
  15. data/lib/guard/srb.rb +105 -0
  16. data/sorbet/config +5 -0
  17. data/sorbet/rbi/annotations/rainbow.rbi +269 -0
  18. data/sorbet/rbi/gems/ast@2.4.2.rbi +584 -0
  19. data/sorbet/rbi/gems/coderay@1.1.3.rbi +3437 -0
  20. data/sorbet/rbi/gems/diff-lcs@1.5.0.rbi +1079 -0
  21. data/sorbet/rbi/gems/ffi@1.15.5.rbi +8 -0
  22. data/sorbet/rbi/gems/formatador@1.1.0.rbi +8 -0
  23. data/sorbet/rbi/gems/guard-compat@1.2.1.rbi +103 -0
  24. data/sorbet/rbi/gems/guard-minitest@2.4.6.rbi +299 -0
  25. data/sorbet/rbi/gems/guard@2.16.2.rbi +2286 -0
  26. data/sorbet/rbi/gems/json@2.6.3.rbi +1541 -0
  27. data/sorbet/rbi/gems/listen@3.8.0.rbi +1181 -0
  28. data/sorbet/rbi/gems/lumberjack@1.2.8.rbi +1501 -0
  29. data/sorbet/rbi/gems/method_source@1.0.0.rbi +272 -0
  30. data/sorbet/rbi/gems/minitest@5.18.0.rbi +2354 -0
  31. data/sorbet/rbi/gems/mocha@2.0.2.rbi +3934 -0
  32. data/sorbet/rbi/gems/nenv@0.3.0.rbi +146 -0
  33. data/sorbet/rbi/gems/netrc@0.11.0.rbi +161 -0
  34. data/sorbet/rbi/gems/notiffany@0.1.3.rbi +1078 -0
  35. data/sorbet/rbi/gems/parallel@1.23.0.rbi +273 -0
  36. data/sorbet/rbi/gems/parser@3.2.2.1.rbi +9454 -0
  37. data/sorbet/rbi/gems/pry@0.14.2.rbi +10079 -0
  38. data/sorbet/rbi/gems/rainbow@3.1.1.rbi +402 -0
  39. data/sorbet/rbi/gems/rake@13.0.6.rbi +3119 -0
  40. data/sorbet/rbi/gems/rb-fsevent@0.11.2.rbi +8 -0
  41. data/sorbet/rbi/gems/rb-inotify@0.10.1.rbi +8 -0
  42. data/sorbet/rbi/gems/rbi@0.0.16.rbi +3049 -0
  43. data/sorbet/rbi/gems/regexp_parser@2.8.0.rbi +3765 -0
  44. data/sorbet/rbi/gems/rexml@3.2.5.rbi +4717 -0
  45. data/sorbet/rbi/gems/rubocop-ast@1.28.1.rbi +6967 -0
  46. data/sorbet/rbi/gems/rubocop@1.50.2.rbi +55367 -0
  47. data/sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi +1317 -0
  48. data/sorbet/rbi/gems/ruby2_keywords@0.0.5.rbi +8 -0
  49. data/sorbet/rbi/gems/shellany@0.0.1.rbi +101 -0
  50. data/sorbet/rbi/gems/spoom@1.2.1.rbi +2536 -0
  51. data/sorbet/rbi/gems/tapioca@0.11.6.rbi +3246 -0
  52. data/sorbet/rbi/gems/thor@1.2.2.rbi +3965 -0
  53. data/sorbet/rbi/gems/unicode-display_width@2.4.2.rbi +65 -0
  54. data/sorbet/rbi/gems/unparser@0.6.7.rbi +4515 -0
  55. data/sorbet/rbi/gems/yard-sorbet@0.8.1.rbi +426 -0
  56. data/sorbet/rbi/gems/yard@0.9.34.rbi +17907 -0
  57. data/sorbet/rbi/todo.rbi +7 -0
  58. data/sorbet/tapioca/config.yml +13 -0
  59. data/sorbet/tapioca/require.rb +14 -0
  60. metadata +155 -0
@@ -0,0 +1,1078 @@
1
+ # typed: true
2
+
3
+ # DO NOT EDIT MANUALLY
4
+ # This is an autogenerated file for types exported from the `notiffany` gem.
5
+ # Please instead update this file by running `bin/tapioca gem notiffany`.
6
+
7
+ # TODO: this probably deserves a gem of it's own
8
+ #
9
+ # source://notiffany//lib/notiffany/notifier/base.rb#3
10
+ module Notiffany
11
+ class << self
12
+ # The notifier handles sending messages to different notifiers. Currently the
13
+ # following libraries are supported:
14
+ #
15
+ # * Ruby GNTP
16
+ # * Growl
17
+ # * Libnotify
18
+ # * rb-notifu
19
+ # * emacs
20
+ # * Terminal Notifier
21
+ # * Terminal Title
22
+ # * Tmux
23
+ #
24
+ # Please see the documentation of each notifier for more information about
25
+ # the requirements
26
+ # and configuration possibilities.
27
+ #
28
+ # Notiffany knows four different notification types:
29
+ #
30
+ # * success
31
+ # * pending
32
+ # * failed
33
+ # * notify
34
+ #
35
+ # The notification type selection is based on the image option that is
36
+ # sent to {#notify}. Each image type has its own notification type, and
37
+ # notifications with custom images goes all sent as type `notify`. The
38
+ # `gntp` notifier is able to register these types
39
+ # at Growl and allows customization of each notification type.
40
+ #
41
+ # Notiffany can be configured to make use of more than one notifier at once.
42
+ #
43
+ # source://notiffany//lib/notiffany/notifier.rb#41
44
+ def connect(options = T.unsafe(nil)); end
45
+ end
46
+ end
47
+
48
+ # source://notiffany//lib/notiffany/notifier/base.rb#4
49
+ class Notiffany::Notifier
50
+ # @return [Notifier] a new instance of Notifier
51
+ #
52
+ # source://notiffany//lib/notiffany/notifier.rb#82
53
+ def initialize(opts); end
54
+
55
+ # Test if notifiers are currently turned on
56
+ #
57
+ # @return [Boolean]
58
+ #
59
+ # source://notiffany//lib/notiffany/notifier.rb#138
60
+ def active?; end
61
+
62
+ # source://notiffany//lib/notiffany/notifier.rb#160
63
+ def available; end
64
+
65
+ # Returns the value of attribute config.
66
+ #
67
+ # source://notiffany//lib/notiffany/notifier.rb#80
68
+ def config; end
69
+
70
+ # source://notiffany//lib/notiffany/notifier.rb#92
71
+ def disconnect; end
72
+
73
+ # Test if the notifications can be enabled based on ENV['GUARD_NOTIFY']
74
+ #
75
+ # @return [Boolean]
76
+ #
77
+ # source://notiffany//lib/notiffany/notifier.rb#133
78
+ def enabled?; end
79
+
80
+ # Show a system notification with all configured notifiers.
81
+ #
82
+ # @option opts
83
+ # @option opts
84
+ # @param message [String] the message to show
85
+ # @param opts [Hash] a customizable set of options
86
+ #
87
+ # source://notiffany//lib/notiffany/notifier.rb#148
88
+ def notify(message, message_opts = T.unsafe(nil)); end
89
+
90
+ # Turn notifications off.
91
+ #
92
+ # source://notiffany//lib/notiffany/notifier.rb#120
93
+ def turn_off; end
94
+
95
+ # Turn notifications on.
96
+ #
97
+ # @option options
98
+ # @param options [Hash] the turn_on options
99
+ #
100
+ # source://notiffany//lib/notiffany/notifier.rb#109
101
+ def turn_on(options = T.unsafe(nil)); end
102
+
103
+ private
104
+
105
+ # source://notiffany//lib/notiffany/notifier.rb#191
106
+ def _activate; end
107
+
108
+ # source://notiffany//lib/notiffany/notifier.rb#170
109
+ def _check_server!; end
110
+
111
+ # @return [Boolean]
112
+ #
113
+ # source://notiffany//lib/notiffany/notifier.rb#174
114
+ def _client?; end
115
+
116
+ # source://notiffany//lib/notiffany/notifier.rb#178
117
+ def _detect_or_add_notifiers; end
118
+
119
+ # source://notiffany//lib/notiffany/notifier.rb#166
120
+ def _env; end
121
+
122
+ # @return [Boolean]
123
+ #
124
+ # source://notiffany//lib/notiffany/notifier.rb#187
125
+ def _notification_wanted?; end
126
+
127
+ # source://notiffany//lib/notiffany/notifier.rb#202
128
+ def _turn_on_notifiers(options); end
129
+ end
130
+
131
+ # source://notiffany//lib/notiffany/notifier/base.rb#5
132
+ class Notiffany::Notifier::Base
133
+ # @return [Base] a new instance of Base
134
+ #
135
+ # source://notiffany//lib/notiffany/notifier/base.rb#47
136
+ def initialize(opts = T.unsafe(nil)); end
137
+
138
+ # source://notiffany//lib/notiffany/notifier/base.rb#75
139
+ def _image_path(image); end
140
+
141
+ # source://notiffany//lib/notiffany/notifier/base.rb#66
142
+ def name; end
143
+
144
+ # source://notiffany//lib/notiffany/notifier/base.rb#70
145
+ def notify(message, opts = T.unsafe(nil)); end
146
+
147
+ # Returns the value of attribute options.
148
+ #
149
+ # source://notiffany//lib/notiffany/notifier/base.rb#45
150
+ def options; end
151
+
152
+ # source://notiffany//lib/notiffany/notifier/base.rb#62
153
+ def title; end
154
+
155
+ private
156
+
157
+ # Override
158
+ #
159
+ # source://notiffany//lib/notiffany/notifier/base.rb#93
160
+ def _check_available(_options); end
161
+
162
+ # source://notiffany//lib/notiffany/notifier/base.rb#114
163
+ def _check_host_supported; end
164
+
165
+ # Override if necessary
166
+ #
167
+ # source://notiffany//lib/notiffany/notifier/base.rb#83
168
+ def _gem_name; end
169
+
170
+ # source://notiffany//lib/notiffany/notifier/base.rb#102
171
+ def _notification_type(image); end
172
+
173
+ # source://notiffany//lib/notiffany/notifier/base.rb#106
174
+ def _notify_options(overrides = T.unsafe(nil)); end
175
+
176
+ # Override
177
+ #
178
+ # source://notiffany//lib/notiffany/notifier/base.rb#98
179
+ def _perform_notify(_message, _opts); end
180
+
181
+ # source://notiffany//lib/notiffany/notifier/base.rb#120
182
+ def _require_gem; end
183
+
184
+ # Override if necessary
185
+ #
186
+ # source://notiffany//lib/notiffany/notifier/base.rb#88
187
+ def _supported_hosts; end
188
+ end
189
+
190
+ # source://notiffany//lib/notiffany/notifier/base.rb#19
191
+ Notiffany::Notifier::Base::ERROR_ADD_GEM_AND_RUN_BUNDLE = T.let(T.unsafe(nil), String)
192
+
193
+ # source://notiffany//lib/notiffany/notifier/base.rb#6
194
+ Notiffany::Notifier::Base::HOSTS = T.let(T.unsafe(nil), Hash)
195
+
196
+ # source://notiffany//lib/notiffany/notifier/base.rb#33
197
+ class Notiffany::Notifier::Base::RequireFailed < ::Notiffany::Notifier::Base::UnavailableError
198
+ # @return [RequireFailed] a new instance of RequireFailed
199
+ #
200
+ # source://notiffany//lib/notiffany/notifier/base.rb#34
201
+ def initialize(gem_name); end
202
+ end
203
+
204
+ # source://notiffany//lib/notiffany/notifier/base.rb#22
205
+ class Notiffany::Notifier::Base::UnavailableError < ::RuntimeError
206
+ # @return [UnavailableError] a new instance of UnavailableError
207
+ #
208
+ # source://notiffany//lib/notiffany/notifier/base.rb#23
209
+ def initialize(reason); end
210
+
211
+ # source://notiffany//lib/notiffany/notifier/base.rb#28
212
+ def message; end
213
+ end
214
+
215
+ # source://notiffany//lib/notiffany/notifier/base.rb#39
216
+ class Notiffany::Notifier::Base::UnsupportedPlatform < ::Notiffany::Notifier::Base::UnavailableError
217
+ # @return [UnsupportedPlatform] a new instance of UnsupportedPlatform
218
+ #
219
+ # source://notiffany//lib/notiffany/notifier/base.rb#40
220
+ def initialize; end
221
+ end
222
+
223
+ # Configuration class for Notifier
224
+ #
225
+ # source://notiffany//lib/notiffany/notifier/config.rb#6
226
+ class Notiffany::Notifier::Config
227
+ # @return [Config] a new instance of Config
228
+ #
229
+ # source://notiffany//lib/notiffany/notifier/config.rb#13
230
+ def initialize(opts); end
231
+
232
+ # Returns the value of attribute env_namespace.
233
+ #
234
+ # source://notiffany//lib/notiffany/notifier/config.rb#9
235
+ def env_namespace; end
236
+
237
+ # Returns the value of attribute logger.
238
+ #
239
+ # source://notiffany//lib/notiffany/notifier/config.rb#10
240
+ def logger; end
241
+
242
+ # Returns the value of attribute notifiers.
243
+ #
244
+ # source://notiffany//lib/notiffany/notifier/config.rb#11
245
+ def notifiers; end
246
+
247
+ # @return [Boolean]
248
+ #
249
+ # source://notiffany//lib/notiffany/notifier/config.rb#21
250
+ def notify?; end
251
+
252
+ private
253
+
254
+ # source://notiffany//lib/notiffany/notifier/config.rb#27
255
+ def _setup_logger(opts); end
256
+ end
257
+
258
+ # source://notiffany//lib/notiffany/notifier/config.rb#7
259
+ Notiffany::Notifier::Config::DEFAULTS = T.let(T.unsafe(nil), Hash)
260
+
261
+ # @private api
262
+ #
263
+ # source://notiffany//lib/notiffany/notifier/detected.rb#27
264
+ class Notiffany::Notifier::Detected
265
+ # @return [Detected] a new instance of Detected
266
+ #
267
+ # source://notiffany//lib/notiffany/notifier/detected.rb#47
268
+ def initialize(supported, env_namespace, logger); end
269
+
270
+ # Called when user has notifier-specific config.
271
+ # Honor the config by warning if something is wrong
272
+ #
273
+ # source://notiffany//lib/notiffany/notifier/detected.rb#82
274
+ def add(name, opts); end
275
+
276
+ # source://notiffany//lib/notiffany/notifier/detected.rb#74
277
+ def available; end
278
+
279
+ # source://notiffany//lib/notiffany/notifier/detected.rb#57
280
+ def detect; end
281
+
282
+ # source://notiffany//lib/notiffany/notifier/detected.rb#53
283
+ def reset; end
284
+
285
+ private
286
+
287
+ # source://notiffany//lib/notiffany/notifier/detected.rb#90
288
+ def _add(name, opts); end
289
+
290
+ # source://notiffany//lib/notiffany/notifier/detected.rb#117
291
+ def _notifiers; end
292
+
293
+ # source://notiffany//lib/notiffany/notifier/detected.rb#109
294
+ def _to_module(name); end
295
+ end
296
+
297
+ # source://notiffany//lib/notiffany/notifier/detected.rb#28
298
+ Notiffany::Notifier::Detected::NO_SUPPORTED_NOTIFIERS = T.let(T.unsafe(nil), String)
299
+
300
+ # source://notiffany//lib/notiffany/notifier/detected.rb#31
301
+ class Notiffany::Notifier::Detected::NoneAvailableError < ::RuntimeError; end
302
+
303
+ # source://notiffany//lib/notiffany/notifier/detected.rb#34
304
+ class Notiffany::Notifier::Detected::UnknownNotifier < ::RuntimeError
305
+ # @return [UnknownNotifier] a new instance of UnknownNotifier
306
+ #
307
+ # source://notiffany//lib/notiffany/notifier/detected.rb#35
308
+ def initialize(name); end
309
+
310
+ # source://notiffany//lib/notiffany/notifier/detected.rb#42
311
+ def message; end
312
+
313
+ # Returns the value of attribute name.
314
+ #
315
+ # source://notiffany//lib/notiffany/notifier/detected.rb#40
316
+ def name; end
317
+ end
318
+
319
+ # Send a notification to Emacs with emacsclient
320
+ # (http://www.emacswiki.org/emacs/EmacsClient).
321
+ #
322
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#5
323
+ class Notiffany::Notifier::Emacs < ::Notiffany::Notifier::Base
324
+ private
325
+
326
+ # @raise [UnavailableError]
327
+ #
328
+ # source://notiffany//lib/notiffany/notifier/emacs.rb#32
329
+ def _check_available(options); end
330
+
331
+ # Get the Emacs color for the notification type.
332
+ # You can configure your own color by overwrite the defaults.
333
+ #
334
+ # notifications (default is 'ForestGreen')
335
+ #
336
+ # notifications (default is 'Firebrick')
337
+ #
338
+ # notifications
339
+ #
340
+ # 'Black')
341
+ #
342
+ # @option options
343
+ # @option options
344
+ # @option options
345
+ # @option options
346
+ # @param type [String] the notification type
347
+ # @param options [Hash] aditional notification options
348
+ # @return [String] the name of the emacs color
349
+ #
350
+ # source://notiffany//lib/notiffany/notifier/emacs.rb#86
351
+ def _emacs_color(type, options = T.unsafe(nil)); end
352
+
353
+ # source://notiffany//lib/notiffany/notifier/emacs.rb#91
354
+ def _erb_for(filename); end
355
+
356
+ # source://notiffany//lib/notiffany/notifier/emacs.rb#28
357
+ def _gem_name; end
358
+
359
+ # Shows a system notification.
360
+ #
361
+ # @option opts
362
+ # @option opts
363
+ # @option opts
364
+ # @option opts
365
+ # @option opts
366
+ # @option opts
367
+ # @param type [String] the notification type. Either 'success',
368
+ # 'pending', 'failed' or 'notify'
369
+ # @param title [String] the notification title
370
+ # @param message [String] the notification message body
371
+ # @param image [String] the path to the notification image
372
+ # @param opts [Hash] additional notification library options
373
+ #
374
+ # source://notiffany//lib/notiffany/notifier/emacs.rb#58
375
+ def _perform_notify(message, opts = T.unsafe(nil)); end
376
+ end
377
+
378
+ # Handles evaluating ELISP code in Emacs via Erb
379
+ #
380
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#6
381
+ class Notiffany::Notifier::Emacs::Client
382
+ # @raise [ArgumentError]
383
+ # @return [Client] a new instance of Client
384
+ #
385
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#28
386
+ def initialize(options); end
387
+
388
+ # @return [Boolean]
389
+ #
390
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#34
391
+ def available?; end
392
+
393
+ # Returns the value of attribute elisp_erb.
394
+ #
395
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#7
396
+ def elisp_erb; end
397
+
398
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#39
399
+ def notify(color, bgcolor, message = T.unsafe(nil)); end
400
+
401
+ private
402
+
403
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#46
404
+ def _emacs_eval(env, code); end
405
+ end
406
+
407
+ # Creates a safe binding with local variables for ERB
408
+ #
409
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#10
410
+ class Notiffany::Notifier::Emacs::Client::Elisp < ::ERB
411
+ # @return [Elisp] a new instance of Elisp
412
+ #
413
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#15
414
+ def initialize(code, color, bgcolor, message); end
415
+
416
+ # Returns the value of attribute bgcolor.
417
+ #
418
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#12
419
+ def bgcolor; end
420
+
421
+ # Returns the value of attribute color.
422
+ #
423
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#11
424
+ def color; end
425
+
426
+ # Returns the value of attribute message.
427
+ #
428
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#13
429
+ def message; end
430
+
431
+ # source://notiffany//lib/notiffany/notifier/emacs/client.rb#23
432
+ def result; end
433
+ end
434
+
435
+ # source://notiffany//lib/notiffany/notifier/emacs.rb#12
436
+ Notiffany::Notifier::Emacs::DEFAULTS = T.let(T.unsafe(nil), Hash)
437
+
438
+ # source://notiffany//lib/notiffany/notifier/emacs.rb#20
439
+ Notiffany::Notifier::Emacs::DEFAULT_ELISP_ERB = T.let(T.unsafe(nil), String)
440
+
441
+ # source://notiffany//lib/notiffany/notifier.rb#0
442
+ class Notiffany::Notifier::Env < ::Nenv::Environment
443
+ # source://nenv/0.3.0/lib/nenv/environment.rb#69
444
+ def notify?; end
445
+
446
+ # source://nenv/0.3.0/lib/nenv/environment.rb#59
447
+ def notify_active=(raw_value); end
448
+
449
+ # source://nenv/0.3.0/lib/nenv/environment.rb#69
450
+ def notify_active?; end
451
+
452
+ # source://nenv/0.3.0/lib/nenv/environment.rb#69
453
+ def notify_pid; end
454
+
455
+ # source://nenv/0.3.0/lib/nenv/environment.rb#59
456
+ def notify_pid=(raw_value); end
457
+ end
458
+
459
+ # Writes notifications to a file.
460
+ #
461
+ # source://notiffany//lib/notiffany/notifier/file.rb#7
462
+ class Notiffany::Notifier::File < ::Notiffany::Notifier::Base
463
+ private
464
+
465
+ # @option opts
466
+ # @param opts [Hash] some options
467
+ #
468
+ # source://notiffany//lib/notiffany/notifier/file.rb#16
469
+ def _check_available(opts = T.unsafe(nil)); end
470
+
471
+ # source://notiffany//lib/notiffany/notifier/file.rb#39
472
+ def _gem_name; end
473
+
474
+ # Writes the notification to a file. By default it writes type, title,
475
+ # and message separated by newlines.
476
+ #
477
+ # @option opts
478
+ # @option opts
479
+ # @option opts
480
+ # @option opts
481
+ # @option opts
482
+ # @param message [String] the notification message body
483
+ # @param opts [Hash] additional notification library options
484
+ #
485
+ # source://notiffany//lib/notiffany/notifier/file.rb#32
486
+ def _perform_notify(message, opts = T.unsafe(nil)); end
487
+ end
488
+
489
+ # source://notiffany//lib/notiffany/notifier/file.rb#8
490
+ Notiffany::Notifier::File::DEFAULTS = T.let(T.unsafe(nil), Hash)
491
+
492
+ # System notifications using the
493
+ # [ruby_gntp](https://github.com/snaka/ruby_gntp) gem.
494
+ #
495
+ # This gem is available for OS X, Linux and Windows and sends system
496
+ # notifications to the following system notification frameworks through the
497
+ #
498
+ # [Growl Network Transport
499
+ # Protocol](http://www.growlforwindows.com/gfw/help/gntp.aspx):
500
+ #
501
+ # * [Growl](http://growl.info)
502
+ # * [Growl for Windows](http://www.growlforwindows.com)
503
+ # * [Growl for Linux](http://mattn.github.com/growl-for-linux)
504
+ # * [Snarl](https://sites.google.com/site/snarlapp)
505
+ #
506
+ # source://notiffany//lib/notiffany/notifier/gntp.rb#18
507
+ class Notiffany::Notifier::GNTP < ::Notiffany::Notifier::Base
508
+ # source://notiffany//lib/notiffany/notifier/gntp.rb#39
509
+ def _check_available(_opts); end
510
+
511
+ # source://notiffany//lib/notiffany/notifier/gntp.rb#35
512
+ def _gem_name; end
513
+
514
+ # Shows a system notification.
515
+ #
516
+ # @option opts
517
+ # @option opts
518
+ # @option opts
519
+ # @option opts
520
+ # @option opts
521
+ # @option opts
522
+ # @option opts
523
+ # @param message [String] the notification message body
524
+ # @param opts [Hash] additional notification library options
525
+ #
526
+ # source://notiffany//lib/notiffany/notifier/gntp.rb#57
527
+ def _perform_notify(message, opts = T.unsafe(nil)); end
528
+
529
+ # source://notiffany//lib/notiffany/notifier/gntp.rb#30
530
+ def _supported_hosts; end
531
+
532
+ private
533
+
534
+ # source://notiffany//lib/notiffany/notifier/gntp.rb#69
535
+ def _gntp_client(opts = T.unsafe(nil)); end
536
+ end
537
+
538
+ # Default options for the ruby gtnp client.
539
+ #
540
+ # source://notiffany//lib/notiffany/notifier/gntp.rb#24
541
+ Notiffany::Notifier::GNTP::CLIENT_DEFAULTS = T.let(T.unsafe(nil), Hash)
542
+
543
+ # source://notiffany//lib/notiffany/notifier/gntp.rb#19
544
+ Notiffany::Notifier::GNTP::DEFAULTS = T.let(T.unsafe(nil), Hash)
545
+
546
+ # System notifications using the
547
+ # [growl](https://github.com/visionmedia/growl) gem.
548
+ #
549
+ # This gem is available for OS X and sends system notifications to
550
+ # [Growl](http://growl.info) through the
551
+ # [GrowlNotify](http://growl.info/downloads) executable.
552
+ #
553
+ # The `growlnotify` executable must be installed manually or by using
554
+ # [Homebrew](http://mxcl.github.com/homebrew/).
555
+ #
556
+ # Sending notifications with this notifier will not show the different
557
+ # notifications in the Growl preferences. Use the :gntp notifier if you
558
+ # want to customize each notification type in Growl.
559
+ #
560
+ # your `Guardfile` notification :growl, sticky: true, host: '192.168.1.5',
561
+ # password: 'secret'
562
+ #
563
+ # @example Install `growlnotify` with Homebrew
564
+ # brew install growlnotify
565
+ # @example Add the `growl` gem to your `Gemfile`
566
+ # group :development
567
+ # gem 'growl'
568
+ # end
569
+ # @example Add the `:growl` notifier to your `Guardfile`
570
+ # notification :growl
571
+ # @example Add the `:growl_notify` notifier with configuration options to
572
+ #
573
+ # source://notiffany//lib/notiffany/notifier/growl.rb#34
574
+ class Notiffany::Notifier::Growl < ::Notiffany::Notifier::Base
575
+ # source://notiffany//lib/notiffany/notifier/growl.rb#48
576
+ def _check_available(_opts = T.unsafe(nil)); end
577
+
578
+ # Shows a system notification.
579
+ #
580
+ # The documented options are for GrowlNotify 1.3, but the older options
581
+ # are also supported. Please see `growlnotify --help`.
582
+ #
583
+ # Priority can be one of the following named keys: `Very Low`,
584
+ # `Moderate`, `Normal`, `High`, `Emergency`. It can also be an integer
585
+ # between -2 and 2.
586
+ #
587
+ # @option opts
588
+ # @option opts
589
+ # @option opts
590
+ # @option opts
591
+ # @option opts
592
+ # @option opts
593
+ # @option opts
594
+ # @param message [String] the notification message body
595
+ # @param opts [Hash] additional notification library options
596
+ #
597
+ # source://notiffany//lib/notiffany/notifier/growl.rb#75
598
+ def _perform_notify(message, opts = T.unsafe(nil)); end
599
+
600
+ # source://notiffany//lib/notiffany/notifier/growl.rb#44
601
+ def _supported_hosts; end
602
+ end
603
+
604
+ # Default options for the growl notifications.
605
+ #
606
+ # source://notiffany//lib/notiffany/notifier/growl.rb#39
607
+ Notiffany::Notifier::Growl::DEFAULTS = T.let(T.unsafe(nil), Hash)
608
+
609
+ # source://notiffany//lib/notiffany/notifier/growl.rb#35
610
+ Notiffany::Notifier::Growl::INSTALL_GROWLNOTIFY = T.let(T.unsafe(nil), String)
611
+
612
+ # System notifications using the
613
+ # [libnotify](https://github.com/splattael/libnotify) gem.
614
+ #
615
+ # This gem is available for Linux, FreeBSD, OpenBSD and Solaris and sends
616
+ # system notifications to
617
+ # Gnome [libnotify](http://developer.gnome.org/libnotify):
618
+ #
619
+ # source://notiffany//lib/notiffany/notifier/libnotify.rb#12
620
+ class Notiffany::Notifier::Libnotify < ::Notiffany::Notifier::Base
621
+ private
622
+
623
+ # source://notiffany//lib/notiffany/notifier/libnotify.rb#25
624
+ def _check_available(_opts = T.unsafe(nil)); end
625
+
626
+ # Shows a system notification.
627
+ #
628
+ # @option opts
629
+ # @option opts
630
+ # @option opts
631
+ # @option opts
632
+ # @option opts
633
+ # @option opts
634
+ # @param message [String] the notification message body
635
+ # @param opts [Hash] additional notification library options
636
+ #
637
+ # source://notiffany//lib/notiffany/notifier/libnotify.rb#42
638
+ def _perform_notify(message, opts = T.unsafe(nil)); end
639
+
640
+ # source://notiffany//lib/notiffany/notifier/libnotify.rb#21
641
+ def _supported_hosts; end
642
+ end
643
+
644
+ # source://notiffany//lib/notiffany/notifier/libnotify.rb#13
645
+ Notiffany::Notifier::Libnotify::DEFAULTS = T.let(T.unsafe(nil), Hash)
646
+
647
+ # source://notiffany//lib/notiffany/notifier.rb#46
648
+ Notiffany::Notifier::NOTIFICATIONS_DISABLED = T.let(T.unsafe(nil), String)
649
+
650
+ # source://notiffany//lib/notiffany/notifier.rb#77
651
+ class Notiffany::Notifier::NotServer < ::RuntimeError; end
652
+
653
+ # System notifications using the
654
+ # [rb-notifu](https://github.com/stereobooster/rb-notifu) gem.
655
+ #
656
+ # This gem is available for Windows and sends system notifications to
657
+ # [Notifu](http://www.paralint.com/projects/notifu/index.html):
658
+ #
659
+ # @example Add the `rb-notifu` gem to your `Gemfile`
660
+ # group :development
661
+ # gem 'rb-notifu'
662
+ # end
663
+ #
664
+ # source://notiffany//lib/notiffany/notifier/rb_notifu.rb#17
665
+ class Notiffany::Notifier::Notifu < ::Notiffany::Notifier::Base
666
+ private
667
+
668
+ # source://notiffany//lib/notiffany/notifier/rb_notifu.rb#37
669
+ def _check_available(_opts = T.unsafe(nil)); end
670
+
671
+ # source://notiffany//lib/notiffany/notifier/rb_notifu.rb#33
672
+ def _gem_name; end
673
+
674
+ # Converts generic notification type to the best matching
675
+ # Notifu type.
676
+ #
677
+ # @param type [String] the generic notification type
678
+ # @return [Symbol] the Notify notification type
679
+ #
680
+ # source://notiffany//lib/notiffany/notifier/rb_notifu.rb#77
681
+ def _notifu_type(type); end
682
+
683
+ # Shows a system notification.
684
+ #
685
+ # @option opts
686
+ # @option opts
687
+ # @option opts
688
+ # @option opts
689
+ # @option opts
690
+ # @option opts
691
+ # @option opts
692
+ # @option opts
693
+ # @option opts
694
+ # @param message [String] the notification message body
695
+ # @param opts [Hash] additional notification library options
696
+ #
697
+ # source://notiffany//lib/notiffany/notifier/rb_notifu.rb#61
698
+ def _perform_notify(message, opts = T.unsafe(nil)); end
699
+
700
+ # source://notiffany//lib/notiffany/notifier/rb_notifu.rb#29
701
+ def _supported_hosts; end
702
+ end
703
+
704
+ # Default options for the rb-notifu notifications.
705
+ #
706
+ # source://notiffany//lib/notiffany/notifier/rb_notifu.rb#18
707
+ Notiffany::Notifier::Notifu::DEFAULTS = T.let(T.unsafe(nil), Hash)
708
+
709
+ # System notifications using notify-send, a binary that ships with
710
+ # the libnotify-bin package on many Debian-based distributions.
711
+ #
712
+ # @example Add the `:notifysend` notifier to your `Guardfile`
713
+ # notification :notifysend
714
+ #
715
+ # source://notiffany//lib/notiffany/notifier/notifysend.rb#14
716
+ class Notiffany::Notifier::NotifySend < ::Notiffany::Notifier::Base
717
+ private
718
+
719
+ # source://notiffany//lib/notiffany/notifier/notifysend.rb#34
720
+ def _check_available(_opts = T.unsafe(nil)); end
721
+
722
+ # notify-send has no gem, just a binary to shell out
723
+ #
724
+ # source://notiffany//lib/notiffany/notifier/notifysend.rb#26
725
+ def _gem_name; end
726
+
727
+ # Converts Guards notification type to the best matching
728
+ # notify-send urgency.
729
+ #
730
+ # @param type [String] the Guard notification type
731
+ # @return [String] the notify-send urgency
732
+ #
733
+ # source://notiffany//lib/notiffany/notifier/notifysend.rb#71
734
+ def _notifysend_urgency(type); end
735
+
736
+ # Shows a system notification.
737
+ #
738
+ # @option opts
739
+ # @option opts
740
+ # @option opts
741
+ # @option opts
742
+ # @option opts
743
+ # @param message [String] the notification message body
744
+ # @param opts [Hash] additional notification library options
745
+ #
746
+ # source://notiffany//lib/notiffany/notifier/notifysend.rb#54
747
+ def _perform_notify(message, opts = T.unsafe(nil)); end
748
+
749
+ # source://notiffany//lib/notiffany/notifier/notifysend.rb#30
750
+ def _supported_hosts; end
751
+
752
+ # Builds a shell command out of a command string and option hash.
753
+ #
754
+ # shell command.
755
+ #
756
+ # @param command [String] the command execute
757
+ # @param supported [Array] list of supported option flags
758
+ # @param opts [Hash] additional command options
759
+ # @return [Array<String>] the command and its options converted to a
760
+ #
761
+ # source://notiffany//lib/notiffany/notifier/notifysend.rb#84
762
+ def _to_arguments(command, supported, opts = T.unsafe(nil)); end
763
+ end
764
+
765
+ # Default options for the notify-send notifications.
766
+ #
767
+ # source://notiffany//lib/notiffany/notifier/notifysend.rb#15
768
+ Notiffany::Notifier::NotifySend::DEFAULTS = T.let(T.unsafe(nil), Hash)
769
+
770
+ # Full list of options supported by notify-send.
771
+ #
772
+ # source://notiffany//lib/notiffany/notifier/notifysend.rb#21
773
+ Notiffany::Notifier::NotifySend::SUPPORTED = T.let(T.unsafe(nil), Array)
774
+
775
+ # source://notiffany//lib/notiffany/notifier.rb#51
776
+ Notiffany::Notifier::ONLY_NOTIFY = T.let(T.unsafe(nil), String)
777
+
778
+ # List of available notifiers, grouped by functionality
779
+ #
780
+ # source://notiffany//lib/notiffany/notifier.rb#54
781
+ Notiffany::Notifier::SUPPORTED = T.let(T.unsafe(nil), Array)
782
+
783
+ # System notifications using the
784
+ #
785
+ # [terminal-notifier](https://github.com/Springest/terminal-notifier-guard)
786
+ #
787
+ # gem.
788
+ #
789
+ # This gem is available for OS X 10.8 Mountain Lion and sends notifications
790
+ # to the OS X notification center.
791
+ #
792
+ # source://notiffany//lib/notiffany/notifier/terminal_notifier.rb#13
793
+ class Notiffany::Notifier::TerminalNotifier < ::Notiffany::Notifier::Base
794
+ # source://notiffany//lib/notiffany/notifier/terminal_notifier.rb#27
795
+ def _check_available(_opts = T.unsafe(nil)); end
796
+
797
+ # source://notiffany//lib/notiffany/notifier/terminal_notifier.rb#23
798
+ def _gem_name; end
799
+
800
+ # Shows a system notification.
801
+ #
802
+ # @option opts
803
+ # @option opts
804
+ # @option opts
805
+ # @option opts
806
+ # @option opts
807
+ # @option opts
808
+ # @option opts
809
+ # @param message [String] the notification message body
810
+ # @param opts [Hash] additional notification library options
811
+ #
812
+ # source://notiffany//lib/notiffany/notifier/terminal_notifier.rb#45
813
+ def _perform_notify(message, opts = T.unsafe(nil)); end
814
+
815
+ # source://notiffany//lib/notiffany/notifier/terminal_notifier.rb#19
816
+ def _supported_hosts; end
817
+ end
818
+
819
+ # source://notiffany//lib/notiffany/notifier/terminal_notifier.rb#14
820
+ Notiffany::Notifier::TerminalNotifier::DEFAULTS = T.let(T.unsafe(nil), Hash)
821
+
822
+ # source://notiffany//lib/notiffany/notifier/terminal_notifier.rb#16
823
+ Notiffany::Notifier::TerminalNotifier::ERROR_ONLY_OSX10 = T.let(T.unsafe(nil), String)
824
+
825
+ # Shows system notifications in the terminal title bar.
826
+ #
827
+ # source://notiffany//lib/notiffany/notifier/terminal_title.rb#7
828
+ class Notiffany::Notifier::TerminalTitle < ::Notiffany::Notifier::Base
829
+ # Clears the terminal title
830
+ #
831
+ # source://notiffany//lib/notiffany/notifier/terminal_title.rb#11
832
+ def turn_off; end
833
+
834
+ private
835
+
836
+ # source://notiffany//lib/notiffany/notifier/terminal_title.rb#21
837
+ def _check_available(_options); end
838
+
839
+ # source://notiffany//lib/notiffany/notifier/terminal_title.rb#17
840
+ def _gem_name; end
841
+
842
+ # Shows a system notification.
843
+ #
844
+ # @option opts
845
+ # @option opts
846
+ # @option opts
847
+ # @param opts [Hash] additional notification library options
848
+ #
849
+ # source://notiffany//lib/notiffany/notifier/terminal_title.rb#32
850
+ def _perform_notify(message, opts = T.unsafe(nil)); end
851
+ end
852
+
853
+ # source://notiffany//lib/notiffany/notifier/terminal_title.rb#8
854
+ Notiffany::Notifier::TerminalTitle::DEFAULTS = T.let(T.unsafe(nil), Hash)
855
+
856
+ # Changes the color of the Tmux status bar and optionally
857
+ # shows messages in the status bar.
858
+ #
859
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#6
860
+ class Notiffany::Notifier::Tmux < ::Notiffany::Notifier::Base
861
+ # Notification stopping. Restore the previous Tmux state
862
+ # if available (existing options are restored, new options
863
+ # are unset) and unquiet the Tmux output.
864
+ #
865
+ # source://notiffany//lib/notiffany/notifier/tmux.rb#52
866
+ def turn_off; end
867
+
868
+ # Notification starting, save the current Tmux settings
869
+ # and quiet the Tmux output.
870
+ #
871
+ # source://notiffany//lib/notiffany/notifier/tmux.rb#44
872
+ def turn_on; end
873
+
874
+ private
875
+
876
+ # source://notiffany//lib/notiffany/notifier/tmux.rb#62
877
+ def _check_available(opts = T.unsafe(nil)); end
878
+
879
+ # source://notiffany//lib/notiffany/notifier/tmux.rb#58
880
+ def _gem_name; end
881
+
882
+ # Shows a system notification.
883
+ #
884
+ # By default, the Tmux notifier only makes
885
+ # use of a color based notification, changing the background color of the
886
+ # `color_location` to the color defined in either the `success`,
887
+ # `failed`, `pending` or `default`, depending on the notification type.
888
+ #
889
+ # You may enable an extra explicit message by setting `display_message`
890
+ # to true, and may further disable the colorization by setting
891
+ # `change_color` to false.
892
+ #
893
+ # @option options
894
+ # @option options
895
+ # @option options
896
+ # @option options
897
+ # @option options
898
+ # @option options
899
+ # @option options
900
+ # @param message [String] the notification message
901
+ # @param options [Hash] additional notification library options
902
+ #
903
+ # source://notiffany//lib/notiffany/notifier/tmux.rb#103
904
+ def _perform_notify(message, options = T.unsafe(nil)); end
905
+
906
+ class << self
907
+ # source://notiffany//lib/notiffany/notifier/tmux.rb#120
908
+ def _end_session; end
909
+
910
+ # source://notiffany//lib/notiffany/notifier/tmux.rb#126
911
+ def _session; end
912
+
913
+ # source://notiffany//lib/notiffany/notifier/tmux.rb#115
914
+ def _start_session; end
915
+ end
916
+ end
917
+
918
+ # Class for actually calling TMux to run commands
919
+ #
920
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#7
921
+ class Notiffany::Notifier::Tmux::Client
922
+ # @return [Client] a new instance of Client
923
+ #
924
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#28
925
+ def initialize(client); end
926
+
927
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#32
928
+ def clients; end
929
+
930
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#49
931
+ def display_message(message); end
932
+
933
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#76
934
+ def display_time=(time); end
935
+
936
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#72
937
+ def message_bg=(color); end
938
+
939
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#68
940
+ def message_fg=(color); end
941
+
942
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#63
943
+ def parse_options; end
944
+
945
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#42
946
+ def set(key, value); end
947
+
948
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#80
949
+ def title=(string); end
950
+
951
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#57
952
+ def unset(key, value); end
953
+
954
+ private
955
+
956
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#99
957
+ def _all_args_for(key, value, client); end
958
+
959
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#91
960
+ def _capture(*args); end
961
+
962
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#95
963
+ def _parse_option(line); end
964
+
965
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#87
966
+ def _run(*args); end
967
+
968
+ class << self
969
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#19
970
+ def _capture(*args); end
971
+
972
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#23
973
+ def _run(*args); end
974
+
975
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#11
976
+ def version; end
977
+ end
978
+ end
979
+
980
+ # source://notiffany//lib/notiffany/notifier/tmux/client.rb#8
981
+ Notiffany::Notifier::Tmux::Client::CLIENT = T.let(T.unsafe(nil), String)
982
+
983
+ # source://notiffany//lib/notiffany/notifier/tmux.rb#15
984
+ Notiffany::Notifier::Tmux::DEFAULTS = T.let(T.unsafe(nil), Hash)
985
+
986
+ # source://notiffany//lib/notiffany/notifier/tmux.rb#39
987
+ Notiffany::Notifier::Tmux::ERROR_ANCIENT_TMUX = T.let(T.unsafe(nil), String)
988
+
989
+ # source://notiffany//lib/notiffany/notifier/tmux.rb#36
990
+ Notiffany::Notifier::Tmux::ERROR_NOT_INSIDE_TMUX = T.let(T.unsafe(nil), String)
991
+
992
+ # source://notiffany//lib/notiffany/notifier/tmux.rb#33
993
+ class Notiffany::Notifier::Tmux::Error < ::RuntimeError; end
994
+
995
+ # Wraps a notification with it's options
996
+ #
997
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#5
998
+ class Notiffany::Notifier::Tmux::Notification
999
+ # @return [Notification] a new instance of Notification
1000
+ #
1001
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#6
1002
+ def initialize(type, options); end
1003
+
1004
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#33
1005
+ def colorize(locations); end
1006
+
1007
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#24
1008
+ def display_message(title, message); end
1009
+
1010
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#15
1011
+ def display_title(title, message); end
1012
+
1013
+ private
1014
+
1015
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#54
1016
+ def _message_for(title, message); end
1017
+
1018
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#48
1019
+ def _value_for(field); end
1020
+
1021
+ # Returns the value of attribute client.
1022
+ #
1023
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#45
1024
+ def client; end
1025
+
1026
+ # Returns the value of attribute color.
1027
+ #
1028
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#43
1029
+ def color; end
1030
+
1031
+ # Returns the value of attribute message_color.
1032
+ #
1033
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#44
1034
+ def message_color; end
1035
+
1036
+ # Returns the value of attribute options.
1037
+ #
1038
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#42
1039
+ def options; end
1040
+
1041
+ # Returns the value of attribute separator.
1042
+ #
1043
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#46
1044
+ def separator; end
1045
+
1046
+ # Returns the value of attribute type.
1047
+ #
1048
+ # source://notiffany//lib/notiffany/notifier/tmux/notification.rb#41
1049
+ def type; end
1050
+ end
1051
+
1052
+ # Preserves TMux settings for all tmux sessions
1053
+ #
1054
+ # source://notiffany//lib/notiffany/notifier/tmux/session.rb#5
1055
+ class Notiffany::Notifier::Tmux::Session
1056
+ # @return [Session] a new instance of Session
1057
+ #
1058
+ # source://notiffany//lib/notiffany/notifier/tmux/session.rb#6
1059
+ def initialize; end
1060
+
1061
+ # source://notiffany//lib/notiffany/notifier/tmux/session.rb#29
1062
+ def close; end
1063
+ end
1064
+
1065
+ # source://notiffany//lib/notiffany/notifier.rb#49
1066
+ Notiffany::Notifier::USING_NOTIFIER = T.let(T.unsafe(nil), String)
1067
+
1068
+ # TODO: use a socket instead of passing env variables to child processes
1069
+ # (currently probably only used by guard-cucumber anyway)
1070
+ #
1071
+ # source://notiffany//lib/notiffany/notifier/detected.rb#0
1072
+ class Notiffany::Notifier::YamlEnvStorage < ::Nenv::Environment
1073
+ # source://nenv/0.3.0/lib/nenv/environment.rb#69
1074
+ def notifiers; end
1075
+
1076
+ # source://nenv/0.3.0/lib/nenv/environment.rb#59
1077
+ def notifiers=(raw_value); end
1078
+ end