lookbook 1.5.2 → 2.3.7

data/lib/lookbook/services/list_resolver.rb

@@ -0,0 +1,35 @@
+module Lookbook
+  class ListResolver < Service
+    attr_reader :item_set
+
+    def initialize(to_include = nil, item_set = nil)
+      @to_include = to_include
+      @item_set = Array(item_set).compact.uniq.map(&:to_s)
+    end
+
+    def call(&resolver)
+      included = to_include.inject([]) do |result, name|
+        if name == "*"
+          result += item_set.select { |item| !result.include?(item) }
+        elsif item_set.include?(name)
+          result << name
+        end
+        result
+      end
+
+      resolved = resolver ? included.map { |item| resolver.call(item) } : included
+      resolved.compact
+    end
+
+    def to_include
+      case @to_include
+      when true
+        ["*"]
+      when false
+        []
+      else
+        Array(@to_include).compact.uniq.map(&:to_s)
+      end
+    end
+  end
+end

data/lib/lookbook/services/markdown_renderer.rb

@@ -6,7 +6,7 @@ module Lookbook
 
     def initialize(text, opts = {})
       @text = text
-      @opts = opts.to_h
+      @opts = Lookbook.config.markdown_options.merge(opts.to_h)
     end
 
     def call
@@ -18,7 +18,15 @@ module Lookbook
     class LookbookMarkdownRenderer < Redcarpet::Render::HTML
       def block_code(code, language = "ruby")
         line_numbers = language.to_s.end_with? "-numbered"
-        ApplicationController.render(Lookbook::Code::Component.new(source: code, language: language.to_s.chomp("-numbered"), line_numbers: line_numbers), layout: nil)
+        ApplicationController.render(Lookbook::Code::Component.new(source: code,
+          language: language.to_s.chomp("-numbered"),
+          line_numbers: line_numbers), layout: nil)
+      end
+
+      def postprocess(full_document)
+        full_document&.gsub!("<p><lookbook", "<lookbook")
+        full_document&.gsub!("</lookbook-embed></p>", "</lookbook-embed>")
+        full_document
       end
     end
   end

data/lib/lookbook/services/priority_prefix_parser.rb

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

data/lib/lookbook/services/tags/tag_options_parser.rb

@@ -9,19 +9,28 @@ module Lookbook
 
     def initialize(input, resolver_opts = {})
       @input = input.to_s.strip
-      @resolver_opts = resolver_opts
+      @resolve = resolver_opts.fetch(:resolve, true)
+      @resolver_opts = resolver_opts.except(:resolve)
       @fallback = resolver_opts.fetch(:fallback, {})
     end
 
     def call
       options_string, remaining_text = parse_input(@input)
-      resolved_options = resolver(options_string).call(options_string, **@resolver_opts)
-      options = prepare_options(resolved_options)
-      [options, remaining_text]
+      if resolve?
+        resolved_options = resolver(options_string).call(options_string, **@resolver_opts)
+        options = prepare_options(resolved_options)
+        [options, remaining_text]
+      else
+        [options_string, remaining_text]
+      end
     end
 
     protected
 
+    def resolve?
+      !!@resolve
+    end
+
     def resolver(options_string)
       if options_string.present?
         handler = RESOLVERS.find { |r| r.resolveable?(options_string) }

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/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/services/urls/search_param_encoder.rb

@@ -0,0 +1,16 @@
+require "cgi"
+
+module Lookbook
+  class SearchParamEncoder < Service
+    attr_reader :data
+
+    def initialize(data)
+      @data = data.to_h
+    end
+
+    def call
+      json = JSON.generate(data)
+      CGI.escape(json)
+    end
+  end
+end

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

@@ -1,15 +1,16 @@
+require "cgi"
+
 module Lookbook
   class SearchParamParser < Service
-    attr_reader :param_value
+    attr_reader :str
 
-    def initialize(param_value)
-      @param_value = param_value.strip
+    def initialize(str)
+      @str = str.to_s.strip
     end
 
     def call
-      pairs_str = param_value.split("|")
-      pairs = pairs_str.map { |pair| [*pair.split(":").map(&:strip)] }
-      pairs.to_h.symbolize_keys
+      json = CGI.unescape(str)
+      JsonParser.call(json)
     end
   end
 end

data/lib/lookbook/stores/config_store.rb

@@ -1,6 +1,24 @@
 module Lookbook
+  # Configuration store for Lookbook.
+  #
+  # Config option values can be get/set using hash property access syntax
+  # or dot-notation syntax.
+  #
+  # @example :ruby
+  #   # Lookbook config access in Rails config files:
+  #   config.lookbook.ui_theme = :zinc
+  #
+  #   # Lookbook config access everywhere else:
+  #   Lookbook.config.ui_theme = :zinc
+  #
+  # @ignore methods
+  # @api public
   class ConfigStore
     CONFIG_FILE = "config/app.yml"
+    DEFAULT_FAVICONS = {
+      light: "assets/img/favicon_light.svg",
+      dark: "assets/img/favicon_dark.svg"
+    }
 
     delegate_missing_to :store
     attr_reader :store
@@ -9,32 +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 preview_display_params
-      Lookbook.logger.warn "The `preview_display_params` config option has been renamed to `preview_display_options` and will be removed in v2.0"
-      store[:preview_display_options]
-    end
-
-    def preview_display_params=(options)
-      Lookbook.logger.warn "The `preview_display_params` config option has been renamed to `preview_display_options` and will be removed in v2.0"
-      store[:preview_display_options] = options.to_h
-    end
-
     def listen_extensions=(extensions = nil)
       store[:listen_extensions].push(*extensions.to_a).uniq!
     end
