Ruby/Ruby on Rails/step by step
Ruby on Railsで繰り返し操作して覚えたい事柄をstepとして整理しました。
- step01 InstantRailsの起動とirb
- step02 プロジェクトの新規作成
- step03 Mongrel webサーバの起動
- step04 Aptana Studio RadRails
- step05 データベース設定
- step06 データベース作成
- step07 migrationによるテーブル作成
- step08 scaffoldによりモデルおよびモデルにアクセスする足場のページを作成
- step09 モデルへの検証処理追加
- step10 月選択のフォームを英語から数字に変更
- step11 インストールされたgemのAPIドキュメント参照
- step12 Ruby-GetTextのインストール
- step13 Ruby-GetTextを利用するようプロジェクトに設定
- step14 Ruby-GetTextを利用して日本語化
- step15 テスト駆動開発(TDD, Test Driven Development)の準備
- step16 ユニットテスト（省略）
- step17 ファンクショナルテスト（省略）
- step18 ビュー書き換え例：入力した内容が'http://'で始まるときにリンクとし、日付yyyy-mm-dd hh:mmに変更
- step19 モデル追加例: 添付ファイルを表すAttachmentモデルを追加します。
- step20 添付ファイルのアップロード
- step21 添付ファイル表示部分を追加
step01 InstantRailsの起動とirb
C:\InstantRails\InstantRails.exeをダブルクリックして起動します。
DOSプロンプト画面を開き、irbで操作してみます。
[Iのアイコン] - [Rails Applications] - [Open Ruby Console Window]
各コマンドの意味
| コマンド | 動作 |
| cmd /f:o | ctrl+fでのファイル名補完を有効とします |
| ruby -v | rubyのバージョンを表示します |
| irb -ribr/completion | 補完機能有りでirbを起動します |
| pu[tab] | 途中でtabキーを押すと補完が効きます |
| puts "Hello World!" | ruby文を打つとすぐに実行されます |
| exit | irbを終了します |
よく使う操作をrails_apps直下のバッチファイルにしました。
| バッチファイル名 | 内容 |
| setenv.bat | cmd /f:o |
| irb.bat | C:\InstantRails\ruby\bin\irb -rirb/completion |
step02 プロジェクトの新規作成
- InstantRailsからDOSプロンプトを開く
カレントフォルダはC:\InstantRails\rails_appsとなります。 - 「rails プロジェクト名」でプロジェクトを新規作成
- 「cd プロジェクト名」でプロジェクトフォルダに移動
以降の操作はプロジェクトフォルダで行います。
step03 Mongrel webサーバの起動
- プロジェクトフォルダでruby script\serverを実行してMongrel webサーバを起動
ctrl+cキーで中断できます。 - http://127.0.0.1:3000/をブラウザで開くと、プロジェクトのWebページが見られます。
step04 Aptana Studio RadRails
UTF-8に初期設定
- Aptana Studioを起動
- 文字コードをUTF-8に初期設定
[Window] - [Preferences] - [General] - [Workspace] - [Text file encoding]をUTF-8で設定に設定します。
Railsプロジェクトのインポート
- [File] - [Import] - [Other] - [Import As New Project] - [Next]
- プロジェクトフォルダを設定
- そのままFinish
step05 データベース設定
config\database.ymlを開いて、必要な情報を入力
development: adapter: mysql database: プロジェクト名_development username: root password: host: localhost test: adapter: mysql database: プロジェクト名_test username: root password: host: localhost production: adapter: mysql database: プロジェクト名_production username: root password: host: localhost
MySQLの既定の文字コードをUTF-8に設定
- [Instant Rails] - [Iアイコン] - [Configure] - [MySql]でmy.iniを開く
- 末尾に次の２行を追加
default-character-set=utf8 skip-character-set-client-handshake
step06 データベース作成
sqlコマンドで作成する方法
- phpMyAdmin起動
[Instant Rails] - [Iアイコン] - [Configure] - [Database(via PhpMyAdmin)]
次のurlをブラウザで開いてもOKです。
http://127.0.0.1/mysql/ - SQLアイコンをクリック
- create database プロジェクト名_development default charset utf8;
- 削除するときはphpMyAdminを使用
- 環境を変えたDBを作成するときは、コマンドで次の???部分をtestやproductionに変更
create database プロジェクト名_??? default charset utf8;
rakeタスクで作成する方法
- lib\tasks\setup_db.rakeファイルを作成
env = ENV['RAILS_ENV'] || 'development' database = "プロジェクト名_#{env}" task :connect_db => [:environment] do ActiveRecord::Base.establish_connection( :adapter => 'mysql', :host => 'localhost', :username => 'root', :database => 'mysql' ) end task :setup_db => [:connect_db] do ActiveRecord::Schema.define do create_database database end end task :destroy_db => [:connect_db] do ActiveRecord::Schema.define do drop_database database end end - プロジェクトフォルダで「rake setup_db」
- 削除するときは「rake destroy_db」
- 環境を変えたDBを作成するときは「rake RAILS_ENV=test setup_db」または「rake RAILS_ENV=production setup_db」
step07 migrationによるテーブル作成
- ruby script\generate migration create_memos_table
- db\migrate\001_create_memos_table.rbを編集（数字は変わる場合があります）
class CreateTable < ActiveRecord::Migration def self.up create_table :memos do |t| t.column :created_at, :datetime t.column :text, :string, :limit => 256 t.column :location, :string, :limit => 64 end end def self.down drop_table :memos end end - 「rake db:migrate」でマイグレートを実行
- migrationにより、後日例えば文字数を変更
ruby script\generate migration expand_location - db\migrate\002_expand_location.rbを編集（数字は変わる場合があります）
class ExpandLocation < ActiveRecord::Migration def self.up change_column :memos, :location, :string, :limit => 256 end def self.down change_column :memos, :location, :string, :limit => 64 end end
- 「rake db:migrate」でマイグレートを実行
- バージョン１に戻すときは、
rake db:migrate VERSION=1
step08 scaffoldによりモデルおよびモデルにアクセスする足場のページを作成
プロジェクトルートで次のコマンドを入力
ruby script\generate scaffold モデル名 ※モデル名はアッパーキャメルの単数形です
例えば「ruby script\generate scaffold Memo」とした場合、次のページが作成されます
- http://127.0.0.1:3000/memos/list ... 一覧
- http://127.0.0.1:3000/memos/new ... 作成
- http://127.0.0.1:3000/memos/show/id ... 表示
- http://127.0.0.1:3000/memos/edit/id ... 更新
- http://127.0.0.1:3000/memos/destroy/id ... 削除
※コントローラーがmemos、アクションがlist, new, show, edit, destroyとなります
次のファイルが作られます。
- app\models\memo.rb ... モデル
- app\controllers\memos_controller.rb ... コントローラー
- app\views\layouts\memos.rhtml ... Webアプリ全体のビュー
- app\views\memos\edit.rhtml ... editアクションのビュー（編集のビュー）
- ...
step09 モデルへの検証処理追加
モデルに検証メソッドを追加します。
app\models\memo.rb
class Memo < ActiveRecord::Base validates_presence_of :text, :location validates_length_of :location, :maximum => 256 validates_length_of :フィールド名, :within 6..12 end
最後の例は6文字以上12文字以下です。
ドットを３っつとすると「未満」となります。
step10 月選択のフォームを英語から数字に変更
app\views\memos\_form.rhtml
... <%= datetime_select 'memo', 'created_at', :use_month_numbers => true %></p> ...
_form.rhtmlから「created_at」の表示を丸ごと削除すると、自動的にデータ作成日時が設定されます。
step11 インストールされたgemのAPIドキュメント参照
- DOSプロンプトからgem_serverと入力
- ブラウザで次のurlを開く
http://127.0.0.1:8808/
例えば検証で用いるメソッドは次のAPIを参照します。
[activerecord rdoc] - [ActiveRecord::Validations::ClassMethods]
step12 Ruby-GetTextのインストール
- 『gettext-1.10.0-mswin32.gem』を入手
- Instant Railsを起動し、そこからDOSプロンプトを開く
- コマンドを入力してインストール
gem install C:\tmp\gettext-1.10.0-mswin32.gem
備考：- 「gem install gettext」と入力して、オンライン取得したメニューから選択するインストール方法もあるそうですが、なぜか「GemNotFoundException」となりインストールできませんでした。
- これより新しいバージョンのRuby-GetTextはRails 2.0のみ対応です
- インストール先：C:\InstantRails\ruby\lib\ruby\gems\1.8\gems\gettext-1.10.0-mswin32
- GNU GetTextをインストール
『ruby-gnome2-0.16.0-1-i386-mswin32.exe』を入手してインストールします。
インストール先：C:\InstantRails\ruby\Ruby-GNOME2 - Instant Railsを再起動
step13 Ruby-GetTextを利用するようプロジェクトに設定
- 『gettext.rake』をlib\tasksにコピー
- script\serverコマンドを実行中のときはctrl+cキーで停止
configフォルダ内のファイルを変更するときは再起動が必要なためです。 - プロジェクトフォルダで「rake init_gettext」を実行
元に戻すときは「rake void_gettext」を実行 - ruby script\serverでWebサーバ再起動
step14 Ruby-GetTextを利用して日本語化
- ビューの書き換え例
app\views\memos\_form.rhtmlを次のように書き換え<label for="memo_created_at">Create at</label> ↓ <label for="memo_created_at"><%=h _('Create at')%></label>app\controllers\memos_controller.rbを次のように書き換えflash[:notice] = 'Memo was successfully created.' ↓ flash[:notice] = _('Memo was successfully created.') - pot/poファイル作成
rake update_po
- poファイルに表示文言を定義
po\ja\memopad.po書き換え例#: app/views/memos/_form.rhtml:4 msgid "Create at" msgstr "作成日付" ... #: app/controllers/memos_controller.rb:26 msgid "Memo was successfully created." msgstr "メモの作成に成功しました"
- moファイル作成
rake make_mo
step15 テスト駆動開発(TDD, Test Driven Development)の準備
- テスト用DB作成
次のどちらかで作成します。- phpMyAdmin SQLコマンド入力で
create database プロジェクト名_test default charset utf8; - DOSプロンプト プロジェクトフォルダでのコマンド入力で
rake RAILS_ENV=test setup_db
- phpMyAdmin SQLコマンド入力で
- テストを実行
プロジェクトフォルダで「rake」 - 静的テストデータ用意
test\fixtures\memos.ymlone: id: 1 text: テストデータ#1 location: 自宅 two: id: 2 text: テストデータ#2 location: 路上
テストデータ プログラム生成例today: <%= Date.today.to_s %> created_at: <%= Time.now.to_formatted_s :db %>
- 動的テストデータ用意
test\functional\memos_controller_test.rb... def setup @controller = MemosController.new @request = ActionController::TestRequest.new @response = ActionController::TestResponse.new @first_id = memos(:one).id ←このようにfirstからoneに書き換え end ... def test_create num_memos = Memo.count ### post :create, :memo => {} ### ↓このようにテストデータを定義 post :create, :memo => {:text => 'テストデータ#3', :location => 'テスト'} assert_response :redirect assert_redirected_to :action => 'list' assert_equal num_memos + 1, Memo.count end ... - 再び「rake」でテストを実行し、failures, errorsが０となることを確認
step16 ユニットテスト（省略）
『10日でおぼえるRuby on Rails』148ページをご参照ください。
step17 ファンクショナルテスト（省略）
『10日でおぼえるRuby on Rails』164ページをご参照ください。
step18 ビュー書き換え例：入力した内容が'http://'で始まるときにリンクとし、日付yyyy-mm-dd hh:mmに変更
app\views\memos\list.rhtml
<h1><%=h _('Listing memos') %></h1>
<table border="1">
<tr>
<% for column in Memo.content_columns %>
<th><%= column.human_name %></th>
<% end %>
</tr>
<% for memo in @memos %>
<tr>
<% for column in Memo.content_columns %>
<% if column.name == 'location' && memo.location.index('http://') == 0 %> ... このように書き換え
<td><%= link_to h(memo.location), memo.location %></td> ... リンクの書き方です。
表示内容はh()でエスケープします。
<% else %>
<td><%=h memo.send(column.name) %></td> ... send()を用いるとフィールド名を決めずにループ処理できます。
例えばcolumn.nameが'text'のとき、memo.send(column.name)は
memo.textとなります。
<% end %>
<% end %>
<td><%= link_to _('Show'), :action => 'show', :id => memo %></td>
<td><%= link_to _('Edit'), :action => 'edit', :id => memo %></td>
<td><%= link_to _('Destroy'), { :action => 'destroy', :id => memo }, :confirm => _('Are you sure?'), :method => :post %></td>
</tr>
<% end %>
</table >
<%= link_to _('Previous page'), { :page => @memo_pages.current.previous } if @memo_pages.current.previous %>
<%= link_to _('Next page'), { :page => @memo_pages.current.next } if @memo_pages.current.next %>
<br />
<%= link_to _('New memo'), :action => 'new' %>
↓
さらにロジック部分をヘルパーメソッドに外出しし、日付も書き換え
app\views\memos\list.rhtml
#pre{{
...
<% for column in Memo.content_columns %>
<td><%= format_column_value memo, column.name %></td>
<% end %>
...
}}
app\helpers\memos_helper.rb
#pre{{
module MemosHelper
# メモオブジェクトの指定カラムを表示用に整形
def format_column_value(memo, colname)
if colname == 'location' && memo.location.index('http://') == 0
link_to h(memo.location), memo.location
elsif colname == 'created_at'
memo.created_at.strftime '%Y-%m-%d %H:%M' if memo.created_at # 日付もこのように整形
else
h memo.send(colname)
end
end
end
}}
step19 モデル追加例: 添付ファイルを表すAttachmentモデルを追加します。
- モデルを生成
C:\InstantRails\rails_apps\memopad>ruby script\generate model Attachment exists app/models/ exists test/unit/ exists test/fixtures/ create app/models/attachment.rb create test/unit/attachment_test.rb create test/fixtures/attachments.yml exists db/migrate create db/migrate/003_create_attachments.rb ... モデルを先に作成すると、このようにテーブル 作成・削除のmigrationファイルひな形が作られます - フィールドを定義
db\migrate\003_create_attachments.rbclass CreateAttachments < ActiveRecord::Migration def self.up create_table :attachments do |t| t.column :memo_id, :integer # このように追加します t.column :name, :string, :limit => 64 t.column :size, :integer t.column :content_type, :string, :limit => 64 t.column :content, :mediumblob end end def self.down drop_table :attachments # 先にモデルを生成すると、このようにテーブル # 削除も自動で入って便利です end end - migration実行
rake db:migrate - 子側：Attachmentモデルに検証、belongs_toメソッド、メタデータ取得メソッドを追加
app\models\attachment.rb#pre{{
class Attachment < ActiveRecord::Base
# 検証処理
validates_presence_of :name, :size, :content_type, :content
# memoオブジェクトに所属することを宣言
# これによってこのクラスから親Memoの属性が使用できます
# memoは単数なので単数形です。
belongs_to :memo
# メタデータカラム名
# 添付ファイル自身以外、すなわち容量が小さいカラムのカラム名です。
METADATA_COLUMNS = 'id, memo_id, name, size, content_type'
# Memoオブジェクトを指定して、添付物メタデータ配列の取得のメソッド
# @param 親のMemoオブジェクト
# @return 添付物メタデータ配列
# 例：arMeta = Attachment.metadatas memos(objMemo)
# puts arMeta.size
# if (arMeta.size > 0)
# puts arMeta[0].memo_id
# end
def self.metadatas(memo)
find :all, :select => METADATA_COLUMNS,
:conditions => ['memo_id = ?', memo.id]
end
# 添付物idからメタデータ取得のメソッド
# @param 添付物id
# @return そのidを持つ添付物メタデータ
def self.metadata(id)
find id, :select => METADATA_COLUMNS
end
end
}} - 親側：Memoモデルにhas_manyメソッドを追加
#pre{{
class Memo < ActiveRecord::Base
validates_presence_of :text, :location
validates_length_of :location, :maximum => 256
# attachmentsオブジェクトを複数持ち、:selectで指定したカラムにアクセスできることを宣言
# attachmentsは複数なので複数形です。
# 第２引数には:orderなどfindメソッドと同じ引数を指定できます。
has_many :attachments, :select => Attachment::METADATA_COLUMNS
def self.bookmarks
find :all, :conditions => "location like 'http://%'", :order => "created_at DESC"
end
end
}}
step20 添付ファイルのアップロード
ビュー書き換え
app\views\memos\new.rhtml
#pre{{
<h1><%=h _('New memo')%></h1>
<% form_tag ({:action => 'create'}, :multipart => true) do %> ... multipartを設定
<%= render 
artial => 'form' %> ... これは元からあるソースで、_form.rhtmlを読み込みます
<p>
<label for="file"><%=h _('Attachment') %><label><br /> ... ラベル
<%= file_field_tag 'file' %> ... ファイル名入力と参照ボタン
</p>
<%= submit_tag _("Create") %>
<% end %>
<%= link_to _('Back'), :action => 'list' %>
}}
添付ファイル入りでモデル生成
app\controllers\memos_controller.rb
#pre{{
...
def create
@memo = Memo.new(params[:memo])
if params[:file] && params[:file].respond_to?(:original_filename)
# createアクションにfileパラメータが入っていたときの処理
@memo.attachments.create :name => params[:file].original_filename,
:size => params[:file].length,
:content_type => params[:file].content_type,
:content => params[:file].read
end
if @memo.save
flash[:notice] = _('Memo was successfully created.')
redirect_to :action => 'list'
else
render :action => 'new'
end
end
...
}}
step21 添付ファイル表示部分を追加
ルーティングの設定
config\routes.rb
次の先頭２行を追加
map.connect ':controller/:action/:id/:filename.:fileext' map.connect ':controller/:action/:id/:filename' map.connect ':controller/:action/:id.:format' map.connect ':controller/:action/:id'
メモの表示に添付ファイルリスト表示
app\views\memos\show.rhtml
#pre{{
...
<% if !@memo.attachments.empty? %>
<b><%=h _('Attachments') %>:</b>
<table border="1">
<tr>
<% for column in @memo.attachments.content_columns %>
<th><%= column.human_name %></th>
<% end %>
</tr>
<% for attachment in @memo.attachments %>
<tr>
<% for column in @memo.attachments.content_columns %>
<td><%= format_column_value attachment, column.name %></td>
<% end %>
</tr>
<% end %>
</table>
<% end %>
...
}}
ロジック部分はヘルパーに記述
app\helpers\memos_helper.rb
#pre{{
module MemosHelper
# オブジェクトの指定カラムを表示用に整形
def format_column_value(ar, colname)
if Memo === ar
format_memo_column_value ar, colname
elsif Attachment === ar
format_attachment_column_value ar, colname
end
end
# メモオブジェクトの指定カラムを表示用に整形
def format_memo_column_value(memo, colname)
...
end
# 添付オブジェクトの指定カラムを表示用に整形
def format_attachment_column_value(atch, colname)
if colname == 'content'
if atch.content_type =~ /image\/(x-|p)?(jpe?g|png|gif)/
image_tag url_for(:action => 'file', :id => atch.id, :filename => atch.name), :alt => h(atch.name)
else
link_to h(atch.name), {:action => 'file', :id => atch.id, :filename => atch.name}
end
else
h atch.send(colname)
end
end
...
end
}}
fileアクションの追加
app\controllers\memos_controller.rb
#pre{{
...
def file
attachment = Attachment.find params[:id]
# return if forbidden?(attachment.memo)
filename = (params[:fileext]) ? "#{params[:filename]}.#{params[:fileext]}" : params[:filename]
if filename != attachment.name
render :file => File.join(RAILS_ROOT, 'public', '404.html'), :status => 404, :layout => true
else
disposition = 'inline'
send_data attachment.content, :filename => attachment.name, :type => attachment.content_type, isposition => disposition
# cache_page if attachment.memo.public_memo
end
end
...
}}
添付ファイル:
step04_RadRailsImport03.gif 696件
[詳細]
step04_RadRailsImport02.gif 750件
[詳細]
step04_RadRailsUTF8.gif 664件
[詳細]
step04_RadRailsImport01.gif 717件
[詳細]
step01_InstantRails.gif 324件
[詳細]
step01_irb.gif 722件
[詳細]
