【97】【Ruby】委譲機能を定義するモジュールForwardable、リファクタリング

この記事を読むと、メソッドの委譲機能を定義するモジュールForwardableについて、理解を深めることができます。

改善したいコード

class Bicycle
 attr_reader :size, :parts
 def initialize(args = {})
   @size = args[:size]
   @parts = args[:parts]
 end
 def spares
   parts.spares
 end
end
class Parts
 attr_reader :parts
 def initialize(parts)
   @parts = parts
 end
 def spares
   parts.select{|part| part.needs_spare}
 end
end


require 'ostruct'
module PartsFactory
 def self.build(config,parts_class = Parts)
   parts_class.new(
       config.collect{|part_config|
         create_part(part_config)
       }
   )
 end
 def self.create_part(part_config)
   OpenStruct.new(
       name: part_config[0],
       description: part_config[1],
       needs_spare: part_config.fetch(2,true)
   )
 end
end

テスト

require_relative '5_5_1_before_refactoring'

RSpec.describe "Bicycleモデル" do
 mountain_config =
     [
         ["chain","10-speed"],
         ["tire_size","Manitou",false ],
         ["rear_shock","Fox"]
     ]
 mountain_bike =
     Bicycle.new(
         size: "L",
         parts: PartsFactory.build(mountain_config)
     )

 spares = mountain_bike.spares.map do |part|
   {"#{part.name}".to_sym =>"#{part.description}"}
 end
 it '#spares' do
   expect(spares).to eq [{:chain=>"10-speed"}, {:rear_shock=>"Fox"}]
 end
 it '#parts.size' do
   expect{mountain_bike.parts.size}
       .to raise_error(NoMethodError)
 end
 it '#parts.parts.size' do
   expect(mountain_bike.parts.parts.size)
       .to eq 3
 end
end

改善したい点

parts.sizeとするとエラーがでる。parts.parts.sizeならok。しかし、parts.parts.sizeは使いたくない。
どうにかして、parts.sizeとすることはできないか？

リファクタリング

class Bicycle
 attr_reader :size, :parts
 def initialize(args = {})
   @size = args[:size]
   @parts = args[:parts]
 end
 def spares
   parts.spares
 end
end
require 'forwardable'
class Parts
 attr_reader :parts
 extend Forwardable
 def_delegators :@parts, :size,:each
 def initialize(parts)
   @parts = parts
 end
 def spares
   parts.select{|part| part.needs_spare}
 end
end
class Part
 attr_reader :name, :description, :needs_spare
 def initialize(args)
   @name = args[:name]
   @description = args[:description]
   @needs_spare = args.fetch(:needs_spare,true)
 end
end
require 'ostruct'
module PartsFactory
 def self.build(config,parts_class = Parts)
   parts_class.new(
       config.collect{|part_config|
         create_part(part_config)
       }
   )
 end
 def self.create_part(part_config)
   OpenStruct.new(
       name: part_config[0],
       description: part_config[1],
       needs_spare: part_config.fetch(2,true)
   )
 end
end

テスト

require_relative '5_5_2_refactoring'

RSpec.describe "Bicycleモデル" do
 mountain_config =
     [
         ["chain","10-speed"],
         ["tire_size","Manitou",false ],
         ["rear_shock","Fox"]
     ]
 mountain_bike =
     Bicycle.new(
         size: "L",
         parts: PartsFactory.build(mountain_config)
     )

 spares = mountain_bike.spares.map do |part|
   {"#{part.name}".to_sym =>"#{part.description}"}
 end
 it '#spares' do
   expect(spares).to eq [{:chain=>"10-speed"}, {:rear_shock=>"Fox"}]
 end
 it '#parts.sizeにおいてNoMethodErrorが起きなくなった' do
   expect{mountain_bike.parts.size}
       .not_to raise_error(NoMethodError)
 end
 it '#parts.size' do
   expect(mountain_bike.parts.size)
       .to eq 3
 end
end

ポイント

メソッドの委譲機能を定義するモジュール、Forwardableを使う。

クラスに対して Object#extend して使います。Module#include でないところに注意して下さい。

 def_delegators :@parts, :size,:each

Bicycleのインスタンス変数@partsに、size,eachを送ります。
こうすることで、parts.sizeとして使うことができるようになりました。

 関連する記事

参考文献

オブジェクト指向設計実践ガイド
～Rubyでわかる 進化しつづける柔軟なアプリケーションの育て方

最後に
私がブログを書く目的は、素晴らしい本や、素晴らしい方々の技術記事を知って頂きたいからです。ぜひ、上記の参考文献を見て下さい。（noteなので広告とかは一切ありません。）

現在、株式会社grabssに行くために最後の悪あがきをしています！！
現在の進行状況
この記事は97件目の投稿。目標達成！！！！
目標再設定
20日までに100件目指す！！（97件目）
20日超えたが、寝るまでは20日営業日！！（まだ寝てない、ちょっと寝##峠を超え目が覚めた！）
気持ちは20日！

よろしければ、スキボタン及びサポートお願いします。勉強の励みになります。