Module: Assembly::ObjectFileable

Included in:
ObjectFile
Defined in:
lib/assembly-objectfile/object_fileable.rb

Overview

Common behaviors we need for other classes in the gem

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#file_attributes ⇒ Object

Returns the value of attribute file_attributes.



8
9
10
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 8

def file_attributes
  @file_attributes
end

#label ⇒ Object

Returns the value of attribute label.



8
9
10
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 8

def label
  @label
end

#path ⇒ Object

Returns the value of attribute path.



8
9
10
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 8

def path
  @path
end

#provider_md5 ⇒ Object

Returns the value of attribute provider_md5.



8
9
10
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 8

def provider_md5
  @provider_md5
end

#provider_sha1 ⇒ Object

Returns the value of attribute provider_sha1.



8
9
10
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 8

def provider_sha1
  @provider_sha1
end

#relative_path ⇒ Object

Returns the value of attribute relative_path.



8
9
10
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 8

def relative_path
  @relative_path
end

Instance Method Details

#dirname ⇒ String

Returns base directory.

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_file.dirname # "/input"

Returns:

  • (String) —

    base directory



58
59
60
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 58

def dirname
  File.dirname(path)
end

#dpg_basename ⇒ String

Returns DPG base filename, removing the extension and the ‘00’,‘05’, etc. placeholders.

Examples:

source_file = Assembly::ObjectFile.new('/input/cy565rm7188_00_001.tif')
puts source_file.dpg_basename # "cy565rm7188_001"

Returns:

  • (String) —

    DPG base filename, removing the extension and the ‘00’,‘05’, etc. placeholders



32
33
34
35
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 32

def dpg_basename
  file_parts = File.basename(path, ext).split('_')
  file_parts.size == 3 ? "#{file_parts[0]}_#{file_parts[2]}" : filename_without_ext
end

#dpg_folder ⇒ String

Returns DPG subfolder for the given filename, i.e. ‘00’,‘05’, etc.

Examples:

source_file = Assembly::ObjectFile.new('/input/cy565rm7188_00_001.tif')
puts source_file.dpg_folder # "00"

Returns:

  • (String) —

    DPG subfolder for the given filename, i.e. ‘00’,‘05’, etc.



41
42
43
44
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 41

def dpg_folder
  file_parts = File.basename(path, ext).split('_')
  file_parts.size == 3 ? file_parts[1] : ''
end

#encoding ⇒ String

Note:

Uses shell call to “file”, only expected to work on unix based systems

Returns encoding for supplied file.

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.txt')
puts source_file.encoding # 'us-ascii'

Returns:

  • (String) —

    encoding for supplied file



160
161
162
163
164
165
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 160

def encoding
  @encoding ||= begin
    check_for_file
    `file --mime-encoding "#{path}"`.delete("\n").split(':')[1].strip
  end
end

#exif ⇒ MiniExiftool

Returns exif information stored as a hash and an object.

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_file.exif # hash with exif information

Returns:

  • (MiniExiftool) —

    exif information stored as a hash and an object



82
83
84
85
86
87
88
89
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 82

def exif
  @exif ||= begin
              check_for_file
              MiniExiftool.new(path, replace_invalid_chars: '?')
            rescue StandardError
              nil
            end
end

#exif_mimetype ⇒ String

Returns mimetype information for the current file based on exif data (if available and not a trusted source that we’d rather get from the file system command)

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.txt')
puts source_file.exif_mimetype # 'text/plain'

Returns:

  • (String) —

    mime type for supplied file



147
148
149
150
151
152
153
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 147

def exif_mimetype
  @exif_mimetype ||= begin
    check_for_file
    prefer_exif = !Assembly::TRUSTED_MIMETYPES.include?(file_mimetype) # if it's not a "trusted" mimetype and there is exif data; get the mimetype from the exif
    exif.mimetype if exif && exif.mimetype && prefer_exif
  end
end

#ext ⇒ String

Returns filename extension.

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_file.ext # ".tif"

Returns:

  • (String) —

    filename extension



66
67
68
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 66

def ext
  File.extname(path)
end

#file_exists? ⇒ Boolean

Determines if the file exists (and is not a directory)

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_file.file_exists? # true

Returns:

  • (Boolean) —

    file exists



233
234
235
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 233

def file_exists?
  File.exist?(path) && !File.directory?(path)
end

#file_mimetype ⇒ String

Returns mimetype information for the current file based on unix file system command.

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.txt')
puts source_file.file_mimetype # 'text/plain'

Returns:

  • (String) —

    mime type for supplied file



135
136
137
138
139
140
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 135

def file_mimetype
  @file_mimetype ||= begin
    check_for_file
    `file --mime-type "#{path}"`.delete("\n").split(':')[1].strip # first try and get the mimetype from the unix file command
  end
end

#filename ⇒ String

Returns base filename.

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_file.filename # "path_to_file.tif"

Returns:

  • (String) —

    base filename



50
51
52
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 50

def filename
  File.basename(path)
end

#filename_without_ext ⇒ String

Returns base filename without extension.

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_file.filename # "path_to_file"

