使用 rails rake 任务插入方法的最佳方法

Question

我正在为 Rails 4 编写一个 gem，它需要向 ApplicationController 添加一些方法，我认为最好的方法是编写一个 rake 任务来打开文件，插入我需要的方法，然后关闭它。使我的方法在类定义中的最佳方法是什么？

class ApplicationController < ActionController::Base

  def existing_methods
    foo
  end

  # insert my methods here

end

编辑

在尝试了以下建议但无济于事后，我尝试关注 this post 并最终尝试以下操作：

lib/my_engine.rb

require "my_engine/engine"
require "my_engine/controller_methods"

module MyEngine
end

lib/my_engine/controller_methods.rb

module MyEngine
  module ControllerMethods
    extend ActiveSupport::Concern

    def foo
      "foo"
    end

  end
end
ActiveRecord::Base.send(:include, MyEngine::ControllerMethods)

运行应用程序时，我的 application.slim 包含 = foo 行，我收到以下错误：

#

的未定义局部变量或方法 `foo'

Answer 1

好的，我们一致认为修改宿主应用的 application_controller.rb 不是可行的方法。让我们看看通过 gem 向 ApplicationController 类（实际上是 ActionController::Base）添加方法的不同方法。

我创建了一个非常简单的 gem。我希望它添加一个功能，rot13，这意味着任何控制器都可以调用rot13('something!') 来取回'fbzrguvat!'。 （在现实生活中，您可以将此添加到 String...）

你可以像这样扩展ActionController::Base：

class ActionController::Base 
  def rot13 str
    a = 'a'.ord
    z = 'z'.ord   
    str.unpack('c*').map { |x| (a..z).cover?(x) ? (((x - a) + 13) % 26) + a : x }.pack('c*') 
  end
end

现在在我的应用程序中，我可以在任何控制器中调用rot13('ibvyn!') 和voila!

添加一个模块并通过 Railtie 钩子将其包含在 ActionController::Base 中会更安全。所以让我们添加一个 Railtie。

我添加lib/rot13/railtie.rb如下：

module Rot13
  class Rot13Railtie < Rails::Railtie
    initializer "rot_13_railtie.extend_action_controller" do  
      ActiveSupport.on_load :action_controller do
        # At this point, self == ActionController::Base
        include Rot13::ControllerMethods
      end
    end
  end
end

现在lib/rot13.rb 看起来像这样：

require "rot13/version"
require "rot13/railtie.rb" if defined? Rails

module Rot13
  module ControllerMethods
    def rot13 str
      a = 'a'.ord
      z = 'z'.ord   
      str.unpack('c*').map { |x| (a..z).cover?(x) ? (((x - a) + 13) % 26) + a : x }.pack('c*') 
    end
  end 
end

这对于大多数用途来说都很好。

假设您不希望您的 rot13 方法在 ActionController::Base 中定义并可供所有控制器使用——假设您希望您的 gem 用户在逐个控制器的基础上“选择加入” ，例如

class ApplicationController < ActionController::Base
  with_rot_13

  # and so on...
end

您可以在 on_load 块中调用 extend Rot13::ControllerOptIn 而不是 include Rot13::ControllerMethods，以在 ActionController::Base 的类级别添加 with_rot_13 方法，然后定义 ControllerOptIn 模块，如下所示：

module Rot13
  module ControllerMethods
    # ...
  end 

  module ControllerOptIn
    def with_rot_13
      include ControllerMethods
    end
  end
end

就是这样！

编辑：只是为了解决“为什么该方法在我的视图中不可见？”的附加问题--您的方法未定义为帮助程序，因此它不会自动在您的不带 controller 后缀的视图，例如%p= controller.rot13 'blah'。幸运的是，您可以通过调用 helper_method 将其定义为助手，例如

module ControllerOptIn
  def with_rot_13
    include ControllerMethods
    helper_method :rot13
  end
end

现在你可以这样做了（注意：HAML）：

%p= controller.rot13 'hello there!'
%p= rot13 'well how are ya?'

但在这里必须指定helper_method :rot13 并不是很好。你能直接从Rot13::ControllerMethods 中挖掘出必要的符号吗？当然，只要你确定这是你想要的：

module ControllerOptIn
  def with_rot_13
    include ControllerMethods
    helper_method *ControllerMethods.instance_methods
  end
end