Create template helper for Scrapbook pages #4
Conversation
This file contains 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
I want to create some potentially useful helper methods that users can use inside their Scrapbook pages, but I don't want to potentially conflict with any helper methods they have created. My solution is to create a helper method named `sb` that returns an object that will have the helper methods as its methods. For example, to get access to the current Scrapbook object, a user can now call `sb.scrapbook`. (This should eventually limit the potential conflicts to just `sb` — right now both `pathname` and `scrapbook` could conflict because I pass them as locals.
These locals will eventually be removed in favor of using the `sb` helper method. Code needs to be updated to call `sb.scrapbook` and `sb.pathname` instead. This should mean that the only possible conflict that the Scrapbook gem could have with the host's helper methods will eventually just be `sb`.
bfad
force-pushed
the
template-helper
branch
from
4316ca9
to
5a31d69
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This creates a helper method named
sbthat can be used by the Scrapbook gem to provide helper methods to be used by the Scrapbook pages of the host application. The idea is that all the helper methods the Scrapbook gem creates will actually be methods on the object thatsbreturns. This enables us to minimize potential name conflicts with the host-app's helper methods. For example, in the future I want to be able to create example could and display its source. I may make a method named "display_view_source" that users could use in their Scrapbook pages by callingsb.display_view_source, and this wouldn't conflict with their own definition of "display_view_source" that they could potentially have in their host application.Since I'm making this move, I'm also making
scrapbookandpathnamemethods available to the object returned bysb. Right now every Scrapbook page is rendered withscrapbookandpathnameas locals to those views, but in the future users will need to access them withsb.scrapbookandsb.pathname. Eventually, only thesbmethod could possibly conflict.