能楽堂

64ビットWindows用のRails環境NougakuDo（能楽堂）を作ったのでリリースします。私が配布しているASRやRuby-1.9.2でRailsを利用するのであれば、こちらを利用した方が、あらゆる点（インストールの簡便さ、実行速度、利用可能なメモリ量＝スレッド数）でお得です。
特に、Windowsの特徴であるHttp.sysの機能を相当引き出しているつもりなので、Windows用実行環境としては、マルチプロセスでの実行の簡単さや、速度面では最も優れていると思います。

特徴

能楽堂には以下の特徴があります。

• Ruby 1.9.3 をVisual Studio 2010 X64 でビルド。
• あらかじめ、Rails 3.x を同梱。
• libyaml, gzip などは64ビットライブラリを同梱
• ruby-sqlite3 はX64用にビルドしたsqlite3と静的にリンク （testスクリプトの実行しか確認していません）
• 超高速なWebサーバ Ennou（https://github.com/arton/ennou）を同梱（後述）
• マルチプロセスサーバを簡単に起動するためのローンチャ（NougakuDo）を同梱
• ライセンスは、Ennouを除きRubyに合わせて第3条項抜きのBSDLとします。
  また、同梱のGemやDLLはそれぞれのライセンスに従います。なお、能楽堂関係の画像はWikipediaのpublic domainのものです。
• 能楽堂 1.0.2からmsvcrt100.dllを同梱しました。
• 能楽堂 1.0.2からactiverecord/sqlserver/adapter (tiny_tds(VC10 X64))を同梱しました。
• 能楽堂 1.1.8からwaz-storageを同梱しました。
• 能楽堂 1.3.2からRMagickを同梱しました。
• 能楽堂 1.3.3からgroongaとrroonga gemを同梱しました。

つまり、WindowsでのRailsの開発、WindowsとWindows Azureでの実行を1つのパッケージでまかなうことを目的とした簡単導入ツールです。

サポートプラットフォーム

条件は、X64版Windowsであることと、HTTP API 2.0をサポートしていることです。

• Windows 7 （X64）： テストは、この環境（SP1）で、行っています。
• Windows Server 2008 R2

Ennou（演能）

Ennouは、WindowsのHTTP.SYSを利用することで、複数のプロセスに同一HTTPポートを割り当てることと、HTTPのプロトコル処理をサービスに実行させることで、複数プロセスへのリクエスト割り当てによる並行性の向上と、プロトコル解析のオーバーヘッドの低減を狙ったRack用Webサーバ（HTTP.SYSラッパー）です。

どのくらい高速かというと、1プロセスでWEBrickの20倍以上、3プロセスで50倍程度です。単なるindex.htmlの応答であればRailsを通しても秒あたり1プロセスで600リクエスト程度は処理しました（このへんはネットワークの太さやマシンスペックに依存するので目安ということで）。ただし、各プロセス、最初のリクエストはRailsの初期化が走るからだと思いますが、普通に時間がかかります。

本プログラムは、LGPLなので、再配布などは完全に自由ですが、ソースを修正した場合は公開してください。

インストール方法

インストールは、http://www.artonx.org/data/nougakudo/から、NougakuDo のリンクを利用してダウンロード、実行してください。

実行すると、選択項目はなく、「Next」のクリックで終了します。

インストール先

インストーラは自動的にユーザのRoamingディレクトリへインストールします。

このディレクトリは通常、\Users\ユーザ名\AppData\Roamingです。ユーザ自身の所有ディレクトリなので、ユーザは書き込み権限を持ちます。このため、Gemを利用したインストールなどは問題なく実行できます。

ただし、うかつにファイルを削除するとMSIの監視機能により再インストールが走るので注意してください。

使い方

インストールすると、スタートメニューに、以下の3つのアイコンが登録されます。

• Prompt − RubyへPATHを通して、Roamingディレクトリを開きます。
  RailsアプリケーションはRoamingディレクトリへ作成するのが良いでしょう。
• irb − irbです。
• NougakuDo − Railsアプリケーションを起動するツールです。

NougakuDoの使い方

NougakuDoアイコンを実行すると、最初に管理者権限への昇格を求められます。

これは、HTTP.SYSを利用するのに管理者権限が必要だからです（※）。

• ※）管理者権限ということで、何をしているか気になるようでしたら、roaming\nougakudo\binのnougakudo.htaを読んでください。HTML＋Rubyの小さなプログラムなので実行内容は明解だと思います。
• 管理者権限を不要化し、現在のユーザーで実行するには、利用するURIを事前に登録してください。
• URIを登録するには、コマンドプロンプトから管理者権限で以下のコマンドを実行します。
• netsh http add urlacl url=http://{仮想ホスト名 | +}:80/{ディレクトリ名} user={グループ名|ユーザ名|ドメイン\ユーザ名}

