Ginza.rb 第8回 Gemfileみせっこ！みんなどんなの使ってます？に先月行ってきた

2月に参加したGinza.rb第8回目についてのエントリー。 書いたのはいいけど、POSTし忘れてました。 というわけでGinza.rbで紹介したgemと紹介し切れなかったgemをまとめました。 全部ではないですが、これってものをピックアップしてます。

Ginza.rbで紹介したgem

seed-fu

seed-fuはseedデータの管理を行うためのgemです。

これに乗り換えたキッカケはRails4でrake db:fixturs:loadを実行してみたらFIXTURES_PATHの指定時にdeprecatedが出た事でした。 (マスターデータをfixtruesでロードしたかった)

Using FIXTURES_PATH env variable is deprecated, 
please use ActiveRecord::Tasks::DatabaseTasks.fixtures_path = '/path/to/fixtures' instead.

FIXTURES_DIRは今まで通りにパラメータで指定できるのに、FIXTURES_PATHは何故かActiveRecord::Tasks::DatabaseTasks.fixtures_pathで指定する方向になるようです。 これはキモいし、なんか不自然な変更なのでまた仕様が変わりそうな予感もする。ならseedでやろうかと思ったのだけど、

rake db:seed # rakeタスク
Rails.application.load_seed # コードで呼び出す場合

どちらもパラメータを受け取らない。実装を見ると、

# File railties/lib/rails/engine.rb, line 538
def load_seed
  seed_file = paths["db/seeds.rb"].existent.first
  load(seed_file) if seed_file
end

"db/seeds.rb"を決め打ちで読み込んでいるのでRailsのseedだとrake db:fixtures:loadの代わりに使う事はできなかった。そこで偶然見つけたのがseed-fuだった。

# rakeタスク
rake db:seed_fu FIXTURE_PATH=path/to/fixtures # パスを指定できる
rake db:seed_fu FILTER=users,articles # 読み込むseedデータを指定できる
# コードで呼び出す場合
SeedFu.seed(fixture_paths, filter) # rakeタスクと同様のオプションを指定可能

という感じでrailsのfixtures:loadとseedのいいとこ取りみたいなライブラリだったので使うことにしました。 パスが未指定の場合"#{Rails.root}/db/fixtures" と "#{Rails.root}/db/fixtures/#{Rails.env}"がデフォルトで設定されているので、環境ごとにseedデータを分けるのも簡単です。production環境のマスターにデータを追加したいなあって時も使えますね。

というわけでseed-fuオススメです。別のエントリーで使い方まとめようかな。

grape

RESTライクなAPIマイクロフレームワーク・・と書かれてますが、 要するにSinatraっぽいAPI専用のフレームワークで、活発に開発が行われています。 Grapeは単体で使用することもできますが、Railsと組み合わせることも可能です。 実際これで某サービスのAPIを実装しました。採用した決め手になったポイントは、

• Railsのコントローラで作るより高速
• 実装が読みやすい
• HTTPリクエストメソッドにPATCHがある(Railsっぽい)
• Railsと同居できる(ActiveRecordとか呼べる)
• 最悪やっぱりRailsのコントローラにしようと思った時に、移行作業がそれほど重くなさそう

といったところで、非常に使いやすかったです。 これ流行ってほしいなー。

Ginza.rbで紹介しなかったgem

paper_trail

世代管理用ライブラリ。RailsCastsで紹介されている割には知名度が低い気がする。全く同じ機能をゴリゴリ書いていたプロダクトを思い出して、これを知ってたら工数減らせたなーとか思った。

pundit

権限管理ライブラリ。ポストcancan！最近流行りつつあるようだ。 cancanよりOOPぽく書ける。

まとめ

これぐらいですかね。全部個人的に流行ってほしいなと思ってるgemの紹介でした。

関連URL

Ginza.rb 第8回 Gemfileみせっこ！みんなどんなの使ってます？ Ginza.rb 第8回 Gemfileみせっこ！みんなどんなの使ってます？ を開催した

