lookbook 1.3.3 → 1.4.0

data/lib/lookbook/param.rb

@@ -33,10 +33,10 @@ module Lookbook
     end
 
     def input_options
-      return @input_options if @input_options
+      return @_input_options if @_input_options
 
       runtime_options = options.except([*methods, :name, :value_default, :description])
-      @input_options ||= Store.new(input_config.options.merge(runtime_options))
+      @_input_options ||= Store.new(input_config.options.merge(runtime_options))
     end
 
     def input_partial

data/lib/lookbook/preview_parser.rb

@@ -26,7 +26,7 @@ module Lookbook
     end
 
     def paths
-      PathUtils.normalize_all(@paths).map { |path| "#{path}/**/*preview.rb" }
+      PathUtils.normalize_paths(@paths).map { |path| "#{path}/**/*preview.rb" }
     end
 
     protected

data/lib/lookbook/rendered_example.rb

@@ -0,0 +1,37 @@
+module Lookbook
+  class RenderedExample
+    delegate_missing_to :example
+
+    attr_reader :output, :example
+
+    def initialize(example, output, params)
+      @example = example
+      @params = params
+      @output = output
+    end
+
+    def source
+      has_custom_template? ? template_source(template) : example.source
+    end
+
+    def source_lang
+      has_custom_template? ? template_lang(template) : example.source_lang
+    end
+
+    protected
+
+    attr_reader :params
+
+    def render_args
+      @_render_args ||= preview.render_args(example.name, params: params)
+    end
+
+    def template
+      render_args[:template]
+    end
+
+    def has_custom_template?
+      template != "view_components/preview" && !custom_source?
+    end
+  end
+end

data/lib/lookbook/services/code/code_beautifier.rb

@@ -12,7 +12,7 @@ module Lookbook
     def call
       language = opts.fetch(:language, "html")
       stripped_source = source.strip
-      result = language.downcase == "html" ? HtmlBeautifier.beautify(stripped_source, opts) : stripped_source
+      result = (language.downcase == "html") ? HtmlBeautifier.beautify(stripped_source, opts) : stripped_source
       result.to_s.strip.html_safe
     rescue
       source.strip.html_safe

data/lib/lookbook/services/code/code_highlighter.rb

@@ -11,7 +11,7 @@ module Lookbook
     end
 
     def opts
-      @opts.is_a?(String) || @opts.is_a?(Symbol) ? {language: @opts} : @opts.to_h
+      (@opts.is_a?(String) || @opts.is_a?(Symbol)) ? {language: @opts} : @opts.to_h
     end
 
     def call

data/lib/lookbook/services/code/code_indenter.rb

