rubocop-twirp

Improve your Twirp code with RuboCop

gem install rubocop-twirp

Add to your Gemfile

gem "rubocop-twirp", require: false

Add to .rubocop.yml

require: rubocop-twirp

Scan and fix issues

rubocop -r rubocop-twirp --only Twirp -A

Fix Twirp::ClientResp breaking change introduced in Twirp v1.10. (Cop disabled by default)

rubocop -r rubocop-twirp --only Twirp/DeprecatedArguments -A

Use webmock-twirp to stub Twirp client responses.

# bad
allow(MyTwirpClient).to receive(:my_rpc).and_return(Twirp::ClientResp.new(...))

# good
stub_twirp_request(MyTwirpClient, :my_rpc).to_return(...)

Checks that Twirp::ClientResp uses keyword arguments instead of positional arguments. Needed for Twirp >= 1.10

# bad
Twirp::ClientResp.new(data, error)

# good
Twirp::ClientResp.new(data: data, error: error)

Use rspec-twirp to simplify specs.

# bad
expect(...).to be_a(Twirp::ClientResp)
expect(...).to be_a(Twirp::Error)

# good
expect(...).to be_a_twirp_response
expect(...).to be_a_twirp_error

Yes please :)

1. Fork it
2. Create your feature branch (git checkout -b my-feature)
3. Ensure the tests pass (bundle exec rspec)
4. Commit your changes (git commit -am 'awesome new feature')
5. Push your branch (git push origin my-feature)
6. Create a Pull Request

• https://docs.rubocop.org/rubocop/1.46/development.html
• https://github.com/rubocop/rubocop-ast/blob/master/docs/modules/ROOT/pages/node_pattern.adoc
• https://github.com/rubocop/rubocop-performance