RSpecの実行結果とコマンドの結果が合わない

Question

こんばんわ。

rspecの実行結果と実際の結果が合わないので、質問をします。

下記がクラスの定義になります。

class Car
  attr_accessor :name, :color
  attr_reader :x, :fuel

  @@count = 0

  def self.count
    @@count
  end

  def initialize(name, color)
    @name = name
    @color = color
    @x = 0
    @fuel = 100
    @@count += 1
  end

  def info
    puts "名前：#{self.name}, 色：#{self.color}"
    # puts "現在の位置: #{self.x}km"
    # puts "ガソリン量: #{self.fuel}リットル"
  end

  def run(distance)
    if distance > @fuel
      puts "ガソリンが足りません"
      return
    end
    @x += distance
    set_fuel(@fuel - distance)
  end

  def charge(litre)
    set_fuel(@fuel + litre)
  end

  private

  def set_fuel(litre)
     @fuel = litre
  end
end

rspecの記述は下記の通りです。

describe Car do
  describe '#info' do
    it 'info is valid' do
      my_car = Car.new('ゴンフォート', '赤')
      expect(my_car.info).to eq '名前：ゴンフォート, 色：赤'
    end
  end
end

エラーメッセージです。

Car
  #info
名前：ゴンフォート, 色：赤
    info is valid (FAILED - 1)

Failures:

  1) Car#info info is valid
     Failure/Error: expect(@my_car.info).to eq '名前：ゴンフォート, 色：赤'
     
       expected: "名前：ゴンフォート, 色：赤"
            got: nil
     
       (compared using ==)
     # ./car_spec.rb:7:in `block (3 levels) in <top (required)>'

Finished in 0.01744 seconds (files took 0.14312 seconds to load)
1 example, 1 failure

Failed examples:

rspec ./car_spec.rb:5 # Car#info info is valid

普通に次の通り行っても、メソッドは実行されます。

my_car = Car.new('ゴンフォート', '赤')
car.info

=>名前：ゴンフォート, 色：赤

なぜ、結果がnilになっているのかが理解できません。
お手数をおかけしますが、ご教授をよろしくおねがいします。

Answer 1

原因：
質問文にある info メソッドは常に nil を返すからです。

解説：

def info
    puts "名前：#{self.name}, 色：#{self.color}"
end

この info メソッドは nil を返します。
(puts ... は nil を返します。そして それは info の return 値になります)

rspec の
expect(my_car.info).to eq '...'
は my_car.info の return 値が eq の後の文字列と一致するかをテストしています。

このテストをパスさせるには、次のようにするのが一番簡単な方法と思います。

def info
    "名前：#{self.name}, 色：#{self.color}"
end

この変更をすると info メソッドはコンソールに文字列を出力しくなります。
info の値をコンソールに表示する場合は
p my_car.info
とか
puts my_car.info
とするようにします。

info を文字列が返るようにしておくと、コンソール出力, ファイル出力したり、web アプリで ブラウザ画面の表示するときにも
info を使えるようになります。
(info 中で puts してしまっていると、ファイル出力するときは、info とは別のメソッドをつくる必要が発生してしまう)

Comments

[ayu]

>(puts ... は nil を返します。そして それは info の return 値になります)
ここを全く知らなかったです。
原因が分かってすっきりしました。
ありがとうございます！

Answer 2

puts を呼び出すと、自身の仕事を終えたのち、nil を返します

p (puts 'Hello') # => "Hello"
# => nil

テストが通る書き方に変えるとすれば、info メソッドはputs せず、呼び出し元がputs するように書き換える必要があるかもしれません

def info
  # puts "名前：#{@name}, 色：#{@color}"
  "名前：#{@name}, 色：#{@color}"
end

このメソッドに複数の値を処理させたい場合は、配列やハッシュに含めて返すなど、工夫が必要かもしれませんね

何か参考になれば幸いです

Link

• Better Specs { rspec guidelines with ruby }

Comments

[ayu]

なるほど。
putsは呼び出した後に、仕事が終わったらnilを返すからなんですね。
これは知らなかった・・・
また、参考リンクもありがとうございます。
一読しておきます！