Rails 3 Engine - 为用户提供配置

Question

我似乎找不到任何有关如何执行以下操作的文档：我需要为使用我的引擎的任何应用程序提供一个配置变量，以便它们可以轻松地将设置传递到我的引擎。

有人有任何正确或可接受的方法的链接吗？

编辑：作为更新，我找到了一个不错的方法来做到这一点。代码如下。

# file: lib/my_engine.rb
module MyEngine

  class Engine < Rails::Engine

    initializer "my_engine.configure_rails_initialization" do |app|
      # Engine configures Rails app here, this is not what my question was about
    end

  end

  # This is what I was trying to figure out
  def self.config(&block)
    @@config ||= MyEngine::Configuration.new

    yield @@config if block

    return @@config
  end

end

这允许任何使用我的引擎的应用程序在其任何初始值设定项或其environment.rb文件中像下面这样配置它，调用 MyEngine::Configuration 类中定义的任何方法：

MyEngine.config do |config|
  config.some_configuration_option = "Whatever"
end

Answer 1

简短回答：

创建一个名为 your_engine_class.rb 的文件并放入托管应用程序的配置/初始化程序中。以下是该文件的示例。

module YourEngineClass
  class Engine < Rails::Engine
    config.param_name = 'value'    
  end
end

然后在你的主engine.rb中你可以访问：

config.param_name

更长的答案：我创建了一个存根引擎，其中包括这个和你需要的许多其他标准配置，你可以使用它作为起点：

http://keithschacht.com/creating-a-rails-3-engine-plugin-gem/

Answer 2

我个人喜欢 Devise 使用的模式，它在引擎的模块中定义一个类方法，然后在父应用程序中定义一个初始化程序。

创建要从父应用程序调用的类方法

module YourEngine
  class << self
    attr_accessor :your_config_var
  end

  def self.setup(&block)
    # You can yield your own object encapsulating your configuration logic/state
    yield self
  end
end

在父应用程序的初始化程序中调用类方法

YourEngine.setup do |config|
  config.your_config_var = "nyan cat"
end

现在，您可以在引擎的初始化过程中自由访问 your_config_var。您可以在引擎的 config/initializers 目录中创建一个文件，或使用 Rails Initializer钩子。

我喜欢这种方法，因为您可以更好地控制向客户端公开的配置对象，并且不会覆盖引擎的 config 方法。

Answer 3

对我来说似乎更好如下：

#lib/my_engine.rb
require 'rails'

module MyEngine
  class Engine < Rails::Engine

  end

  def self.config(&block)
    yield Engine.config if block
    Engine.config
  end
end