创建一个简单的 Rails 3 文本助手 Gem

Question

我一直在开发我的第一个 Rails 3 插件，以打包一个简单的辅助函数，我喜欢在我所有应用程序的 ApplicationHelper 中使用该函数。您可以在 Github 上查看完整代码。

这是我的第一次尝试：

## lib/semantic_id.rb ##

require 'semantic_id/version'

module ::ActionView::Helpers::TextHelper

  def semantic_id
    string = String.new

    case
    when controller.action_name =~ /new|edit/
      string += controller.action_name + "_"
    when controller.action_name =~ /index|create/
      string += controller.controller_name
    else
      string += controller.controller_name.singularize
    end

    string += "_view"
  end

end

现在，这可行，但据我了解，这不是扩展 ActiveSupport 或任何其他 Rails 模块的“Rails 3 Way”。我还没有找到太多关于如何“应该”构建 Rails 3 gem 的文档。我尝试遵循Rails Guide，但是那里给出的添加助手的方法不起作用，或者我错过了一些东西。

我的问题是：将上面的代码作为我正在寻找的功能的示例，您如何将其转换为 Rails 3 插件 Gem？

谢谢！

Answer 1

您所做的事情的问题在于您已将 gem 的功能绑定到 ActionView。让它更通用会更好。

要解决此问题，您应该将代码打包到其自己的模块中，然后将该模块注入到您的视图环境中。例如，将您的帮助程序放入其自己的模块（和文件）中：

# lib/semantic_id/helper.rb

module SemanticId
  module Helper
    def semantic_id
      ...
    end
  end
end

然后使用 Railtie 将其添加到 ActionView：

# lib/semantic_id.rb

require 'semantic_id/helper'

ActiveSupport.on_load(:action_view) do
  include SemanticId::Helper
end

您希望将帮助程序的功能部分与将其插入框架的部分分开。您的方法包含一些特定于 Rails 的代码，但如果没有，此技术也允许您将其与 Sinatra 和其他框架一起使用。

一般来说，项目的核心内容应该位于 lib//*.rb 中，而 lib/.rb 应该只提供功能可以访问。