Class: Train::File

Inherits:
Object
  • Object
show all
Defined in:
lib/train/file.rb,
lib/train/file/local.rb,
lib/train/file/remote.rb,
lib/train/file/local/unix.rb,
lib/train/file/remote/aix.rb,
lib/train/file/remote/qnx.rb,
lib/train/file/remote/unix.rb,
lib/train/file/remote/linux.rb,
lib/train/file/local/windows.rb,
lib/train/file/remote/windows.rb

Overview

rubocop:disable Metrics/ClassLength

Direct Known Subclasses

Local, Remote, Transports::Mock::Connection::File

Defined Under Namespace

Classes: Local, Remote

Constant Summary collapse

DATA_FIELDS =

interface methods: these fields should be implemented by every backend File

%w{
  exist? mode owner group uid gid content mtime size selinux_label path
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(backend, path, follow_symlink = true) ⇒ File

Returns a new instance of File.



12
13
14
15
16
17
18
 
# File 'lib/train/file.rb', line 12

def initialize(backend, path, follow_symlink = true)
  @backend = backend
  @path = path || ""
  @follow_symlink = follow_symlink

  sanitize_filename(path)
end

Instance Method Details

#block_device? ⇒ Boolean

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/train/file.rb', line 82

def block_device?
  type.to_s == "block_device"
end

#character_device? ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/train/file.rb', line 86

def character_device?
  type.to_s == "character_device"
end

#directory? ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/train/file.rb', line 102

def directory?
  type.to_s == "directory"
end

#file? ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/train/file.rb', line 94

def file?
  type.to_s == "file"
end

#file_version ⇒ Object

file_version is primarily used by Windows operating systems only and will be overwritten in Windows-related classes. Since this field is returned for all file objects, the acceptable default value is nil



73
74
75
 
# File 'lib/train/file.rb', line 73

def file_version
  nil
end

#md5sum ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/train/file.rb', line 135

def md5sum
  # Skip processing rest of method if fallback method is selected
  return perform_checksum_ruby(:md5) if defined?(@ruby_checksum_fallback)

  checksum = if @backend.os.family == "windows"
               perform_checksum_windows(:md5)
             else
               @md5_command ||= case @backend.os.family
                                when "darwin"
                                  "md5 -r"
                                when "solaris"
                                  "digest -a md5"
                                else
                                  "md5sum"
                                end

               perform_checksum_unix(@md5_command)
             end

  checksum || perform_checksum_ruby(:md5)
end

#mounted? ⇒ Boolean

if the OS-specific file class supports inquirying as to whether the file/device is mounted, the #mounted method should return a command object whose stdout will not be nil if indeed the device is mounted.

if the OS-specific file class does not support checking for mount status, the method should not be implemented and this method will return false.

Returns:

  • (Boolean) 


129
130
131
132
133
 
# File 'lib/train/file.rb', line 129

def mounted?
  return false unless respond_to?(:mounted)

  !mounted.nil? && !mounted.stdout.nil? && !mounted.stdout.empty?
end

#owned_by?(sth) ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/train/file.rb', line 110

def owned_by?(sth)
  owner == sth
end

#path ⇒ Object 



114
115
116
117
118
119
120
 
# File 'lib/train/file.rb', line 114

def path
  if symlink? && @follow_symlink
    link_path
  else
    @path
  end
end

#pipe? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/train/file.rb', line 90

def pipe?
  type.to_s == "pipe"
end

#product_version ⇒ Object

product_version is primarily used by Windows operating systems only and will be overwritten in Windows-related classes. Since this field is returned for all file objects, the acceptable default value is nil



66
67
68
 
# File 'lib/train/file.rb', line 66

def product_version
  nil
end

#sanitize_filename(_path) ⇒ Object

This method gets override by particular os class.



21
22
23
 
# File 'lib/train/file.rb', line 21

def sanitize_filename(_path)
  nil
end

#sha256sum ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/train/file.rb', line 157

def sha256sum
  # Skip processing rest of method if fallback method is selected
  return perform_checksum_ruby(:sha256) if defined?(@ruby_checksum_fallback)

  checksum = if @backend.os.family == "windows"
               perform_checksum_windows(:sha256)
             else
               @sha256_command ||= case @backend.os.family
                                   when "darwin", "hpux", "qnx"
                                     "shasum -a 256"
                                   when "solaris"
                                     "digest -a sha256"
                                   else
                                     "sha256sum"
                                   end

               perform_checksum_unix(@sha256_command)
             end

  checksum || perform_checksum_ruby(:sha256)
end

#socket? ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
 
# File 'lib/train/file.rb', line 98

def socket?
  type.to_s == "socket"
end

#source ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/train/file.rb', line 51

def source
  if @follow_symlink
    self.class.new(@backend, @path, false)
  else
    self
  end
end

#source_path ⇒ Object 



59
60
61
 
# File 'lib/train/file.rb', line 59

def source_path
  @path
end

#symlink? ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/train/file.rb', line 106

def symlink?
  source.type.to_s == "symlink"
end

#to_json ⇒ Object 



39
40
41
42
43
44
45
 
# File 'lib/train/file.rb', line 39

def to_json
  res = Hash[DATA_FIELDS.map { |x| [x, method(x).call] }]
  # additional fields provided as input
  res["type"] = type
  res["follow_symlink"] = @follow_symlink
  res
end

#type ⇒ Object 



47
48
49
 
# File 'lib/train/file.rb', line 47

def type
  :unknown
end

#version?(version) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
80
 
# File 'lib/train/file.rb', line 77

def version?(version)
  (product_version == version) ||
    (file_version == version)
end