Rails 3引擎 - 为用户提供配置

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的文件,并输入托管应用程序的config/initializers.以下是此文件的示例.

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方法.