Preview Components that require helpers

[henrikbjorn]

Hey

Thanks for the work on this gem. Works great and we are starting to test it out.

Some of our old view code uses gems such as breadcrumbs_on_rails (https://github.com/weppos/breadcrumbs_on_rails/) which hooks into ActionController and as a helper.

This gives us a problem during previews, as we can't call the method add_breadcrumb from inside a preview.

a controller would look like this

class AwesomeController < ApplicationController
  def index
    add_breadcrumb "Super awesome title", root_path
    # .. and so on
  end
end

The component would be a simple wrapper component that delegates to the helper delegate :render_breadcrumbs, to: :helpers and then the template would contain:

<div class="breadcrumbs_wrapper">
  <%= render_breadcrumbs separator: ' > ' %>
</div>

The preview would be:

class BreadcrumbsComponentPreview < ViewComponent::Preview
  include Rails.application.routes.url_helpers

  def default
    add_breadcrumb "Awesome Title", root_path
    render BreadcrumbsComponent.new
  end
end

Any idea on how to get the ActionController context here, so that the preview can work ?

[henrikbjorn]

Gonna answer my own questions by throwing code at it:

# frozen_string_literal: true

class Settings::BreadcrumbsComponent < ApplicationComponent

  def initialize(breadcrumbs: [], **options)
    @breadcrumbs = breadcrumbs.map { |b| wrap_element(b) }

    @options = options.merge(
      separator: ' <span class=\'seperator\'>></span> '
    )
  end

  def breadcrumbs
    builder.render.html_safe
  end

  protected

  def builder
    @builder ||= BreadcrumbsOnRails::Breadcrumbs::SimpleBuilder.new(self, @breadcrumbs || helpers.breadcrumbs, @options)
  end

  def wrap_element(elm)
    return elm unless elm.is_a? Array

    BreadcrumbsOnRails::Breadcrumbs::Element.new(b.first, b.last)
  end
end