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

Add new Style/MinMax cop #4711

Merged
merged 1 commit into from Sep 11, 2017
Merged

Conversation

Drenmi
Copy link
Collaborator

@Drenmi Drenmi commented Sep 7, 2017

Just got back from vacation, so I wrote this small cop to get back into flow. It can be extended to also check for potential uses of Enumerable#minmax_by, but I don't have the time right now. 🙂

This cop checks for potential uses of Enumberable#minmax, e.g.:

[foo.min, foo.max]

can be changed to:

foo.minmax

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).
  • Used the same coding conventions as the rest of the project.
  • 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.
  • All tests(rake spec) are passing.
  • The new code doesn't generate RuboCop offenses that are checked by rake internal_investigation.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
  • Updated cop documentation with rake generate_cops_documentation (required only when you've added a new cop or changed the configuration/documentation of an existing cop).

@Drenmi Drenmi requested a review from pocke September 7, 2017 16:01
Copy link
Collaborator

@pocke pocke left a comment

Choose a reason for hiding this comment

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

👍


context 'with an array literal containing calls to `#min` and `#max`' do
it 'registers an offense if the receivers match' do
expect_offense(<<-RUBY.strip_indent)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I guess you should add one example of return foo.min, foo.max.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah. Yes. Perhaps parallel assignment, too. bar = foo.min, foo.max

@bbatsov
Copy link
Collaborator

bbatsov commented Sep 8, 2017

I guess the inverse method doesn't exist right? I'm just wondering whether to flag [foo.max, foo.min] and suggest using minmax + reverse.

@Drenmi
Copy link
Collaborator Author

Drenmi commented Sep 8, 2017

I guess the inverse method doesn't exist right? I'm just wondering whether to flag [foo.max, foo.min] and suggest using minmax + reverse.

Yeah. It doesn't exist. I was actually thinking about this as well. Might add it. I think I'll do #minmax_by first.

RUBY
end

it 'does not register an offense if there are additional receivers' do
Copy link
Contributor

Choose a reason for hiding this comment

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

In this test there is only one receiver, foo. Perhaps reword as “does not register an offense if there are additional elements in the array”?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good catch!

@bbatsov
Copy link
Collaborator

bbatsov commented Sep 11, 2017

You should also take a look at those build failures.

This cop checks for potential uses of `Enumberable#minmax`, e.g.:

```
[foo.min, foo.max]
```

can be changed to:

```
foo.minmax
```
@Drenmi
Copy link
Collaborator Author

Drenmi commented Sep 11, 2017

@bbatsov: Support for return added, build fixed, and branch rebased.

@bbatsov bbatsov merged commit e0fdb0b into rubocop:master Sep 11, 2017
@bbatsov
Copy link
Collaborator

bbatsov commented Sep 11, 2017

👍

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.

None yet

4 participants