lookbook 1.1.0 → 1.2.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lookbook
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Mark Perkins
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-01 00:00:00.000000000 Z
+date: 2022-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: css_parser
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +240,12 @@ files:
 - app/components/lookbook/dimensions_display/component.html.erb
 - app/components/lookbook/dimensions_display/component.js
 - app/components/lookbook/dimensions_display/component.rb
+- app/components/lookbook/display_options/editor/component.html.erb
+- app/components/lookbook/display_options/editor/component.rb
+- app/components/lookbook/display_options/field/component.css
+- app/components/lookbook/display_options/field/component.html.erb
+- app/components/lookbook/display_options/field/component.js
+- app/components/lookbook/display_options/field/component.rb
 - app/components/lookbook/embed/component.html.erb
 - app/components/lookbook/embed/component.js
 - app/components/lookbook/embed/component.rb
@@ -316,24 +336,25 @@ files:
 - app/views/lookbook/previews/panels/_preview.html.erb
 - app/views/lookbook/previews/panels/_source.html.erb
 - app/views/lookbook/previews/show.html.erb
+- config/app.yml
+- config/hooks.yml
+- config/inputs.yml
+- config/panels.yml
 - config/routes.rb
+- config/tags.yml
 - lib/lookbook.rb
 - lib/lookbook/code_formatter.rb
 - lib/lookbook/collection.rb
 - lib/lookbook/component.rb
-- lib/lookbook/config.rb
-- lib/lookbook/data.rb
 - lib/lookbook/engine.rb
 - lib/lookbook/entity.rb
 - lib/lookbook/error.rb
 - lib/lookbook/features.rb
-- lib/lookbook/hooks.rb
 - lib/lookbook/lang.rb
 - lib/lookbook/markdown.rb
 - lib/lookbook/page.rb
 - lib/lookbook/page_collection.rb
 - lib/lookbook/page_section.rb
-- lib/lookbook/panels.rb
 - lib/lookbook/params.rb
 - lib/lookbook/parser.rb
 - lib/lookbook/preview.rb
@@ -341,8 +362,23 @@ files:
 - lib/lookbook/preview_controller.rb
 - lib/lookbook/preview_example.rb
 - lib/lookbook/preview_group.rb
+- lib/lookbook/services/config_loader.rb
+- lib/lookbook/services/search_param_builder.rb
+- lib/lookbook/services/search_param_parser.rb
+- lib/lookbook/services/tags/key_value_tag_parser.rb
 - lib/lookbook/source_inspector.rb
-- lib/lookbook/store.rb
+- lib/lookbook/stores/config_store.rb
+- lib/lookbook/stores/hook_store.rb
+- lib/lookbook/stores/input_store.rb
+- lib/lookbook/stores/panel_store.rb
+- lib/lookbook/stores/tag_store.rb
+- lib/lookbook/support/errors/config_error.rb
+- lib/lookbook/support/errors/lookbook_error.rb
+- lib/lookbook/support/errors/parser_error.rb
+- lib/lookbook/support/service.rb
+- lib/lookbook/support/store.rb
+- lib/lookbook/support/utils/attribute_utils.rb
+- lib/lookbook/support/utils/path_utils.rb
 - lib/lookbook/tag.rb
 - lib/lookbook/tag_options.rb
 - lib/lookbook/tags.rb

data/lib/lookbook/config.rb