Returns:

  • (String) —

    base filename without extension



74
75
76
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 74

def filename_without_ext
  File.basename(path, ext)
end

#filesize ⇒ Integer

Returns file size information for the current file in bytes.

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_file.filesize # 1345

Returns:

  • (Integer) —

    file size in bytes



223
224
225
226
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 223

def filesize
  check_for_file
  @filesize ||= File.size(path)
end

#has_color_profile? ⇒ Boolean

Returns true if image has a color profile, false if not.

Examples:

source_img = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_img.has_color_profile? # true

Returns:

  • (Boolean) —

    true if image has a color profile, false if not.



200
201
202
203
204
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 200

def has_color_profile?
  return false unless exif

  exif['profiledescription'] || exif['colorspace'] ? true : false
end

#image? ⇒ Boolean

Returns if object is an image.

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_file.image? # true

Returns:

  • (Boolean) —

    if object is an image



180
181
182
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 180

def image?
  object_type == :image
end

#initialize(path, params = {}) ⇒ Object

Examples:

Assembly::ObjectFile.new('/input/path_to_file.tif')

Parameters:

  • path (String) —

    full path to the file to be worked with

  • params (Hash<Symbol => Object>) (defaults to: {}) —

    options used during content metadata generation

Options Hash (params):

  • :file_attributes (Hash<Symbol => ['yes', 'no']>) —

    e.g. :preserve=>‘yes’,:shelve=>‘no’,:publish=>‘no’, defaults pulled from mimetype

  • :label (String) —

    a resource label (files bundlded together will just get the first file’s label attribute if set)

  • :provider_md5 (String) —

    pre-computed MD5 checksum

  • :provider_sha1 (String) —

    pre-computed SHA1 checksum

  • :relative_path (String) —

    if you want the file ids in the content metadata it can be set, otherwise content metadata will get the full path



19
20
21
22
23
24
25
26
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 19

def initialize(path, params = {})
  @path = path
  @label = params[:label]
  @file_attributes = params[:file_attributes]
  @relative_path = params[:relative_path]
  @provider_md5 = params[:provider_md5]
  @provider_sha1 = params[:provider_sha1]
end

#jp2able? ⇒ Boolean

Examines the input image for validity to create a jp2. Same as valid_image? but also confirms the existence of a profile description and further restricts mimetypes. It is used by the assembly robots to decide if a jp2 will be created and is also called before you create a jp2 using assembly-image.

Examples:

source_img = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_img.jp2able? # true

Returns:

  • (Boolean) —

    true if image should have a jp2 created, false if not.



212
213
214
215
216
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 212

def jp2able?
  return false unless exif

  Assembly::VALID_IMAGE_MIMETYPES.include?(mimetype)
end

#md5 ⇒ String

Computes md5 checksum or returns cached value

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_file.md5 # 'XXX123XXX1243XX1243'

Returns:

  • (String) —

    md5 checksum



96
97
98
99
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 96

def md5
  check_for_file unless @md5
  @md5 ||= Digest::MD5.file(path).hexdigest
end

#mimetype ⇒ String

Returns mimetype information for the current file based on

(1) exifdata (if available), (2) unix file type or (3) file extension using the mimetypes gem, in this priority order

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.txt')
puts source_file.mimetype # 'text/plain'

Returns:

  • (String) —

    mime type



117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 117

def mimetype
  @mimetype ||= begin
    if exif_mimetype # first, try the exif data
      exif_mimetype
    elsif file_mimetype # next, try exif/unix file system command
      file_mimetype
    else  # finally, get it from the mime-types gem (using the file extension) if both of those failed for some reason
      mtype = MIME::Types.type_for(path).first
      mtype ? mtype.content_type : ''
    end
  end
end

#object_type ⇒ Symbol

Returns the type of object, could be :application (for PDF or Word, etc), :audio, :image, :message, :model, :multipart, :text or :video.

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_file.object_type # :image

Returns:

  • (Symbol) —

    the type of object, could be :application (for PDF or Word, etc), :audio, :image, :message, :model, :multipart, :text or :video



171
172
173
174
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 171

def object_type
  lookup = MIME::Types[mimetype][0]
  lookup.nil? ? :other : lookup.media_type.to_sym
end

#sha1 ⇒ String

Computes sha1 checksum or return cached value

Examples:

source_file = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_file.sha1 # 'XXX123XXX1243XX1243'

Returns:

  • (String) —

    sha1 checksum



106
107
108
109
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 106

def sha1
  check_for_file unless @sha1
  @sha1 ||= Digest::SHA1.file(path).hexdigest
end

#valid_image? ⇒ Boolean

Examines the input image for validity. Used to determine if image is a valid and useful image. If image is not a jp2, also checks if it is jp2able?

Examples:

source_img = Assembly::ObjectFile.new('/input/path_to_file.tif')
puts source_img.valid_image? # true

Returns:

  • (Boolean) —

    true if image is valid, false if not.



190
191
192
193
194
 
# File 'lib/assembly-objectfile/object_fileable.rb', line 190

def valid_image?
  return false unless image?

  mimetype == 'image/jp2' || jp2able? ? true : false
end