irohiroki's blog

Ruby, Rails, and Web technologies

Quick link to a sample app.

Autotestはテスト駆動開発において欠かせないツールです。しかし、特にRuby 1.9ではRspecの起動の遅く、イライラしている人も多いでしょう。

Rspecの起動を早くするツールにSporkがありますが、以下のような問題があります:

  • 製品コードを更新してもリロードしてくれない(ぇ
  • ruby-debugが使えない

このエントリではこれらの問題を解決していきます。目指すのは次のような環境です:

  • appの下はもちろん、configの下を更新した場合もリロードしてテストしてくれる
  • 製品コードでもテストコードでも、debuggerと書いたらruby-debugが使える

Spork

まずはベースの環境から作りましょう。なお、ここで使うのはMac上のRails 3.0.3とRuby 1.9.2です。

gem install rails
rails new my_app

最初にRSpecとautotest、sporkを入れるために、Gemfileに以下の行を加えます。

gem 'rspec-rails'
gem 'autotest-rails'
gem 'spork'

Gemfileを編集したらbundleしておきます。

bundle

RSpecをインストールします:

rails g rspec:install

Sporkに必要な準備をします:

spork --bootstrap

ここで、表示される指示に従ってspec/spec_helper.rbを編集します。下のようにしておけばよいでしょう。

require 'rubygems'
require 'spork'

Spork.prefork do
  ENV["RAILS_ENV"] ||= 'test'
  require File.expand_path("../../config/environment", __FILE__)
  require 'rspec/rails'

  Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}

  RSpec.configure do |config|
    config.mock_with :rspec
    config.fixture_path = "#{::Rails.root}/spec/fixtures"
    config.use_transactional_fixtures = true
  end
end

Spork.each_run do
end

またSporkを有効にするため、rspec:installによって生成された.rspecファイルに--drbを加えておきます。

--color --drb

これで素のAutotestとSporkの環境はできました。適当なコードをscaffoldして試してみてもいいでしょう。

rails g scaffold user name:string
rake db:migrate RAILS_ENV=test

sporkを起動し、別のターミナルでautotestも実行します。

spork
autotest

さらに別のターミナルでテストコードを失敗するように修正するとすぐさまautotestが赤くなります。しかし、製品コードを壊した場合、テストは走りますが緑のままです。

リロードさせる

製品コードのリロードは、実は次の2つの問題に分けられます。

  1. app下のファイルを修正した時
  2. それ以外

1はRuby on Rails Tutorial: Learn Rails by Example | Ruby on Rails 3 Tutorial book and screencasts | Static Pagesに回避方法が載っています。まず下のようにspec/spec_helper.rbのRSpec.configureのブロックに1行加えます。

diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
index 9fd4d4a..0d793e4 100644
--- a/spec/spec_helper.rb
+++ b/spec/spec_helper.rb
@@ -12,6 +12,8 @@ Spork.prefork do
     config.mock_with :rspec
     config.fixture_path = "#{::Rails.root}/spec/fixtures"
     config.use_transactional_fixtures = true
+
+    ActiveSupport::Dependencies.clear
   end
 end
 

そしてconfig/application.rbも下のように修正します:

diff --git a/config/application.rb b/config/application.rb
index 590b85c..02b3ca4 100644
--- a/config/application.rb
+++ b/config/application.rb
@@ -38,5 +38,13 @@ module MyApp
 
     # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]
+
+    ### Part of a Spork hack. See http://bit.ly/arY19y
+    if Rails.env.test?
+      initializer :after => :initialize_dependency_mechanism do
+        # Work around initializer in railties/lib/rails/application/bootstrap.rb
+        ActiveSupport::Dependencies.mechanism = :load
+      end
+    end
   end
 end

これでapp以下を修正した場合でもリロードしてテストしてくれます。

app以外、例えばconfig/application.rbやconfig/initializersの中は、rspecの起動を速くするためにプリロードしているので、sporkの再起動で解決します。これを自動的にやってくれるのがguard-sporkです。まずguard-sporkとFSEvent APIのRubyバインディングであるrb-fseventをインストールします。ただしここで使うguard-sporkは、後述するruby-debugのために私が改造したものです。

gem 'guard-spork', :git => 'https://github.com/irohiroki/guard-spork.git'
gem 'rb-fsevent'

加えたらbundleしてguard-sporkの初期化をします。

bundle
bundle exec guard init spork

そしてguardを起動。

bundle exec guard start

sporkはguardが起動してくれます。config/application.rbなどを更新するとguardがsporkを再起動します。

ところでguardが監視してくれるファイルの中にはconfig/routes.rbがないのですが、これは下の修正をすることでテストに反映できるようになります。

diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
index 6f6a223..cffc9f5 100644
--- a/spec/spec_helper.rb
+++ b/spec/spec_helper.rb
@@ -19,4 +19,5 @@ Spork.prefork do
 end
 
 Spork.each_run do
+  MyApp::Application.reload_routes!
 end

ruby-debugを使う

この時点では、rdebugを起動してコードの中にdebuggerと書いても止まってくれません。なぜなら、実際のテストはDRbサーバであるsporkで動いているからです(たぶん)。

この問題に対して、sporkの作者のTim Harper氏がrdebugのセッションをフォワードするプロキシを書いてくれました。これを使うと、debuggerが現れたときにsporkのターミナルにrdebugのプロンプトが出ます(autotestのターミナルではない)。ただし、一箇所RuntimeErrorが出るところがあるので、ここでは私の修正版を使います。まずcurlなどでプロキシモジュールをspecディレクトリに入れます。

