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 a false positive for Lint/DuplicateMethods #11176

Merged

Conversation

koic
Copy link
Member

@koic koic commented Nov 12, 2022

This PR fixes the following false positive cases for Lint/DuplicateMethods when using duplicate nested method.

It prevents false positives in test cases such as:

def test_foo
  class A
    def x
      prepare_for_foo
    end
  end

  assert...
end

def test_bar
  class A
    def x
      prepare_for_bar
    end
  end

  assert...
end

The above is a false positive found in the rails/rails repository.

Also as an edge case, nested methods may have been intended.

def foo
  def x
    puts 'foo'
  end
end

def bar
  def x
    puts 'bar'
  end
end

foo
x #=> foo

bar
x #=> bar

foo
x #=> foo

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.

This PR fixes the following false positive cases for `Lint/DuplicateMethods`
when using duplicate nested method.

It prevents false positives in test cases such as:

```ruby
def test_foo
  class A
    def x
      prepare_for_foo
    end
  end

  assert...
end

def test_bar
  class A
    def x
      prepare_for_bar
    end
  end

  assert...
end
```

The above is a false positive found in the rails/rails repository.

Also as an edge case, nested methods may have been intended.

```ruby
def foo
  def x
    puts 'foo'
  end
end

def bar
  def x
    puts 'bar'
  end
end

foo
x #=> foo

bar
x #=> bar

foo
x #=> foo
```
@bbatsov bbatsov merged commit 3f3c829 into rubocop:master Nov 12, 2022
@bbatsov
Copy link
Collaborator

bbatsov commented Nov 12, 2022

Looks good. Thanks!

@koic koic deleted the fix_a_false_positive_for_lint_duplicate_methods branch November 12, 2022 17:55
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

2 participants