File: tee.rb

package info (click to toggle)
ruby-process-executer 4.0.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 408 kB
  • sloc: ruby: 873; makefile: 4
file content (67 lines) | stat: -rw-r--r-- 2,202 bytes parent folder | download
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# frozen_string_literal: true

require_relative 'destination_base'

module ProcessExecuter
  module Destinations
    # Handles a destination for writing to multiple destinations
    #
    # The destination is an array with the first element being :tee and the rest
    # being the destinations.
    #
    # @api private
    class Tee < DestinationBase
      # Initializes a destination handler for writing to multiple output destinations
      #
      # @param destination [Array<Symbol, Object...>] array in the form [:tee, destination...]
      #
      # @raise [ArgumentError] if a child destination is invalid or incompatible
      #
      def initialize(destination)
        super
        @child_destinations = destination[1..].map { |dest| ProcessExecuter::Destinations.factory(dest) }
      end

      # An array of child destinations
      #
      # @return [Array<ProcessExecuter::Destinations::DestinationBase>]
      #   An array of the child destination handlers
      #
      attr_reader :child_destinations

      # Writes data each of the {child_destinations}
      #
      # @example
      #   tee = ProcessExecuter::Destinations::Tee.new([:tee, "output1.log", "output2.log"])
      #   tee.write("Log entry with specific permissions")
      #   tee.close # Important to close the tee to ensure all data is flushed
      #
      # @param data [String] the data to write
      #
      # @return [Integer] the number of bytes in the input data (which is written to each destination)
      #
      # @raise [IOError] if the file is closed
      #
      def write(data)
        super
        child_destinations.each { |dest| dest.write(data) }
        data.bytesize
      end

      # Closes the child_destinations
      #
      # @return [void]
      def close
        child_destinations.each(&:close)
      end

      # Determines if this class can handle the given destination
      #
      # @param destination [Object] the destination to check
      # @return [Boolean] true if destination is an Array in the form [:tee, destination...]
      def self.handles?(destination)
        destination.is_a?(Array) && destination.size > 1 && destination[0] == :tee
      end
    end
  end
end