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 Rails/RedundantTravelBack cop #524

Merged
merged 1 commit into from
Jul 28, 2021

Conversation

koic
Copy link
Member

@koic koic commented Jul 24, 2021

This PR adds new Rails/RedundantTravelBack cop. It checks for redundant travel_back.
Since Rails 5.2, travel_back automatically called at the end of the test.

# bad
def teardown
  do_something
  travel_back
end

# good
def teardown
  do_something
end

# bad
after do
  do_something
  travel_back
end

# good
after do
  do_something
end

It depends on minimum_target_rails_version, so it's packaged in this RuboCop Rails instead of RuboCop RSpec.


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 (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.
  • 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.
  • If this is a new cop, consider making a corresponding update to the Rails Style Guide.

@koic koic force-pushed the add_new_rails_redundant_travel_back_cop branch from 4041cce to be516e8 Compare July 24, 2021 18:09
This PR adds new `Rails/RedundantTravelBack` cop. It checks for redundant `travel_back`.
Since Rails 5.2, `travel_back` automatically called at the end of the test.

```ruby
# bad
def teardown
  do_something
  travel_back
end

# good
def teardown
  do_something
end

# bad
after do
  do_something
  travel_back
end

# good
after do
  travel_back
end
```

It depends on `minimum_target_rails_version`, so it's packaged in this RuboCop Rails
instead of RuboCop RSpec.
@koic koic force-pushed the add_new_rails_redundant_travel_back_cop branch from be516e8 to 3820d0f Compare July 27, 2021 06:47
@koic koic merged commit e796e2d into rubocop:master Jul 28, 2021
@koic koic deleted the add_new_rails_redundant_travel_back_cop branch July 28, 2021 14:33
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.

2 participants