Skip to content

Commit

Permalink
PreviewHelper: Rename private #find_template_data method to something…
Browse files Browse the repository at this point in the history
… less generic

The default Rails configuration loads the PreviewHelper for every controller.
We should use specific method names to prevent name clashes with user-provided helpers.
  • Loading branch information
triskweline committed Jun 14, 2024
1 parent 941da31 commit c0faca6
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion app/helpers/preview_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def prism_js_source_url
serve_static_preview_assets? ? asset_path("prism.min.js", skip_pipeline: true) : "https://cdn.jsdelivr.net/npm/[email protected]/prism.min.js"
end

def find_template_data(lookup_context:, template_identifier:)
def find_template_data_for_preview_source(lookup_context:, template_identifier:)
template = lookup_context.find_template(template_identifier)

if Rails.version.to_f >= 6.1 || template.source.present?
Expand Down
2 changes: 1 addition & 1 deletion app/views/view_components/_preview_source.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<%= h @preview.preview_source(@example_name) %>
</code>
<% else %>
<% template_data = find_template_data(lookup_context: @view_renderer.lookup_context, template_identifier: @render_args[:template]) %>
<% template_data = find_template_data_for_preview_source(lookup_context: @view_renderer.lookup_context, template_identifier: @render_args[:template]) %>
<code class="language-<%= template_data[:prism_language_name] %>">
<%= h template_data[:source] %>
</code>
Expand Down
12 changes: 6 additions & 6 deletions test/sandbox/test/preview_helper_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def test_returns_template_data_with_no_template
lookup_context = Minitest::Mock.new
lookup_context.expect(:find_template, mock_template, [template_identifier])

template_data = PreviewHelper.find_template_data(
template_data = PreviewHelper.find_template_data_for_preview_source(
lookup_context: lookup_context,
template_identifier: template_identifier
)
Expand All @@ -40,7 +40,7 @@ def test_returns_template_data_with_template_of_different_languages
lookup_context = Minitest::Mock.new
lookup_context.expect(:find_template, mock_template, [template_identifier])

template_data = PreviewHelper.find_template_data(
template_data = PreviewHelper.find_template_data_for_preview_source(
lookup_context: lookup_context,
template_identifier: template_identifier
)
Expand Down Expand Up @@ -68,7 +68,7 @@ def test_returns_template_data_without_dedicated_template
mock = Minitest::Mock.new
mock.expect :map, [expected_template_path]
ViewComponent::Base.stub(:preview_paths, mock) do
template_data = PreviewHelper.find_template_data(
template_data = PreviewHelper.find_template_data_for_preview_source(
lookup_context: lookup_context,
template_identifier: template_identifier
)
Expand Down Expand Up @@ -96,7 +96,7 @@ def test_returns_template_data_with_dedicated_template
mock.expect :map, [expected_template_path]
Rails.application.config.view_component.stub(:preview_paths, mock) do
File.stub(:read, expected_source, [expected_template_path]) do
template_data = PreviewHelper.find_template_data(
template_data = PreviewHelper.find_template_data_for_preview_source(
lookup_context: lookup_context,
template_identifier: template_identifier
)
Expand All @@ -122,7 +122,7 @@ def test_raises_with_no_matching_template
mock.expect :map, []
Rails.application.config.view_component.stub :preview_paths, mock do
exception = assert_raises ViewComponent::NoMatchingTemplatesForPreviewError do
PreviewHelper.find_template_data(
PreviewHelper.find_template_data_for_preview_source(
lookup_context: lookup_context,
template_identifier: template_identifier
)
Expand All @@ -146,7 +146,7 @@ def test_raises_with_conflict_in_template_resolution
mock.expect :map, [template_identifier + ".html.haml", template_identifier + ".html.erb"]
Rails.application.config.view_component.stub :preview_paths, mock do
exception = assert_raises ViewComponent::MultipleMatchingTemplatesForPreviewError do
PreviewHelper.find_template_data(
PreviewHelper.find_template_data_for_preview_source(
lookup_context: lookup_context,
template_identifier: template_identifier
)
Expand Down

0 comments on commit c0faca6

Please sign in to comment.