次に、HTMLアプリケーションが動き出します。「select your config.ru:」に対して、RailsアプリケーションのRack設定ファイル（通常、config.ru）を指定してください。

Rack設定ファイルが選択されると、NougakuDoは指定されたファイルを読み込んでアプリケーション名などの実行に必要な情報を取得します。

NougakuDoは情報を確認すると、次に実行に必要なパラメータをリスト表示します。

Railsアプリケーションを起動するには、デバッグの有無などのオプションやプロセス数を設定してから、Launchボタンをクリックします。

なお、アプリケーションのURIは、http://ホスト名:80/アプリケーション名/ となります。

能楽堂は、仮想ホスト名ではなく、トップディレクトリでアプリケーションを分けることを本則とします。このとき、アプリケーション名には、Railsコマンドで作成したアプリケーション名が利用されます。これは、Config.ruのrunコマンドから読み取ります。

Launchボタンをクリックして起動に成功すると、黒いコマンドプロンプトが表示されます。

NougakuDoから実行したRailsアプリケーションは、1プロセスの場合も、複数プロセスの場合も、1つのコンソールを共用します。

アプリケーションを終了するには、Ctrl-Cを打ち込んでください。

なお、同時に同一アプリケーションを複数起動することはできません。HTTP.SYSによってURI競合としてエラーとなります。

異なるアプリケーションを起動することは可能ですが、能楽堂 1.0.x ではサポートしていません。この機能は、1.1以降でサポートする予定です。

Save Configボタンをクリックすると、configを選択したすべてのアプリケーションディレクトリのconfig.ruを設定内容で更新します。また、「アプリケーション名.bat」というファイルをアプリケーションディレクトリへ生成します。このバッチファイルは、Promptからの起動用です。

能楽堂を利用しない実行

NougakuDoを利用せずに、演能をWebサーバとしてRailsアプリケーションを実行するには、スタートメニューでPromptを右クリックしてコンテキストメニューを表示し、『管理者として実行』を選択して管理者権限で実行してください。WEBrickを利用する場合は管理者権限は不要です。

次に、開いたコマンドプロンプトで、 rackupを利用します。

最初にcdコマンドを利用してアプリケーションのルートディレクトリへ入り、次に、rackupを実行します。

この時、 演能を利用する場合は、

• rackup -s Ennou # シングルプロセス
• rackup -s Ennoumu # マルチプロセス

と入力します。

マルチプロセスの場合、プロセス数の指定はconfig.ruで行います。

指定方法は、config.ruのrunメソッド呼び出しの直前の行で、

require 'rack/handler/ennoumu'
Rack::Handler::Ennoumu.config :nprocs => 4 # 既定は2 。この例では4

のようにEnnoumu（マルチプロセス版演能のクラス名です）のconfigメソッドにハッシュで与えます。

なお、能楽堂のSave Configを実行することで、上記を自動化したアプリケーション起動用バッチファイルを生成します。これを利用する場合は、Promptを起動して「アプリケーション名\アプリケーション名」を実行してください。

tiny_tdsの利用方法

SQLServer Expressをインストールしている場合は、以下の手順でSQLServer Expressをデータベースとして利用できます。

rails new appでプロジェクトを生成したら、その状態でtds_setup appをコマンドプロンプトで実行します。これでsqlserver-adapterを利用するための準備ができるため、後はconfig/database.ymlのユーザ名やデータベース名などを修正するだけです。

tds_setupコマンドは以下の処理を実行するバッチファイルです。

• アプリケーションのルートディレクトリのGemfileに、次の行を挿入します。
  gem 'activerecord-sqlserver-adapter'
  場所はどこでも構いませんが、既定で設定されるgem 'sqlite3'の置き換えが良いでしょう。
• 次にconfig/database.ymlにデータベースの設定を記述します。以下にSQLServer ExpressをWindows認証でインストールした場合の例を示します。

  development:
    adapter: sqlserver
    username: コンピュータ名\ユーザ名
    password: ユーザのパスワード
    dataserver: localhost\SQLEXPRESS
    database: データベース名
    pool: 5
    timeout: 5000
       

• SQL Azureを利用する場合は、database.ymlに、azure: trueを設定してください（未テスト）。

SQL Server(Standard Edition以上)を利用する場合は、幾つかの考慮点があります。

