2011年8月23日火曜日

Rails3を初歩から学ぶ #8 create(テスト編)

この一連のエントリは
Ruby on Rails 3 Tutorial: Learn Rails by Example (Addison-Wesley Professional Ruby Series)
で参考に学んだことを凝縮してお送りしています。


前回showアクションを実装しました。今回は後回しにしていたcreateアクションを実装しましょう。前々回説明したようにnewアクションで表示されるページでボタンをクリックするとcreateアクションに処理が渡ります。ここで渡されたパラメータを元にDBに新規ユーザーを登録します。登録に成功したら登録したユーザーのページ(/users/:id)に遷移します。
これをやりたかったので前回showアクション(/users/:idで呼ばれる)を先に実装しました。

というわけでテストから。

describe "POST 'create'" do
describe "登録させないケースの検証" do
before(:each) do
@attr = {:name => "", :password => "", :password_confirmation => "" }
end
it "ユーザーを登録しないこと" do
lambda do
post :create, :user => @attr
end.should_not change(User, :count)
end
it "新規登録ページに戻ること(タイトル検証)" do
post :create, :user => @attr
response.should have_selector("title", :content => "新規登録")
end

it "新規登録ページに戻ること(テンプレート検証)" do
post :create, :user => @attr
response.should render_template('new')
end
end #登録させないケースの検証
describe "登録に成功するケースの検証" do
before(:each) do
@attr = { :name => "Cli lin", :password => "foobar",
:password_confirmation => "foobar" }
end
it "DBに新規ユーザーを登録していること" do
lambda do
post :create, :user => @attr
end.should change(User, :count).by(1)
end
it "ユーザー情報ページに遷移していること" do
post :create, :user => @attr
response.should redirect_to(user_path(assigns(:user)))
end
it "登録に成功した旨をユーザーに表示していること" do
post :create, :user => @attr
flash[:success].should =~ /登録に成功しました/
end
end #登録に成功するケースの検証
end # POST 'create'
ちょっと長いです。登録に成功するケースと失敗するケースそれぞれで別階層にテストを記述しています(describe文)。
検証時に「lambda」を使用している箇所があります。これは要求を実行した結果、データベースがどうなったかを検証するために使用します。これまで要求に対するResponseを検証していましたが、データベースの結果については応答では判定できないためこのようにlambdaでくくってやって実行結果に対して検証するようにしています。
「change(User, :count)」はUserモデルのレコード数(:count)の変化有無を確認するメソッドです。1つ増加したことを検証する場合は「change(User, :count).by(1)」とします。削除確認のときは「-1」にしてやります。

登録失敗時は再度新規登録画面を表示するため「Erender_template('new')」としてnewテンプレート(= new.html.erb)に遷移することを確認しています。
また登録成功時には「redirect_to(user_path(assgins(:user)))」として新規に登録したユーザーのidから生成したURL、つまり「/users/1」などといったパスにリダイレクトすることを検証しています。
ここで出てくる「user_path」とは何でしょう。
もう一度「rake routes」としてルート定義を見てみましょう。


users GET /users(.:format) {:action=>"index", :controller=>"users"}
POST /users(.:format) {:action=>"create", :controller=>"users"}
new_user GET /users/new(.:format) {:action=>"new", :controller=>"users"}
edit_user GET /users/:id/edit(.:format) {:action=>"edit", :controller=>"users"}
user GET /users/:id(.:format) {:action=>"show", :controller=>"users"}
PUT /users/:id(.:format) {:action=>"update", :controller=>"users"}
DELETE /users/:id(.:format) {:action=>"destroy", :controller=>"users"}

注目するのは左端、各GETメソッドに対して「users」や「new_user」と定義されています。これらはコード中に「users_path」とすると「/users」に、「new_user_path」とすれば「/users/new」に変換されることを示しています。
ここで使用している「user_path」は「/users/:id」に該当しますが、「:id」が変数に当たるので「user_path」のパラメータとして渡してやります。つまり「user_path(1) 」とすると「/users/1」に変換されます。テストコードでは「assigns(:user)」としてコントローラのインスタンス変数@userのidを渡しているわけです。
整理するとここではユーザーを新規に登録し、「/users/登録ユーザーID」にリダイレクトすることを検証していることになります。

