Class: ProcessExecuter::Destinations::FilePath Private

Inherits:
DestinationBase show all
Defined in:
lib/process_executer/destinations/file_path.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Handles file path destinations

Instance Attribute Summary collapse

Attributes inherited from DestinationBase

#destination

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DestinationBase

compatible_with_monitored_pipe?, #compatible_with_monitored_pipe?

Constructor Details

#initialize(destination) ⇒ FilePath

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initializes a new file path destination handler

Redirects to the file at destination via open(destination, 'w', 0644)

Parameters:

  • destination (String) —

    the file path to write to

Raises:

  • (Errno::ENOENT) —

    if the file path is invalid



19
20
21
22
 
# File 'lib/process_executer/destinations/file_path.rb', line 19

def initialize(destination)
  super
  @file = File.open(destination, 'w', 0o644)
end

Instance Attribute Details

#file ⇒ File (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The opened file object

Returns:

  • (File) —

    the opened file



27
28
29
 
# File 'lib/process_executer/destinations/file_path.rb', line 27

def file
  @file
end

Class Method Details

.handles?(destination) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Determines if this class can handle the given destination

Parameters:

  • destination (Object) —

    the destination to check

Returns:

  • (Boolean) —

    true if destination is a String



57
58
59
 
# File 'lib/process_executer/destinations/file_path.rb', line 57

def self.handles?(destination)
  destination.is_a? String
end

Instance Method Details

#close

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Closes the file if it's open



49
50
51
 
# File 'lib/process_executer/destinations/file_path.rb', line 49

def close
  file.close unless file.closed?
end

#write(data) ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Writes data to the file

Examples:

file_handler = ProcessExecuter::Destinations::FilePath.new("output.log")
file_handler.write("Log entry")

Parameters:

  • data (String) —

    the data to write

Returns:

  • (Integer) —

    the number of bytes written

Raises:

  • (IOError) —

    if the file is closed



41
42
43
44
 
# File 'lib/process_executer/destinations/file_path.rb', line 41

def write(data)
  super
  file.write data
end