Fix current_page? helper issue with engine root path

[savroff]

Summary

Solving for #29401.
I just figure out that we need to clean request_uri as well as url_string.

[rails-bot]

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @eileencodes (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

[rafaelfranca]

Looks good to me. Could you add a changelog entry?

[rafaelfranca]

Could you explain how this is testing what happens in a real engine and why we need to clear request_uri to make it work?

[savroff]

basically, with scope in routes, we will duplicate situation

# routes.rb
  mount MyEngine::Engine => '/my_engine'

Problem is that here we will get url_string == '/engine' and will try to compare it to request_uri == '/engine/'.
I jump around stack, but could not figure out where exactly we get this difference.
This is why I make fix in easy way.

[JanBussieck]

An even simpler way would be to ensure that we do not chomp('/') the url_string passed in by the user if the request_uri ends with '/', otherwise we'd introduce the inequality which we later on check.
So as I mentioned in #29401 I think it would be easiest to change this line
url_string.chomp!("/") if url_string.start_with?("/") && url_string != "/"
to this line:
url_string.chomp!("/") if url_string.start_with?("/") && !request_uri.end_with? "/"

[savroff]

@JanBussieck I tried this, this will not solve the problem with scope, the test will still fail. We will get request_uri eq to /engine/ and in your case, we will still get false, because '/engine' != '/engine/'. Or else you need to force people to write in helper always like this:

current_page?('/engine/')

And it's easy to fail this :)
I'm usually doing something like this:

current_page?('/engine')

[rafaelfranca]

Better to say:

Fix issues with scopes and engine on current_page? method.

[savroff]

@rafaelfranca thank you! Fill fix in a second.
First pull request, a little bit nerveus 😟

[savroff]

@rafaelfranca

• Added change to CHANGELOG
• Tests are green

Maybe I rename route in tests to something more generic like scope :blog or we are good to go here?

[jerome-diver]

one year after, current_page?() failed again on rails-5.2.
It failed to give back false. Instead it give bacjk an error about route not match (to bad...).

[savroff]

@jerome-diver sorry :) I tried.

Can you show me an example of a simple app?

[jerome-diver]

@savroff yes sure...

rails new exemple
cd exemple
vim Gemfile
# # (i and add haml genfile, then <esc> :wq)
bundle
rails g scaffold Test title:string content:text
rails db:migrate
vim app/views/tests/_partial.haml
# # (i)
# - if current_page?(controller: :tests, action: :edit)
#   %p edit page
# - else
#   %p BAM ! error no match route instead of false when open from show page
# (and <esc> :wq)
vim app/views/test/show.html.haml # (i don't know why, but generator provide ext .html.haml instead of simply .haml... it is not really a bug, but something complicate for nothing more)
# # (i)
# Et voilà, ça va bugger ferme...
# = render partial: "test/partial"
# # ( <esc> :wq
vim config/routes.rb
# # check for presence of
# resources :tests
rails routes (for be sure)
rails s

now create a test record in your database the way you like
let's go inside tests/show/1 route...

if you want also, i can give you the link of my own web site who is a public code in bitbucket ?
tell me....

[eileencodes]

I'm unable to reproduce this in a brand new test app using Rails 5.2.0. I didn't use haml however and used erb. If it's only reproducible using haml it's likely a problem with that gem than rails.

If you are able to reproduce it in an app without using haml please open a new issue and provide an application that reproduces the error.

[jerome-diver]

@savroff sorry, i've spoken to quick and i missed that it can also be a kind of border interaction problem from an other one gem or my own code...
@eileencodes yes correct a test case simply show it works, i created a test case application:
my public test case for current_page? use
where part of this code is inside app/view/posts/_form.html.haml

but that works fine there. I also try with sassc-rails instead of sass-rails
By the time, i have some more gem to check for... maybe devise make things turn bad (i'm thinking that because of route devise own code inside routes.rb file, but i may be wrong).
here is my own rails-5.2 public app for my futur web site where problem is happening with this current_page? code:
my public web site to come

Thank you for try to help me on this. I think that if it is not my own code and if it is in relation with an other one gem, we should be able to contribute to increase compatibility/quality of other open source gem codes.