Dimensions 库使用与技术文档

1. 安装指南

在开始使用 Dimensions 库之前，您需要确保您的系统中已经安装了 Ruby 环境。以下是安装 Dimensions 库的步骤：

gem install dimensions

使用上述命令，您可以从 RubyGems 仓库中安装 Dimensions 库。

2. 项目的使用说明

Dimensions 库是一个纯 Ruby 库，用于读取 GIF、PNG、JPEG 和 TIFF 图像的宽度、高度以及旋转角度。您可以通过 dimensions、width 和 height 方法来测量图像文件。

以下是一些基础的使用示例：

require 'dimensions'

# 读取图像尺寸
dimensions = Dimensions.dimensions("upload_bird.jpg")  # => [300, 225]

# 获取图像宽度
width = Dimensions.width("upload_bird.jpg")       # => 300

# 获取图像高度
height = Dimensions.height("upload_bird.jpg")      # => 225

Dimensions 库还支持自动读取并处理 EXIF 方向属性，确保图像的宽度和高度值能正确反映旋转后的显示效果。您可以使用 angle 方法来检查 JPEG 图像的旋转角度。

angle = Dimensions.angle("upload_bird.jpg")       # => 0
angle_rotated = Dimensions.angle("rotated.jpg")   # => 90

3. 项目API使用文档

以下是 Dimensions 库的主要 API 文档：

Dimensions.dimensions(file_path)

• 参数：file_path (String) - 图像文件的路径
• 返回值：返回一个包含图像宽度和高度的数组。

Dimensions.width(file_path)

• 参数：file_path (String) - 图像文件的路径
• 返回值：返回图像的宽度。

Dimensions.height(file_path)

• 参数：file_path (String) - 图像文件的路径
• 返回值：返回图像的高度。

Dimensions.angle(file_path)

• 参数：file_path (String) - JPEG 图像的路径
• 返回值：返回图像的旋转角度。

Dimensions::IO

• 功能：将 Dimensions 方法扩展到 IO 对象上，用于透明地检测读取过程中的图像尺寸和方向。

4. 项目安装方式

项目的安装方式已在“安装指南”部分中说明。您可以使用 RubyGems 提供的 gem install dimensions 命令来进行安装。安装完成后，您就可以在 Ruby 项目中引入并使用 Dimensions 库了。