ihower { blogging }

我在 Rails3 Beta 發佈: 重點導覽 中提到過 ActiveModel，今天讓我們更深入看看什麼時候會用到，以及怎麼使用它。

ActiveModel 定義了一組介面可以與 ActionPack helpers 銜接，也提供了許多現成的 Module 功能。任何 Class 只要實作了 ActiveModel 的介面，然後選配 include 你需要的 Module，就可以與 Rails3 helpers 銜接在一起了。

什麼時候會用到 ActiveModel 呢? 例如你想要換不同的 ORM 而不使用 ActiveRecord，或是你沒有 backend storage 只是想要拿來做其他動作(例如單純的聯絡表單用來寄信)。在 Building Web Service Clients with ActiveModel 這篇投影片中，Paul Dix 也將 ActiveModel 應用在 SOA 架構的 client-side model (就不要用 ActiveResource 吧，用 ActiveModel 配上 HTTP client library 自己寫一個比較合用)。

讓我們來看看 ActiveModel 定義的介面吧，你的 Model 得實作以下方法：

1. to_model, to_key, to_param, persisted?
2. model_name 以及 model_name.human, model_name.partial_path, model_name.singular, model_name.plural
3. valid?, errors 以及 errors[], errors.full_messages

這樣才能與 ActionPack helpers 接起來(這些 helpers 例如 link_to, form_for 等等)。所幸要預設實作這樣介面非常容易，除了 persisted? 之外，ActiveModel 都有提供現成的 Module 可以使用：

class YourModel
    extend ActiveModel::Naming
    include ActiveModel::Conversion
    include ActiveModel::Validations
     
    def persisted?
        false
    end
end

其中 persisted? 的實作得依照你的 backend storage 而定。如果你的 Model 沒有 backend storage，那麼就是 false。
而 ActiveModel::Validations 提供了你熟悉的各種 validation 方法，例如 validates_presence_of, validates_format_of 等等 (除了 validates_uniqueness_of 之外，原因不證自明)。

如果你不想要整套的 validation 框架，也可以不 include ActiveModel::Validations。你可以讓 valid? 恆真，然後使用 ActiveModel::Errors 定義 errors 方法即可滿足介面要求：

class YourModel
    extend ActiveModel::Naming
    include ActiveModel::Conversion

    def valid?() true end



    def errors
    
        @errors ||= ActiveModel::Errors.new(self)
  
    end

    def persisted?
        false
    end
end

以上這些介面 ActiveModel 也有提供 Lint Tests 可以測試，只要 include 它即可：

require 'test_helper'
class YourModelTest < ActiveSupport::TestCase
  include ActiveModel::Lint::Tests
end

以上就是 ActiveModel 介面的最低要求了，透過 ActiveModel 內建的 Naming, Conversion, Validations module 就可以輕易實作出來。ActiveModel 還有提供許多好用的 Module 來擴充，包括有：

• AttributeMethods
• Callback
• Dirty
• MassAssignmentSecurity
• Observing
• Serialization
• Translation

就不一一詳述了，詳細的用法請看原始碼及文件說明。最後提一下 MassAssignment。

MassAssignmentSecurity

如果你想要實作 MassAssignment 功能，就是有 YourModel.new(params[:model]) 這樣的介面，你可以這樣實作：

class YourModel
    # ...
    def initialize(attributes = {})
        if attributes.present?
          attributes.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
        end
      end
end

但是提到 MassAssignment，就可能會有 MassAssignment Security 的需求，我們想要保護一些特定的屬性不能透過 Mass Assignment 來設定值。
ActiveModel 提供了 MassAssignmentSecurity 這個 Module 讓我們可以獲得 attr_protected 和 attr_accessible 方法來保護特定屬性。用法如下：

class YourModel
    # ...
    include ActiveModel::MassAssignmentSecurity
    
    def initialize(attributes = {})
        if attributes.present?
          sanitize_for_mass_assignment(attributes).each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
        end
    end
end

參考資料