@@ -1,282 +0,0 @@
-require "lookbook/markdown"
-require "lookbook/theme"
-require "lookbook/store"
-
-module Lookbook
-  class Config
-    def initialize
-      @options = Store.new({}, true)
-
-      @options.set({
-        project_name: "Lookbook",
-        log_level: 2,
-        log_use_rails_logger: true,
-        auto_refresh: true,
-
-        components_path: "app/components",
-
-        page_controller: "Lookbook::PageController",
-        page_route: "pages",
-        page_paths: ["test/components/docs"],
-        page_options: {},
-        markdown_options: Markdown::DEFAULT_OPTIONS,
-
-        preview_paths: [],
-        preview_display_params: {},
-        preview_srcdoc: nil,
-        preview_tags: {},
-        preview_disable_action_view_annotations: true,
-        preview_param_inputs: {
-          select: "lookbook/previews/inputs/select",
-          textarea: "lookbook/previews/inputs/textarea",
-          toggle: "lookbook/previews/inputs/toggle",
-          color: "lookbook/previews/inputs/color",
-          range: "lookbook/previews/inputs/range",
-          text: "lookbook/previews/inputs/text",
-          email: "lookbook/previews/inputs/text",
-          number: "lookbook/previews/inputs/text",
-          tel: "lookbook/previews/inputs/text",
-          url: "lookbook/previews/inputs/text",
-          date: "lookbook/previews/inputs/text",
-          datetime_local: "lookbook/previews/inputs/text"
-        },
-        preview_params_options_eval: false,
-        sort_examples: false,
-
-        listen: Rails.env.development?,
-        listen_paths: [],
-        listen_extensions: ["rb", "html.*"],
-        listen_use_polling: false,
-
-        cable_mount_path: "/cable",
-
-        parser_registry_path: "tmp/storage/.yardoc",
-
-        ui_theme: "indigo",
-        ui_theme_overrides: {},
-        ui_favicon: true,
-
-        hooks: {
-          after_initialize: [],
-          before_exit: [],
-          after_change: []
-        },
-
-        debug_menu: Rails.env.development?,
-
-        experimental_features: false,
-
-        inspector_panels: {
-          preview: {
-            pane: :main,
-            position: 1,
-            partial: "lookbook/previews/panels/preview",
-            hotkey: "v",
-            panel_classes: "overflow-hidden",
-            padded: false,
-            system: true
-          },
-          output: {
-            pane: :main,
-            position: 2,
-            partial: "lookbook/previews/panels/output",
-            label: "HTML",
-            hotkey: "h",
-            padded: false,
-            system: true
-          },
-          source: {
-            pane: :drawer,
-            position: 1,
-            partial: "lookbook/previews/panels/source",
-            label: "Source",
-            hotkey: "s",
-            copy: ->(data) { data.examples.map { |e| e.source }.join("\n") },
-            padded: false,
-            system: true
-          },
-          notes: {
-            pane: :drawer,
-            position: 2,
-            partial: "lookbook/previews/panels/notes",
-            label: "Notes",
-            hotkey: "n",
-            disabled: ->(data) { data.examples.select { |e| e.notes.present? }.none? },
-            padded: false,
-            system: true
-          },
-          params: {
-            pane: :drawer,
-            position: 3,
-            partial: "lookbook/previews/panels/params",
-            label: "Params",
-            hotkey: "p",
-            disabled: ->(data) { data.preview.params.none? },
-            padded: false,
-            system: true
-          }
-        }
-      })
-    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 project_name
-      @options.project_name == false ? nil : @options.project_name
-    end
-
-    def components_path
-      absolute_path(@options.components_path)
-    end
-
-    def page_paths=(paths = [])
-      @options.page_paths += paths if paths.is_a? Array
-    end
-
-    def page_paths
-      normalize_paths(@options.page_paths)
-    end
-
-    def preview_paths=(paths = [])
-      @options.preview_paths += paths if paths.is_a? Array
-    end
-
-    def preview_paths
-      normalize_paths(@options.preview_paths)
-    end
-
-    def preview_srcdoc=(enable)
-      Lookbook.logger.warn "The `preview_srcdoc` config option is deprecated and will be removed in v2.0"
-    end
-
-    def listen_paths
-      normalize_paths(@options.listen_paths)
-    end
-
-    def listen_extensions=(extensions = [])
-      @options.listen_extensions += extensions if extensions.is_a? Array
-      @options.listen_extensions.uniq!
-    end
-
-    def parser_registry_path
-      absolute_path(@options.parser_registry_path)
-    end
-
-    def inspector_panels(&block)
-      panels = Store.new(@options.inspector_panels.select { |key, panel| panel != false })
-      if block
-        yield panels
-      else
-        panels
-      end
-    end
-
-    def define_inspector_panel(name, opts = {})
-      pane = opts[:pane].presence || :drawer
-      siblings = inspector_panels.select { |key, panel| panel.pane == pane }
-      opts[:position] ||= siblings.size + 1
-      @options.inspector_panels[name] = opts
-      siblings.each do |key, panel|
-        if panel.position >= opts[:position]
-          panel.position += 1
-        end
-      end
-    end
-
-    def amend_inspector_panel(name, opts = {})
-      if opts == false
-        @options.inspector_panels[name] = false
-      else
-        @options.inspector_panels[name].merge!(opts)
-      end
-    end
-
-    def remove_inspector_panel(name)
-      amend_inspector_panel(name, false)
-    end
-
-    def inspector_panel_defaults
-      {
-        id: ->(data) { "inspector-panel-#{data.name}" },
-        partial: "lookbook/previews/panels/content",
-        content: nil,
-        label: ->(data) { data.name.titleize },
-        pane: :drawer,
-        position: ->(data) { data.index_position },
-        hotkey: nil,
-        disabled: false,
-        show: true,
-        copy: nil,
-        panel_classes: nil,
-        locals: {},
-        system: false
-      }
-    end
-
-    def ui_theme=(name)
-      name = name.to_s
-      if Theme.valid_theme?(name)
-        @options.ui_theme = name
-      else
-        Lookbook.logger.warn "'#{name}' is not a valid Lookbook theme. Theme setting not changed."
-      end
-    end
-
-    def ui_theme_overrides(&block)
-      if block
-        yield @options.ui_theme_overrides
-      else
-        @options.ui_theme_overrides
-      end
-    end
-
-    def [](key)
-      if respond_to? key.to_sym
-        public_send(key.to_sym)
-      else
-        @options[key.to_sym]
-      end
-    end
-
-    def []=(key, value)
-      setter_key = "#{key}=".to_sym
-      if respond_to? setter_key
-        public_send(setter_key, value)
-      else
-        @options[key.to_sym] = value
-      end
-    end
-
-    def to_h
-      @options.to_h
-    end
-
-    def to_json(*a)
-      to_h.to_json(*a)
-    end
-
-    protected
-
-    def normalize_paths(paths)
-      paths.map! do |path|
-        full_path = absolute_path(path)
-        full_path if Dir.exist?(full_path)
-      end.compact!
-      paths
-    end
-
-    def absolute_path(path)
-      File.absolute_path(path.to_s, Rails.root)
-    end
-
-    def method_missing(name, *args)
-      @options.send(name, *args)
-    end
-
-    def respond_to_missing?(name, *)
-      to_h.key? name
-    end
-  end
-end

