Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fix #10421] Make Style/DefWithParentheses aware of endless method definition #10425

Conversation

koic
Copy link
Member

@koic koic commented Feb 17, 2022

Fixes #10421.

This PR makes Style/DefWithParentheses aware of endless method definition.

def foo() do_something end will continue to allow because def foo do_something end is a syntax error.
On the other hand, be aware that the endless method definition's parentheses can be omitted.


Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

@koic koic force-pushed the make_style_def_with_parentheses_aware_of_endless_method_definition branch 2 times, most recently from 9e79f9c to 0f45607 Compare February 18, 2022 20:08
# # good
# def foo = do_something
#
# # good
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add an explanation here? E.g., # good (without parentheses it's a syntax error).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! I've updated it!

…method definition

Fixes rubocop#10421.

This PR makes `Style/DefWithParentheses` aware of endless method definition.

`def foo() do_something end` will continue to allow because `def foo do_something end`
is a syntax error.
On the other hand, be aware that the endless method definition's parentheses can be omitted.
@koic koic force-pushed the make_style_def_with_parentheses_aware_of_endless_method_definition branch from 0f45607 to b1778dd Compare February 20, 2022 09:18
@bbatsov bbatsov merged commit aa47871 into rubocop:master Feb 20, 2022
@bbatsov
Copy link
Collaborator

bbatsov commented Feb 20, 2022

Thanks!

@koic koic deleted the make_style_def_with_parentheses_aware_of_endless_method_definition branch February 21, 2022 01:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Flag offence for empty parentheses in single line method definitions
3 participants