ORM Adapter 技术文档

1. 安装指南

首先，您需要确保您的系统中已经安装了Ruby环境。接下来，通过以下命令将ORM Adapter安装到您的项目中：

gem install orm_adapter

确保您的Gemfile中已经添加了orm_adapter，然后执行bundle install以安装所有依赖项。

2. 项目的使用说明

ORM Adapter为流行的Ruby ORMs提供了一个统一的入口点，适用于希望支持多个ORM的gem作者。以下是使用示例：

require 'orm_adapter'

# 假设User是一个ActiveRecord、DM Resource、MongoMapper或MongoId Document
User.to_adapter.find_first :name => 'Fred' # 我们不关心具体是哪种ORM!

user_model = User.to_adapter
user_model.get!(1)                      # 通过id查找记录
user_model.find_first(:name => 'fred')  # 查找名字为fred的第一个用户
user_model.find_first(:level => 'awesome', :id => 23)
                                          # 如果用户23的级别是awesome，则查找该用户
user_model.find_all                     # 查找所有用户
user_model.find_all(:name => 'fred')    # 查找所有名字为fred的用户
user_model.find_all(:order => :name)    # 查找所有名字为fred的用户，并按名字排序
user_model.create!(:name => 'fred')     # 创建一个名字为fred的用户
user_model.destroy(object)              # 销毁用户对象

3. 项目API使用文档

ORM Adapter提供了一系列基本方法，例如get、find_first、create!等，以下是一些API的使用说明：

• get!(id): 通过ID查找并返回记录，如果未找到则抛出异常。
• find_first(conditions): 根据给定条件查找并返回第一个匹配的记录。
• find_all(conditions): 根据给定条件查找并返回所有匹配的记录。
• create!(attributes): 创建一个新的记录，如果创建失败则抛出异常。
• destroy(object): 销毁指定的对象。

更多API详细信息，请参考OrmAdapter::Base。

4. 项目安装方式

除了使用gem安装外，您还可以直接从GitHub克隆项目代码到本地：

git clone https://github.com/ianwhite/orm_adapter.git
cd orm_adapter
bundle install

若要针对不同版本的ORM运行测试，可以在gemfiles目录中指定一个gemfile，例如：

BUNDLE_GEMFILE=gemfiles/activerecord-4.1.gemfile bundle install
BUNDLE_GEMFILE=gemfiles/activerecord-4.1.gemfile bundle exec rake spec