lookbook 2.0.5 → 2.3.2

data/assets/js/app.js

@@ -25,6 +25,12 @@ export default function app() {
         const socket = createSocket(window.SOCKET_PATH);
         socket.addListener("Lookbook::ReloadChannel", () => this.updateDOM());
       }
+
+      this.$watch("$store.layout.mobile", (mobile) => {
+        if (!mobile) {
+          this.$store.layout.sidebar.hidden = true;
+        }
+      });
     },
 
     navigateTo(path) {
@@ -37,7 +43,9 @@ export default function app() {
       this.debug("Navigating to ", window.location.pathname);
       this.$dispatch("navigation:start");
       this.location = window.location;
-      await this.updateDOM();
+      await this.updateDOM("#app-main", {
+        headers: { "X-Lookbook-Frame": "main" },
+      });
       this.$dispatch("navigation:complete");
     },
 
@@ -59,16 +67,17 @@ export default function app() {
       }
     },
 
-    async updateDOM() {
+    async updateDOM(rootSelector = `#${this.$root.id}`, options = {}) {
       this.debug("Starting DOM update");
       this.$dispatch("dom:update-start");
       this.requestStart();
       try {
         const { fragment, title } = await fetchHTML(
           window.location,
-          `#${this.$root.id}`
+          rootSelector,
+          options
         );
-        morph(this.$root, fragment);
+        morph(document.querySelector(rootSelector), fragment);
         document.title = title;
         this.requestEnd();
         this.$dispatch("dom:update-complete");

data/assets/js/helpers/request.js

@@ -1,5 +1,5 @@
-async function fetchHTML(url, selector) {
-  const response = await fetch(url || window.document.location);
+async function fetchHTML(url, selector, options = {}) {
+  const response = await fetch(url || window.document.location, options);
   const html = await response.text();
   const doc = new DOMParser().parseFromString(html, "text/html");
   return {

data/config/app.yml

@@ -3,6 +3,7 @@ shared:
   project_logo: ~
 
   preview_collection_label: "Previews"
+  preview_nav_filter: true
   preview_paths: [test/components/previews]
   preview_display_options: {}
   preview_controller: "Lookbook::PreviewController"
@@ -10,6 +11,7 @@ shared:
   preview_inspector:
     main_panels: [preview, output]
     drawer_panels: [source, notes, params, "*"]
+    sidebar_panels: [previews, pages]
   preview_embeds:
     enabled: true
     policy: SAMEORIGIN
@@ -19,10 +21,13 @@ shared:
     display_option_controls: true
   preview_layout: ~
   preview_disable_action_view_annotations: true
+  preview_disable_action_view_partial_prefixes: true
   preview_type_default: view_component
   preview_sort_scenarios: false
+  preview_disable_error_handling: false
 
   page_collection_label: "Pages"
+  page_nav_filter: false
   page_controller: "Lookbook::PageController"
   page_route: pages
   page_paths: [test/components/docs]
@@ -62,7 +67,7 @@ shared:
   links:
     docs: https://v2.lookbook.build
     demo: https://v2-demo.lookbook.build
-    repo: https://github.com/ViewComponent/lookbook/tree/v2
+    repo: https://github.com/lookbook-hq/lookbook/tree/v2
 
 development:
   debug_menu: true

data/lib/lookbook/cable/cable.rb

@@ -1,6 +1,6 @@
 require "action_cable/engine"
-require_relative "./connection"
-require_relative "./reload_channel"
+require_relative "connection"
+require_relative "reload_channel"
 
 module Lookbook
   class Cable

data/lib/lookbook/engine.rb

@@ -62,7 +62,9 @@ module Lookbook
         ViewComponent::Preview.extend(Lookbook::PreviewAfterRender)
       end
 
-      opts.reload_on_change = host_config.reload_classes_only_on_change if opts.reload_on_change.nil?
+      if opts.reload_on_change.nil?
+        opts.reload_on_change = !host_config.cache_classes && host_config.reload_classes_only_on_change
+      end
     end
 
     config.after_initialize do

data/lib/lookbook/entities/collections/preview_collection.rb

@@ -44,10 +44,7 @@ module Lookbook
     end
 
     def entities
-      @_cache[:entities] ||= begin
-        all = collect_ordered_entities(to_tree(include_hidden: true))
-        all.filter { _1.is_a?(Lookbook::PreviewEntity) }
-      end
+      @_cache[:entities] ||= collect_ordered_entities(to_tree(include_hidden: true)).grep(Lookbook::PreviewEntity)
     end
 
     class << self

data/lib/lookbook/entities/entity.rb

@@ -65,6 +65,10 @@ module Lookbook
     alias_method :path, :lookup_path
     deprecate path: :lookup_path, deprecator: Deprecation
 
+    def search_terms
+      @_search_terms ||= lookup_path.split("/").map(&:titleize)
+    end
+
     # @!endgroup
 
     def <=>(other)

data/lib/lookbook/entities/page_entity.rb

@@ -105,7 +105,7 @@ module Lookbook
 
     # @api private
     def search_terms
-      label
+      lookup_path.split("/") << label
     end
 
     # @api private

data/lib/lookbook/entities/scenario_entity.rb

@@ -134,7 +134,7 @@ module Lookbook
 
     # @api private
     def search_terms
-      [parent.label, label]
+      [parent.search_terms, parent.label, label]
     end
 
     alias_method :lang, :source_lang

data/lib/lookbook/entities/scenario_group_entity.rb

@@ -124,7 +124,7 @@ module Lookbook
 
     # @api private
     def search_terms
-      [parent.label, label]
+      [parent.search_terms, parent.label, label]
     end
 
     # @api private

data/lib/lookbook/file_watcher.rb

@@ -13,7 +13,7 @@ module Lookbook
 
       def file_watcher
         @_file_watcher ||= begin
-          require_relative "./support/evented_file_update_checker"
+          require_relative "support/evented_file_update_checker"
 
           EventedFileUpdateChecker
         rescue LoadError

data/lib/lookbook/helpers/ui_elements_helper.rb

@@ -18,7 +18,7 @@ module Lookbook
     # @param name [Symbol, String] Name of the icon
     # @param opts [Hash] Options hash
     def icon(name, **opts)
-      lookbook_render :icon, name: name, **opts
+      lookbook_render(:icon, name: name, **opts)
     end
 
     # Display a syntax-highlighted block of code.
@@ -36,12 +36,12 @@ module Lookbook
 
     # @api private
     def prose(**opts, &block)
-      lookbook_render :prose, **opts, &block
+      lookbook_render(:prose, **opts, &block)
     end
 
     # @api private
     def lookbook_tag(tag = :div, **attrs, &block)
-      lookbook_render :tag, tag: tag, **attrs, &block
+      lookbook_render(:tag, tag: tag, **attrs, &block)
     end
 
     # @api private

data/lib/lookbook/param.rb

@@ -28,7 +28,7 @@ module Lookbook
       val = @value || value_default
       if value_type == "datetime"
         formatter = (input == "datetime-local") ? "%Y-%m-%dT%T" : "%Y-%m-%d"
-        StringValueCaster.call(val, "datetime").strftime(formatter)
+        StringValueCaster.call(val, "datetime")&.strftime(formatter)
       else
         val
       end

data/lib/lookbook/preview.rb

@@ -11,6 +11,7 @@ module Lookbook
           template: args[:template] || Lookbook.config.preview_template,
           args: args,
           locals: args[:locals] || {},
+          assigns: args[:assigns] || {},
           block: block
         }
       else

data/lib/lookbook/preview_controller_actions.rb

@@ -4,7 +4,7 @@ module Lookbook
 
     included do
       helper PreviewHelper
-      helper Rails.application.routes.url_helpers
+      send(:helper, Rails.application.routes.url_helpers) # YARD parsing workaround: https://github.com/lsegal/yard/issues/546
       prepend_view_path Engine.root.join("app/views")
 
       def render_scenario_to_string(preview, scenario)
@@ -18,26 +18,26 @@ module Lookbook
         locals = @render_args[:locals]
         opts = {}
         opts[:layout] = nil
+        opts[:assigns] = @render_args[:assigns] || {}
         opts[:locals] = locals if locals.present?
 
-        rendered = render_to_string(template, **opts)
+        with_action_view_settings do
+          rendered = render_to_string(template, **opts)
 
-        if scenario.after_render_method.present?
-          render_context = Store.new({
-            preview: preview,
-            scenario: scenario,
-            params: user_request_parameters
-          })
-          rendered = @preview.after_render(method: scenario.after_render_method, html: rendered, context: render_context)
-        end
-
-        with_optional_action_view_annotations do
+          if scenario.after_render_method.present?
+            render_context = Store.new({
+              preview: preview,
+              scenario: scenario,
+              params: user_request_parameters
+            })
+            rendered = @preview.after_render(method: scenario.after_render_method, html: rendered, context: render_context)
+          end
           render html: rendered
         end
       end
 
       def render_in_layout_to_string(template, locals, opts = {})
-        with_optional_action_view_annotations do
+        with_action_view_settings do
           html = render_to_string(template, locals: locals, **determine_layout(opts[:layout]))
           if opts[:append_html].present?
             html += opts[:append_html]
@@ -48,9 +48,12 @@ module Lookbook
 
       protected
 
-      def with_optional_action_view_annotations(&block)
-        disable = Lookbook.config.preview_disable_action_view_annotations
-        ActionViewAnnotationsHandler.call(disable_annotations: disable, &block)
+      def with_action_view_settings(&block)
+        ActionViewConfigHandler.call(
+          disable_annotations: Lookbook.config.preview_disable_action_view_annotations,
+          disable_partial_prefixes: Lookbook.config.preview_disable_action_view_partial_prefixes,
+          &block
+        )
       end
 
       def user_request_parameters

data/lib/lookbook/services/data/resolvers/data_resolver.rb

@@ -47,7 +47,7 @@ module Lookbook
             eval_context.instance_eval(input.to_s)
           }.call
         rescue => exception
-          raise_error "Could not evaluate statetment (#{exception.message})", exception
+          raise_error "Could not evaluate statement (#{exception.message})", exception
         end
       else
         Lookbook.logger.debug "Data cannot be evaluated (Input: '#{input}')"

data/lib/lookbook/services/templates/action_view_config_handler.rb

@@ -0,0 +1,50 @@
+module Lookbook
+  class ActionViewConfigHandler < Service
+    attr_reader :disable_annotations, :disable_partial_prefixes
+
+    def initialize(disable_annotations: true, disable_partial_prefixes: true)
+      @disable_annotations = disable_annotations
+      @disable_partial_prefixes = disable_partial_prefixes
+    end
+
+    def call
+      handle_annotations
+      handle_partial_prefixes
+
+      yield
+    ensure
+      restore_annotations
+      restore_partial_prefixes
+    end
+
+    private
+
+    def handle_annotations
+      return unless disable_annotations && ActionView::Base.respond_to?(:annotate_rendered_view_with_filenames)
+
+      @original_annotations_value = ActionView::Base.annotate_rendered_view_with_filenames
+      ActionView::Base.annotate_rendered_view_with_filenames = false
+    end
+
+    def restore_annotations
+      return if @original_annotations_value.nil?
+
+      ActionView::Base.annotate_rendered_view_with_filenames = @original_annotations_value
+      @original_annotations_value = nil
+    end
+
+    def handle_partial_prefixes
+      return unless disable_partial_prefixes && ActionView::Base.respond_to?(:prefix_partial_path_with_controller_namespace)
+
+      @original_partial_prefix_value = ActionView::Base.prefix_partial_path_with_controller_namespace
+      ActionView::Base.prefix_partial_path_with_controller_namespace = false
+    end
+
+    def restore_partial_prefixes
+      return if @original_partial_prefix_value.nil?
+
+      ActionView::Base.prefix_partial_path_with_controller_namespace = @original_partial_prefix_value
+      @original_partial_prefix_value = nil
+    end
+  end
+end

data/lib/lookbook/stores/config_store.rb

@@ -59,6 +59,10 @@ module Lookbook
       store[:highlighter_options].merge!(options.to_h)
     end
 
+    def preview_disable_error_handling=(value)
+      store[:preview_disable_error_handling] = value
+    end
+
     def ui_theme=(name)
       name = name.to_s
       if Theme.valid_theme?(name)

data/lib/lookbook/theme.rb

@@ -30,19 +30,15 @@ module Lookbook
     end
 
     def favicon_light_mode
-      (
-        @overrides[:favicon_light_mode].presence ||
+      @overrides[:favicon_light_mode].presence ||
         @overrides[:favicon].presence ||
         BASE_THEMES[@base_theme.to_sym][:favicon_light_mode]
-      )
     end
 
     def favicon_dark_mode
-      (
-        @overrides[:favicon_dark_mode].presence ||
+      @overrides[:favicon_dark_mode].presence ||
         @overrides[:favicon].presence ||
         BASE_THEMES[@base_theme.to_sym][:favicon_dark_mode]
-      )
     end
 
     def to_css

data/lib/lookbook/version.rb

@@ -1,3 +1,3 @@
 module Lookbook
-  VERSION = "2.0.5"
+  VERSION = "2.3.2"
 end

data/lib/lookbook/websocket.rb

@@ -2,7 +2,7 @@ module Lookbook
   class Websocket
     class << self
       def new(mount_path, **kwargs)
-        require_relative "./cable/cable"
+        require_relative "cable/cable"
 
         Cable.new(mount_path, **kwargs)
       rescue LoadError