lookbook 2.0.0.beta.3 → 2.0.0.beta.5

data/lib/lookbook/helpers/ui_elements_helper.rb

@@ -34,30 +34,6 @@ module Lookbook
       lookbook_render :code, **opts, &block
     end
 
-    # Render a 'live' embed of a component preview.
-    #
-    # If no scenario name is provided then the default (first) preview
-    # scenario will be rendered in the embed.
-    #
-    # @param preview [String] Name of the preview class to embed
-    # @param scenario [String] Example method name
-    # @param opts [Hash] Options hash
-    def embed(preview, scenario = nil, **opts)
-      preview_entity = if preview.is_a?(Symbol)
-        Engine.previews.find_by_path(preview)
-      else
-        Engine.previews.find_by_preview_class(preview)
-      end
-      scenario_entity = scenario ? preview_entity&.scenario(scenario) : preview_entity&.default_scenario
-      opts[:actions] ||= ["inspect", "open"]
-
-      lookbook_render Embed::Component.new(
-        scenario: scenario_entity,
-        params: opts.fetch(:params, {}),
-        options: opts.except(:params)
-      )
-    end
-
     # @api private
     def prose(**opts, &block)
       lookbook_render :prose, **opts, &block

data/lib/lookbook/param.rb

@@ -65,7 +65,7 @@ module Lookbook
 
     def input_config
       config = Lookbook::Engine.inputs.get_input(input)
-      config || raise(LookbookError.new("Unknown input type '#{input}'"))
+      config || raise(Lookbook::Error.new("Unknown input type '#{input}'"))
     end
 
     def guess_input

data/lib/lookbook/preview.rb

@@ -35,6 +35,10 @@ module Lookbook
     alias_method :render_component, :render
 
     class << self
+      def preview_name
+        name.chomp("Preview").underscore
+      end
+
       # Returns the arguments for rendering of the component in its layout
       def render_args(scenario, params: {})
         scenario_params_names = instance_method(scenario).parameters.map(&:last)

data/lib/lookbook/services/urls/data_uri_encoder.rb

@@ -0,0 +1,14 @@
+module Lookbook
+  class DataUriEncoder < Service
+    attr_reader :str, :mime_type
+
+    def initialize(str, mime_type)
+      @str = str
+      @mime_type = mime_type
+    end
+
+    def call
+      "data:#{mime_type},#{ERB::Util.url_encode(str)}"
+    end
+  end
+end

data/lib/lookbook/services/urls/file_data_uri_encoder.rb

@@ -0,0 +1,24 @@
+require "marcel"
+
+module Lookbook
+  class FileDataUriEncoder < Service
+    attr_reader :path
+
+    def initialize(path, mime_type = nil)
+      @path = path
+      @mime_type = mime_type
+    end
+
+    def content
+      File.read(path)
+    end
+
+    def mime_type
+      @mime_type || Marcel::MimeType.for(Pathname.new(path))
+    end
+
+    def call
+      DataUriEncoder.call(content, mime_type)
+    end
+  end
+end

data/lib/lookbook/stores/config_store.rb

@@ -15,6 +15,10 @@ module Lookbook
   # @api public
   class ConfigStore
     CONFIG_FILE = "config/app.yml"
+    DEFAULT_FAVICONS = {
+      light: "app/assets/lookbook/img/favicon_light.svg",
+      dark: "app/assets/lookbook/img/favicon_dark.svg"
+    }
 
     delegate_missing_to :store
     attr_reader :store
@@ -23,26 +27,26 @@ module Lookbook
       @store = Store.new(config, recursive: true)
     end
 
-    def project_name=(name)
-      store[:project_name] = (name == false) ? nil : name
+    def project_name
+      if store[:project_name].nil?
+        if store[:project_logo].nil?
+          Rails.application.class.module_parent.name.titleize
+        else
+          false
+        end
+      else
+        store[:project_name]
+      end
     end
 
-    def page_paths=(paths = nil)
-      store[:page_paths].push(*paths.to_a)
+    def project_name=(name)
+      store[:project_name] = name
     end
 
     def page_extensions=(extensions = nil)
       store[:page_extensions].push(*extensions.to_a).uniq!
     end
 
-    def preview_paths=(paths = nil)
-      store[:preview_paths].push(*paths.to_a)
-    end
-
-    def component_paths=(paths = nil)
-      store[:component_paths].push(*paths.to_a)
-    end
-
     def listen_extensions=(extensions = nil)
       store[:listen_extensions].push(*extensions.to_a).uniq!
     end
@@ -64,6 +68,14 @@ module Lookbook
       end
     end
 
+    def ui_favicon_light
+      @_ui_favicon_light ||= get_favicon(:light)
+    end
+
+    def ui_favicon_dark
+      @_ui_favicon_dark ||= get_favicon(:dark)
+    end
+
     def ui_theme_overrides(&block)
       if block
         yield store[:ui_theme_overrides]
