DEV Community

loading...

Rspec Cheat Sheet

hoanganhlam profile image Lâm ・2 min read

Spec helpers

module UserSpecHelper
  def valid_user_attributes
    { :email => "joe@bloggs.com",
      :username => "joebloggs",
      :password => "abcdefg"}
  end
end
Enter fullscreen mode Exit fullscreen mode
describe User do
  include UserSpecHelper

  ...
end
Enter fullscreen mode Exit fullscreen mode

[Doubles] Method stubs

allow(die).to receive(:roll)
allow(die).to receive(:roll) { 3 }
allow_any_instance_of(Die).to receive(:roll)

expect(die).to receive(:roll)
  .with(1)
  .with(1, true)
  .with(boolean)
  .with(anything)
  .with(any_args)
  .with(1, any_args)
  .with(no_args)
  .with(hash_including(a: 1))
  .with(hash_excluding(a: 1))
  .with(array_including(:a, :b))
  .with(array_excluding(:a, :b))
  .with(instance_of(Fixnum))
  .with(kind_of(Numeric))
  .with(<matcher>)

  .once
  .twice
  .exactly(n).times
  .at_least(:once)
  .at_least(:twice)
  .at_least(n).times
  .at_most(:once)
  .at_most(:twice)
  .at_most(n).times
Enter fullscreen mode Exit fullscreen mode

https://relishapp.com/rspec/rspec-mocks/docs

Doubles

book = double('book')
book = instance_double('Book', pages: 250)
Enter fullscreen mode Exit fullscreen mode

[Expectations] Change

expect { thing.approve! }.to \
  change(thing, :status)
  .from(Status::AWAITING_APPROVAL)
  .to(Status::APPROVED)

expect { thing.destroy }.to \
  change(Thing, :count)
  .by(-1)
Enter fullscreen mode Exit fullscreen mode

[Expectations] Enumerables/arrays

expect(list).to include(<object>)

expect(list).to have(1).things
expect(list).to have_at_least(2).things
expect(list).to have_at_most(3).things

expect(list).to have(2).errors_on(:field)
Enter fullscreen mode Exit fullscreen mode

[Expectations] Control flow

expect { user.save! }.to raise_error
expect { user.save! }.to raise_error(ExceptionName, /msg/)
expect { user.save! }.to throw :symbol
Enter fullscreen mode Exit fullscreen mode

[Expectations] Objects

expect(obj).to be_an_instance_of MyClass
expect(obj).to be_a_kind_of MyClass
expect(obj).to respond_to :save!
Enter fullscreen mode Exit fullscreen mode

[Expectations] Predicate

expect(x).to be_zero    # FixNum#zero?
expect(x).to be_empty   # Array#empty?
expect(x).to have_key   # Hash#has_key?
Enter fullscreen mode Exit fullscreen mode

[Expectations] Comparison

expect(x).to be value
expect(x).to satisfy { |arg| ... }
expect(x).to match /regexp/
Enter fullscreen mode Exit fullscreen mode

[Expectations] Numeric

expect(5).to be < 6
expect(5).to == 5
expect(5).to equal value
expect(5).to be_between(1, 10)
expect(5).to be_within(0.05).of value
Enter fullscreen mode Exit fullscreen mode

Reference

Discussion (0)

Forem Open with the Forem app