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.

Sign up for GitHub

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

Jump to bottom

[Fix #7064] Multiline when then cop #7114

Merged
merged 1 commit into from
Jul 2, 2019
Merged

[Fix #7064] Multiline when then cop #7114

merged 1 commit into from
Jul 2, 2019

Conversation

okuramasafumi
Copy link
Contributor

@okuramasafumi okuramasafumi commented Jun 6, 2019 •
edited

This cop check the use of the then keyword in multi-line when
statements.
Its name comes from Style/MultilineIfThen cop.
This cop is enabled by default because Style/MultilineIfThen cop is
enabled by default.
Related issue is #7064

Before submitting the PR make sure the following are checked:

  • 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.
  • Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
  • Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.

koic
koic reviewed Jun 7, 2019
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
@koic
Copy link
Member

koic commented Jun 7, 2019 •
edited

Style/MultilineIfThen cop is based on the Ruby Style Guide.
https://github.com/rubocop-hq/ruby-style-guide#no-then

Only if / unless is mentioned above. when should be added to it. I think this change is appropriate if accepted there.

koic
koic reviewed Jun 7, 2019
View reviewed changes
config/default.yml Outdated Show resolved Hide resolved
okuramasafumi added a commit to okuramasafumi/ruby-style-guide that referenced this pull request Jun 11, 2019
@okuramasafumi
Add when description/example to no-then rule
9669a5a 
There's a PR to add a cop named `MultilineWhenThen`,
which detects `then` in multiline `when`.
rubocop/rubocop#7114
It refers to `MultilineIfThen` cop, which is based on `no-then` rule here.
So this commit adds `when` description and example to `no-then` rule,
making newly added `MultilineWhenThen` cop based on the style guide.
FYI, the discussion about this feature is here: rubocop/rubocop#7064
@okuramasafumi okuramasafumi mentioned this pull request Jun 11, 2019
Merged
okuramasafumi added a commit to okuramasafumi/ruby-style-guide that referenced this pull request Jun 11, 2019
@okuramasafumi
Add when description/example to no-then rule
35a1504 
There's a PR to add a cop named `MultilineWhenThen`,
which detects `then` in multiline `when`.
rubocop/rubocop#7114
It refers to `MultilineIfThen` cop, which is based on `no-then` rule here.
So this commit adds `when` description and example to `no-then` rule,
making newly added `MultilineWhenThen` cop based on the style guide.
FYI, the discussion about this feature is here: rubocop/rubocop#7064
@okuramasafumi okuramasafumi force-pushed the multiline-when-then-cop branch 2 times, most recently from e04bb76 to 9aaaddd Compare June 11, 2019 09:31
okuramasafumi added a commit to okuramasafumi/ruby-style-guide that referenced this pull request Jun 12, 2019
@okuramasafumi
Add when description/example to no-then rule
16bec12 
There's a PR to add a cop named `MultilineWhenThen`,
which detects `then` in multiline `when`.
rubocop/rubocop#7114
It refers to `MultilineIfThen` cop, which is based on `no-then` rule here.
So this commit adds `when` description and example to `no-then` rule,
making newly added `MultilineWhenThen` cop based on the style guide.
FYI, the discussion about this feature is here: rubocop/rubocop#7064
okuramasafumi added a commit to okuramasafumi/ruby-style-guide that referenced this pull request Jun 12, 2019
@okuramasafumi
Add when description/example to no-then rule
ffa9007 
There's a PR to add a cop named `MultilineWhenThen`,
which detects `then` in multiline `when`.
rubocop/rubocop#7114
It refers to `MultilineIfThen` cop, which is based on `no-then` rule here.
So this commit adds `when` description and example to `no-then` rule,
making newly added `MultilineWhenThen` cop based on the style guide.
FYI, the discussion about this feature is here: rubocop/rubocop#7064
bbatsov pushed a commit to rubocop/ruby-style-guide that referenced this pull request Jun 12, 2019
@okuramasafumi @bbatsov
Add when description/example to no-then rule
bc7e604 
There's a PR to add a cop named `MultilineWhenThen`,
which detects `then` in multiline `when`.
rubocop/rubocop#7114
It refers to `MultilineIfThen` cop, which is based on `no-then` rule here.
So this commit adds `when` description and example to `no-then` rule,
making newly added `MultilineWhenThen` cop based on the style guide.
FYI, the discussion about this feature is here: rubocop/rubocop#7064
@okuramasafumi okuramasafumi force-pushed the multiline-when-then-cop branch 2 times, most recently from be6fae2 to 6734aca Compare June 16, 2019 14:06
koic
koic reviewed Jun 16, 2019
View reviewed changes
config/default.yml Outdated Show resolved Hide resolved
koic added a commit to koic/rubocop that referenced this pull request Jun 17, 2019
@koic
Add a period at EOL of description
dcef703 
This PR detects problems that have been reviewed several times as follows.

- rubocop#7114 (comment)
- rubocop#7140 (comment)

And this PR fixes existing descriptions found using this added spec.

The following is an example of detection.

```console
% bundle exec rspec spec/project_spec.rb:30
Run options: include {:focus=>true, :locations=>{"./spec/project_spec.rb"=>[30]}}

Randomized with seed 57903
F

Failures:

  1) RuboCop Project default configuration file have a period at EOL of description
    Failure/Error: expect(description).to match(/\.\z/)

     expected "Checks for flip-flops" to match /\.\z/
     Diff:
     @@ -1,2 +1,2 @@
     -/\.\z/
     +"Checks for flip-flops"

     # ./spec/project_spec.rb:34:in `block (4 levels) in <top (required)>'
     # ./spec/project_spec.rb:31:in `each'
     # ./spec/project_spec.rb:31:in `block (3 levels) in <top (required)>'

Finished in 0.07499 seconds (files took 1.61 seconds to load)
1 example, 1 failure

Failed examples:

rspec ./spec/project_spec.rb:30 # RuboCop Project default configuration
file have a period at EOL of description

Randomized with seed 57903
```
@koic koic mentioned this pull request Jun 17, 2019
Merged
8 tasks
bbatsov pushed a commit that referenced this pull request Jun 17, 2019
@koic @bbatsov
Add a period at EOL of description
a7b36d0 
This PR detects problems that have been reviewed several times as follows.

- #7114 (comment)
- #7140 (comment)

And this PR fixes existing descriptions found using this added spec.

The following is an example of detection.

```console
% bundle exec rspec spec/project_spec.rb:30
Run options: include {:focus=>true, :locations=>{"./spec/project_spec.rb"=>[30]}}

Randomized with seed 57903
F

Failures:

  1) RuboCop Project default configuration file have a period at EOL of description
    Failure/Error: expect(description).to match(/\.\z/)

     expected "Checks for flip-flops" to match /\.\z/
     Diff:
     @@ -1,2 +1,2 @@
     -/\.\z/
     +"Checks for flip-flops"

     # ./spec/project_spec.rb:34:in `block (4 levels) in <top (required)>'
     # ./spec/project_spec.rb:31:in `each'
     # ./spec/project_spec.rb:31:in `block (3 levels) in <top (required)>'

Finished in 0.07499 seconds (files took 1.61 seconds to load)
1 example, 1 failure

Failed examples:

rspec ./spec/project_spec.rb:30 # RuboCop Project default configuration
file have a period at EOL of description

Randomized with seed 57903
```
@okuramasafumi okuramasafumi force-pushed the multiline-when-then-cop branch 3 times, most recently from 5100c15 to 858c23d Compare June 18, 2019 11:52
@bbatsov
Copy link
Collaborator

bbatsov commented Jun 25, 2019

@okuramasafumi The specs are currently failing. You'll also have to rebase on top of master.

@okuramasafumi
Copy link
Contributor Author

@bbatsov Thanks, I'll fix and rebase it when I have time (hopefully next week).

@okuramasafumi
Add MultilineWhenThen cop
1452d41 
This cop check the use of the `then` keyword in multi-line when
statements.
Its name comes from `Style/MultilineIfThen` cop.
This cop is enabled by default because `Style/MultilineIfThen` cop is
enabled by default.
@okuramasafumi
Copy link
Contributor Author

@bbatsov I rebased on master and fixed the failing specs. I also added some specs so that the cop is more robust.

@bbatsov bbatsov merged commit 203843f into rubocop:master Jul 2, 2019
@bbatsov
Copy link
Collaborator

bbatsov commented Jul 2, 2019

Thanks!

@koic koic mentioned this pull request Aug 7, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@koic koic koic left review comments

@bbatsov bbatsov bbatsov left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@okuramasafumi @koic @bbatsov