CGI.escapeについて

Question

Rails tutorial 11.2.3や12.2.2の演習でCGI.escapeを削除するとテスト結果がredであることを確認するとありますが、greenのままとなります。

CGI.escapeは文字列を暗号化するためのメソッドであると認識していますが、これがgreenのままだとどのような問題があるのかよくわかりません。

Answer 1

演習でCGI.escapeを削除するとテスト結果がredであることを確認するとありますが、greenのまま

ですが、11.2.3 送信メールのテスト - Ruby on Rails チュートリアルの演習で記述されている「CGI.escapeの部分を削除する」とは、
assert_match CGI.escape(user.email), mail.body.encoded の部分を「CGI.escapeの呼び出しを削除して、assert_match user.email, mail.body.encoded のように修正する」と言う意味ではないでしょうか。これだとassert_matchは失敗し、演習の答え通りREDになるはずです。

CGI.escapeは文字列を暗号化するためのメソッドであると認識していますが、これがgreenのままだとどのような問題があるのかよくわかりません。

言葉の使い方だけの問題ですが、CGI.escapeは暗号化をするものではありません。暗号化とは、簡単に書くと「ある者しか知らないキーやルールを用いて、そのキーやルールを知らない者以外はデータを復元できないようにする。」ことです。（逆は「復号化」です）CGI.escapeは、CGIと言うインターフェース仕様に適合するようにCGIの仕様に沿って文字列を変換するだけなので、暗号化とは言いません。Rubyでも例えば2重引用符"を文字列中に含める場合、\"にエスケープする、などと言いますよね。そんな用法のCGI版だと思えば良いです。

では「greenのままだとどのような問題があるのか。」ですが、この場合は「チュートリアルの手順を正しく進めていない。その時点で理解すべきことが欠けているかもしれない。」ことを示します。まず、CGI.escapeは引数の文字列をCGI用にエスケープした文字列を返します。チュートリアルのコードは以下ですが、

# https://railstutorial.jp/chapters/account_activation?version=5.1#sec-email_tests より

require 'test_helper'

class UserMailerTest < ActionMailer::TestCase

  test "account_activation" do
    user = users(:michael)
    user.activation_token = User.new_token
    mail = UserMailer.account_activation(user)
...省略
    assert_match CGI.escape(user.email),  mail.body.encoded
  end
end

ここで assert_match CGI.escape(user.email), mail.body.encoded とあるように、user.emailをCGIエスケープした結果がmail.body.encoded の文字列と同じであることを主張(assert)します。同じであればOKで、パスします。つまり「user.emailをCGI.escapeすることであらかじめエスケープ（されているはずの）mail.body.encodedと同じになる」ことを確認できます。この行をassert_match user.email, mail.body.encoded と修正すると、user.emailはエスケープしないままmail.body.encoded と比較されるのでassert_matchは失敗します。したがってテスト結果がREDになるはずです。このテストがGREENである場合、コードの修正が間違っていたり、これまでの理解が足りていないかもしれないことを示しているので、演習の目的を達していないことになります。つまり、問題がある、と言うことです。

Comments

[ItiroWakuda]

ご指摘の通りするとredになりました。
コードの意味を理解せずに漫然とやってしまいました。丁寧な説明大変ありがとうございます。

検索するとエンコードというワードが出てきたため、暗号化なのかと思っていました。今一度エスケープの意味について調べ直してみようと思います。