More than 3 years have passed since last update.

【Rails/simple_format】フォームで入力した改行を反映させるヘルパーメソッド

Last updated at 2020-11-03Posted at 2020-11-01

状況

【参照】

app/controllers/tasks_controller.rb

def show
  @task = Task.find(params[:id])
  @commits = @task.commits
end

app/views/tasks/show.html.erb

<% @commits.each do |commit| %>
  <%= commit.content %>
<% end %>

この表示の仕方だと、commit.contentの改行が反映されません。

<こんな感じです>

これはsimple_formatを使うことで解決できます。実際にやってみましょう。

app/views/tasks/show.html.erb

<!-- simple_formatを使う -->
<% @commits.each do |commit| %>
  <%= simple_format(commit.content) %>
<% end %>

simple_formatは、改行をpタグやbrタグで表現してくれるヘルパーメソッドです。
出力したいテキストをsimple_formatに入れるだけで完了します。

<結果はこんな感じ>

さて、とりあえず目標達成です。
しかし、この実装には問題があります。それは「エスケープ」ができていないということです。

詳しく見ていきましょう。

エスケープは、セキュリティ対策で使われる技術です。簡単に言うと「意味がある文字の意味をなくす」役割があります。

具体的に見ていきます。
例えばこんな入力をしたとします。

この値をエスケープしないまま表示すると、こんな感じで「HTMLタグ」として認識されてしまいます。

HTMLでは "<" を「タグが始まりますよ！」という意味で認識します。よってエスケープしない場合はh1要素として表示してしまいます。

このエスケープ機能は、Railsのビューで用いる<%= %>を使うことで付与されます。
しかし、simple_formatを使ってしまうと、この機能が失われます。

よって、simple_formatを使う際は、hオプションを使います。これはsimple_formatにエスケープ機能を付与してくれる優れものです。

app/views/tasks/show.html.erb


<%# hオプションを使う %>
<% @commits.each do |commit| %>
  <%= simple_format(h(commit.content)) %>
<% end %>

こうすると、表示が下記のように変化します。

"<"などから意味が奪われ、ただの記号や文字として表示されています。それに伴い文字も小さくなりました！(pタグで囲まれた)

simple_formatは使う機会が多そうですが、セキュリティ対策を怠ると怖いヘルパーメソッドでもあります。使う際は頭に入れて使っていきます。