Yudai Takada RubyKaigi 2023 After Party 2023.06.22 (Thu) The Labyrinth of How to Write RSpec Pending Reasons

ɾ Name: Yudai Takada ɾ GitHub: @ydah ɾ Twitter: @ydah_ ɾ Member of RuboCop RSpec team ɾ Software Engineer at ANDPAD, Inc. self.inspect

ݐஙɾݐઃۀʹಛԽͨ͠Ϋϥ΢υαʔϏε ఏڙ

⼤阪Ruby会議03 "Rubyで笑おう" 2023-09-09 (Sat) 2023-06-23 23:55 CFP締切

Today’s Talk

Today, I talk about another proposal

RSpec

About RSpec pending and skip

RSpec/PendingWithoutReason

About RSpec/ PendingWithoutReason 34QFD1FOEJOH8JUIPVU3FBTPOJTBDPQGPS 3VCP$PQ34QFD 
 
 5IJTDPQDIFDLTGPSQFOEJOHPSTLJQQFE FYBNQMFTXJUIPVUSFBTPO

About RSpec/ PendingWithoutReason # bad it 'does something' do skip end # good it 'does something' do skip 'reason' end

Result Foo does something (PENDING : No reason given) does something (PENDING : reason)

Is it surprisingly easy?

🙅

Case 1 RSpec.describe Foo do it 'does something' do skip 'xxx' end it 'does something' do pending 'xxx' raise 'should not get here' end end RSpec.describe Foo do pending 'xxx' do # ... end skip 'xxx' do # ... end end

Case 1 RSpec.describe Foo do it 'does something' do skip 'xxx' end it 'does something' do pending 'xxx' raise 'should not get here' end end RSpec.describe Foo do pending 'xxx' do # ... end skip 'xxx' do # ... end end 🙆 🙅

Case 2 RSpec.describe Foo do it 'does something' do skip 'xxx' do # . .. end end end

Case 2 🙆 Foo does something (PENDING: xxx)

Case 3 RSpec.describe Foo do it 'does something' do pending 'xxx' do # . .. end end end

Case 3 🥺 ArgumentError: The semantics of `RSpec::Core::Pending#pending` have changed in RSpec 3. In RSpec 2.x, it caused the example to be skipped. In RSpec 3, the rest of the example is still run but is expected to fail, and will be marked as a failure (rather than as pending) if the example passes. Passing a block within an example is now deprecated. Marking the example as pending provides the same behavior in RSpec 3 which was provided only by the block in RSpec 2.x. Move the code in the block provided to `pending` into the rest of the example body.

Various ways to skip/pending still exist

Temporarily skipping by prefixing example with an x RSpec.describe "an example" do xit "is skipped using xit" do end xspecify "is skipped using xspecify" do end xexample "is skipped using xexample" do end end

Skipping using metadata RSpec.describe "an example" do example "is skipped", :skip => true do end end

When implementing a RuboCop’s cop, there are additional considerations to take into account 😇

Cases to ignore in RuboCop FactoryBot.def i ne do factory :task do pending skip { true } end end

Cases to ignore in RuboCop RSpec.describe Foo do it 'does something' do Foo.pending Foo.skip end end

Cases to ignore in RuboCop RSpec.describe Foo do it 'does something' do expect('foo').to eq(pending) foo(bar, pending, skip) foo(bar, pending: pending, skip: skip) is_expected.to match_array([foo, pending, skip]) list = [skip, pending] end end

Writing reasons for pending or skip in RSpec was a labyrinth…

end