在主应用程序中扩展 Rails 3 引擎的控制器

Question

我在我的应用程序中使用 Rails 引擎作为 gem。该引擎有 PostsController 和许多方法，我想在我的主应用程序中扩展控制器逻辑，例如添加一些方法。如果我只是在主应用程序中创建 PostsController，则不会加载引擎的控制器。

Rails 引擎扩展功能 中提出了一个基于更改 ActiveSupport: 的解决方案： Dependency#require_or_load

这是执行此操作的唯一/正确方法吗？如果是的话，我应该把这段代码放在哪里？

EDIT1：

这是Andrius建议的Rails 2.x代码

module ActiveSupport::Dependencies
  alias_method :require_or_load_without_multiple, :require_or_load
  def require_or_load(file_name, const_path = nil)
    if file_name.starts_with?(RAILS_ROOT + '/app')
      relative_name = file_name.gsub(RAILS_ROOT, '')
      @engine_paths ||= Rails::Initializer.new(Rails.configuration).plugin_loader.engines.collect {|plugin| plugin.directory }
      @engine_paths.each do |path|
        engine_file = File.join(path, relative_name)
        require_or_load_without_multiple(engine_file, const_path) if File.file?(engine_file)
      end
    end
    require_or_load_without_multiple(file_name, const_path)
  end
end

Answer 1

根据设计，Rails::Engine 中的类应该限定在引擎范围内。这样，他们就不会因意外破坏主应用程序或其他引擎加载的所有代码而引入奇怪的错误。 Monkeypatching ActiveSupport::Dependency 来全面混合引擎是一个非常糟糕的解决方法。

只需使用 Rails::Railtie 即可。它们具有相同的功能，但范围与引擎不同。您可以访问整个 Rails 应用程序堆栈（包括引擎）。这是一种更像外科手术的方法。

module MyModule

  module SomeModelExtensions
    # Called when this module is included on the given class.
    def self.included(base)
      base.send(:include, InstanceMethods)
      base.extend(ClassMethods)
    end

    module ClassMethods
      def some_new_class_method
        # do stuff...
      end
    end

    module InstanceMethods
      def some_new_instance_method
        # do stuff...
      end
    end

  end

  module SomeControllerExtensions
    def self.included(base)
      base.send(:include, InstanceMethods)
      base.alias_method_chain :new, :my_module
    end

    module InstanceMethods
      # override the 'new' method
      def new_with_my_module
        # do stuff
      end
    end
  end

  class Railtie < ::Rails::Railtie

    # The block you pass to this method will run for every request in
    # development mode, but only once in production.
    config.to_prepare do
      SomeModel.send(:include, MyModule::SomeModelExtensions)
      SomeController.send(:include, MyModule::SomeControllerExtensions)
    end

  end

end

就文件布局而言，railties 看起来与引擎完全相同。

进一步阅读：使用 Railties 扩展 Rails 3

如果你还是很困惑，看看这个 git 项目，它有一个完整的实现： https://github.com/ jamezilla/bcms_pubcookie

Answer 2

为什么不直接继承应用程序中引擎的控制器类（并将路由指向新的子控制器）？听起来概念上类似于扩展内置 Devise 控制器的方式。

Answer 3

方法 1

这是我在 require 'rails/all' 之后在 application.rb 中的 Rails 3 应用程序中放置的内容（如果放置位置不好，请告诉我） ）

require 'active_support/dependencies'
module ActiveSupport::Dependencies
  alias_method :require_or_load_without_multiple, :require_or_load
  def require_or_load(file_name, const_path = nil)
    if file_name.starts_with?(Rails.root.to_s + '/app')
      relative_name = file_name.gsub(Rails.root.to_s, '')
      #@engine_paths ||= Rails::Application.railties.engines.collect{|engine| engine.config.root.to_s }
      #EDIT: above line gives deprecation notice in Rails 3 (although it works in Rails 2), causing error in test env.  Change to:
      @engine_paths ||= YourAppName::Application.railties.engines.collect{|engine| engine.config.root.to_s }
      @engine_paths.each do |path|
        engine_file = File.join(path, relative_name)
        require_or_load_without_multiple(engine_file, const_path) if File.file?(engine_file)
      end
    end
    require_or_load_without_multiple(file_name, const_path)
  end
end

有一段时间这不起作用

TypeError in PostsController#index

superclass mismatch for class PostsController

，但这是由于类定义输入错误 class PostsController <; ActionController::Base 应该是 class PostsController ApplicationController

方法2

如果您不想对所有引擎控制器等执行此操作，您可以在主应用程序中的定义之前加载引擎的控制器

require PostsEngine::Engine.config.root + 'app' + 'controllers' + 'posts_controller'

class PostsController < ApplicationController
  # extended methods
end

Answer 4

我根据上面 Andrius 和 Andrei 的代码创建了一个 gem。无需复制该代码，只需使用 mixable_engines gem。目前仅适用于 Rails 3。

https://github.com/asee/mixable_engines

https://rubygems.org/gems/mixable_engines

@Andrei 和 @Artrius：我已在许可证文件中注明了您的身份，如果您想要真实的，请告诉我姓名或其他信用。

Answer 5

如果您不希望补丁主动支持按照 Rails 引擎扩展功能中的建议更改加载顺序，您可以利用机架中间件进行身份验证。如果身份验证作为每个控制器操作的一部分完成，那么这种方法可能会节省大量代码和时间。

Answer 6

您可以使用 Ruby 的 send() 方法在创建引擎时将代码注入到控制器中...

# lib/cool_engine/engine.rb

module CoolEngine
  class Engine < ::Rails::Engine

    isolate_namespace CoolEngine

    initializer "cool_engine.load_helpers" do |app|
      # You can inject magic into all your controllers...
      ActionController::Base.send :include, CoolEngine::ActionControllerExtensions
      ActionController::Base.send :include, CoolEngine::FooBar

      # ...or add special sauce to models...
      ActiveRecord::Base.send :include, CoolEngine::ActiveRecordExtensions
      ActiveRecord::Base.send :include, CoolEngine::MoreStuff

      # ...even provide a base set of helpers
      ApplicationHelper.send :include, CoolEngine::Helpers
    end
  end
end

此方法使您无需在主应用程序中重新定义控制器继承。

Answer 7

@cowboycoded 方法 2 与 require_dependency 和 config.reload_plugins 结合使用，在 Rails 3.2.2 / Ruby 1.9 上为我工作。

这是代码：https://stackoverflow.com/a/9790497/22237