data/lib/lookbook/data.rb

@@ -1,11 +0,0 @@
-module Lookbook
-  module Data
-    def data
-      @data ||= Store.new({}, true)
-    end
-
-    def data=(props)
-      @data = Store.new(props, true)
-    end
-  end
-end

data/lib/lookbook/hooks.rb

@@ -1,21 +0,0 @@
-module Lookbook
-  module Hooks
-    def after_initialize(&block)
-      add_hook(:after_initialize, block)
-    end
-
-    def before_exit(&block)
-      add_hook(:before_exit, block)
-    end
-
-    def after_change(&block)
-      add_hook(:after_change, block)
-    end
-
-    protected
-
-    def add_hook(event_name, block)
-      Lookbook.config.hooks[event_name] << block
-    end
-  end
-end

data/lib/lookbook/panels.rb

@@ -1,25 +0,0 @@
-module Lookbook
-  module Panels
-    def define_panel(name, *args)
-      Lookbook.config.define_inspector_panel(name, extract_opts(args))
-    end
-
-    def amend_panel(name, *args)
-      Lookbook.amend_inspector_panel(name, extract_opts(args))
-    end
-
-    def remove_panel(name)
-      Lookbook.remove_inspector_panel(name)
-    end
-
-    def extract_opts(args)
-      if args.many?
-        opts = args[1]
-        opts[:partial] = args[0]
-        opts
-      elsif args.any?
-        args[0].is_a?(String) ? {partial: args[0]} : args[0]
-      end
-    end
-  end
-end

data/lib/lookbook/store.rb

@@ -1,48 +0,0 @@
-module Lookbook
-  class Store < ActiveSupport::OrderedOptions
-    def initialize(data = {}, deep = false)
-      super()
-      @deep = deep
-      set(data) if data.present?
-    end
-
-    def [](key)
-      super(normalize_key(key))
-    end
-
-    def []=(key, value)
-      super(normalize_key(key), normalize_value(value))
-    end
-
-    def set(data)
-      data.keys.each do |key|
-        self[normalize_key(key)] = normalize_value(data[key])
-      end
-      self
-    end
-
-    def get(key, fallback = nil)
-      if key?(normalize_key(key))
-        self[normalize_key(key)]
-      else
-        fallback
-      end
-    end
-
-    def method_missing(name, *args)
-      super(normalize_key(name), *args.map { |arg| normalize_value(arg) })
-    end
-
-    def respond_to_missing?(name, *)
-      key?(name)
-    end
-
-    def normalize_key(key)
-      key.to_s.downcase.tr("-", "_").to_sym
-    end
-
-    def normalize_value(value)
-      @deep && !value.is_a?(Store) && value.is_a?(Hash) ? Store.new(value, @deep) : value
-    end
-  end
-end