最後にflashについて。flashはアクションをまたいで一時的に情報を保持する機能です。
「登録成功しました」「パスワード間違ってます」なんて情報を遷移先のページに表示させるために使います。自分で一時変数を用意すると値を消し忘れて、特定の遷移ルートをたどった時のみ変なメッセージが出てくるんですけど!なんて問題になりかねませんが、Railsにおけるflashは自動で削除してくれるので心配ありません。
ここでは登録成功時に「flash[:success]」に成功した旨の情報を格納していることを検証しています。

コントローラの実装は次回。

2011年8月15日月曜日

Rails3を初歩から学ぶ #7 FactoryGirlを導入しよう

この一連のエントリは
Ruby on Rails 3 Tutorial: Learn Rails by Example (Addison-Wesley Professional Ruby Series)
で参考に学んだことを凝縮してお送りしています。



前回の予告通り、今回はUsersコントローラにshowアクションを定義します。
では例によってテストを書きましょう。
でも、待てよ、と。
showアクションは登録ユーザーの情報を表示するアクションですが検査時にその登録ユーザーはどうやって用意するんだ!?という問題があります。
もちろんUserオブジェクトを用意してDBに登録してやれば出来なくはないけれど、それってshowアクションの検査としてはあまり純粋じゃないし、不要なトラブルの元になりそうです。
こういうときにはテスト用のデータを用意するわけで、YAML形式でデータを用意するFixtureというものがRailsでは用意されています。
が、これはちょっと柔軟性に欠ける仕組みなのでRubyで試験データを用意できてしまうFactoryGirlなるものを導入してしまいましょう。
「Gemfile」に下記の赤字部分を追加します。

group :test do
  gem 'rspec'
  gem 'webrat'
  gem 'factory_girl_rails', '1.0'
end
バージョンを指定しないと最新版がインストールされますが、ここでは「1.0」を明示的に指定しています。最新版でも問題ないかもしれませんが、トラブったら1.0を指定してみましょう。
編集したら「bundle install」でインストールします。

インストールしたら「spec/factories.rb」というファイルを用意して以下のように編集します。

Factory.define :user do |user|
  user.name      "Son Gokuu"
  user.password  "foobar"
  user.password_confirmation  "foobar"
end
これでRSpecファイルから「Factory(:user)」とすれば名前が「Son Gokuu」でパスワードが「foobar」というユーザーがDBに登録済み、という状態になります。
早速つかってみましょう。

  describe "GET 'show'" do
    before(:each) do
      @user = Factory(:user)
    end
    it "should be successful" do
      get :show, :id => @user
      response.should be_success
    end
    it "正しいユーザーを表示していること" do
      get :show, :id => @user
      assigns(:user).should == @user
    end
    it "タイトルの検証" do
      get :show, :id => @user
      response.should have_selector("title", :content => @user.name)
    end
  end #GET 'show'
もうちょっとHTMLの中身を検査してもいいかもしれませんが、そこはお任せ。
とりあえず例題のshowアクションの検査としては上記のような感じになります。
beforeブロックは(eachを指定しているので)各検証コード(itブロック)を実行する前に毎回実行されます。ここで先ほど用意したFactoryGirlの機能を使ってテスト用のUserオブジェクトを取得しています。
RSpecでは1つの検証を終えるたびに環境をキレイにするので毎回DBへの登録が必要です。
また「assigns」メソッドはコントローラのインスタンス変数にアクセスするものです。
コントローラの@userがテストコードで生成した@userと一致することを確認しているわけです。
ではコントローラのshowアクションを用意しましょう。

  def show
    @user = User.find(params[:id])
    @title = @user.name
  end