@@ -47,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)
@@ -56,6 +72,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]
@@ -64,14 +88,6 @@ module Lookbook
       end
     end
 
-    def runtime_parsing=(value)
-      Lookbook.logger.warn "The `runtime_parsing` config option has been deprecated and will be removed in v2.0"
-    end
-
-    def preview_srcdoc=(enable)
-      Lookbook.logger.warn "The `preview_srcdoc` config option is deprecated and will be removed in v2.0"
-    end
-
     def self.init_from_config(env: Rails.env)
       new(default_config(env: env))
     end
@@ -79,5 +95,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

@@ -2,9 +2,7 @@ module Lookbook
   class InputStore
     CONFIG_FILE = "config/inputs.yml"
 
-    DEFAULTS = {
-      # TODO
-    }
+    DEFAULTS = {}
 
     attr_reader :store
     delegate :to_h, to: :store
@@ -13,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
@@ -49,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

@@ -3,7 +3,7 @@ module Lookbook
     CONFIG_FILE = "config/panels.yml"
 
     DEFAULTS = {
-      label: lambda { |data| data.name.titleize },
+      label: lambda { |data| data.name.to_s.titleize },
       hotkey: nil,
       disabled: false,
       show: true,
@@ -19,65 +19,56 @@ module Lookbook
       load_config(config)
     end
 
-    def add_panel(name, group_name, *args)
+    def add_panel(name, *args)
       if get_panel(name)
         raise ConfigError.new("panel with name '#{name}' already exists", scope: "panels.config")
       else
-        panel = build_config(name, group_name, *args)
-        insert_at_position(group_name, panel.position, panel)
+        store[Utils.symbolize_name(name)] = build_config(name, *args)
       end
     end
 
     def update_panel(name, opts = {})
       panel = get_panel(name)
       if panel.present?
-        panel.merge!(opts.except(:name, :position))
-        if opts.key?(:position)
-          remove_panel(name)
-          insert_at_position(panel.group, opts[:position], panel)
-        end
+        panel.merge!(opts.except(:name))
       else
         not_found!(name)
       end
     end
 
     def remove_panel(name)
-      store.each do |group_name, panels|
-        return true unless panels.reject! { |p| p.name == name.to_sym }.nil?
-      end
-      not_found!(name)
+      store.delete(Utils.symbolize_name(name)) { |name| not_found!(name) }
     end
 
     def load_config(config)
-      config.to_h.each do |group_name, panels|
-        panels.each do |opts|
-          add_panel(opts[:name], group_name, opts.except(:name))
-        end
+      config.to_h.each do |name, opts|
+        opts[:system] = true
+        add_panel(name, opts)
       end
     end
 
-    def get_panel(name, group_name = nil)
-      panels(group_name).find { |p| p.name == name.to_sym }
+    def get_panel(name)
+      panels.find { |panel| panel.name == Utils.symbolize_name(name) }
     end
 
-    def count_panels(group_name = nil)
-      panels(group_name).count
+    def get_panels(*names)
+      ListResolver.call(names.flatten, panels.map(&:name)) { |name| get_panel(name) }
     end
 
-    def in_group(name)
-      store[name.to_sym] ||= []
+    def panels
+      store.map { |name, panel| panel }
     end
 
-    def panels(group_name = nil)
-      store.to_h.reduce([]) do |result, (name, group_panels)|
-        result.push(*group_panels) if group_name.nil? || name == group_name.to_sym
-      end
+    def names
+      panels.map(&:name)
     end
 
+    alias_method :all, :panels
+
     def self.resolve_config(opts, data)
       if opts[:name].present?
         data = data.is_a?(Store) ? data : Store.new(data)
-        data.name = opts[:name].to_s
+        data.name = Utils.symbolize_name(opts[:name])
         resolved = opts.transform_values do |value|
           value.respond_to?(:call) ? value.call(data) : value
         end
@@ -93,10 +84,14 @@ module Lookbook
 
     def self.default_config
       config = ConfigLoader.call(CONFIG_FILE)
-      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
+      config.to_h.transform_values! do |opts|
+        opts.transform_values! do |value|
+          if value.is_a?(String) && value.start_with?("->")
+            proc {
+              eval(value) # standard:disable Security/Eval
+            }.call
+          else
+            value
           end
         end
       end
@@ -104,21 +99,8 @@ module Lookbook
 
     protected
 
-    def insert_at_position(group_name, position, opts)
-      group_panels = in_group(group_name)
-      index = insert_index(position, group_panels.count)
-      group_panels.insert(index, opts.except!(:position))
-    end
-
-    def insert_index(position, items_count)
-      index = (position == 0) ? 1 : (position || 0).to_int
-      last_position = items_count + 1
-      index = last_position if index > last_position
-      index - 1
-    end
-
-    def build_config(name, group_name, *args)
-      opts = if args.many? && args.last.is_a?(Hash)
+    def build_config(name, *args)
+      opts = if args.many? && args.first.is_a?(String) && args.last.is_a?(Hash)
         args.last.merge({partial: args.first})
       elsif args.any?
         args.first.is_a?(String) ? {partial: args.first} : args.first
@@ -126,8 +108,7 @@ module Lookbook
         {}
       end
       if opts[:partial].present?
-        opts[:name] = name.to_sym
-        opts[:group] = group_name.to_sym
+        opts[:name] = Utils.symbolize_name(name)
         Store.new(DEFAULTS.merge(opts))
       else
         raise ConfigError.new("panels must define a partial path", scope: "panels.config")

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/deprecation.rb

@@ -0,0 +1,5 @@
+require "active_support"
+
+module Lookbook
+  Deprecation = ::ActiveSupport::Deprecation.new("3.0", "Lookbook")
+end

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

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