lookbook 3.0.0.alpha.1 → 3.0.0.alpha.2

data/lib/lookbook/directory_entity.rb

@@ -0,0 +1,72 @@
+module Lookbook
+  class DirectoryEntity < Entity
+    include EntityTreeNode
+
+    CONFIG_FILE_NAME = "_config.yml"
+
+    attr_reader :lookup_path
+
+    def initialize(lookup_path, path: nil)
+      @lookup_path = lookup_path
+      @path = path
+      @type = :directory
+    end
+
+    def id
+      @id ||= Utils.id(lookup_path)
+    end
+
+    def name
+      @name ||= lookup_path.split("/").pop
+    end
+
+    def label
+      config.fetch(:label, super)
+    end
+
+    def hidden?
+      config.fetch(:hidden, false) || children.select(&:visible?).none?
+    end
+
+    def path
+      Pathname(@path) if @path
+    end
+
+    def exists?
+      path ? File.exist?(path) : false
+    end
+
+    def children
+      raise Lookbook::Error, "DirectoryEntity subclasses must define a #children method"
+    end
+
+    def parent
+      raise Lookbook::Error, "DirectoryEntity subclasses must define a #parent method"
+    end
+
+    def to_h
+      {
+        entity: "directory",
+        name: name,
+        label: label,
+        lookup_path: lookup_path,
+        path: path.to_s,
+        children: children.map(&:to_h)
+      }
+    end
+
+    protected
+
+    def config
+      @config ||= begin
+        opts = if exists?
+          config_file_path = File.join(path, CONFIG_FILE_NAME)
+          if File.exist?(config_file_path)
+            YAML.safe_load_file(config_file_path)
+          end
+        end
+        DataObject.new(opts || {})
+      end
+    end
+  end
+end

data/lib/lookbook/engine.rb

@@ -13,7 +13,7 @@ module Lookbook
     end
 
     config.to_prepare do
-      ViewComponentConfigSync.call if Gem.loaded_specs.has_key?("view_component")
+      ViewComponentConfigSync.call if Utils.gem_installed?("view_component")
 
       preview_controller = Lookbook.config.preview_controller.constantize
       unless preview_controller.include?(Lookbook::PreviewControllerActions)

data/lib/lookbook/entity.rb

@@ -1,5 +1,7 @@
 module Lookbook
   class Entity
+    DEFAULT_PRIORITY = 1
+
     send(:include, Lookbook::Engine.routes.url_helpers) # YARD parsing workaround: https://github.com/lsegal/yard/issues/546
 
     def id
@@ -29,7 +31,7 @@ module Lookbook
     end
 
     def priority
-      default_priority || 0
+      default_priority || DEFAULT_PRIORITY
     end
 
     attr_reader :default_priority
@@ -39,7 +41,7 @@ module Lookbook
     end
 
     def <=>(other)
-      [priority || Float::INFINITY, label] <=> [other.priority || Float::INFINITY, other.label]
+      [priority || DEFAULT_PRIORITY, label.downcase] <=> [other.priority || DEFAULT_PRIORITY, other.label.downcase]
     end
 
     def parent_lookup_path = nil

data/lib/lookbook/entity_tree.rb

@@ -4,13 +4,19 @@ module Lookbook
 
     attr_reader :lookup_path
 
-    def initialize(leaf_nodes = [])
+    def initialize(leaf_nodes = [], config_path: nil)
       @leaf_nodes = leaf_nodes
+      @config_path = config_path
       @lookup_path = ""
     end
 
     def children
-      @children ||= nodes.select { _1.depth == 1 }.sort
+      @children ||= begin
+        child_nodes = nodes.select { _1.depth == 1 }.sort
+        ListResolver.call(config.fetch(:children, "*"), child_nodes.map(&:name)) do |name|
+          child_nodes.find { _1.name == name }
+        end
+      end
     end
 
     def children_of(parent)
@@ -61,5 +67,14 @@ module Lookbook
         [node, child_nodes]
       end
     end
+
+    def config
+      @config ||= begin
+        opts = if @config_path && File.exist?(@config_path)
+          YAML.safe_load_file(@config_path)
+        end
+        DataObject.new(opts || {})
+      end
+    end
   end
 end

data/lib/lookbook/pages/page_directories.rb

@@ -0,0 +1,20 @@
+module Lookbook
+  class PageDirectories
+    def initialize
+      @directories = []
+    end
+
+    def find_or_add(lookup_path, path = nil)
+      find(lookup_path) || add(lookup_path, path)
+    end
+
+    def find(lookup_path)
+      @directories.find { _1.lookup_path == lookup_path }
+    end
+
+    def add(lookup_path, path = nil)
+      @directories << PageDirectoryEntity.new(lookup_path, path: path)
+      @directories.last
+    end
+  end
+end

