Module: Assembly

Defined in:

lib/assembly-objectfile/version.rb,
lib/assembly-objectfile.rb,
lib/assembly-objectfile/object_file.rb,
lib/assembly-objectfile/object_fileable.rb,
lib/assembly-objectfile/content_metadata.rb,
lib/assembly-objectfile/content_metadata/file.rb,
lib/assembly-objectfile/content_metadata/config.rb,
lib/assembly-objectfile/content_metadata/file_set.rb,
lib/assembly-objectfile/content_metadata/file_set_builder.rb,
lib/assembly-objectfile/content_metadata/nokogiri_builder.rb

Overview

Main Assembly namespace

Defined Under Namespace

Modules: ObjectFileable Classes: ContentMetadata, ObjectFile

Constant Summary

PATH_TO_GEM =

the path to the gem, used to access profiles stored with the gem

File.expand_path("#{File.dirname(__FILE__)}/..")

VALID_IMAGE_MIMETYPES =

if input image is not one of these mime types, it will not be regarded as a valid image for the purpose of generating a JP2 derivative

['image/jpeg', 'image/tiff', 'image/tif', 'image/png'].freeze

VALID_THREE_DIMENSION_EXTENTIONS =

if input file has one of these extensions in a 3D object, it will get the 3d resource type

['.obj'].freeze

TRUSTED_MIMETYPES =

the list of mimetypes that will be “trusted” by the unix file command; if a mimetype other than one of these is returned

by the file command, then a check will be made to see if exif data exists...if so, the mimetype returned by the exif data will be used
if no exif data exists, then the mimetype returned by the unix file command will be used

['text/plain', 'plain/text', 'application/pdf', 'text/html', 'application/xml'].freeze

OVERRIDE_MIMETYPES =

this is a manual override mapping of file extension to mimetype; if a file with the given extension is found, the mapped

mimetype will be returned and no further methods will be used - this is used to force a specific mimetype to be returned for
for a given file extension regardless of what exif or the unix file system command returns
the mapping format is "extension with period: returned mimetype",  e.g. for any .json file, you will always get `application/json`

{
  '.json': 'application/json'
}.freeze

SPECIAL_DPG_FOLDERS =

these special dpg folders will force any files contained in them into their own resources, regardless of filenaming convention

%w[31 44 50].freeze

DEPRECATED_STYLES =

these are used when :bundle=>:dpg only

i[book_with_pdf book_as_image].freeze

VALID_STYLES =

i[simple_image simple_book file map document 3d webarchive-seed].freeze