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 #822] Extends Rails/HttpStatus cop to check routes.rb #823

Merged
merged 1 commit into from
Oct 22, 2022

Conversation

anthony-robin
Copy link
Contributor

Fixes #822.

This PR extends Rails/HttpStatus cop to detects offenses in routes.rb on redirections:

Rails.application.routes.draw do
  get '/foobar', to: redirect('/foobar/baz', status: 301)
end

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

Fixes rubocop#822.

This PR extends `Rails/HttpStatus` to detects offenses in `routes.rb` on redirections:

```ruby
Rails.application.routes.draw do
  get '/foobar', to: redirect('/foobar/baz', status: 301)
end
```
@koic koic merged commit e40d8b9 into rubocop:master Oct 22, 2022
@koic
Copy link
Member

koic commented Oct 22, 2022

Thanks!

@anthony-robin anthony-robin deleted the http-status-routes branch October 22, 2022 06:51
@anthony-robin
Copy link
Contributor Author

I think this PR should be reverted because it appears that Rails doesn't support symbols in routes.rb redirect method :(

Puma caught this error: undefined method `to_i' for :moved_permanently:Symbol

          status = status.to_i
                         ^^^^^
Did you mean?  to_s (NoMethodError)
/.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/request.rb:82:in `handle_request'
/.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/server.rb:443:in `process_client'
/.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/thread_pool.rb:147:in `block in spawn_thread'

I'm not sure why the error did not occur earlier to me so sorry for this mess :(
Maybe this should be proposed to Rails as an enhancement to keep consistency with controllers ?

jdufresne added a commit to jdufresne/rubocop-rails that referenced this pull request Oct 23, 2022
…-routes"

This reverts commit e40d8b9, reversing
changes made to 6051ed8.

The auto-corrected code is not compatible with Rails/Puma, resulting the
error:

    Puma caught this error: undefined method `to_i' for :moved_permanently:Symbol

              status = status.to_i
                             ^^^^^
    Did you mean?  to_s (NoMethodError)
    /.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/request.rb:82:in `handle_request'
    /.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/server.rb:443:in `process_client'
    /.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/thread_pool.rb:147:in `block in spawn_thread'
jdufresne added a commit to jdufresne/rubocop-rails that referenced this pull request Oct 23, 2022
…-routes"

This reverts commit e40d8b9, reversing
changes made to 6051ed8.

The auto-corrected code is not compatible with Rails/Puma, resulting the
error:

    Puma caught this error: undefined method `to_i' for :moved_permanently:Symbol

              status = status.to_i
                             ^^^^^
    Did you mean?  to_s (NoMethodError)
    /.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/request.rb:82:in `handle_request'
    /.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/server.rb:443:in `process_client'
    /.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/thread_pool.rb:147:in `block in spawn_thread'
jdufresne added a commit to jdufresne/rubocop-rails that referenced this pull request Oct 23, 2022
…-routes"

This reverts commit e40d8b9, reversing
changes made to 6051ed8.

The auto-corrected code is not compatible with Rails/Puma, resulting the
error:

    Puma caught this error: undefined method `to_i' for :moved_permanently:Symbol

              status = status.to_i
                             ^^^^^
    Did you mean?  to_s (NoMethodError)
    /.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/request.rb:82:in `handle_request'
    /.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/server.rb:443:in `process_client'
    /.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/thread_pool.rb:147:in `block in spawn_thread'
@jdufresne
Copy link
Contributor

I observed the same issue. I opened #829 to do the revert.

jdufresne added a commit to jdufresne/rubocop-rails that referenced this pull request Oct 23, 2022
…-routes"

This reverts commit e40d8b9, reversing
changes made to 6051ed8.

The auto-corrected code is not compatible with Rails/Puma, resulting the
error:

    Puma caught this error: undefined method `to_i' for :moved_permanently:Symbol

              status = status.to_i
                             ^^^^^
    Did you mean?  to_s (NoMethodError)
    /.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/request.rb:82:in `handle_request'
    /.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/server.rb:443:in `process_client'
    /.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/puma-5.6.5/lib/puma/thread_pool.rb:147:in `block in spawn_thread'
@rnestler
Copy link

Also getting hit by this.

koic added a commit that referenced this pull request Oct 25, 2022
Revert "Merge pull request #823 from anthony-robin/http-status-routes"
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.

Extends Rails/HttpStatus cop to check routes.rb
4 participants