ルート定義にあった「/users/:id」の「:id」に当たる部分を「params[:id]」で取得しています。Userテーブルに対して「Where id = X」で検索した結果を@userに格納している形になります。
さて次はviewを用意するんですが、「rails generate」でコントローラを生成するときにアクションまで指定していれば該当するviewファイルまで自動生成してくれます。が、今回のshowアクションは手動で追加しているのでviewファイルも手動で用意します。
「app/views/users/show.html.erb」を用意して以下のように編集します。
<h1><%= @user.name %></h1>
まあ、なんとも手抜きですが。。
ここまで出来たらテストを実行しましょう。全てパスするハズです。
ブラウザから動作確認する場合はDBが空なので(FactoryGirlはあくまでテスト環境のみで有効です)エラーになってしまいます。
「rails console」としてコンソールから無理矢理データをつくってしまいましょう。
※「rails console --sandbox」としないように。サンドボックス環境は終了時にロールバックされてしまいます
$rails console
>user = User.new(:name => "Son Gohan", :password => "foobar",
:password_confirmation => "foobar")
>user.save!
さあ、「rails server」でサーバーを起動したらブラウザから「http://localhost:3000/users/1」にアクセスしてみましょう。
デカデカと「Son Gohan」と出ていれば成功です。

2011年8月13日土曜日

Rails3を初歩から学ぶ #6 コントローラをつくろう

前回作成したコントローラ向けのテストをパスできるようにnewアクションを実装します。
app/controller/users_controller.rb を開いて以下のように編集します。

class UsersController < ApplicationController
  def new
    @user = User.new
    @title = "新規登録"
  end
end
@のついたインスタンス変数をViewで参照します。
ここでは空で生成したUserオブジェクトと 、タイトルを変数に格納しています。
次に対応したviewを編集するのですが、Railsでは「app/views/コントローラ名/アクション名.html.erb」が該当するviewとなります。
今回の例では「app/views/users/new.html.erb」がnewアクションに対応したviewとなります。
<%= form_for(@user) do |f| %>
    <%= f.label :name, "ユーザー名" %>
    <%= f.text_field :name %>
    <%= f.label :password, "パスワード" %>
    <%= f.password_field :password %>
    <%= f.label :password_confirmation, "パスワード(確認)" %>
    <%=f.password_field :password_confirmation %>
    <%=f.submit "新規登録" %>
<% end %>
form_forに渡している「@user」がコントローラで生成した@userです。
form_forからendまでのブロック内はそのuserオブジェクトのフィールドに対応づけられます。「 f.text_field :name」なんていう指定だけで、うまいこと設定されるのはこのようにRailsが対応付けしてくれているからなんですね。

ここでは一つ一つのdivにクラス指定していますが、CSS用です。
今回はデザイン面は放置するので使いませんが。
ここまででほぼテストは通りますが、まだタイトルがNGです。
タイトルを定義しましょう。
ここではWebアプリ全体で「FavMovie | XXXX」というタイトルを表示するものとします。「XXXX」の部分には「新規登録」「ユーザー情報編集」などアクションに応じたタイトルを設定します。

アクション共通で使用されるテンプレートは app/views/layout/application.html.erb です。この中に「<%= yield %>」となっている箇所がありますが、ここにアクションごとの個別のテンプレートが挿入されます。先ほどの例でいえば「new.html.erb」の内容がここに挿入されます。
titleは上のheader要素内にありますが、今回は動的にタイトルを変更したいので、ここでそのようなコードを入れると可読性が損なわれます。そこでヘルパメソッドとして定義しましょう。
app/helpers/application_helper.rb を開きます。

module ApplicationHelper
  def title
    base_title = "FavMovie"
    if @title.nil?
      base_title
    else
      #{base_title} | #{@title}
    end
  end
end

ここで見ている@titleがコントローラで設定されるものです。セットされていない場合は「FavMovie」とだけ表示します。
そして application.html.erb で呼び出してみましょう。
<title><%= title %></title>
これでテストは全てパスするようになります。
コンソールから「rails server」としてサーバを立ち上げて「http://localhost:3000/users/new」にアクセスしてみましょう。
3つのテキストボックスと1つのサブミットボタンがあることが確認できます。
ここでソースを確認してみるとform要素は以下のようになっています。
<form accept-charset="UTF-8" action="/users" class="new_user" id="new_user" method="post">
ここから「users」コントローラに対して「POST」で要求されることが読み取れます。
前回実行した「rake routes」の結果を再確認してみましょう。
POST   /users(.:format)          {:action=>"create", :controller=>"users"}
「/users」に対して「POST」要求がされた場合、usersコントローラのcreateアクションに処理が渡ることが示されています。
というわけで、お次はcreateアクションの実装、といきたいところですが、その前にshowアクションを実装することにします。ルート定義はこちら。