Railsのエラーハンドリング

Rails3.2から結構いい感じになったエラーハンドリング

Railsは1.xからやっているけど、気に喰わないのがエラーハンドリング周りだった。 特にRoutingエラーを補足する為に各バージョンごとに対応が微妙に違ったりして、毎回調べたりRailsの実装を追っていた記憶がある。 だけどRails3.2から実装された機能で、個人的にはこれで落ち着いたかなと思えた。 既に4が出ているので今更感があるけど、備忘録として書いておく。 Rails4.0.2,Ruby2.0.0で確認しています。

Release Notesでは以下のように書かれている。

Added config.exceptions_app to set the exceptions application invoked
by the ShowException middleware when an exception happens.
Defaults to ActionDispatch::PublicExceptions.new(Rails.public_path).

つまり、例外発生時に呼ばれる例外処理アプリケーションを config.exceptions_app で設定できるようになった。 デフォルトではActionDispatch::PublicExceptions.new(Rails.public_path)が設定される。

どうやって使うか

色々と調べた結果、ActionDispatch::Routing::RouteSetをセットしてやるのが一番シンプルかなーと思った。 まずはself.routesをセット。

# config/application.rb
config.exceptions_app = self.routes #=>ActionDispatch::Routing::RouteSet

で、例外処理用のコントローラを作成しておく。

# app/controllers/erros_controller.rb
class ErrorsController < ApplicationController
  def not_found
    render status: 404
  end

  def internal_server_error
    render status: 500
  end
end

最後にroutes.rbで各httpステータスコードを判定し、ErrorsControllerの各メソッドを指定してやる。

# config/routes.rb
  get '/404', to: 'errors#not_found'
  get '/500', to: 'errors#internal_error'

他のやり方

self.routes以外を指定する事も当然出来る。 というかRackアプリを指定できるのでRailsで無くてもOKです。 例えば以下の様な感じ。

# config/application.rb
config.exceptions_app = ->(env) { ErrorsController.action(:error_page).call(env) }

明確にエラーコードを表示したいウェブアプリだと使うかも。

思うこと

エラーハンドリングに関してはRails newした時に雛形を作るなどしてしまってもいいのではと思った。フリーランスで働いていた時に、途中から入ったプロジェクトの場合、エラーハンドリングの実装方法がバラバラで、その内容によっては無駄に工数がかかるケースもあったので。 ま、Rails is omakaseなので嫌なら使うなって話ですが。

Capistrano3が良さげ

CapistranoのVersion3がリリースされてますね。変更点は以下のサイトに大量に書かれています。
Capistrano Version 3 ReleaseAnnounceme

変更点が多過ぎて全部まとめるのは諦めたので、個人的にこれはいいなーと思った点を上げます。

良かった変更点

• マルチステージをデフォルトでサポート

もうこれでcapistrano-extはいらない。まあ、これは標準サポートされてもいいですよね。

• デプロイの高速化

確か以前はコマンド1回実行毎にsshのセッションを貼り直していたので遅かったはず。SSHのライブラリを変更したのと同時にココらへんも改善されたのかも。ただ、やっぱりRailsをデプロイする時はassetsのコンパイルでちょっと止まりますね。

• 実装が見やすくなった

capistrano2はネットにドキュメントが少なくて結局実装を読む事になる場合が多かったのですが、2と比較すると3の方が見やすくなってました。これは助かります。

• linked_files, linked_dirs

これ凄い便利です。シンボリックリンクを貼りたいファイルがあった時に短く書ける。確かcapistrano2の時は確か無かったと思いますが・・どうなんだろ。
例えばdatabase.ymlのようにgitなどで管理したくないファイルを渡してやると、

set :linked_files, %w{config/database.yml}

