Module: Rordash::FileUtil

Defined in:
lib/rordash/file_util.rb

Constant Summary collapse

FILE_EXTENSION_MATCH = 
/^.*\.\S+\w$/.freeze
CONTENT_TYPE_TO_EXT_MATCH = 
%r{/(.*)$}.freeze
UNSUPPORTED_CONTENT_TYPE_MAP = 
{
  'application/vnd.ms-publisher' => 'pub'
}.freeze

Class Method Summary collapse

Class Method Details

.content_type_from_filename(filename) ⇒ Object 



77
78
79
80
 
# File 'lib/rordash/file_util.rb', line 77

def content_type_from_filename(filename)
  mime_type = mime_type_from_filename(filename)
  mime_type&.content_type
end

.content_type_to_extension(content_type) ⇒ Object 



24
25
26
27
28
29
30
31
 
# File 'lib/rordash/file_util.rb', line 24

def content_type_to_extension(content_type)
  return content_type if content_type.blank?

  ext = mime_type_for_content_type(content_type)&.preferred_extension
  ext = UNSUPPORTED_CONTENT_TYPE_MAP[content_type] if ext.blank?
  ext = content_type.match(CONTENT_TYPE_TO_EXT_MATCH).to_a.last if ext.blank?
  ext
end

.create_file_blob(filename:, content_type: nil, metadata: nil) ⇒ Object

Raises:

  • (StandardError) 


64
65
66
67
68
69
70
71
 
# File 'lib/rordash/file_util.rb', line 64

def create_file_blob(filename:, content_type: nil, metadata: nil)
  content_type = content_type.present? ? content_type : content_type_from_filename(filename) || Mime[:jpg]

  raise StandardError, "ActiveStorage must be installed" unless defined? ActiveStorage::Blob

  ActiveStorage::Blob.create_after_upload! io: ::File.open(fixture_file_path(filename).to_s), filename: filename,
                                           content_type: content_type, metadata: metadata
end

.file_url_for(filename) ⇒ Object 



73
74
75
 
# File 'lib/rordash/file_util.rb', line 73

def file_url_for(filename)
  Addressable::URI.parse(Faker::Internet.url)&.join(filename).to_s
end

.filename_has_extension?(filename) ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/rordash/file_util.rb', line 90

def filename_has_extension?(filename)
  filename.to_s.match?(FILE_EXTENSION_MATCH)
end

.filename_with_ext_from(filename:, content_type:) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/rordash/file_util.rb', line 12

def filename_with_ext_from(filename:, content_type:)
  filename = filename.to_s.strip
  return filename if filename.blank?
  return filename if filename_has_extension?(filename)
  return filename if content_type.blank?

  ext = content_type_to_extension(content_type)
  return filename if ext.blank?

  "#{filename}.#{ext}"
end

.fixture_file_path(filename) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/rordash/file_util.rb', line 33

def fixture_file_path(filename)
  rel_path = PathUtil.fixtures_path('files')
  path = rel_path.join(filename)

  if path.exist?
    path
  else
    msg = "the directory '%s' does not contain a file named '%s'"
    raise ArgumentError, format(msg, rel_path, filename)
  end
end

.fixture_file_path_str(filename) ⇒ Object 



45
46
47
 
# File 'lib/rordash/file_util.rb', line 45

def fixture_file_path_str(filename)
  fixture_file_path(filename).to_s
end

.mime_type_for_content_type(content_type) ⇒ Object 



86
87
88
 
# File 'lib/rordash/file_util.rb', line 86

def mime_type_for_content_type(content_type)
  MIME::Types[content_type].first
end

.mime_type_from_filename(filename) ⇒ Object 



82
83
84
 
# File 'lib/rordash/file_util.rb', line 82

def mime_type_from_filename(filename)
  MIME::Types.type_for(filename).first
end

.open_fixture_file(filename) ⇒ Object 



53
54
55
56
57
58
 
# File 'lib/rordash/file_util.rb', line 53

def open_fixture_file(filename)
  pathname = fixture_file_path(filename)
  return nil unless pathname.exist?

  ::File.open(pathname.to_s)
end

.read_fixture_file(rel_path) ⇒ Object 



49
50
51
 
# File 'lib/rordash/file_util.rb', line 49

def read_fixture_file(rel_path)
  File.read(PathUtil.fixtures_path(rel_path))
end

.read_fixture_file_as_hash(rel_path) ⇒ Object 



60
61
62
 
# File 'lib/rordash/file_util.rb', line 60

def read_fixture_file_as_hash(rel_path)
  HashUtil.from_string(read_fixture_file(rel_path))
end