MimeMagic 项目技术文档

1. 安装指南

依赖项

在使用 MimeMagic 之前，您需要确保系统中已安装 Freedesktop.org 的 shared-mime-info 数据库。以下是不同操作系统的安装方法：

Linux

在大多数 Linux 发行版中，您可以通过包管理器安装 shared-mime-info。例如，在 Debian 或 Ubuntu 系统中，您可以使用以下命令：

sudo apt-get install shared-mime-info

macOS

macOS 用户可以通过 Homebrew 安装 shared-mime-info：

brew install shared-mime-info

Windows

如果您无法使用包管理器，可以通过以下步骤手动安装：

1. 从 Debian 包管理器下载 shared-mime-info 包。
2. 确保已安装 7-Zip 命令行版本。
3. 使用以下命令提取 freedesktop.org.xml 文件：

   7z x -so shared-mime-info_2.0-1_amd64.deb data.tar | 7z e -sidata.tar "./usr/share/mime/packages/freedesktop.org.xml"
   

4. 将 freedesktop.org.xml 文件放置在合适的位置，并设置环境变量 FREEDESKTOP_MIME_TYPES_PATH 指向该路径。

安装 MimeMagic

安装 MimeMagic 的 RubyGem：

gem install mimemagic

2. 项目的使用说明

基本用法

MimeMagic 提供了多种方法来检测文件的 MIME 类型。以下是一些基本示例：

require 'mimemagic'

# 通过扩展名检测 MIME 类型
MimeMagic.by_extension('html').text?
MimeMagic.by_extension('.html').child_of? 'text/plain'

# 通过文件路径检测 MIME 类型
MimeMagic.by_path('filename.txt')

# 通过文件内容检测 MIME 类型
MimeMagic.by_magic(File.open('test.html'))

自定义 MIME 类型

您可以通过 MimeMagic.add 方法添加自定义的 MIME 类型：

MimeMagic.add('application/my-custom-type', extensions: ['custom'], parents: 'text/plain')

3. 项目 API 使用文档

MimeMagic 提供了丰富的 API 接口，以下是一些常用的 API 方法：

by_extension(extension)

通过文件扩展名检测 MIME 类型。

by_path(path)

通过文件路径检测 MIME 类型。

by_magic(file)

通过文件内容检测 MIME 类型。

add(mime_type, options)

添加自定义的 MIME 类型。

4. 项目安装方式

通过 RubyGem 安装

最简单的安装方式是通过 RubyGem 安装：

gem install mimemagic

手动安装

如果您需要手动安装，可以按照以下步骤操作：

1. 下载 MimeMagic 的源代码。
2. 解压源代码并进入目录。
3. 运行以下命令进行安装：

   gem build mimemagic.gemspec
   gem install ./mimemagic-x.x.x.gem
   

通过以上步骤，您可以成功安装并使用 MimeMagic 项目。