data/lib/lookbook/pages/page_directory_entity.rb

@@ -1,55 +1,24 @@
 module Lookbook
-  class PageDirectoryEntity < Entity
-    include EntityTreeNode
-
-    attr_reader :path
-
-    def initialize(path, default_priority: nil)
-      @path = Pathname(path)
-      @default_priority = default_priority
-      @type = :directory
-    end
-
-    def lookup_path
-      @lookup_path ||= PathPriorityPrefixesStripper.call(path)
-    end
-
-    def id
-      @id ||= Utils.id(lookup_path)
-    end
-
-    def name
-      @name ||= lookup_path.split("/").pop
-    end
-
+  class PageDirectoryEntity < DirectoryEntity
     def children
-      @children ||= Pages.tree.children_of(self).sort
-    end
-
-    def hidden?
-      children.select(&:visible?).none?
+      @children ||= begin
+        child_nodes = Pages.tree.children_of(self).sort
+        ListResolver.call(config.fetch(:children, "*"), child_nodes.map(&:name)) do |name|
+          child_nodes.find { _1.name == name }
+        end
+      end
     end
 
     def parent
       parent_lookup_path = File.dirname(lookup_path).delete_prefix(".")
-      Pages.directories.find { _1.lookup_path == parent_lookup_path }
+      Pages.directories.find_or_add(parent_lookup_path, File.dirname(path)) if parent_lookup_path.present?
     end
 
     def priority
       @priority = begin
-        pos = PriorityPrefixParser.call(File.basename(path)).first || @default_priority
+        pos = PriorityPrefixParser.call(File.basename(path)).first || Entity::DEFAULT_PRIORITY
         pos.to_i
       end
     end
-
-    def to_h
-      {
-        entity: "directory",
-        name: name,
-        label: label,
-        lookup_path: lookup_path,
-        children: children.map(&:to_h)
-      }
-    end
   end
 end

data/lib/lookbook/pages/page_entity.rb

@@ -56,7 +56,9 @@ module Lookbook
     end
 
     def parent
-      Pages.directories.find { _1.lookup_path == parent_lookup_path }
+      if parent_lookup_path.present?
+        Pages.directories.find_or_add(parent_lookup_path, File.dirname(file_path))
+      end
     end
 
     def next
@@ -69,7 +71,7 @@ module Lookbook
 
     def priority
       @priority = begin
-        pos = PriorityPrefixParser.call(file_name).first || metadata.fetch(:priority, 0)
+        pos = PriorityPrefixParser.call(file_name).first || metadata.fetch(:priority, Entity::DEFAULT_PRIORITY)
         pos.to_i
       end
     end

data/lib/lookbook/pages/pages.rb

@@ -30,7 +30,10 @@ module Lookbook
       def tree
         @tree ||= begin
           debug("pages: building tree")
-          EntityTree.new(store.all)
+
+          config_dir = page_paths.detect { Dir["#{_1}/#{DirectoryEntity::CONFIG_FILE_NAME}"].first }
+          config_path = File.join(config_dir, DirectoryEntity::CONFIG_FILE_NAME) if config_dir
+          EntityTree.new(store.all, config_path: config_path)
         end
       end
 
@@ -44,19 +47,7 @@ module Lookbook
         Utils.deep_camelize_keys(to_data(...))
       end
 
-      def directories
-        @directories ||= begin
-          dirnames = store.all.map { _1.relative_file_path.dirname.to_s.delete_prefix(".") }.compact_blank.uniq
-          directory_paths = dirnames.flat_map do |path|
-            current_path = ""
-            path.split("/").map do |segment|
-              current_path = "#{current_path}/#{segment}".delete_prefix("/")
-            end
-          end
-          sorted_paths = directory_paths.uniq.sort
-          sorted_paths.map.with_index(1) { PageDirectoryEntity.new(_1, default_priority: _2) }
-        end
-      end
+      def directories = @directories ||= PageDirectories.new
 
       def reloader
         Reloader.new(:pages, watch_paths, watch_extensions) do |changes|

data/lib/lookbook/previews/preview_directories.rb

@@ -0,0 +1,20 @@
+module Lookbook
+  class PreviewDirectories
+    def initialize
+      @directories = []
+    end
+
+    def find_or_add(lookup_path, path = nil)
+      find(lookup_path) || add(lookup_path, path)
+    end
+
+    def find(lookup_path)
+      @directories.find { _1.lookup_path == lookup_path }
+    end
+
+    def add(lookup_path, path = nil)
+      @directories << PreviewDirectoryEntity.new(lookup_path, path: path)
+      @directories.last
+    end
+  end
+end

data/lib/lookbook/previews/preview_directory_entity.rb

