class Faker::File

def dir(legacy_segment_count = NOT_GIVEN, legacy_root = NOT_GIVEN, legacy_directory_separator = NOT_GIVEN, segment_count: 3, root: nil, directory_separator: ::File::Separator)

Returns:
  • (String) -

Parameters:
  • directory_separator (String) -- Specifies the separator between the segments.
  • root (String) -- Specifies the root of the generated string.
  • segment_count (Integer) -- Specifies the number of nested folders in the generated string. 
def dir(legacy_segment_count = NOT_GIVEN, legacy_root = NOT_GIVEN, legacy_directory_separator = NOT_GIVEN, segment_count: 3, root: nil, directory_separator: ::File::Separator)
  warn_for_deprecated_arguments do |keywords|
    keywords << :segment_count if legacy_segment_count != NOT_GIVEN
    keywords << :root if legacy_root != NOT_GIVEN
    keywords << :directory_separator if legacy_directory_separator != NOT_GIVEN
  end
  Array
    .new(segment_count) { Faker::Internet.slug }
    .unshift(root)
    .compact
    .join(directory_separator)
    .squeeze(directory_separator)
end

def extension

Returns:
  • (String) - 
def extension
  fetch('file.extension')
end

def file_name(legacy_dir = NOT_GIVEN, legacy_name = NOT_GIVEN, legacy_ext = NOT_GIVEN, legacy_directory_separator = NOT_GIVEN, dir: nil, name: nil, ext: nil, directory_separator: ::File::Separator)

Returns:
  • (String) -

Parameters:
  • directory_separator (String) -- Specifies the separator between the directory and name elements.
  • ext (String) -- Specifies the extension used the generated file.
  • name (String) -- Specifies the filename used for the generated file.
  • dir (String) -- Specifies the path used for the generated file. 
def file_name(legacy_dir = NOT_GIVEN, legacy_name = NOT_GIVEN, legacy_ext = NOT_GIVEN, legacy_directory_separator = NOT_GIVEN, dir: nil, name: nil, ext: nil, directory_separator: ::File::Separator)
  warn_for_deprecated_arguments do |keywords|
    keywords << :dir if legacy_dir != NOT_GIVEN
    keywords << :name if legacy_name != NOT_GIVEN
    keywords << :ext if legacy_ext != NOT_GIVEN
    keywords << :directory_separator if legacy_directory_separator != NOT_GIVEN
  end
  dir ||= dir(segment_count: 1)
  name ||= Faker::Lorem.word.downcase
  ext ||= extension
  [dir, name].join(directory_separator) + ".#{ext}"
end

def mime_type

Returns:
  • (String) - 
def mime_type
  fetch('file.mime_type')
end