Class: Hyrax::FileMetadata

Inherits:
Valkyrie::Resource
  • Object
show all
Defined in:
app/models/hyrax/file_metadata.rb

Defined Under Namespace

Modules: Use

Constant Summary collapse

GENERIC_MIME_TYPE = 
'application/octet-stream'

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.for(file:) ⇒ Object

Parameters:



106
107
108
109
110
 
# File 'app/models/hyrax/file_metadata.rb', line 106

def self.for(file:)
  new(label: file.original_filename,
      original_filename: file.original_filename,
      mime_type: file.content_type)
end

Instance Method Details

#content ⇒ #to_s

Deprecated.

get content from #file instead

Returns:

  • (#to_s) 


146
147
148
149
150
151
152
 
# File 'app/models/hyrax/file_metadata.rb', line 146

def content
  Deprecation.warn('This convienince method has been deprecated. ' \
                   'Retrieve the file from the storage adapter instead.')
  file.read
rescue Valkyrie::StorageAdapter::FileNotFound
  ''
end

#download_id ⇒ Object 



134
135
136
 
# File 'app/models/hyrax/file_metadata.rb', line 134

def download_id
  id
end

#extracted_file? ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
 
# File 'app/models/hyrax/file_metadata.rb', line 126

def extracted_file?
  type.include?(Use::EXTRACTED_TEXT)
end

#file ⇒ Object 



154
155
156
 
# File 'app/models/hyrax/file_metadata.rb', line 154

def file
  Hyrax.storage_adapter.find_by(id: file_identifier)
end

#original_file? ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'app/models/hyrax/file_metadata.rb', line 114

def original_file?
  type.include?(Use::ORIGINAL_FILE)
end

#thumbnail_file? ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'app/models/hyrax/file_metadata.rb', line 120

def thumbnail_file?
  type.include?(Use::THUMBNAIL)
end

#title ⇒ Object 



130
131
132
 
# File 'app/models/hyrax/file_metadata.rb', line 130

def title
  label
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


138
139
140
 
# File 'app/models/hyrax/file_metadata.rb', line 138

def valid?
  file.valid?(size: size.first, digests: { sha256: checksum&.first&.sha256 })
end