@@ -1,44 +1,17 @@
 module Lookbook
-  class PreviewDirectoryEntity < Entity
-    include EntityTreeNode
-
-    attr_reader :lookup_path
-
-    def initialize(lookup_path, default_priority: nil)
-      @lookup_path = lookup_path
-      @default_priority = default_priority
-      @type = :directory
-    end
-
-    def id
-      @id ||= Utils.id(lookup_path)
-    end
-
-    def name
-      @name ||= lookup_path.split("/").pop
-    end
-
+  class PreviewDirectoryEntity < DirectoryEntity
     def children
-      @children ||= Previews.tree.children_of(self).sort
-    end
-
-    def hidden?
-      children.select(&:visible?).none?
+      @children ||= begin
+        child_nodes = Previews.tree.children_of(self).sort
+        ListResolver.call(config.fetch(:children, "*"), child_nodes.map(&:name)) do |name|
+          child_nodes.find { _1.name == name }
+        end
+      end
     end
 
     def parent
       parent_lookup_path = File.dirname(lookup_path).delete_prefix(".")
-      Previews.directories.find { _1.lookup_path == parent_lookup_path }
-    end
-
-    def to_h
-      {
-        entity: "directory",
-        name: name,
-        label: label,
-        lookup_path: lookup_path,
-        children: children.map(&:to_h)
-      }
+      Previews.directories.find_or_add(parent_lookup_path, File.dirname(path)) if parent_lookup_path.present?
     end
   end
 end

data/lib/lookbook/previews/preview_entity.rb

@@ -1,6 +1,7 @@
 module Lookbook
   class PreviewEntity < Entity
     include EntityTreeNode
+    include FeatureChecks
 
     attr_reader :preview_class, :preview_class_name, :preview_methods, :file_path, :metadata
 
@@ -35,10 +36,6 @@ module Lookbook
       metadata.status(default: Lookbook.config.preview_default_status)
     end
 
-    def priority
-      metadata.fetch(:priority, super)
-    end
-
     def url_param
       case Lookbook.config.preview_url_param.to_sym
       when :uuid
@@ -152,11 +149,13 @@ module Lookbook
     end
 
     def mailer_preview?
-      preview_class.ancestors.include?(::ActionMailer::Preview)
+      action_mailer_available? && preview_class.ancestors.include?(::ActionMailer::Preview)
     end
 
     def parent
-      Previews.directories.find { _1.lookup_path == parent_lookup_path }
+      if parent_lookup_path.present?
+        Previews.directories.find_or_add(parent_lookup_path, File.dirname(file_path))
+      end
     end
 
     def children
@@ -181,9 +180,9 @@ module Lookbook
     private
 
     def default_readme_path
-      preview_base_path = file_path.to_s.delete_suffix("_preview.rb")
+      preview_basename = File.basename(file_path)
       page_extensions_glob = "{#{Lookbook.config.page_extensions.join(",")}}"
-      readme_path = Dir["#{preview_base_path}*.#{page_extensions_glob}"].first
+      readme_path = Dir["#{preview_basename}.#{page_extensions_glob}"].first
       Pathname(readme_path) if readme_path
     end
 

data/lib/lookbook/previews/previews.rb

@@ -2,6 +2,7 @@ module Lookbook
   module Previews
     class << self
       include Loggable
+      include FeatureChecks
 
       delegate_missing_to :store
 
@@ -31,7 +32,10 @@ module Lookbook
       def tree
         @tree ||= begin
           debug("previews: building tree")
-          EntityTree.new(inspector_targets)
+
+          config_dir = preview_paths.detect { Dir["#{_1}/#{DirectoryEntity::CONFIG_FILE_NAME}"].first }
+          config_path = File.join(config_dir, DirectoryEntity::CONFIG_FILE_NAME) if config_dir
+          EntityTree.new(inspector_targets, config_path: config_path)
         end
       end
 
@@ -54,13 +58,19 @@ module Lookbook
       def preview_class?(klass)
         if (defined?(ViewComponent) && klass.ancestors.include?(ViewComponent::Preview)) ||
             klass.ancestors.include?(Lookbook::Preview) ||
-            klass.ancestors.include?(::ActionMailer::Preview)
+            (action_mailer_available? && klass.ancestors.include?(::ActionMailer::Preview))
           !klass.respond_to?(:abstract_class) || klass.abstract_class != true
         end
       end
 
       def preview_paths
-        @preview_paths ||= Utils.normalize_paths(Lookbook.config.preview_paths)
+        @preview_paths ||= begin
+          action_mailer_paths = if Rails.application.config.respond_to?(:action_mailer)
+            Rails.application.config.action_mailer.preview_paths
+          end
+          paths = [Lookbook.config.preview_paths, action_mailer_paths].compact.flatten
+          Utils.normalize_paths(paths)
+        end
       end
 
       def component_paths
