Stache 项目技术文档

一、安装指南

在开始使用 Stache 项目之前，您需要确保已经安装了以下依赖项：

1. Mustache 或 Handlebars gem：

   gem "mustache" # 或 "handlebars"
   

2. Stache gem：

   gem "stache"
   

安装完成后，您可以通过在 config/initializers 目录下创建一个初始化文件来覆盖默认配置。

Stache.configure do |c|
  # 以下配置项可能会需要修改
  # 默认值为 'app/templates'
  c.template_base_path = "..."

  # 用于解决命名冲突，如邮件程序
  c.wrapper_module_name = "..."

  # 选择使用 Mustache 或 Handlebars
  c.use :mustache
  # c.use :handlebars

  # 是否在 script 标签的 id 中包含模板路径
  c.include_path_in_id = false

  # 在生产环境中启用模板缓存
  c.template_cache = ActiveSupport::Cache::MemoryStore.new if Rails.env.production?
end

或者使用以下更简洁的配置方式：

Stache.template_base_path = File.join(Rails.root, "app", "şablon")
Stache.template_cache = ActiveSupport::Cache::MemoryStore.new if Rails.env.production?

二、项目使用说明

Stache 提供了一种简便的方式，在 Rails 应用程序中使用 Mustache 或 Handlebars 模板。

Helper 方法

Stache 提供了一个辅助方法 template_include_tag，用于将部分模板的内容输出到一个 script 标签中，便于在 JavaScript 中访问。

<%= template_include_tag 'profiles/profile' %>

指定包含的模板路径应该是相对于模板基本路径的。

视图类

Stache 包含一个名为 Stache::Mustache::View 的 Mustache 视图类的功能完整的子类。当无法找到更合适的视图类时，会自动使用此视图类。建议自定义视图类时继承自 Stache::Mustache::View。

例如，假设有一个模板 app/templates/profiles/index，Stache 会尝试查找名为 Profiles::Index 的视图类，如果找不到，则会使用基础的 Stache::Mustache::View。

module Profiles
  class Index < ::Stache::Mustache::View
    def my_view_helper_method
      "whoo"
    end
  end