@@ -79,5 +91,26 @@ module Lookbook
     def self.default_config(env: Rails.env)
       ConfigLoader.call(CONFIG_FILE, env: env)
     end
+
+    private
+
+    def get_favicon(theme)
+      default_favicon_path = Engine.root.join(DEFAULT_FAVICONS[theme])
+      default_favicon = FileDataUriEncoder.call(default_favicon_path)
+
+      if ui_favicon.present?
+        if ui_favicon.is_a?(Hash)
+          if ui_favicon[theme].is_a?(String)
+            DataUriEncoder.call(ui_favicon[theme], "image/svg+xml")
+          else
+            default_favicon
+          end
+        elsif ui_favicon.is_a?(String)
+          DataUriEncoder.call(ui_favicon, "image/svg+xml")
+        else
+          default_favicon
+        end
+      end
+    end
   end
 end

data/lib/lookbook/stores/hook_store.rb

@@ -1,7 +1,5 @@
 module Lookbook
   class HookStore
-    CONFIG_FILE = "config/hooks.yml"
-
     attr_reader :store
     delegate :to_h, to: :store
 
@@ -16,13 +14,5 @@ module Lookbook
     def for_event(event_name)
       store[event_name.to_sym] ||= []
     end
-
-    def self.init_from_config
-      new(default_config)
-    end
-
-    def self.default_config
-      ConfigLoader.call(CONFIG_FILE)
-    end
   end
 end

data/lib/lookbook/stores/input_store.rb

@@ -11,6 +11,7 @@ module Lookbook
       @store = {}
 
       config.to_h.each do |name, opts|
+        opts[:system] = true
         add_input(name, opts[:partial], opts.except(:partial))
       end
     end
@@ -47,11 +48,16 @@ module Lookbook
         partial = args.first
       end
       if partial.present?
-        Store.new({
+        input = Store.new({
           name: name.to_sym,
           partial: partial,
           options: DEFAULTS.merge(opts.to_h)
         })
+        if input.options.key?(:system)
+          input.system = input.options[:system]
+          input.options.delete(:system)
+        end
+        input
       else
         raise ConfigError.new("inputs must define a partial path", scope: "inputs.config")
       end

data/lib/lookbook/stores/panel_store.rb

@@ -41,7 +41,10 @@ module Lookbook
     end
 
     def load_config(config)
-      config.to_h.each { |name, opts| add_panel(name, opts) }
+      config.to_h.each do |name, opts|
+        opts[:system] = true
+        add_panel(name, opts)
+      end
     end
 
     def get_panel(name)

data/lib/lookbook/stores/tag_store.rb

@@ -7,15 +7,15 @@ module Lookbook
 
     def initialize(config = nil)
       @store = {}
-      config.to_h.each { |k, v| add_tag(k, v) }
+      config.to_h.each { |k, opts| add_tag(k, opts, true) }
     end
 
-    def add_tag(name, opts = nil)
+    def add_tag(name, opts = nil, is_system = false)
       name = name.to_sym
       if store.key?(name)
         raise ConfigError.new("tag with name '#{name}' already exists", scope: "tags.config")
       else
-        store[name] = build_config(name, opts)
+        store[name] = build_config(name, opts, is_system)
       end
     end
 
@@ -33,11 +33,12 @@ module Lookbook
 
     protected
 
-    def build_config(name, opts = nil)
+    def build_config(name, opts = nil, is_system = false)
       Store.new({
         name: name.to_sym,
         label: name.to_s.titleize,
-        options: opts.to_h
+        options: opts.to_h,
+        system: is_system
       })
     end
   end

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

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

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

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

@@ -1,5 +1,5 @@
 module Lookbook
-  class PreviewTemplateError < LookbookError
+  class PreviewTemplateError < Error
     def initialize(msg = nil, scope: "preview", **kwargs)
       super(msg, scope: scope, **kwargs)
     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(msg, scope: scope, **kwargs)
+    end
+  end
+end

data/lib/lookbook/version.rb

@@ -1,3 +1,3 @@
 module Lookbook
-  VERSION = "2.0.0.beta.3"
+  VERSION = "2.0.0.beta.5"
 end

data/lib/lookbook.rb

@@ -218,9 +218,9 @@ module Lookbook
               view_component: config.using_view_component
             }
           },
-          {panels: Engine.panels.to_h},
-          {inputs: Engine.inputs.to_h},
-          {tags: Engine.tags.to_h}
+          {panels: Engine.panels.to_h.reject { |k, v| v[:system] }},
+          {inputs: Engine.inputs.to_h.reject { |k, v| v[:system] }},
+          {tags: Engine.tags.to_h.reject { |k, v| v[:system] }}
         ].inject(:merge)
       }
     end