使用rackup文件自定义配置应用程序实例

时间:2013-02-25 04:41:21

标签: ruby sinatra rack

tl; dr 如何通过自定义config.ru让单个Sinatra应用在不同服务器上的启动方式大不相同?

背景

我有一个使用Sinatra编写的Web应用程序,它运行在不同的服务器上。目前,这些服务器的代码库是分叉的,因为它们的方式(离散)部分有一些非平凡的差异。例如:

  • 一台服务器通过Intranet LDAP服务器验证用户,而另一台服务器使用更简单的本地数据库表查找。
  • 一台服务器使用外部cron作业定期更新某些统计信息,而另一台(基于Windows)服务器使用内部困线程。
  • 一台服务器将某些元数据存储在本地表中,而另一台服务器通过屏幕抓取(!)从外部Wiki中提取元数据。

......等等。

我想完全共享这些代码库(单个Git repo)。我设想每个服务器都会有一个略有不同的配置文件,导致应用程序以不同的方式启动。

废弃的解决方案

可以根据环境变量更改应用的行为。由于行为的变化不是很少,我宁愿不要隐藏环境变量中的设置。

可以创建我自己的“server-settings.rb”文件,该文件对于每台计算机都是唯一的,在我的app.rb中需要它,然后在那里更改配置。然而,这似乎可能是重新发明轮子。我已经拥有每个服务器名为config.ru的文件。我不应该使用它吗?

当前代码

此应用的config.ru目前只是:

require ::File.join( ::File.dirname(__FILE__), 'app' )
run MyApp.new

它所需要的app.rb本质上是:

require 'sinatra'
require_relative 'helpers/login' # customized for LDAP lookup on this server

class MyApp < Sinatra::Application
  use Rack::Session::Cookie, key:'foo.bar', path:'/', secret:'ohnoes'
  set :protection, except: [:path_traversal, :session_hijacking]
  configure :production do
    # run various code that depends on server settings, e.g.
    Snapshotter.start # there is no cron on this machine, so we do it ourselves
  end
  configure :development do
    # run various code that depends on server settings
  end
end

问题

我想让config.ru辜负它的名字,让它看起来像这样:

require ::File.join( ::File.dirname(__FILE__), 'app' )
run MyApp.new( auth: :ldap, snapshot:false, metadata: :remote_wiki, … )

如何根据config.ru提供的设置修改我的应用程序以更改其配置行为?或者这是对config.ru的滥用,试图将它用于完全错误的事情?

1 个答案:

答案 0 :(得分:1)

一旦我开始阅读这个问题,第一个回答我的问题就是“环境变量”,但你马上就把它弄清楚了:)

我将使用你的一个 cans 和所需的结果代码的混合物,因为它是我构建事物的方式......

因为我希望能够更轻松地测试我的应用程序,所以我将大部分Ruby从config.ru中取出并放入一个单独的config.rb文件中,并将config.ru作为引导程序文件。所以我的标准是:

config.ru

# encoding: UTF-8

require 'rubygems'
require 'bundler'
Bundler.setup

root = File.expand_path File.dirname(__FILE__)
require File.join( root , "./app/config.rb" )

# everything was moved into a separate module/file to make it easier to set up tests

map "/" do
  run APP_NAME.app
end

应用程序/ config.rb

# encoding: utf-8
require_relative File.expand_path(File.join File.dirname(__FILE__), "../lib/ext/warn.rb")

require_relative "./init.rb"  # config
require_relative "./main.rb"  # routes and helpers
require 'encrypted_cookie'

# standard cookie settings
COOKIE_SETTINGS = {
  :key => 'usr',
  :path => "/",
  :expire_after => 86400, # In seconds, 1 day
  :secret => ENV["LLAVE"],
  :httponly => true
}

module APP_NAME # overall name of the app

  require 'rack/ssl' # force SSL
  require 'rack/csrf'

  if ENV["RACK_ENV"] == "development"
    require 'pry'
    require 'pry-nav'
  end

  # from http://devcenter.heroku.com/articles/ruby#logging
  $stdout.sync = true

  ONE_MONTH = 60 * 60 * 24 * 30

  def self.app
    Rack::Builder.app do

      cookie_settings = COOKIE_SETTINGS
      # more security if in production
      cookie_settings.merge!( :secure => true ) if ENV["RACK_ENV"] == "production"

      # AES encryption of cookies
      use Rack::Session::EncryptedCookie, cookie_settings

      if ENV["RACK_ENV"] == "production"
        use Rack::SSL, :hsts => {:expires => ONE_MONTH}
      end

      # to stop XSS
      use Rack::Csrf, :raise => true unless ENV["RACK_ENV"] == "test"

      run App # the main Sinatra app
    end
  end # self.app

end # APP_NAME

我这样做的最初原因是可以轻松地在规格中运行应用程序:

shared_context "All routes" do
  include Rack::Test::Methods
  let(:app){ APP_NAME.app }
end

但是将这段代码与其他应用程序代码保持在一起是有道理的,可以这么说,因为我可以将各种东西捆绑在一起,运行其他应用程序等。我已经将它用于conditionally load different examples into the specs了几个项目(它有助于减少重复工作并检查示例真的有效),所以我不明白为什么你不能用它来有条件地加载配置。

这样你就可以选择在config.ru中使用条件来确定你将使用哪个config.rb文件,或者在config.rb中使用env var来确定self.app的定义使用,或将选项哈希传递给self.app ...

通过您的设置,我将APP_NAME模块重命名为MyApp,将Sinatra类重命名为App(因为我经常会有一个运行前端的网站和一个API,所以Sinatra类通过它们的函数(App,API等)命名并包装在以该站点命名的模块中,最后得到:

config.ru

map "/" do
  run MyApp.app( auth: :ldap, snapshot:false, metadata: :remote_wiki )
end

config.rb

def self.app( opts={} )
  opts = DEFAULT_OPTIONS.merge opts
  # …
  run App
end

看看其他人如何解决这个问题会很有趣。