• rake db:createを利用したデータベースの作成はできません(TinyTDS Tenderfootでも「At this time you must manually create a database and assign permissions for a user to connect to that database」とされています）。)。
• デフォルトインスタンスと接続する場合のdatabase.ymlの記述例を以下に示します。SQLExpressと異なり、dataserverにインスタンス名を記述しません（既定のポート：1344の場合）。また、データベース（databaseで指定するもの）とユーザはあらかじめSQL Server Management Studioなどを利用して作成しておいてください。このとき、ユーザは該当データベースのOWNERとして設定します。なお、Windows認証ではなくSQL Server認証を利用する場合は、usernameの「コンピュータ名\」は付けません。

  development:
    adapter: sqlserver
    username: コンピュータ名\ユーザ名
    password: ユーザのパスワード
    dataserver: データベースサーバのコンピュータ名
    database: データベース名
    pool: 5
    timeout: 5000
       

• デフォルトインスタンス以外のデータベースを利用する場合は、dataserverに「サーバ名\インスタンス名」と記述します。このとき、データベースサーバでSQL Server Browserサービスを実行してください。TDSはインスタンスが利用する接続先ポート番号をSQL Server Browser経由で取得するからです。

assetのpath設定について

演能は、仮想ホストではなくディレクトリによってアプリケーションを分離します。それに対してRailsは仮想ホストによるアプリケーション分離を前提としているため、既定で作成するcssやJavaScriptのパスは/から始まります。

このため、もしホスト上で実行しているすべてのアプリケーションのCSSやJavaScriptが共通であれば、IISの仮想ディレクトリとして/javascriptsや/stylesheetsを用意することで、これらのアセットをRailsの介在なしに処理できます。

そうではなく、アセットをアプリケーション単位に提供したい場合には、

1. 能楽堂 1.1.xでは自動的にconfig/environment.rbの先頭にRAILS_RELATIVE_URL_ROOTを設定します。これにより、サブディレクトリモードと仮想ホストモードで設定を変更しなくても利用できます。

   重要!: productionモードでアセットを演能に処理させるには、
   config/environments/production.rbのconfig.serve_static_assetsをtrueに設定してください。
   既定ではこの変数はfalseに設定されています。

2. 能楽堂 1.0.xでは以下のようにconfig/application.rbで、アプリケーション名(演能が認識しているURIのディレクトリ名)をアセットのURIに追加してください。

       config.action_controller.asset_path = '/アプリケーション名/%s'
     

   このように設定することで、Railsが生成するアセットのURIは/アプリケーション名/javascripts/rails.jsなどのアプリケーション名が先頭に付加された形式となります。これによってアセットも演能によって処理されるようになります。

能楽堂 1.1.8以降(Rails 3.1.1)のassets:precompileについて

Rails 3.1.1が利用するJavaScriptコンパイラのuglifier-1.0.4とJScriptの組み合わせは、rake assets:precompileでTypeErrorが発生します。これを避けるには次のいずれかを利用してください。

1. config/environemnts/production.rbで、JavaScriptの圧縮指定を解除。
   config.assets.compress = falseを設定する(既定はtrue)。
2. uglifierのかわりにclosure-compilerを利用。
   能楽堂にはあらかじめclosure-compilerと、設定をuglifierからclosure-compilerへ変更するuse_closureコマンドを用意してあります。
   なおclosure-compilerを利用するにはPATHにJavaが登録されている必要があります。
   use_closureコマンドを実行すると、引数で指定したディレクトリのGemfileおよびconfig/environments/production.rbに必要な設定を行います。

問題点（あるいは制限事項）

WebアプリケーションがGVLを解除せずに同期的に外部リソース（RDBなど）を呼び出すスレッドが存在するとそのプロセスは止まります。

このような外部リソースを利用するアプリケーションはプロセス数を増やして実行してください。

その他

Ennouに関する質問や要望、バグ報告については https://github.com/arton/ennouのIssuesを利用してください。

その他のことについては、rails ML(rails@ruby.ml.fdiary.net)で質問してください。能楽堂に対する質問のつもり でも、実際はRailsについての質問という可能性があるからです。また、1人が持つ疑問は30人が持つものです。できるだけ知識を共有するためにも、MLを利用してください。

参考書

WEB+DB PRESS Vol.58(編/WEB+DB PRESS編集部)

Rails3はまずここから。

読みやすく利用しやすい達人出版会の電子書籍もどうぞ!
達人出版会の「はじめる! Rails3 (1)」
達人出版会の「はじめる! Rails3 (2)」