Implement helpers proxy in controller instance level#24866
Merged
Conversation
There were a lot of protected instance variables in AbsctractController::Rendering that were related to Action Controller and Action View. Moving to ActionController::Base's protected instance list we make it closer to where they are really defined.
Member
Author
Contributor
There was a problem hiding this comment.
There's also assert_includes :)
Contributor
|
LGTM and like the idea. Should we make this available for Action Mailer too? |
Member
Author
Yeah, that makes sense. Neither of them are available in mailers. |
Member
Author
|
So, after checking mailers helpers don't use |
rafaelfranca
force-pushed
the
actionview-helpers
branch
2 times, most recently
from
9ef054e to
c41b823
Compare
It is a common pattern in the Rails community that when people want to
:xa
use any kind of helper that is defined inside app/helpers they includes
the helper module inside the controller like:
module UserHelper
def my_user_helper
# ...
end
end
class UsersController < ApplicationController
include UserHelper
def index
render inline: my_user_helper
end
end
This has problem because the helper can't access anything that is
defined in the view level context class.
Also all public methods of the helper become available in the controller
what can lead to undesirable methods being routed and behaving as
actions.
Also if you helper depends on other helpers or even Action View helpers
you need to include each one of these dependencies in your controller
otherwise your helper is not going to work.
We already have a helpers proxy at controller class level but that proxy
doesn't have access to the instance variables defined in the
controller.
With this new instance level helper proxy users can reuse helpers in the
controller without having to include the modules and with access to
instance variables defined in the controller.
class UsersController < ApplicationController
def index
render inline: helpers.my_user_helper
end
end
rafaelfranca
force-pushed
the
actionview-helpers
branch
from
c41b823 to
541a51e
Compare
Member
|
❤️ |
prathamesh-sonpatki
added a commit
to prathamesh-sonpatki/rails
that referenced
this pull request
May 6, 2016
Contributor
|
Sweet ❤️ |
kaspth
added a commit
that referenced
this pull request
May 6, 2016
…se-notes [ci skip] Release notes: Add PR #24866 to release notes
|
❤️ |
Sporky023
reviewed
Oct 24, 2016
|
|
||
| # Provides a proxy to access helpers methods from outside the view. | ||
| def helpers | ||
| @_helper_proxy ||= view_context |
There was a problem hiding this comment.
Just curious - why not use view_context.some_helper_method in the controller instead of helpers.some_helper_method?
Member
Author
There was a problem hiding this comment.
Because view_context is not cached and it working view_context is just an implementation detail that I plan to change some point in the future.
This was referenced Nov 2, 2016
kaspermeyer
added a commit
to kaspermeyer/actionview-component
that referenced
this pull request
Nov 11, 2019
Adds a `#helpers` method that works as a proxy for components to access helper methods through. Inspired by a similar feature in Rails by @rafaelfranca: rails/rails#24866 Resolves: ViewComponent#92
kaspermeyer
added a commit
to kaspermeyer/actionview-component
that referenced
this pull request
Nov 11, 2019
Adds a `#helpers` method that works as a proxy for components to access helper methods through. Inspired by a similar feature in Rails by @rafaelfranca: rails/rails#24866 Resolves: ViewComponent#95
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
It is a common pattern in the Rails community that when people want to
use any kind of helper that is defined inside app/helpers they includes
the helper module inside the controller like:
This has problem because the helper can't access anything that is
defined in the view level context class.
Also all public methods of the helper become available in the controller
what can lead to undesirable methods being routed and behaving as
actions.
Also if you helper depends on other helpers or even Action View helpers
you need to include each one of these dependencies in your controller
otherwise your helper is not going to work.
We already have a helpers proxy at controller class level but that proxy
doesn't have access to the instance variables defined in the
controller.
With this new instance level helper proxy users can reuse helpers in the
controller without having to include the modules and with access to
instance variables defined in the controller.