user GET    /users/:id(.:format)      {:action=>"show", :controller=>"users"}


「/users/1」などというパスでGETが要求されるとshowアクションが呼ばれます。
「:id」に当たる部分はUserテーブルのid(主キー)に該当します。
つまりリソース(ここではUserモデル)の1レコードに対する情報を表示するページとなります。
今回のUsersモデルの例でいえば各ユーザーの個人ページに当たるでしょう。
次回はこちらを作成してみることにします。



2011年8月11日木曜日

Rails3を初歩から学ぶ#5 ルートを定義しよう

ものすごくちゃんとしたRailsの日本語解説を見つけてしまった。
Ruby on Rails 3.0日記
一連のエントリの存在意義が、、、(あと20回くらい続く予定、、、)
まあ、自分自身の復習も兼ねているので続けますね。
=======================

前回モデルを実装しましたが、RailsではRESTfulなインターフェースに沿ってCRUD(create, read, update, delete)を実現する思想になっています。
HTTPメソッドの「GET」「POST」「PUT」「DELETE」を通じてリソースを操作します。
そこで前回作成したUserモデル用のインターフェースを定義しましょう。
config/route.rbを開きます。

Favmovie::Application.routes.draw do
  resources :users
end
赤字の行を追加します。
route.rbはルートを定義するファイルです。
ここの定義に従ってアクセスしてきた要求をどのコントローラのどのアクションに振り分けるかを決定します。
「resources」メソッドは指定したリソースに対するCRUD操作を自動で定義してくれる機能を提供しています。
ファイルを保存したら「rake routes」として定義されたルートを確認してみましょう。
たった1行でこれだけのルートが定義されます。
例えばHTTPのGETで「http://〜/users」にアクセスすると「usersコントローラ」の「index」アクションが呼ばれることが上図から分かります。
これらコントローラに対して対応するアクションを実装していくのが次の仕事です。
まずはコントローラの生成から始めましょう。
rails generate controller Users new
コントローラは対応するモデルの複数形が名前になります。ここでは「User」モデルに対応したコントローラであるため「Users」となります。
次のパラメータがコントローラに定義するアクションです。とりあえず今の段階では「new」アクションだけを用意します。
ちなみに先ほどの図から「new」アクションが呼ばれるのは「http://〜/users/new」に対してGETが要求されたときであることが分かります。
ちょっと試してみましょう。
rails server
としてサーバを起動します。
ブラウザを立ち上げてアドレス欄に「http://localhost:3000/users/new」と入力してアクセスすると「Users #new」とデカデカと表示されたページが表示されます。
これで正しくusersコントローラのnewアクションに処理が渡ったことが分かります。
ちなみにアクションを定義していないindexアクションにアクセスしてみましょう。
アドレス欄から「new」の部分を消してやればindexアクションです。
そうすると「Unknown action」と出て「The action 'index' could not be found for UsersController」というメッセージが表示されます。
これはUsersControllerにindexアクションは定義されていませんよ、ということを示しています。

ではこれからUsersControllerにnewアクションを実装していきます。
まずはテストコードから作成しますが、先ほどコントローラを生成したときにいくつか不要なテストファイルが出来ているので削除しておきます。
rm spec/helpers/users_helper_spec.rb
rm spec/views/users/new.html.erb_spec.rb
ヘルパはそれを利用するコントローラの検査で、ビューはインテグレーションテストで検証するので削除しておきます。この辺りは個人の好みで。
さて、コントローラのテストをつくりましょう。
spec/controller/users_controller_spec.rb を開きます。