• ASCIIcasts: Active Model: 示範實作一個 Message model 用來寄信而不是存進資料庫
• Building Web Service Clients with ActiveModel: 投影片 及 影片
• Rails and Merb Merge: ORM Agnosticism (Part 5 of 6): ActiveModel 設計說明
• ActiveModel: Make Any Ruby Object Feel Like ActiveRecord: 最早的 ActiveModel 設計說明，注意到介面略有改，最早的 new_record? 和 destroyed? 被簡化成 persisted?
• BasicActiveModel: 一個基本的 ActiveModel 實作範例
• SuperModel: 一個 Ruby in-memory models 的應用實作
• Contact form: 一個更簡單的 Contact form 應用

Rails3 提供了一些新的方法來擴充 Rails，其中最重要的算是了解 Railtie 吧。(我個人對 Generator 比較沒興趣)

Railtie 是 Rails 的核心程式，提供了 hooks 來修改啟動時的載入流程。Rails 的主要元件 (Action Mailer, Action Controller, Action View, Active Record, Active Resource) 都有 Railtie 來各自負責自己的載入流程。這樣設計的好處有 1. 主要元件也是可以抽換的(例如換 ORM) 2. 要在 Rails 裡 hook 變得十分乾淨，只要撰寫 railtie 即可，不像之前只能用 alias_method_chain。

不過，擴充 Rails 不一定會用到 Railtie。會需要實作的情境是你要在 Rails 框架啟動流程中做些互動，例如：

1. 建立 initializers
2. 新增 generator
3. 修改 Rails config.*
4. 訂閱 Rails +ActiveSupport::Notifications+
5. 新增 rake tasks

因此，我歸類出寫 Rails Plugin 的考量有 1. 要不要寫成 Gem 2. 需不需要用到 Railstie：

傳統 vender/plugin

傳統的 plugin 寫法依然適用，Rails 還是會去載入 plugin 目錄下的 init.rb。有趣的是，在 Rails 內部是把 plugin 自動包裝成一個 Rails::Plugin 類別，而這個 Plugin class 也是繼承自 Rails::Railtie 的。

包成 Rubygem

自從有了 Bundler 之後，包成 Gem 可以說是最佳實務了。透過標準的 Gem 格式，可以 1.設定 dependcncies 2. 有版號 version 3. 方便分享及安裝

如何包成 Gem 請參考 Rubygems 套件管理工具 這篇，很簡單的。

沒用到 railtie

Rails3 架構師 wycats 開示：”如果你沒有要 hook 在 Rails lifecycle 之中，不要用 Railtie。就如同一般的 Ruby library，你先 require 你需要的 Rails 元件，然後再修改或擴充即可” (例如 override 或 include something)

# in your_lib.rb
require "active_record" 
require "your_lib/extensions" 
class ActiveRecord::Base
  include YourLib::Extensions
end

用到 railtie

如果你需要 hook 或載入 rake, generator 等，那就需要用到 railtie 了，該怎麼寫呢?

基本的寫法如下:

# my_new_gem/my_new_gem.rb
require 'rails'
class MyCoolRailtie < Rails::Railtie

  # console 時載入
  console do 
    Foo.console_mode!
  end

  # 載入 generator
  generators do
    require 'path/to/generator'
  end

  # 載入 rake tasks
  rake_tasks do
    require 'path/to/railtie.tasks'
  end

  # 建立 config/initializers
  initializer "my_cool_railtie.boot_foo" do
    Foo.boot(Bar)
  end

end

除了上述這些，還有更多細微的 hook 如 config.after _initialize, config.middlewares, before_configuration, before_eager_load, before_initialize, to_prepare 等等族繁不及背載，如果沒仔細研究 Rails 的啟動流程恐怕也搞不清楚所有的差異。

如果你的 gem 不只給 rails 用，可以這樣寫:

# lib/my_new_gem/my_cool_railtie.rb
module MyNewGem
  class MyCoolRailtie < ::Rails::Railtie
    # Railtie code here
  end
end

# lib/my_new_gem.rb
require 'my_new_gem/my_cool_railtie.rb' if defined?(Rails)

請期待下集 "Rails3: Engine 和 Plugins 系統"，Rails::Engine 可以讓你包裝出獨立的 App 元件。

參考資料

Plugin Authors: Toward a Better Future
Rails 3 Plugins - Part 1 - The Big Picture
Extending Rails 3 with Railties
Class Rails::Railtie