curl https://gist.github.com/raw/814375/ccbe163559376e109e30574b1086a32fb626e374/spork-ruby-debug.rb > spec/spork-ruby-debug.rb

そしてそれをspec/spec_helper.rbからrequireします。

diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
index 0d793e4..6f6a223 100644
--- a/spec/spec_helper.rb
+++ b/spec/spec_helper.rb
@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'spork'
+require File.expand_path("../spork-ruby-debug", __FILE__)
 
 Spork.prefork do
   ENV["RAILS_ENV"] ||= 'test'

もちろんruby-debugもインストールしておきましょう。Gemfileに下の行を加えてbundleします。

gem 'ruby-debug19'
bundle

これで完成です。bundle execを付けるのを忘れずにguardを起動してください。

bundle exec guard start

実はオリジナルのguard-sporkだとsporkのプロセスがbackgroundへ回されてしまってrdebugのプロンプトが取れないのですが、そこは私の修正版で回避してあります。

以上の手順で作った環境をgithubに置きましたのでよろしければ参考にしてください。

Published on 08/02/2011 at 05h16 under . Tags ,

Rails 3ではroutesのDSLが完全に刷新されました。特に、あの見難かったハッシュの塊が解かれて、:member:getなど予約語の役割をしていたシンボルはディレクティブになりました。例えばRails 2の以下の記述は

map.resources :users, :member => {:foo => :get}, :collection => {:bar => :post}

Rails 3では下のように書けます:

resources :users do
  member do
    get :foo
  end

  collection do
    post :bar
  end
end

このように、Rails 2では"予約語"がキーになったり(:member:collection)値になったり(:get:post)していたものが、Rails 3ではディレクティブになり、ユーザの与える値がシンボルとして残りました。

また、ActionController::Routing::RouteSet::Mapperインスタンスであるmapが必要なくなっています。

このエントリでは、8月21日のRails勉強会@東京第54回@a_matsudaさんに教えていただいたことをベースに、Rails 3のroutesについてまとめます。

基本

URLのパターンに対し、コントローラとアクションを指定する方法は、Rails 2では

map.connect 'friends/:id', :controller => 'users', :action => 'show'

でしたが、Rails 3では

match 'friends/:id', :to => 'users#show'

になります。mapが不要になったことと、コントローラとアクションを1つの値で指定できることで簡潔になっていますね。

逆に、オプションのパラメータは()で囲む必要があります。例えば、デフォルトルートは下のように定義されます。

match '/:controller(/:action(/:id))'

名前付き(Named)

Rails 2では下の.friendのようにMapperインスタンスへ送るメッセージがルート名になったのですが

map.friend 'friends/:id', :controller => 'users', :action => 'show'

Rails 3では基本のmatchディレクティブに:asを付けます。

match 'friends/:id', :to => 'users#show', :as => 'friend'

root

root、つまり「/」に対するrouteは、Rails 2ではmap.rootというnamed routeが「/」に予約されていましたが、Rails 3ではrootというディレクティブを使います。例えば下のようになります:

root :to => 'home#show'

基本の省略形

基本のmatchディレクティブでは、実は:toを省略できます。つまり、下の2つは同じことです。

match 'friends/:id', :to => 'users#show'
match 'friends/:id' => 'users#show'

さらに、パスのノード名がコントローラ名とアクションに一致するなら、それも省略可能です。よって下の2つは同じです。

match 'users/summary' => 'users#summary'
match 'users/summary'

特定のコントローラに対するルートは、controllerディレクティブでまとめることができます:

controller :users do
  match 'summary', :to => :short
  match 'pretty', :to => :pp
end

resources

RESTfulなルートを定義するのに便利だったmap.resourcesですが、Rails 3でもresourcesとして使用可能です。例を挙げます:

resources :users

さらに、複数のリソースを渡せるようになりました:

resources :users, :products, :shops

resourcesはブロックを受け取り、その中で冒頭で紹介したmembergetといったディレクティブを使用できます。

resourcesをネストした場合は、Rail 2と同様、has_manyの関係を定義できます。

resources :users do
  resources :items
end

# user.rb
class User < ActiveRecord::Base
  has_many :items
end

:only:exceptといったオプションを与えて生成するルートを絞ることや、:constraintsオプションで受け付けるパラメータのパターンを制限するのもRails 2と同じです。

namespace

namespaceディレクティブを使うことで、パス(URL)とコントローラを任意の名前空間に入れることができます。例えば下のように書くことで、パスは/admin/users、コントローラはapp/controllers/admin/users_controller.rbに置かれたAdmin::UsersControllerになります。

namespace "admin" do
  resources :users
end

もしパスだけに名前空間をつけてコントローラはapp/controllersに入れたければ、scopeを使います:

scope "/admin" do
  resources :users
end

反対に、コントローラにだけ名前空間を付けたければ、scope :module => を使います:

scope :module => "admin" do
  resources :users
end

Rackアプリケーションへルート

Rails 3ではルーティングの機構自体がRackミドルウェアなので、別のRackアプリケーションを呼び出すようなルートも書けるようになりました。例えば:toの先にSinatra::Baseの子クラスを書くことができます。また、redirectというメソッドを使ってリダイレクトを指定することもできます:

match "/users/:id", :to => redirect("/accounts/%{id}")

参考

講師をしてくださった松田さんがRails 3の特集を書かれました。

WEB+DB PRESS Vol.58
WEB+DB PRESS Vol.58
  • 発売元: 技術評論社
  • 価格: ¥ 1,554
  • 発売日: 2010/08/24

Published on 29/08/2010 at 02h15 under . Tags ,

Powered by Typo – Thème Frédéric de Villamil | Photo L. Lemos