# -*- coding: utf-8 -*-
require 'spec_helper'
describe UsersController do
  render_views
  describe "GET 'new'" do
    it "should be successful" do
      get 'new'
      response.should be_success
    end
    it "タイトルの検証" do
      get :new
      response.should have_selector("title", :content => "新規登録")
    end
    it "ユーザー名入力欄があること" do
      get :new
      response.should have_selector("input[name='user[name]'][type='text']")
    end
    it "パスワード入力欄があること" do
      get :new
      response.should have_selector("input[name='user[password]']
[type='password']")
    end
    it "パスワード確認欄があること" do
      get :new
      response.should    have_selector("input[name='user[password_confirmation]']
[type='password]']")
    end
  end #GET 'new'
end
newアクションはユーザーの新規登録のページを表示するアクションですので、ちゃんと新規登録ページを表示できているかの検証になります。
どこまで評価するかは色んな方針があると思いますが、見た目に関わる部分なのであまり細かく検証してしまうとデザインを変えるためびにNGになってメンドーなのでバランスを考えましょう。
ここではタイトルと最低限の入力項目が存在することのみ検証しています。
2行目にある「render_views」を忘れないでください。
これがないとviewを描画しないので必ずエラーになります。どう考えても検査をパスするハズなのになぁ、と悩んだら確認してみましょう。

次回はこの検証コードがパスできるようにコントローラを実装します。

2011年8月9日火曜日

新たにMac book Air を買ったとき、開発環境はどうなるか?

買ってしまいました、Mac book Air。
その素晴らしさは、まあ置いておいて、新たにマシンを購入したときにiPhoneアプリ開発のために用意した各種証明書やプロビジョニングをどうしたらいいのか、という点が心配な方は多いんじゃないでしょうか。
キーチェインからエクスポートして、再度iTunesConnectからダウンロードして、うんぬんかんぬん、そういった面倒な手続きがあって、、、、

なんて考えていたとしたら大間違い。

1)旧マシンを外付けHDDでタイムマシーンを使ってバックアップ
2)新マシン起動時にそのHDDを指定する
3)旧マシンと同じ環境が出来上がり

いきなり開発できます。
AppStoreへの公開も同じ。
Lion素晴らしい。

外付けHDDを使ってなくてもHDDの代わりに旧マシンを指定してやれば同じことが出来ます。


2011年8月8日月曜日

Rails3を初歩から学ぶ#4 モデル向けのテストをつくる

前々回Userモデルを作成したので、このモデルにバリデーションを追加しましょう。
Userモデルで必要な必要な検証を下表に示します。
idinteger-
namestring必須、一意,50文字以内
★passwordstring必須,6文字以上40文字以内
encrypted_passwordstring
saltstring-
adminboolean-
created_atdatetime-
updated_atdatetime-
★印をつけた「password」だけは例外で実際のデータベースには格納しません。passwordを元に暗号化した値を「encrypted_password」としてDBに格納します。
ただしUserオブジェクト生成時では必須なので必須指定としています。
この辺りの事情は前回の解説をみてください。

というわけでまずはこの「name」と「password」に対する検証がちゃんと動作しているかを確認するテストコードを作成します。
モデル生成時に「spec/model/user_spec.rb」というファイルが出来ているのでこれを日以下のように編集します。

# -*- coding: utf-8 -*-
require 'spec_helper'
describe User do
  before(:each) do
    @attr = {
      :name => "hogetarou",
      :password => "foobar",
      :password_confirmation => "foobar",
    }
  end
  it "名前がないと検証NGであること" do
    user = User.new(@attr.merge(:name => ""))
    user.should_not be_valid
  end
  it "名前が50文字を超えると検証NGであること" do
    long_name = "a"* 51
    user = User.new(@attr.merge(:name => long_name))
    user.should_not be_valid
  end
  it "パスワードがないと検証NGであること" do
    user = User.new(@attr.merge(:password => "", :password_confirmation => ""))
    user.should_not be_valid
  end
  it "パスワードと確認用が一致しないと検証NGであること" do
    user = User.new(@attr.merge(:password_confirmation => "invalid"))
    user.should_not be_valid
  end
  it "パスワードが6文字未満だと検証NGであること" do
    short = "a" * 5
    user = User.new(@attr.merge(:password => short, :password_confirmation => short))
    user.should_not be_valid
  end
  it "パスワードが41文字以上だと検証NGであること" do
    long = "a" * 41
    user = User.new(@attr.merge(:password => long, :password_confirmation => long))
    user.should_not be_valid
  end
  it "全て満たしたとき検証OKであること" do
    user = User.new(@attr)
    user.should be_valid
  end
  it "ユーザー名が重複したらダメ" do
    User.create!(@attr)
    user = User.new(@attr)
    user.should_not be_valid
  end