/shared/config/database.ymlから/deploy先のバス/current/config/database.ymlにシンボリックリンクを貼ってくれる！2まではrunとかで普通にコマンドを書いていたので、これは楽です。やっぱりこういうファイルってshared配下に置く人が多いんだろうか。linked_dirsもlinked_filesと同じ感じです。

デプロイスクリプトのサンプル

とりあえずRailsアプリをデプロイするスクリプトを書いてみた。ただファイルを置くだけなんで、Webサーバの再起動とかプロセスのリスタートとかは書いてません。

Gemfile

  gem 'capistrano', '3.0.0', github: 'capistrano/capistrano'                                                                                                                                                           
  gem 'capistrano-rails'                                                                                                                                                                                               
  gem 'capistrano-rbenv', github: 'capistrano/rbenv'                                                                                                                                                                   
  gem 'capistrano-bundler', github: 'capistrano/bundler' 

Capfiile

require 'capistrano/setup'
require 'capistrano/deploy'
require 'capistrano/console'
require 'capistrano/rbenv'
set :rbenv_type, :user
set :rbenv_ruby, '2.0.0-p247'
require 'capistrano/bundler'
require 'capistrano/rails'

# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
Dir.glob('lib/capistrano/tasks/*.cap').each { |r| import r }

config/deploy.rb

set :application, :sample
set :repo_url, 'git://hogehogehoge.com/hoge.git'
ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }

set :deploy_to, '/deploy/to'
set :scm, :git

set :pty, true

set :linked_files, %w{config/database.yml config/resque.yml}
# set :linked_dirs, %w{bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system}

set :keep_releases, 10

config/deploy/production.rb

set :stage, :production

# Simple Role Syntax
# ==================
# Supports bulk-adding hosts to roles, the primary
# server in each group is considered to be the first
# unless any hosts have the primary property set.
role :app, %w{app@hoge1 app@hoge2}
role :web, %w{app@hoge1 app@hoge2}
role :db,  %w{app@hoge1}, primary: true

# you can set custom ssh options
# it's possible to pass any option but you need to keep in mind that net/ssh understand limited list of options
# you can see them in [net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start)
# set it globally
set :ssh_options, {
  keys: %w(/home/app/.ssh/id_rsa),
  forward_agent: true,
  auth_methods: %w(publickey)
}
# and/or per server
# server 'example.com',
#   user: 'user_name',
#   roles: %w{web app},
#   ssh_options: {
#     user: 'user_name', # overrides user setting above
#     keys: %w(/home/user_name/.ssh/id_rsa),
#     forward_agent: false,
#     auth_methods: %w(publickey password)
#     # password: 'please use keys'
#   }
# setting per server overrides global ssh_options

# fetch(:default_env).merge!(:rails_env, :production)

サーバの再起動とか全くやってないのであまり参考にはならない。。
ま、ドキュメント読んだりちょっといじってみた結果、実行速度を理由にminaを使うならCapistrano3を使った方がいいかなと感じました。十分早いし、ちょと複雑な事をminaでやろうとすると時間がかかったりするんで。

追記

いいまとめエントリーきました！
Capistrano 3への手引き - 今日のごはんは素麺です http://takkkun.hatenablog.com/entry/2013/10/12/Capistrano_3%E3%81%B8%E3%81%AE%E6%89%8B%E5%BC%95%E3%81%8D

Rails4にアップデートした

Rails4にアップデートする情報は十分にあるので、あえて書くことは無いんですが、今やってるプロジェクトでRails3.2.14からRails4に上げた時のメモ。

基本的にRails3のうちにstrong_parametersさえ対応しておけば大したことはないというのが感想。
問題は使っているgemがRails4に対応しているかどうかですね。
ほぼ全てのgemが対応済みだったり、対策方法があってスムーズに移行が進んだのですが、ちょっとはまったのがglobalize3でした。rails4というブランチがあるので、それをGemfileで指定してbundle installしたら以下のエラーが発生。

