Temple 项目技术文档

1. 安装指南

环境要求

• Ruby 1.9.3 或更高版本

安装步骤

1. 打开终端或命令行工具。
2. 运行以下命令安装 Temple Gem：

   gem install temple
   

2. 项目使用说明

项目概述

Temple 是一个用于将模板编译为纯 Ruby 代码的抽象框架。它的目标是简化模板语言的实验、实现和优化过程。Temple 的核心思想是将模板分解为静态文本、动态文本和代码三部分，并通过一系列抽象和优化步骤最终生成高效的 Ruby 代码。

使用步骤

1. 创建模板引擎：使用 Temple 提供的 Temple::Engine 类创建自定义模板引擎。
2. 配置编译器链：定义解析器、过滤器和生成器的顺序，以实现从模板到最终 Ruby 代码的转换。
3. 渲染模板：使用生成的模板引擎渲染模板文件或字符串。

示例代码

以下是一个简单的 Temple 引擎示例：

class MyEngine < Temple::Engine
  use MyParser
  use MyFilter
  filter :MultiFlattener
  filter :StaticMerger
  filter :DynamicInliner
  generator :ArrayBuffer
end

engine = MyEngine.new
result = engine.call(template_string)
puts result

3. 项目 API 使用文档

核心 API

• Temple::Engine：用于创建模板引擎的基类。
• Temple::Filters::DynamicInliner：优化动态代码的内联器。
• Temple::Filters::StaticMerger：合并静态文本的过滤器。
• Temple::Generators::ArrayBuffer：生成 Ruby 代码的生成器。

使用示例

# 创建自定义过滤器
class MyFilter
  def call(exp)
    # 自定义处理逻辑
    exp
  end
end

# 使用自定义过滤器
class MyEngine < Temple::Engine
  use MyParser
  use MyFilter
  filter :MultiFlattener
  filter :StaticMerger
  filter :DynamicInliner
  generator :ArrayBuffer
end

4. 项目安装方式

通过 RubyGems 安装

运行以下命令安装 Temple：

gem install temple

手动安装

1. 克隆项目仓库：

   git clone https://github.com/judofyr/temple.git
   

2. 进入项目目录并安装依赖：

   cd temple
   bundle install
   

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