lookbook 1.5.2 → 2.3.7

data/lib/lookbook/support/errors/error.rb

@@ -0,0 +1,64 @@
+module Lookbook
+  class Error < StandardError
+    attr_reader :scope, :original, :status, :detail, :source
+
+    def initialize(message = nil,
+      scope: nil, original: nil, status: nil, detail: nil,
+      file_path: nil, source: nil, line_number: nil, **kwargs)
+      @scope = scope
+      @original = original
+      @message = message
+      @status = status
+      @detail = detail
+      @file_path = file_path
+      @source = source
+      @line_number = line_number
+      super(message)
+    end
+
+    def message
+      @message || original&.message
+    end
+
+    def backtrace
+      original&.backtrace || super
+    end
+
+    def type
+      (original.presence || self).class.to_s
+    end
+
+    def file_path
+      return @file_path.to_s if @file_path.present?
+
+      parsed_backtrace[0][0] if parsed_backtrace.any?
+    end
+
+    def relative_file_path
+      file_path&.delete_prefix("#{Rails.root}/")
+    end
+
+    def line_number
+      return @line_number.to_i if @line_number.present?
+
+      if parsed_backtrace.any?
+        number = parsed_backtrace[0][1]
+        number.to_i if number.present?
+      end
+    end
+
+    def backtrace_lines
+      root = Rails.root.to_s
+      backtrace.map { |line| line.gsub(root, "") }
+    end
+
+    protected
+
+    def parsed_backtrace
+      backtrace.map do |line|
+        line =~ /^(.+?):(\d+)(|:in `(.+)')$/
+        [$1, $2, $4]
+      end
+    end
+  end
+end

data/lib/lookbook/support/errors/parser_error.rb

@@ -1,7 +1,7 @@
 module Lookbook
-  class ParserError < LookbookError
+  class ParserError < Error
     def initialize(msg = nil, scope: "parser", **kwargs)
-      super(msg, scope: scope, **kwargs)
+      super
     end
   end
 end

data/lib/lookbook/support/errors/preview_template_error.rb

@@ -0,0 +1,7 @@
+module Lookbook
+  class PreviewTemplateError < Error
+    def initialize(msg = nil, scope: "preview", **kwargs)
+      super
+    end
+  end
+end

data/lib/lookbook/support/errors/routing_error.rb

@@ -0,0 +1,7 @@
+module Lookbook
+  class RoutingError < Error
+    def initialize(msg = nil, scope: "request", **kwargs)
+      super(msg, scope: scope, status: :not_found, **kwargs)
+    end
+  end
+end

data/lib/lookbook/support/errors/template_error.rb

@@ -0,0 +1,7 @@
+module Lookbook
+  class TemplateError < Error
+    def initialize(msg = nil, scope: "template", **kwargs)
+      super
+    end
+  end
+end

data/lib/lookbook/support/evented_file_update_checker.rb

@@ -0,0 +1,69 @@
+require "active_support/evented_file_update_checker"
+
+module Lookbook
+  require "listen" unless Engine.runtime_context.rails_newer_than?("6.1.0")
+
+  class EventedFileUpdateChecker < ActiveSupport::EventedFileUpdateChecker
+    if Engine.runtime_context.rails_newer_than?("6.1.0")
+
+      def initialize(files, dirs = {}, &block)
+        super
+        @core = Core.new(files, dirs)
+      end
+
+      class Core < ActiveSupport::EventedFileUpdateChecker::Core
+        def changed(modified, added, removed)
+          super
+          Engine.files_changed(modified, added, removed) if @updated
+        end
+
+        # Patched to handle regex-style
+        # extension matchers like `.html.*`
+        def watching?(file)
+          return true if super
+
+          file = Pathname(file)
+          name_parts = file.basename.to_s.split(".")
+          ext = "." + name_parts.drop(1).join(".").to_s
+
+          file.dirname.ascend do |dir|
+            matching = @dirs.fetch(dir, []).map { |m| Regexp.new(m) }
+            if matching.empty? || matching.find { |m| m.match?(ext) }
+              break true
+            elsif dir == @common_path || dir.root?
+              break false
+            end
+          end
+        end
+      end
+
+    else
+
+      # Patched to handle regex-style
+      # extension matchers like `.html.*`
+      def watching?(file)
+        return true if super
+
+        file = Pathname(file)
+        name_parts = file.basename.to_s.split(".")
+        ext = "." + name_parts.drop(1).join(".").to_s
+
+        file.dirname.ascend do |dir|
+          matching = @dirs.fetch(dir, []).map { |m| Regexp.new(m) }
+          if matching.empty? || matching.find { |m| m.match?(ext) }
+            break true
+          elsif dir == @lcsp || dir.root?
+            break false
+          end
+        end
+      end
+
+      private
+
+      def changed(modified, added, removed)
+        super
+        Engine.files_changed(modified, added, removed) if updated?
+      end
+    end
+  end
+end

data/lib/lookbook/support/null_websocket.rb

@@ -0,0 +1,9 @@
+module Lookbook
+  class NullWebsocket < NullObject
+    def mountable?
+      false
+    end
+
+    alias_method :mounted?, :mountable?
+  end
+end

data/lib/lookbook/support/store.rb

@@ -1,4 +1,13 @@
 module Lookbook
+  # Generic hash-like key/value store.
+  #
+  # Properties can be get/set using hash access syntax (`data[:key]`)
+  # or dot-notation syntax (`data.key`).
+  #
+  # Based on [ActiveSupport::OrderedOptions](https://api.rubyonrails.org/classes/ActiveSupport/OrderedOptions.html)
+  #
+  # @ignore methods
+  # @api public
   class Store < ActiveSupport::OrderedOptions
     def initialize(initial_data = nil, opts = {})
       @recursive = opts[:recursive] || false
@@ -18,7 +27,7 @@ module Lookbook
       if name.to_s.end_with?("=")
         args[0] = normalize_value(args[0])
       end
-      super(name, *args)
+      super
     end
 
     def respond_to_missing?(name, include_private)

data/lib/lookbook/support/tree_node.rb

@@ -8,10 +8,10 @@ module Lookbook
     attr_accessor :path, :content
     attr_reader :children
 
-    def initialize(path = nil, content = nil, position: 10000)
+    def initialize(path = nil, content = nil, priority: 10000)
       @path = path.to_s
       @content = content
-      @position = position
+      @priority = priority
       @children = []
     end
 
@@ -27,8 +27,8 @@ module Lookbook
       content_value(:label, name.titleize)
     end
 
-    def position
-      content_value(:position, @position)
+    def priority
+      content_value(:priority, @priority)
     end
 
     def type
@@ -39,8 +39,8 @@ module Lookbook
       path.split("/").size
     end
 
-    def add_child(name, content = nil, position: 10000)
-      children << TreeNode.new("#{path}/#{name}", content, position: position)
+    def add_child(name, content = nil, priority: 10000)
+      children << TreeNode.new("#{path}/#{name}", content, priority: priority)
     end
 
     def has_child?(name)
@@ -69,7 +69,7 @@ module Lookbook
       if content?
         content <=> (other.content? ? other.content : other)
       else
-        [position, label] <=> [other.position, other.label]
+        [priority, label] <=> [other.priority, other.label]
       end
     end
 

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

@@ -14,11 +14,11 @@ module Lookbook
         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("-", "_")
+        segments.map! do |segment|
+          PriorityPrefixParser.call(segment).last.tr("-", "_")
         end
 
-        to_path(stripped_segments)
+        to_path(segments)
       end
 
       def to_path(*args)
@@ -41,6 +41,12 @@ module Lookbook
       def strip_slashes(path)
         path.to_s.gsub(/\A\/|\/\z/, "")
       end
+
+      def determine_full_path(rel_path, search_dirs = [])
+        base_path = search_dirs.detect { |p| Dir["#{p}/#{rel_path}"].first }
+        path = Dir["#{base_path}/#{rel_path}"].first
+        Pathname(path) if path
+      end
     end
   end
 end

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

@@ -7,8 +7,16 @@ module Lookbook
         PathUtils.strip_slashes(id_str).tr("/", "-").gsub("--", "-")
       end
 
+      def temp_id(prefix: nil)
+        [prefix, (Time.now.to_f * 1000).to_i + rand(0..100)].compact.join("-")
+      end
+
       def name(str)
-        str.to_s.parameterize.tr("-", "_")
+        str.to_s.force_encoding("UTF-8").parameterize.tr("-", "_")
+      end
+
+      def symbolize_name(str)
+        name(str).to_sym
       end
 
       def value_or_fallback(value, fallback = nil, &block)

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

@@ -0,0 +1,49 @@
+module Lookbook
+  module Where
+    class << self
+      attr_accessor :editor
+
+      def is_proc(proc)
+        source_location(proc)
+      end
+
+      def is_method(klass, method_name)
+        source_location(klass.method(method_name))
+      end
+
+      def is_instance_method(klass, method_name)
+        source_location(klass.instance_method(method_name))
+      end
+
+      def is_class(klass)
+        methods = defined_methods(klass)
+        file_groups = methods.group_by { |sl| sl[0] }
+        file_counts = file_groups.map do |file, sls|
+          lines = sls.map { |sl| sl[1] }
+          count = lines.size
+          line = lines.min
+          {file: file, count: count, line: line}
+        end
+        file_counts.sort_by! { |fc| fc[:count] }
+        file_counts.map { |fc| [fc[:file], fc[:line]] }
+      end
+
+      private
+
+      def source_location(method)
+        method.source_location || (
+          method.to_s =~ /: (.*)>/
+          $1
+        )
+      end
+
+      def defined_methods(klass)
+        methods = klass.methods(false).map { |m| klass.method(m) } +
+          klass.instance_methods(false).map { |m| klass.instance_method(m) }
+        methods.map!(&:source_location)
+        methods.compact!
+        methods
+      end
+    end
+  end
+end

data/lib/lookbook/tags/after_render_tag.rb

@@ -0,0 +1,7 @@
+module Lookbook
+  class AfterRenderTag < YardTag
+    def value
+      text.sub(/\A:/, "")
+    end
+  end
+end

data/lib/lookbook/tags/param_tag.rb

@@ -1,7 +1,7 @@
 module Lookbook
   class ParamTag < YardTag
     VALUE_TYPE_MATCHER = /^(\[\s?([A-Z]{1}\w+)\s?\])/
-    DESCRIPTION_MATCHER = /(?<=\s|^)"(.*[^\\])"(?:\s|$)/
+    DESCRIPTION_MATCHER = /(?<=\s|^)"(.*?[^\\])"(?:\s|$)/
 
     supports_options
 
@@ -28,7 +28,7 @@ module Lookbook
     def value_default
       default_value_parts = object.parameters.find { |parts| parts[0].chomp(":") == name }
       if default_value_parts
-        object.instance_eval(default_value_parts[1])
+        host_class_instance.instance_eval(default_value_parts[1])
       else
         raise ParserError.new "Unknown method parameter '#{name}'"
       end
@@ -45,19 +45,29 @@ module Lookbook
       value_type = nil
       description = nil
 
+      # Parse out YARD-style value type definition - i.e. [Boolean]
       text.match(VALUE_TYPE_MATCHER) do |match_data|
         value_type = match_data[2]
         text.gsub!(VALUE_TYPE_MATCHER, "").strip!
       end
 
+      # Parse and remove any options from string
+      options_str, text = parse_options(text, resolve: false)
+
+      # Parse description, if provided
       text.match(DESCRIPTION_MATCHER) do |match_data|
         description = match_data[1]
-        text.gsub!(DESCRIPTION_MATCHER, "").strip!
+        text.sub!(DESCRIPTION_MATCHER, "").strip!
       end
 
       input, rest = text.split(" ", 2)
 
-      {input: input, value_type: value_type, description: description, rest: rest}
+      {
+        input: input,
+        value_type: value_type,
+        description: description,
+        rest: [rest, options_str].compact.join(" ")
+      }
     end
   end
 end

data/lib/lookbook/tags/{position_tag.rb → priority_tag.rb}

@@ -1,13 +1,13 @@
 module Lookbook
-  class PositionTag < YardTag
-    DEFAULT_POSITION = 100000
+  class PriorityTag < YardTag
+    DEFAULT_PRIORITY = 100000
 
     def value
       if text.present?
         int = text.to_i
-        (int == 0) ? DEFAULT_POSITION : int
+        (int == 0) ? DEFAULT_PRIORITY : int
       else
-        DEFAULT_POSITION
+        DEFAULT_PRIORITY
       end
     end
 

data/lib/lookbook/tags/renders_tag.rb

@@ -0,0 +1,4 @@
+module Lookbook
+  class RendersTag < YardTag
+  end
+end

data/lib/lookbook/tags/tag_provider.rb

@@ -7,6 +7,9 @@ module Lookbook
         raise NameError.new "'custom' is a reserved tag name and cannot be used"
       end
 
+      # Handle aliasing of removed `@component` tags
+      tag_name = "renders" if tag_name == "component"
+
       begin
         tag_class = "Lookbook::#{tag_name.camelize}Tag".constantize
         tag_class.new(text)

data/lib/lookbook/tags/type_tag.rb

@@ -0,0 +1,7 @@
+module Lookbook
+  class TypeTag < YardTag
+    def value
+      text.downcase.to_sym
+    end
+  end
+end

data/lib/lookbook/tags/yard_tag.rb

@@ -5,7 +5,7 @@ module Lookbook
         tag_name = self.class.name.demodulize.underscore.chomp("_tag")
         super(tag_name, args.first, nil, @name)
       else
-        super(*args)
+        super
       end
     end
 
@@ -40,16 +40,7 @@ module Lookbook
 
     def tag_parts
       if @tag_parts.nil?
-        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
+        options, text = parse_options(@text)
       end
       @tag_parts ||= {options: options, text: text}
     end
@@ -86,5 +77,18 @@ module Lookbook
       end
       host_code_object&.path&.constantize
     end
+
+    def parse_options(input, resolve: true)
+      if self.class.supports_options?
+        TagOptionsParser.call(input, {
+          file: host_file,
+          base_dir: host_file&.dirname,
+          eval_context: host_class_instance,
+          resolve: resolve
+        })
+      else
+        [{}, @text]
+      end
+    end
   end
 end

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 = "1.5.2"
+  VERSION = "2.3.7"
 end

data/lib/lookbook/websocket.rb

@@ -1,60 +1,13 @@
 module Lookbook
   class Websocket
-    attr_reader :engine_mount_path, :server, :logger
+    class << self
+      def new(mount_path, **kwargs)
+        require_relative "cable/cable"
 
-    def initialize(engine_mount_path, logger: Lookbook.logger)
-      @engine_mount_path = engine_mount_path
-      @logger = logger
-
-      logger.info "Initializing websocket"
-
-      if Gem::Version.new(Rails.version) >= Gem::Version.new(6.0)
-        @server = ActionCable::Server::Base.new config: cable_config
-      else
-        @server = ActionCable::Server::Base.new
-        @server.config = cable_config
+        Cable.new(mount_path, **kwargs)
+      rescue LoadError
+        NullWebsocket.new
       end
     end
-
-    def broadcast(message, payload = nil)
-      logger.debug message.to_s
-      server.broadcast(message.to_s, payload.to_h)
-    end
-
-    def mount_path
-      "/cable"
-    end
-
-    def full_mount_path
-      "#{engine_mount_path}/#{mount_path}".gsub("//", "/")
-    end
-
-    def mountable?
-      true
-    end
-
-    alias_method :mounted?, :mountable?
-
-    def self.noop
-      NullWebsocket.new
-    end
-
-    protected
-
-    def cable_config
-      cable = ActionCable::Server::Configuration.new
-      cable.cable = {adapter: "async"}.with_indifferent_access
-      cable.mount_path = nil
-      cable.connection_class = -> { Lookbook::Connection }
-      cable.logger = logger
-      cable
-    end
-  end
-
-  class NullWebsocket < NullObject
-    def mountable?
-      false
-    end
-    alias_method :mounted?, :mountable?
   end
 end