class MIME::Types::Loader
This class is responsible for initializing the MIME::Types registry from the data files supplied with the mime-types library.
The Loader will use one of the following paths:
-
The
path
provided in its constructor argument; -
The value of ENV; or
-
The value of MIME::Types::Loader::PATH.
When load is called, the
path
will be searched recursively for all YAML (.yml or .yaml)
files. By convention, there is one file for each media type
(application.yml, audio.yml, etc.), but this is not required.
Constants
- BadV1Format
Raised when a V1 format file is discovered. This exception will be removed for mime-types 3.0.
- PATH
The path that will be used for loading the MIME::Types data. The default location is __FILE__/../../../../data, which is where the data lives in the gem installation of the mime-types library.
The MIME::Types::Loader will load all JSON or columnar files contained in this path.
System repackagers note: this is the constant that you would change if you repackage mime-types for your system. It is recommended that the path be something like /usr/share/ruby/mime-types/.
Attributes
The MIME::Types container instance that will be loaded. If not provided at initialization, a new MIME::Types instance will be constructed.
The path that will be read for the MIME::Types files.
Public Class Methods
Creates a Loader object that can be used to load MIME::Types registries into memory, using YAML, JSON, or v1 registry format loaders.
# File lib/mime/types/loader.rb, line 27 def initialize(path = nil, container = nil) path = path || ENV['RUBY_MIME_TYPES_DATA'] || MIME::Types::Loader::PATH @container = container || MIME::Types.new @path = File.expand_path(path) # begin # require 'mime/lazy_types' # @container.extend(MIME::LazyTypes) # end end
Public Instance Methods
Loads a MIME::Types registry. Loads from JSON files by default (#load_json).
This will load from columnar files (#load_columnar) if columnar:
true
is provided in options
and there are columnar
files in path
.
# File lib/mime/types/loader.rb, line 83 def load(options = { columnar: false }) if options[:columnar] && !Dir[columnar_path].empty? load_columnar else load_json end end
Loads a MIME::Types registry from columnar
files recursively found in path
.
# File lib/mime/types/loader.rb, line 70 def load_columnar require 'mime/types/columnar' unless defined?(MIME::Types::Columnar) container.extend(MIME::Types::Columnar) container.load_base_data(path) container end
Loads MIME::Types from a single JSON file.
It is expected that the JSON objects will be an array of hash objects. The JSON format is the registry format for the MIME types registry shipped with the mime-types library.
# File lib/mime/types/loader.rb, line 224 def load_from_json(filename) require 'json' JSON.parse(read_file(filename)).map { |type| MIME::Type.new(type) } end
Build the type list from a file in the format:
[*][!][os:]mt/st[<ws>@ext][<ws>:enc][<ws>'url-list][<ws>=docs]
*¶ ↑
An unofficial MIME type. This should be used if and only if the MIME type is not properly specified (that is, not under either x-type or vnd.name.type).
!¶ ↑
An obsolete MIME type. May be used with an unofficial MIME type.
os:¶ ↑
Platform-specific MIME type definition.
mt¶ ↑
The media type.
st¶ ↑
The media subtype.
<ws>@ext¶ ↑
The list of comma-separated extensions.
<ws>:enc¶ ↑
The encoding.
<ws>'url-list¶ ↑
The list of comma-separated URLs.
<ws>=docs¶ ↑
The documentation string.
That is, everything except the media type and the subtype is optional. The more information that's available, though, the richer the values that can be provided.
This method has been deprecated and will be removed in mime-types 3.0.
# File lib/mime/types/loader.rb, line 153 def load_from_v1(filename, __internal__ = false) MIME::Types.deprecated(self.class, __method__) unless __internal__ data = read_file(filename).split($/) mime = MIME::Types.new data.each_with_index { |line, index| item = line.chomp.strip next if item.empty? m = V1_FORMAT.match(item) unless m MIME::Types.logger.warn <<-EOS #{filename}:#{index + 1}: Parsing error in v1 MIME type definition. => #{line} EOS fail BadV1Format, line end unregistered, obsolete, _, mediatype, subtype, extensions, encoding, urls, docs, _ = *m.captures next if mediatype.nil? extensions &&= extensions.split(/,/) urls &&= urls.split(/,/) if docs.nil? use_instead = nil else use_instead = docs.scan(%r{use-instead:(\S+)}).flatten.first docs = docs.gsub(%r{use-instead:\S+}, '').squeeze(' \t') end mime_type = MIME::Type.new("#{mediatype}/#{subtype}") do |t| t.extensions = extensions t.encoding = encoding t.obsolete = obsolete t.registered = false if unregistered t.use_instead = use_instead t.docs = docs end mime.add_type(mime_type, true) } mime end
Loads MIME::Types from a single YAML file.
It is expected that the YAML objects contained within the registry array
will be tagged as !ruby/object:MIME::Type
.
Note that the YAML format is about 2½ times slower than either the v1 format or the JSON format.
NOTE: The purpose of this format is purely for maintenance reasons.
# File lib/mime/types/loader.rb, line 209 def load_from_yaml(filename) begin require 'psych' rescue LoadError nil end require 'yaml' YAML.load(read_file(filename)) end
Loads a MIME::Types registry from JSON files
(*.json
) recursively found in path
.
It is expected that the JSON objects will be an array of hash objects. The JSON format is the registry format for the MIME types registry shipped with the mime-types library.
# File lib/mime/types/loader.rb, line 60 def load_json Dir[json_path].sort.each do |f| types = self.class.load_from_json(f) container.add(*types, :silent) end container end
Loads a MIME::Types registry from files found
in path
that are in the v1 data format. The file search for
this will exclude both JSON (*.json
) and YAML
(*.yml
or *.yaml
) files.
This method has been deprecated and will be removed from mime-types 3.0.
# File lib/mime/types/loader.rb, line 96 def load_v1 MIME::Types.deprecated(self.class, __method__) Dir[v1_path].sort.each do |f| next if f =~ /\.(?:ya?ml|json|column)$/ container.add(self.class.load_from_v1(f, true), true) end container end
Loads a MIME::Types registry from YAML files
(*.yml
or *.yaml
) recursively found in
path
.
It is expected that the YAML objects contained within the registry array
will be tagged as !ruby/object:MIME::Type
.
Note that the YAML format is about 2½ times slower than either the v1 format or the JSON format.
NOTE: The purpose of this format is purely for maintenance reasons.
# File lib/mime/types/loader.rb, line 47 def load_yaml Dir[yaml_path].sort.each do |f| container.add(*self.class.load_from_yaml(f), :silent) end container end
Private Instance Methods
# File lib/mime/types/loader.rb, line 246 def columnar_path File.join(path, '*.column') end
# File lib/mime/types/loader.rb, line 242 def json_path File.join(path, '*.json') end
# File lib/mime/types/loader.rb, line 231 def read_file(filename) File.open(filename, 'r:UTF-8:-') { |f| f.read } end
# File lib/mime/types/loader.rb, line 250 def v1_path File.join(path, '*') end
# File lib/mime/types/loader.rb, line 238 def yaml_path File.join(path, '*.y{,a}ml') end