end
最初の「before」で正しいデータを用意しておいて、各検証コードで「merge」メソッドを使って検証対象のフィールドをいじりながら検証しています。
rspec spec/user_spec.rb
と実行すると全てNGで返ってきます。
ちなみに「:password_confirmationなんて無いぞ!」というエラーばかりだと思います。
今はこれでOK。
ではモデルの方を作ってみましょう。
「app/model/user.rb」を以下のように編集します。

class User < ActiveRecord::Base
  attr_accessor  :password
  attr_accessible :name, :password, :password_confirmation
  validates :name, :presence => true, :uniqueness => true, :length => { :maximum => 50 }
  validates :password, :presence => true, :confirmation => true, :length => { :within => 6..40}
end
まず1行目の「attr_accessor」ですが、これはRailsではなくRubyの仕様で、渡したパラメータのgetterとsetterを生成してくれるメソッドです。
モデル生成時に指定したフィールドはActiveModelが自動で生成してくれますが、passwordフィールドは生成していません(何度も言いますがDBに格納するのは暗号化した「encrypted_password」です)。なのでここでpasswordというフィールドを定義しているわけです。

次のattr_accessibleは指定した以外のフィールドを保護するメソッドです。
例えば前々回作成したモデルには管理者を示す「admin」フィールドが存在しますが、ユーザーインターフェース上に「admin」を示す入力項目が無かったとしても、悪意あるユーザーがPOSTメソッドで「admin=true」としたパラメータを送りつけて来た場合に、無条件に「update_attributes」メソッドなどでUserオブジェクトを更新してしまうと、そのユーザーに管理者権限を与えてしまうことになります。
attr_accessibleではコンストラクタや「update_attributes」メソッドで更新可能なフィールドを指定し、指定されなかったフィールドについては更新を許可しません。
ちょっと確認してみましょう。
「rails console --sandbox」としてコンソールを起動してみます。
rails console --sandbox

>> user = User.new(:name => "hogehoge", :password => "foobar", :password_confirmation => "foobar", :admin => true)
=> #
このように「:admin => true」と指定しているのに結果は「admin: false」となっていることからちゃんと保護されていることが分かります。
「attr_accessible」と似たものに「attr_protected」があり、こちらは逆に指定したフィールドだけを保護するメソッドです。
長期的にはフィールドが増加したときに「指定し忘れ」が起きてしまうことを考えると「attr_accessible」にしておいた方が安全でしょう。

以降は「validates」メソッドで必要な検証を定義しています。
「password」に対して「:confirmation => true」としています。
こうすることで「password_confirmation」というフィールドが自動で付加されて、「password」と一致していることをチェックしてくれます。

さて、user.rbを保存したらもう一度RSpecを実行してみましょう。
今度は全て成功するハズです。

2011年8月7日日曜日

Rails3を初歩から学ぶ#3 passwordについて

この一連のエントリは
Ruby on Rails 3 Tutorial: Learn Rails by Example (Addison-Wesley Professional Ruby Series)
で参考に学んだことを凝縮してお送りしています。



前回作成したUserモデルに「encrypted_password」と「salt」というものを追加していますが、どのような認証のシーケンスをたどるのか、あらかじめここで考えておきます。
Userクラスにはユーザーから渡されたパスワードを保持する「password」フィールドを定義します。これは前回生成した「encrypted__password」とは別モノです。
データベース上に格納するのはあくまで暗号化した情報である「encrypted_password」です。

Userモデルでは「password」を受け取るとこれを暗号化して「encrypted_password」としてデータベースに格納します。
このとき単純にハッシュをかけて暗号化するだけではセキュリティ上危険なので毎回異なる値をパスワードに付加してハッシュするようにします。この「毎回異なる値」が「salt」です。
なのでまとめると、「ユーザー入力」->「passwordフィールド」->「salt生成」
->「salt+passwordでハッシュ算出」->「encrypted_password」として格納、となります。

また一般的なWebサービスでの新規登録時にはパスワードを二回入力することが求められることが多いです。Railsでは「password」というフィールドに対して「:confirmation=>true」と指定することで「password_confirmation」というフィールドが自動で追加されます。
そして「password」と「password_confirmation」が一致しないと自動的にエラーを返すようになります。

この辺りの事情を頭に入れて、次回からUserモデルを実装していきます。