@@ -104,18 +114,7 @@ module Lookbook
         @inspector_targets ||= Previews.all.flat_map { _1.inspector_targets }
       end
 
-      def directories
-        @directories ||= begin
-          directory_paths = store.all.map(&:parent_lookup_path).compact_blank.uniq.flat_map do |path|
-            current_path = ""
-            path.split("/").map do |segment|
-              current_path = "#{current_path}/#{segment}".delete_prefix("/")
-            end
-          end
-          sorted_paths = directory_paths.uniq.sort
-          sorted_paths.map.with_index(1) { PreviewDirectoryEntity.new(_1, default_priority: _2) }
-        end
-      end
+      def directories = @directories ||= PreviewDirectories.new
 
       def statuses
         @statuses ||= Lookbook.config.preview_statuses.map do |name, props|

data/lib/lookbook/previews/scenario_entity.rb

@@ -86,7 +86,7 @@ module Lookbook
     def render_args(request_params: {})
       resolved_params = resolve_request_params(request_params)
       result = call_method(**resolved_params)
-      if result.is_a?(ActionMailer::Parameterized::MessageDelivery)
+      if mailer_preview?
         {
           email: result,
           template: Previews.scenario_template

data/lib/lookbook/reloader.rb

@@ -1,6 +1,7 @@
 module Lookbook
   class Reloader
     include Loggable
+    include FeatureChecks
 
     delegate :execute, :execute_if_updated, :updated?, to: :file_watcher
 
@@ -39,7 +40,7 @@ module Lookbook
           @last_changeset = nil
         end
 
-        if evented?
+        if listen_available?
           file_watcher.on_change do |changeset|
             if watching?(changeset.all)
               debug("#{name}: file changes detected")
@@ -54,7 +55,7 @@ module Lookbook
     end
 
     def file_watcher_class
-      if evented?
+      if listen_available?
         require_relative "evented_file_update_checker"
 
         Lookbook::EventedFileUpdateChecker
@@ -62,9 +63,5 @@ module Lookbook
         ActiveSupport::FileUpdateChecker
       end
     end
-
-    def evented?
-      Gem.loaded_specs.has_key?("listen")
-    end
   end
 end

data/lib/lookbook/services/list_resolver.rb

@@ -8,15 +8,26 @@ module Lookbook
     end
 
     def call(&resolver)
-      included = to_include.inject([]) do |result, name|
+      included = to_include.each_with_object([]) do |name, result|
         if name.to_s == "*"
-          result += item_set.select { |item| !result.include?(item) }
+          result << "*"
         elsif item_set.include?(name)
           result << name
         end
         result
       end
 
+      remaining_items = item_set.difference(included)
+      included = included.flat_map do |name|
+        if name == "*"
+          rest = remaining_items
+          remaining_items = []
+          rest
+        else
+          name
+        end
+      end
+
       resolved = resolver ? included.map { |item| resolver.call(item) } : included
       resolved.compact.uniq
     end

data/lib/lookbook/services/styles_extractor.rb

@@ -33,7 +33,7 @@ module Lookbook
     end
 
     def strip_styles(text)
-      iframes = text.scan(IFRAME_REGEX).flatten
+      iframes = text.scan(IFRAME_REGEX).flatten.map(&:strip).compact_blank
       iframes.each.with_index(1) { text.gsub!(_1, "IFRAME_#{_2}") }
       text = text.gsub(STYLE_TAGS_REGEX, "").strip
       iframes.each.with_index(1) { text.gsub!("IFRAME_#{_2}", _1) }

data/lib/lookbook/utils.rb

@@ -75,6 +75,10 @@ module Lookbook
           obj
         end
       end
+
+      def gem_installed?(name)
+        Gem.loaded_specs.has_key?(name)
+      end
     end
   end
 end

data/lib/lookbook/version.rb

@@ -1,3 +1,3 @@
 module Lookbook
-  VERSION = "3.0.0.alpha.1"
+  VERSION = "3.0.0.alpha.2"
 end

data/lib/lookbook.rb

@@ -1,5 +1,4 @@
 require "zeitwerk"
-require "action_mailer"
 require "yard"
 require_relative "lookbook/version"
 require_relative "lookbook/logger"

data/public/lookbook-assets/app.css

@@ -2402,6 +2402,8 @@ tr:not(:last-child) {
     grid-template-rows: 1fr;
     outline: 1px solid #d1d5db;
     outline: 1px solid var(--lb-color-surface-divider);
+    background-color: #fff;
+    background-color: var(--lb-viewport-background-color);
   }
 .resize-x[data-component="viewport"] .viewport-dimensions {
       right: 1rem;