Joint项目技术文档

1. 安装指南

在开始使用Joint项目之前，您需要确保已经安装了MongoMapper和GridFS。以下是基于Ruby环境的安装步骤：

• 确保您的系统已经安装了MongoDB数据库。

• 使用RubyGems安装MongoMapper和MongoDB的Ruby驱动：

  gem install mongo_mapper
  gem install mongo
  

• 将Joint项目添加到您的项目中。如果您是通过git进行管理的项目，您可以将其作为子模块添加：

  git submodule add <joint-repo-url> vendor/joint
  

  或者，您可以直接将其作为gem安装（假设它已被发布为gem）：

  gem install joint
  

2. 项目的使用说明

Joint项目是一个插件，它允许您在MongoMapper文档中使用文件上传功能。以下是如何在您的项目中声明和使用Joint插件的示例：

首先，声明您的类，并包含MongoMapper::Document模块和Joint插件：

class Foo
  include MongoMapper::Document
  plugin Joint

  attachment :image
  attachment :pdf
end

这样，您就会得到#image、#image=、#pdf和#pdf=方法。带有=的方法接受任何响应read方法的IO对象（如File、Tempfile等）。image和pdf方法返回一个GridIO实例。

此外，#image和#pdf是代理方法，所以您可以使用如下方式：

doc.image.id
doc.image.size
doc.image.type
doc.image.name

如果调用代理中不存在的方法，它会在GridIO实例上调用该方法，因此您仍然可以访问所有GridIO实例方法。

3. 项目API使用文档

以下是Joint项目的主要API使用方法：

• 声明附件：

  class Foo
    attachment :image
    attachment :pdf
  end
  

• 设置附件：

  doc.image = File.open('/path/to/image.jpg')
  doc.pdf = File.open('/path/to/document.pdf')
  

• 读取附件：

  image_data = doc.image.read
  pdf_data = doc.pdf.read
  

• 访问附件属性：

  image_id = doc.image.id
  pdf_size = doc.pdf.size
  

4. 项目安装方式

项目的安装方式已在安装指南中说明。您可以通过RubyGems或直接从源代码库添加Joint项目到您的项目中。请确保遵循安装指南中的步骤以成功集成Joint到您的MongoMapper文档中。