@@ -0,0 +1,14 @@
+module Lookbook
+  class CodeIndenter < Service
+    def initialize(source)
+      @source = source.to_s
+    end
+
+    def call
+      source = @source.chomp
+      last = source.split(/\r?\n/).last
+      indent = last ? last[/^([ \t]*)/, 1].length : 0
+      source.gsub(/^[ \t]{#{indent}}/, "")
+    end
+  end
+end

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

@@ -11,8 +11,8 @@ module Lookbook
       @permit_eval = permit_eval
       @fail_silently = fail_silently
       @fallback = fallback
-      @base_dir = base_dir
-      @file = file
+      @base_dir = base_dir.to_s
+      @file = file.to_s
     end
 
     def call

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

@@ -1,6 +1,6 @@
 module Lookbook
   class MethodResolver < DataResolver
-    MATCHER = /(:([a-zA-Z_\d]+))$/
+    MATCHER = /(:{1}([a-zA-Z_\d]+))$/
     MATCH_INDEX = 2
 
     def resolve(input)

data/lib/lookbook/services/entities/entity_tree_builder.rb

@@ -0,0 +1,45 @@
+module Lookbook
+  class EntityTreeBuilder < Service
+    attr_reader :include_hidden
+
+    def initialize(entities, include_hidden: false)
+      @entities = entities.to_a
+      @include_hidden = include_hidden
+    end
+
+    def call
+      root_node = TreeNode.new
+      entities.each do |entity|
+        current_node = root_node
+        path_segments = parse_segments(entity.logical_path)
+        path_segments.each.with_index(1) do |segment, i|
+          name, position_prefix = segment
+          content = entity if entity.depth == i # entities are always on the leaf nodes
+
+          current_node.add_child(name, content, position: position_prefix) unless current_node.has_child?(name)
+          current_node = current_node.get_child(name)
+
+          if content && content.type == :preview
+            content.visible_examples.each do |example|
+              current_node.add_child(example.name, example)
+            end
+          end
+        end
+      end
+      root_node
+    end
+
+    def parse_segments(path)
+      path.split("/").map do |segment|
+        unless segment.start_with?(".")
+          position, name = PositionPrefixParser.call(segment)
+          [name, position || 10000]
+        end
+      end.compact
+    end
+
+    def entities
+      include_hidden ? @entities : @entities.select(&:visible?)
+    end
+  end
+end

data/lib/lookbook/services/position_prefix_parser.rb

@@ -0,0 +1,16 @@
+module Lookbook
+  class PositionPrefixParser < Service
+    POSITION_PREFIX_REGEX = /^(\d+?)[-_]/
+
+    attr_reader :input
+
+    def initialize(input)
+      @input = String(input)
+    end
+
+    def call
+      matches = input.match(POSITION_PREFIX_REGEX)
+      matches ? [matches[1].to_i, input.gsub(POSITION_PREFIX_REGEX, "")] : [nil, input]
+    end
+  end
+end

data/lib/lookbook/stores/config_store.rb

@@ -10,7 +10,7 @@ module Lookbook
     end
 
     def project_name=(name)
-      store[:project_name] = name == false ? nil : name
+      store[:project_name] = (name == false) ? nil : name
     end
 
     def page_paths=(paths = nil)

data/lib/lookbook/stores/panel_store.rb

@@ -96,7 +96,7 @@ module Lookbook
       config.each do |group, panels|
         panels.map! do |opts|
           opts.transform_values! do |value|
-            value.is_a?(String) && value.start_with?("->") ? eval(value) : value # standard:disable Security/Eval
+            (value.is_a?(String) && value.start_with?("->")) ? eval(value) : value # standard:disable Security/Eval
           end
         end
       end
@@ -111,7 +111,7 @@ module Lookbook
     end
 
     def insert_index(position, items_count)
-      index = position == 0 ? 1 : (position || 0).to_int
+      index = (position == 0) ? 1 : (position || 0).to_int
       last_position = items_count + 1
       index = last_position if index > last_position
       index - 1

data/lib/lookbook/support/store.rb

@@ -25,39 +25,6 @@ module Lookbook
       true
     end
 
-    # def [](key)
-    #   key = key.to_sym
-    #   if respond_to? key
-    #     public_send(key)
-    #   else
-    #     self[key]
-    #   end
-    # end
-
-    # def []=(key, value)
-    #   setter_key = "#{key}=".to_sym
-    #   if respond_to? setter_key
-    #     public_send(setter_key, value)
-    #   else
-    #     _set(key.to_sym, normalize_value(value))
-    #   end
-    # end
-
-    # def method_missing(key, *args)
-    #   if key.to_s.end_with?("=")
-    #     args[0] = normalize_value(args[0])
-    #   end
-    #   public_send(key.to_sym, *args)
-    # end
-
-    # def respond_to_missing?(key, *args)
-    #   key?(key.to_sym)
-    # end
-
-    # def fetch(key, *args)
-    #   super.fetch(key.to_sym, *args)
-    # end
-
     def to_h
       transform_values do |value|
         value.is_a?(Store) ? value.to_h : value
@@ -71,7 +38,7 @@ module Lookbook
     protected
 
     def normalize_value(value)
-      @recursive && !value.is_a?(Store) && value.is_a?(Hash) ? Store.new(value, recursive: @recursive) : value
+      (@recursive && !value.is_a?(Store) && value.is_a?(Hash)) ? Store.new(value, recursive: @recursive) : value
     end
   end
 end

data/lib/lookbook/support/tree_node.rb

@@ -0,0 +1,83 @@
+module Lookbook
+  class TreeNode
+    include Enumerable
+
+    delegate_missing_to :content
+
+    attr_accessor :path, :content
+    attr_reader :children
+
+    def initialize(path = nil, content = nil, position: 10000)
+      @path = path.to_s
+      @content = content
+      @position = position
+      @children = []
+    end
+
+    def id
+      Utils.id(content_value(:id, path))
+    end
+
+    def name
+      segments.last
+    end
+
+    def label
+      content_value(:label, name.titleize)
+    end
+
+    def position
+      content_value(:position, @position)
+    end
+
+    def type
+      content_value(:type, :directory)
+    end
+
+    def depth
+      path.split("/").size
+    end
+
+    def add_child(name, content = nil, position: 10000)
+      children << TreeNode.new("#{path}/#{name}", content, position: position)
+      sort_children
+    end
+
+    def has_child?(name)
+      !!get_child(name)
+    end
+
+    def get_child(name)
+      children.find { |child| child.name == name }
+    end
+
+    def content?
+      content.present?
+    end
+
+    def each(&block)
+      if block
+        children.each do |child|
+          yield child
+        end
+      else
+        to_enum(:each)
+      end
+    end
+
+    protected
+
+    def content_value(method_name, fallback = nil)
+      value = content.send(method_name) if content
+      value || fallback
+    end
+
+    def sort_children
+      @children.sort_by! { |child| [child.position, child.label] }
+    end
+
+    def segments
+      path.split("/")
+    end
+  end
+end

data/lib/lookbook/support/utils/path_utils.rb

@@ -5,10 +5,30 @@ module Lookbook
         File.absolute_path(path.to_s, Rails.root)
       end
 
-      def normalize_all(paths, allow_root: false)
+      def to_lookup_path(file_path)
+        path = file_path.to_s.downcase
+
+        directory_path = File.dirname(path)
+        directory_path = nil if directory_path.start_with?(".")
+
+        file_name = File.basename(path).split(".").first
+
+        segments = [*directory_path&.split("/"), file_name].compact
+        stripped_segments = segments.map! do |segment|
+          PositionPrefixParser.call(segment).last.tr("-", "_")
+        end
+
+        to_path(stripped_segments)
+      end
+
+      def to_path(*args)
+        args.flatten.compact.map(&:to_s).join("/")
+      end
+
+      def normalize_paths(paths, allow_root: false)
         Array(paths).map do |path|
           full_path = to_absolute(path)
-          if Dir.exist?(full_path)
+          if File.exist?(full_path)
             full_path if allow_root || !root_path?(full_path)
           end
         end.compact.uniq
@@ -17,6 +37,10 @@ module Lookbook
       def root_path?(path)
         Rails.application.root.to_s == path.to_s
       end
+
+      def strip_slashes(path)
+        path.to_s.gsub(/\A\/|\/\z/, "")
+      end
     end
   end
 end

data/lib/lookbook/support/utils/utils.rb

@@ -0,0 +1,24 @@
+module Lookbook
+  module Utils
+    class << self
+      def id(*args)
+        parts = args.map { |arg| arg.to_s }
+        id_str = parts.join("-").force_encoding("UTF-8").parameterize.dasherize
+        PathUtils.strip_slashes(id_str).tr("/", "-").gsub("--", "-")
+      end
+
+      def name(str)
+        str.to_s.parameterize.tr("-", "_")
+      end
+
+      def value_or_fallback(value, fallback = nil, &block)
+        if value.nil?
+          fallback_block = block || proc { fallback }
+          fallback_block.call
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/lookbook/tags/component_tag.rb

@@ -2,6 +2,12 @@ module Lookbook
   class ComponentTag < YardTag
     def value
       text.constantize if text.present?
+    rescue
+      nil
+    end
+
+    def tag_body
+      text
     end
   end
 end

data/lib/lookbook/tags/custom_tag.rb

@@ -1,5 +1,7 @@
 module Lookbook
   class CustomTag < YardTag
+    supports_options
+
     attr_reader :arg_names, :tag_args
 
     def initialize(tag_name, text = nil, *args)

data/lib/lookbook/tags/id_tag.rb

@@ -1,7 +1,7 @@
 module Lookbook
   class IdTag < YardTag
     def value
-      AttributeUtils.entity_id(text) if text.present?
+      Utils.id(text) if text.present?
     end
   end
 end

data/lib/lookbook/tags/logical_path_tag.rb

@@ -1,4 +1,7 @@
 module Lookbook
   class LogicalPathTag < YardTag
+    def value
+      PathUtils.strip_slashes(super)
+    end
   end
 end

data/lib/lookbook/tags/param_tag.rb

@@ -3,6 +3,8 @@ module Lookbook
     VALUE_TYPE_MATCHER = /^(\[\s?([A-Z]{1}\w+)\s?\])/
     DESCRIPTION_MATCHER = /"(.*[^\\])"$/
 
+    supports_options
+
     attr_reader :tag_args
 
     def initialize(text)

data/lib/lookbook/tags/position_tag.rb

@@ -5,7 +5,7 @@ module Lookbook
     def value
       if text.present?
         int = text.to_i
-        int == 0 ? DEFAULT_POSITION : int
+        (int == 0) ? DEFAULT_POSITION : int
       else
         DEFAULT_POSITION
       end

data/lib/lookbook/tags/source_tag.rb

@@ -0,0 +1,7 @@
+module Lookbook
+  class SourceTag < YardTag
+    def value
+      resolve_path(text.strip) if text.present?
+    end
+  end
+end

data/lib/lookbook/tags/yard_tag.rb

@@ -26,23 +26,51 @@ module Lookbook
     # i.e. for the @hidden tag this would return boolean true/false.
     alias_method :value, :text
 
+    def self.supports_options(value = true)
+      @supports_options = !!value
+    end
+
+    def self.supports_options?
+      @supports_options.nil? ? false : @supports_options
+    end
+
+    supports_options
+
     protected
 
     def tag_parts
       if @tag_parts.nil?
-        options, text = TagOptionsParser.call(@text, {
-          file: host_file,
-          base_dir: (File.dirname(host_file) if host_file),
-          eval_context: host_class_instance,
-          permit_eval: Lookbook.config.preview_params_options_eval
-        })
+        options, text = if self.class.supports_options?
+          TagOptionsParser.call(@text, {
+            file: host_file,
+            base_dir: host_file&.dirname,
+            eval_context: host_class_instance,
+            permit_eval: Lookbook.config.preview_params_options_eval
+          })
+        else
+          [{}, @text]
+        end
       end
       @tag_parts ||= {options: options, text: text}
     end
 
+    def resolve_path(path)
+      return unless host_file
+
+      dir = path.start_with?(".") ? host_file.dirname : host_file_base_directory
+      Pathname(File.expand_path(path, dir))
+    end
+
     def host_file
       location = object&.files&.first # [file, line_number]
-      location&.first
+      Pathname(location.first) if location
+    end
+
+    def host_file_base_directory
+      return unless host_file
+
+      directories = Engine.preview_paths.map(&:to_s).sort_by(&:length).reverse
+      directories.first { |dir| host_file.to_s.start_with?(dir) }
     end
 
     def host_class_instance

data/lib/lookbook/theme.rb

@@ -12,6 +12,14 @@ module Lookbook
       blue: {
         favicon_light_mode: "#2563EB",
         favicon_dark_mode: "#60A5FA"
+      },
+      green: {
+        favicon_light_mode: "#16a34a",
+        favicon_dark_mode: "#66E093"
+      },
+      rose: {
+        favicon_light_mode: "#E11D48",
+        favicon_dark_mode: "#FFA0B5"
       }
     }
 

data/lib/lookbook/version.rb

@@ -1,3 +1,3 @@
 module Lookbook
-  VERSION = "1.3.3"
+  VERSION = "1.4.0"
 end

data/lib/lookbook.rb

@@ -16,23 +16,27 @@ module Lookbook
     end
 
     def config
-      @config ||= ConfigStore.init_from_config
+      @_config ||= ConfigStore.init_from_config
     end
 
     def configure
       yield(config)
     end
 
+    def engine
+      Engine
+    end
+
     def data
-      @data ||= Store.new
+      @_data ||= Store.new
     end
 
     def data=(new_data)
-      @data = Store.new(new_data)
+      @_data = Store.new(new_data)
     end
 
     def logger
-      @logger ||= if Rails.logger.present? && config.log_use_rails_logger
+      @_logger ||= if Rails.logger.present? && config.log_use_rails_logger
         Rails.logger
       else
         logger = Logger.new($stdout)
@@ -55,11 +59,11 @@ module Lookbook
     end
 
     def previews
-      Preview.all
+      Engine.previews
     end
 
     def pages
-      Page.all
+      Engine.pages
     end
 
     def broadcast(event_name, data = {})
@@ -67,7 +71,7 @@ module Lookbook
     end
 
     def theme
-      @theme ||= Lookbook::Theme.new(config.ui_theme, config.ui_theme_overrides)
+      @_theme ||= Lookbook::Theme.new(config.ui_theme, config.ui_theme_overrides)
     end
 
     def define_param_input(*args)