Bundler could not find compatible versions for gem "activerecord":
  In Gemfile:
    globalize3 (>= 0) ruby depends on
      activerecord (~> 3.0) ruby

    rails (= 4.0.0) ruby depends on
      activerecord (4.0.0)

Bundler could not find compatible versions for gem "rails":
  In Gemfile:
    globalize3 (>= 0) ruby depends on
      rails (~> 3) ruby

    rails (4.0.0)

調べてみたらpaper_trailとの依存関係が問題で、paper_trailを使っていなくても同じくrails4ブランチを指定してGemfileに追記すればおkでした。
Rubyも2.0になってるし、とりあえずは安心。

undefined method `mtime' for nil:NilClass(i18n-js)

RailsでJavaScriptの国際化をするライブラリは今のところi18n-jsが有名です。
暫く使っていなかったのだけど、久しぶりに使う機会がきたのでgithubを見てみたら便利になってた。なんとassetsを有効にしている環境なら以下の２行を追加するだけで動いてくれるらしい。

//= require i18n
//= require i18n/translations

早速やってみた(Rails3.2.12)ら「undefined method `mtime' for nil:NilClass」というエラーが発生。調べてみると"rake i18n:js:setup"でconfigファイルを作ってやれば動くとのこと。
・・で、configファイルを作ったら無事動きました。ちなみにtranslations fileを指定したりする必要は無いようです。前回使った時はtranslations fileがgrepの時にひっかかりまくってうざかったんですよね。それが無くなるだけでかなり快適。

Rails + Sass + Compass環境でTwitterBootstrapのvariablesを変更する

【注意】この情報古いっす。bootstrap-sassのgithub見てください。もっと簡単にできます。

bootstrapの公式サイトには Customize variablesというページがあって、これを変更する事によって色などを変更したbootstrapをダウンロードできます。これをRailsで変更したいという時にどうするか。

環境は、Railsが3.1.12で、gemは bootstrap-sass, compass-railsを使用しているものとします。

bootstrap-sassではこのファイルで全てのvariablesが宣言されているので、これを上書きしえてしまえばいいわけです。

ファイル構成

以下の様な構成でファイルを作成します。

app/assets/stylesheets/
├── application.css.scss
├── bootstrap
│   └── _variables.scss # variablesを定義する場所
├── bootstrap_load.css.scss # bootstrap読み込み用
└── layout.css.scss # 独自の定義など

各ファイルの内容

app/assets/stylesheets/bootstrap/_variables.scss

$tableBackground: #fff;  // 例えば@tableBackgroundを上書きしたいならこんな感じ。

app/assets/stylesheets/application.css.scss

@import "compass";

app/assets/stylesheets/bootstrap_load.css.scss

@import "bootstrap/variables"; // _variables.scssで変数を上書きしている
@import "bootstrap";           
@import "bootstrap-responsive";

app/assets/stylesheets/layout.css.scss

// 独自に定義したスタイルを書く

大体こんな感じ。app/assets/stylesheets/bootstrap/_variables.scssはsass-railsと同じディレクトリ構成にしておいた方が分かりやすくていいかなと思ってこうやってます。bootstrap-sassが推奨のテンプレをgenerateしてくれるといいんだけどなあ。

ActiveResourceでバリデーションのエラーメッセージを送信する方法

よく見るサンプルコードみたく以下のように書くとダメ。

if @hoge.save
  format.json { render :json => @hoge, :status => :ok } 
else
  format.json { render :json => @hoge.errors, :status => :unprocessable_entity }
end

エラーを返す時はハッシュで:errorsをつけてやるとおｋでした。

if @hoge.save
  format.json { render :json => @hoge, :status => :ok } 
else
  format.json { render :json => {:errors => @hoge.errors.to_json}, :status => :unprocessable_entity }
end

クライアント側ではこれをやってやるだけで取得できます。Railsが勝手にやってくれると思い込んでたんだけど、こうしないとダメらしい。なんか面倒だな。@hoge.errors.to_jsonの#to_jsonは省略できないものか。。