TL;DR
一見似た動作をするメソッド同士でも、レシーバにどんなオブジェクトを取れるかが異なる場合には、期待する範囲に近いものを選ぶことで、意図のわかりやすいコードにしよう
intro
先日こういうコードを書いていたら、レビューでアドバイスをもらいました。
<% if @user.errors.present? %>
<ul class="alert alert-warning">
<% @user.errors.full_messages.each do |msg| %>
<li><%= msg %></li>
<% end %>
</ul>
<% end %>
<%= form_with model: @user, url: admin_users_path, local: true do |f| %>
# （略）
-> レビュー：「present? は any? に置き換えても良いかも。メソッドが実装されているオブジェクトの範囲は、より狭いものを使う癖をつけておくのがおすすめ」
???となったので、ちょっと調べてみました。
検証環境
-
Ruby 2.6.3
-
Rails 5.2.3
そもそも present? とは
仕様
定義箇所
console で調べてみた：
> @user.errors.method(:present?)
=> #<Method: ActiveModel::Errors(Object)#present?>
> @user.errors.method(:present?).owner
=> Object
> @user.errors.method(:present?).source_location
=> ["/Users/(ユーザー名)/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/activesupport-5.2.3/lib/active_support/core_ext/object/blank.rb", 26]
# （略）
class Object
# An object is blank if it's false, empty, or a whitespace string.
# For example, +nil+, '', ' ', [], {}, and +false+ are all blank.
# （略）
def present?
!blank?
end
# （略）
上記の通り、 Object クラスを再オープンして定義されている。
つまり、どんなクラスのインスタンスに対しても呼び出す事ができる。
blank? については以下の通り
def blank?
respond_to?(:empty?) ? !!empty? : !self
end
読み解いてみると：
-
respond_to?(:メソッド名)- 引数に取ったメソッドをレシーバに対して呼べるかどうかチェックして真偽値を返すメソッド（リファレンス）
-
!!-
nilでなく真偽値が確実に返るようにする
-
-
!self-
nil,falseは偽と評価される ->!で反転してtrueが返る - 上記以外の値（文字列、数値その他）は
真と評価される ->!で反転してfalseが返る
-
そもそも any? とは
定義箇所
> @user.errors.method(:any?)
=> #<Method: ActiveModel::Errors(Enumerable)#any?>
> @user.errors.method(:any?).source_location
=> nil # C言語で定義されているため（※注）
> @user.errors.method(:any?).owner
=> Enumerable
Enumerable モジュール に定義されている。
つまり、Enumerable モジュールをインクルードしているクラス（Array, Hash, Enumerator, Range など）のインスタンスに対して呼び出すことができる。
このケースでは、ActiveModel::Errors クラスが Enumerable モジュールをインクルードしているので、any? が使える。（該当箇所：https://github.com/rails/rails/blob/v5.2.3/activemodel/lib/active_model/errors.rb#L60)
※注 Rails ではなく Ruby に定義されている。
その手続オブジェクトが ruby で定義されていない(つまりネイティブ である)場合は nil を返します。
仕様
リファレンス
https://docs.ruby-lang.org/ja/2.6.0/method/Enumerable/i/any=3f.html
以下 Ruby 2.6.0 リファレンスマニュアル instance method Enumerable#any? から引用
すべての要素が偽である場合に false を返します。 真である要素があれば、ただちに true を返します。
p [1, 2, 3].any? {|v| v > 3 } # => false
p [1, 2, 3].any? {|v| v > 1 } # => true
p [].any? {|v| v > 0 } # => false
p %w[ant bear cat].any?(/d/) # => false
p [nil, true, 99].any?(Integer) # => true
p [nil, true, 99].any? # => true
p [].any? # => false
レビューコメントの趣旨は...
-
present?はObjectクラスに定義されているので、どんなクラスのインスタンスに対しても呼び出せる -
any?はEnumerableモジュールに定義されているので、Enumerableモジュールをインクルードしているクラスのインスタンスに対してしか呼び出せない - つまり、メソッドが定義されているオブジェクトの影響範囲は
present?>any?であるといえる
見方を変えると、
- コードの読み手は、この箇所を見たとき
present?が定義されていれば「レシーバがどんな型かは特に考慮していないのかな」 と推測するし、any?なら暗に「レシーバがEnumerableモジュールをインクルードしたクラスのインスタンスであることを期待しているのだな」と推測する - 冒頭のケースでは、
errorsが必ずActiveModel::Errorsクラスのオブジェクトであることがわかっている。このような場合は、どんなオブジェクトに対しても呼べるpresent?よりもany?を使うことで、「errors にはEnumerableなものが渡ってきますよ」という意図を表現したほうがわかりやすい