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

Make offense locations of metrics cops to contain whole a method #5042

Merged
merged 1 commit into from
Nov 12, 2017

Conversation

pocke
Copy link
Collaborator

@pocke pocke commented Nov 12, 2017

Problem

Currently, metrics cops add an offence for a complex method to def keyword.
For example, Metrics/AbcSize

Inspecting 1 file
C

Offenses:

test.rb:1:1: C: Assignment Branch Condition size for complex is too high. [1.41/1]
def complex
^^^

1 file inspected, 1 offense detected

However, the "def" is not complex, the method body is complex.
So I think this cop should add an offence whole the method.

Note: Metrics/MethodLength already adds offences whole the method.

Solution

Make offense locations of metrics cops to contain whole a method.
AbcSize, CyclomaticComplexity and PerceivedComplexity cops are targets of this change.

For example

Inspecting 1 file
C

Offenses:

test.rb:1:1: C: Assignment Branch Condition size for complex is too high. [1.41/1]
def complex ...
^^^^^^^^^^^

1 file inspected, 1 offense detected

Note

Our spec helper does not support multi line offences completely. But we have a workaround for multi line offences, we can write an annotation after first line of an offence to test the offence that is for multi-line.
For example:

expect_offense(<<-RUBY)
  def foo
  ^^^^^^^ message
    bar
  end
RUBY

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).

Problem
====

Currently, metrics cops add an offence for a complex method to `def` keyword.
For example, `Metrics/AbcSize`

```
Inspecting 1 file
C

Offenses:

test.rb:1:1: C: Assignment Branch Condition size for complex is too high. [1.41/1]
def complex
^^^

1 file inspected, 1 offense detected
```

However, the "`def`" is not complex, the method body is complex.
So I think this cop should add an offence whole the method.

Note: Metrics/MethodLength already adds offences whole the method.

Solution
====

Make offense locations of metrics cops to contain whole a method.
AbcSize, CyclomaticComplexity and PerceivedComplexity cops are targets of this change.

For example

```
Inspecting 1 file
C

Offenses:

test.rb:1:1: C: Assignment Branch Condition size for complex is too high. [1.41/1]
def complex ...
^^^^^^^^^^^

1 file inspected, 1 offense detected
```
Copy link
Contributor

@garettarrowood garettarrowood left a comment

Choose a reason for hiding this comment

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

Makes sense and looks good to me.

@bbatsov
Copy link
Collaborator

bbatsov commented Nov 12, 2017

Solid improvement! 👍

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.

3 participants