【Game8アドベントカレンダー】Rubyのyield_selfの効果的な活用

はじめに

Game8アドベントカレンダー1日目を担当します。
弊社ではバックエンドの言語にRubyを採用する機会が多いです。そのRubyの中でも特に便利だと思うyield_selfについて活用例を交えて紹介できればと思います。

yield_selfについての説明

yield_self（Ruby 2.5以降ではthenとも呼ばれる）はRubyのメソッドで、Ruby 2.5で導入されました。このメソッドはオブジェクトに対してブロックを適用し、ブロックの結果を返します。yield_selfは、レシーバ（メソッドを呼び出したオブジェクト）をブロックに渡し、ブロックの実行結果を返します。

使用例

result = "Hello".yield_self { |str| str.upcase }
result は "HELLO" になります

&. 演算子との組み合わせ

Rubyの &. 演算子、別名「セーフナビゲーション演算子」は、メソッド呼び出しやブロックの実行を行う前に、レシーバが nil でないかを安全にチェックするために使用されます。これにより、NoMethodError の発生を防ぐことができます。

使用例

result = user&.address&.yield_self { |address| address.upcase }

yield_selfの具体的な使用シーン

データ変換や加工

formatted_data = data.yield_self { |d| d.strip }
                       .yield_self { |d| JSON.parse(d) }
                       .yield_self { |d| d.map { |item| item.transform_keys(&:to_sym) } }		       
		     		     

条件付きのチェーン処理

result = value.yield_self { |v| v > 10 ? perform_some_operation(v) : v }

リファクタリングとコードの整理

result = complex_calculation.yield_self { |calc| adjust_calculation(calc) }
                               .yield_self { |calc| format_result(calc) }

遅延評価

expensive_operation.yield_self { |result| result if result.valid? }

これらの例では、yield_selfを使うことで、コードの流れを直線的に保ちつつ、各ステップでのデータ変換や加工を明確に表現しています。また、これによりコードの再利用性が向上し、複雑な操作をより管理しやすくしています。

弊社での使用例

弊社では記事に必要なデータを取得する際に&. 演算子とgsubを組み合わせ実行を行う前に一部使用しています。

value&.result&.yield_self { |result| result.gsub(/hogehoge/, 'fugafuga') }

value&.result: ここで、&.（安全なナビゲーション演算子）が使用されています。これはvalueがnilでない場合にのみresultメソッドを呼び出すことを意味します。valueがnilの場合、この式全体はnilを返します。

&.yield_self { |result| ... }: ここでは、resultがnilでない場合にのみブロック内のコードが実行されます。yield_selfメソッドは、ブロックに現在のオブジェクト（この場合はresultの結果）を渡します。

{ |result| result.gsub(/hogehoge/, 'fugafuga') }: このブロックは、resultに対してgsubメソッドを呼び出し、ある文字列（"hogehoge"）を別の文字列（"fugafuga"）で置換します。

このようにyield_selfを活用することにより以下のメリットがあると考えています。

• コードの流れの明確化: yield_self/thenは、特定のオブジェクトに対する一連の操作をブロック内で明確に表現します。これにより、どのオブジェクトに対してどのような操作が行われているかが一目でわかります。

• 中間変数の削減: yield_self/thenを使用することで、中間結果を格納するための一時変数を減らすことができます。これにより、コードがすっきりとし、エラーの可能性が減少します。

• メソッドチェーンの促進: メソッドチェーンを使うことで、処理の流れが連続していることが視覚的にわかりやすくなります。