File: file.rb

package info (click to toggle)
ruby-notiffany 0.1.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 584 kB
  • sloc: ruby: 3,094; makefile: 8; sh: 2
file content (44 lines) | stat: -rw-r--r-- 1,436 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
require "notiffany/notifier/base"

module Notiffany
  class Notifier
    # Writes notifications to a file.
    #
    class File < Base
      DEFAULTS = { format: "%s\n%s\n%s\n" }

      private

      # @param [Hash] opts some options
      # @option opts [Boolean] path the path to a file where notification
      #   message will be written
      #
      def _check_available(opts = {})
        fail UnavailableError, "No :path option given" unless opts[:path]
      end

      # Writes the notification to a file. By default it writes type, title,
      # and message separated by newlines.
      #
      # @param [String] message the notification message body
      # @param [Hash] opts additional notification library options
      # @option opts [String] type the notification type. Either 'success',
      #   'pending', 'failed' or 'notify'
      # @option opts [String] title the notification title
      # @option opts [String] image the path to the notification image
      # @option opts [String] format printf style format for file contents
      # @option opts [String] path the path of where to write the file
      #
      def _perform_notify(message, opts = {})
        fail UnavailableError, "No :path option given" unless opts[:path]

        str = format(opts[:format], opts[:type], opts[:title], message)
        ::File.write(opts[:path], str)
      end

      def _gem_name
        nil
      end
    end
  end
end