lookbook 1.0.0.beta.1 → 1.0.0.beta.4

data/lib/lookbook/config.rb

@@ -6,11 +6,13 @@ module Lookbook
   class Config
     def initialize
       @options = Store.new
-      foobar = "bax"
+      
       @options.set({
         project_name: "Lookbook",
         log_level: 2,
         auto_refresh: true,
+
+        components_path: "app/components",
         
         page_controller: "Lookbook::PageController",
         page_route: "pages",
@@ -37,13 +39,24 @@ module Lookbook
         ui_theme: "indigo",
         ui_theme_overrides: {},
 
+        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"
+            panel_classes: "overflow-hidden",
+            padded: false
           },
           output: {
             pane: :main,
@@ -51,6 +64,7 @@ module Lookbook
             partial: "lookbook/previews/panels/output",
             label: "HTML",
             hotkey: "h",
+            padded: false
           },
           source: {
             pane: :drawer,
@@ -58,7 +72,8 @@ module Lookbook
             partial: "lookbook/previews/panels/source",
             label: "Source",
             hotkey: "s",
-            copy: ->(data) { data.examples.map { |e| e[:source] }.join("\n") }
+            copy: ->(data) { data.examples.map { |e| e.source }.join("\n") },
+            padded: false
           },
           notes: {
             pane: :drawer,
@@ -66,7 +81,8 @@ module Lookbook
             partial: "lookbook/previews/panels/notes",
             label: "Notes",
             hotkey: "n",
-            disabled: ->(data) { data.examples.filter { |e| e.notes.present? }.none? }
+            disabled: ->(data) { data.examples.select { |e| e.notes.present? }.none? },
+            padded: false
           },
           params: {
             pane: :drawer,
@@ -74,7 +90,8 @@ module Lookbook
             partial: "lookbook/previews/panels/params",
             label: "Params",
             hotkey: "p",
-            disabled: ->(data) { data.preview.params.none? }
+            disabled: ->(data) { data.preview.params.none? },
+            padded: false
           }
         },
 
@@ -90,25 +107,76 @@ module Lookbook
           show: true,
           copy: nil,
           panel_classes: nil,
-          locals: {}
+          locals: {},
+          padded: true
         },
-
-        experimental_features: false,
       })
     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
+      normalize_paths(@options.page_paths)
+    end
+
+    def preview_paths
+      normalize_paths(@options.preview_paths)
+    end
+
+    def listen_paths
+      normalize_paths(@options.listen_paths)
+    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_given?
-        yield get(:inspector_panels)
+        yield panels
+      else
+        panels
+      end
+    end
+
+    def define_inspector_panel(name, opts = {})
+      @options.inspector_panels[name] = opts
+      if opts[:position].present?
+        pane = inspector_panels[name].pane.presence || :drawer
+        siblings = inspector_panels.select do |key, panel|
+          panel.pane == pane && key != name.to_sym
+        end
+        siblings.each do |key, panel|
+          if panel.position >= opts[:position]
+            panel.position += 1
+          end
+        end
+      end
+    end
+
+    def amend_inspector_panel(name, opts = {})
+      if opts == false
+        @options.inspector_panels[name] = false
       else
-        get(:inspector_panels)
+        @options.inspector_panels[name].merge!(opts)
       end
     end
 
+    def remove_inspector_panel(name)
+      amend_inspector_panel(name, false)
+    end
+
     def ui_theme=(name)
       name = name.to_s
       if Theme.valid_theme?(name)
-        @options[:ui_theme] = name
+        @options.ui_theme = name
       else
         Lookbook.logger.warn "'#{name}' is not a valid Lookbook theme. Theme setting not changed."
       end
@@ -116,18 +184,27 @@ module Lookbook
 
     def ui_theme_overrides(&block)
       if block_given?
-        yield get(:ui_theme_overrides)
+        yield @options.ui_theme_overrides
       else
-        get(:ui_theme_overrides)
+        @options.ui_theme_overrides
       end
     end
 
     def [](key)
-      get(key.to_sym)
+      if respond_to? key.to_sym
+        public_send(key.to_sym)
+      else
+        @options[key.to_sym]
+      end
     end
 
     def []=(key, value)
-      @options[key.to_sym] = 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
@@ -140,41 +217,17 @@ module Lookbook
     
     protected
 
-    def get_inspector_panels(panels)
-      panels.filter! { |key, panel| panel }
-      panels
-    end
-
-    def get_project_name(name)
-      name == false ? nil : name
-    end
-
     def normalize_paths(paths)
       paths.map! { |path| absolute_path(path) }
-      paths.filter! { |path| Dir.exist?(path) }
-      paths
+      paths.select { |path| Dir.exist?(path) }
     end
 
     def absolute_path(path)
       File.absolute_path(path.to_s, Rails.root)
     end
 
-    alias_method :get_page_paths, :normalize_paths
-    alias_method :get_preview_paths, :normalize_paths
-    alias_method :get_listen_paths, :normalize_paths
-    alias_method :get_parser_registry_path, :absolute_path
-
-    def get(name)
-      getter_name = "get_#{name}".to_sym
-      respond_to?(getter_name, true) ? send(getter_name, @options[name]) : @options[name]
-    end
-
-    def set(name, *args)
-      @options.send(name, *args)
-    end
-
     def method_missing(name, *args)
-      args.any? ? set(name, *args) : get(name)
+      @options.send(name, *args)
     end
   end
 end

data/lib/lookbook/engine.rb

@@ -8,16 +8,20 @@ module Lookbook
   autoload :Config, "lookbook/config"
   
   class << self
+    def version
+      Lookbook::VERSION
+    end
+
     def config
       @config ||= Config.new
     end
 
-    def logger
-      @logger ||= Rails.env.development? ? Logger.new($stdout) : Rails.logger
+    def configure
+      yield(config)
     end
 
-    def version
-      Lookbook::VERSION
+    def logger
+      @logger ||= Rails.env.development? ? Logger.new($stdout) : Rails.logger
     end
 
     def debug_data
@@ -28,8 +32,46 @@ module Lookbook
       }
     end
 
-    def configure
-      yield(config)
+    def previews
+      Preview.all
+    end
+
+    def pages
+      Page.all
+    end
+
+    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
+
+    def define_panel(name, opts = {})
+      config.define_inspector_panel(name, opts)
+    end
+
+    def amend_panel(name, opts = {})
+      config.amend_inspector_panel(name, opts)
+    end
+
+    def remove_panel(name)
+      config.remove_inspector_panel(name)
+    end
+
+    def broadcast(event_name, data = {})
+      Engine.websocket&.broadcast(event_name.to_s, data)
+    end
+
+    protected
+
+    def add_hook(event_name, block)
+      config.hooks[event_name] << block
     end
   end
 
@@ -43,8 +85,10 @@ module Lookbook
       config.lookbook.preview_paths += config.view_component.preview_paths
       config.lookbook.preview_controller ||= config.view_component.preview_controller
 
+      config.lookbook.components_path = config.view_component.view_component_path if config.view_component.view_component_path.present?
+
       config.lookbook.listen_paths += config.lookbook.preview_paths
-      config.lookbook.listen_paths << (config.view_component.view_component_path.presence || "app/components")
+      config.lookbook.listen_paths << config.lookbook.components_path 
     end
 
     initializer "lookbook.logging.development" do
@@ -73,12 +117,14 @@ module Lookbook
           only: /\.(rb|html.*)$/,
           force_polling: Lookbook.config.listen_use_polling
         ) do |modified, added, removed|
+          changes = { modified: modified, added: added, removed: removed }
           begin
             parser.parse
           rescue
           end
           Lookbook::Preview.clear_cache
-          Lookbook::Engine.websocket&.broadcast("reload", {})
+          Lookbook::Engine.reload_ui(changes)
+          Lookbook::Engine.run_hooks(:after_change, changes)
         end
         Lookbook::Engine.register_listener(preview_listener)
 
@@ -87,7 +133,9 @@ module Lookbook
           only: /\.(html.*|md.*)$/,
           force_polling: Lookbook.config.listen_use_polling
         ) do |modified, added, removed|
-          Lookbook::Engine.websocket&.broadcast("reload", {})
+          changes = { modified: modified, added: added, removed: removed }
+          Lookbook::Engine.reload_ui(changes)
+          Lookbook::Engine.run_hooks(:after_change, changes)
         end
         Lookbook::Engine.register_listener(page_listener)
       end
@@ -103,18 +151,20 @@ module Lookbook
           "
         end
       end
+
+      Lookbook::Engine.run_hooks(:after_initialize)
     end
 
     at_exit do
       if config.lookbook.listen
         Lookbook.logger.debug "Stopping listeners"
-        Lookbook::Engine.listeners.each do |listener|
-          listener.stop
-        end
+        Lookbook::Engine.listeners.each { |listener| listener.stop } 
       end
+      Lookbook::Engine.run_hooks(:before_exit)
     end
 
     class << self
+
       def websocket
         if config.lookbook.auto_refresh
           cable = ActionCable::Server::Configuration.new
@@ -162,6 +212,16 @@ module Lookbook
         @listeners ||= []
       end
 
+      def run_hooks(event_name, *args)
+        Lookbook.config.hooks[event_name].each do |hook|
+          hook.call(Lookbook, *args)
+        end
+      end
+
+      def reload_ui(changed = {})
+        websocket&.broadcast("reload", changed)
+      end
+
       attr_reader :preview_controller
     end
   end

data/lib/lookbook/page.rb

@@ -19,7 +19,7 @@ module Lookbook
 
     def initialize(path, base_path)
       @pathname = Pathname.new path
-      @base_path = base_path
+      @base_path = Pathname.new base_path
       @options = nil
       @errors = []
       @sections = []
@@ -30,7 +30,7 @@ module Lookbook
     end
 
     def url_path
-      page_path lookup_path
+      lookbook_page_path lookup_path
     end
 
     def full_path
@@ -177,7 +177,7 @@ module Lookbook
       end
 
       def page_paths
-        Lookbook.config.page_paths.filter { |dir| Dir.exist? dir }
+        Lookbook.config.page_paths.select { |dir| Dir.exist? dir }
       end
 
       def section_path?(path)

data/lib/lookbook/parser.rb

@@ -23,10 +23,6 @@ module Lookbook
       registry.get(path)
     end
 
-    # def yardoc_file_path
-    #   Rails&.root ? Rails.root.join(YARDOC_FILE_PATH) : YARDOC_FILE_PATH
-    # end
-
     class << self
       def define_tags
         YARD::Tags::Library.define_tag("Hidden status", :hidden)
@@ -34,6 +30,7 @@ module Lookbook
         YARD::Tags::Library.define_tag("Display", :display)
         YARD::Tags::Library.define_tag("Position", :position)
         YARD::Tags::Library.define_tag("ID", :id)
+        YARD::Tags::Library.define_tag("Component", :component)
       end
     end
   end

data/lib/lookbook/preview.rb

@@ -8,7 +8,7 @@ module Lookbook
     def initialize(preview)
       @preview = preview
       @preview_inspector = SourceInspector.new(@preview.name)
-      super(preview_class_name(preview_class_basename(@preview.name)))
+      super(preview_class_path(@preview.name))
     end
 
     def id
@@ -34,7 +34,7 @@ module Lookbook
     def examples
       return @examples if @examples.present?
       public_methods = @preview.public_instance_methods(false)
-      public_method_objects = @preview_inspector&.methods&.filter { |m| public_methods.include?(m.name) }
+      public_method_objects = @preview_inspector&.methods&.select { |m| public_methods.include?(m.name) }
       examples = (public_method_objects || []).map { |m| PreviewExample.new(m.name.to_s, self) }
       sorted = Lookbook.config.sort_examples ? examples.sort_by(&:label) : examples
       @examples = []
@@ -62,18 +62,14 @@ module Lookbook
     end
 
     def full_path
-      base_path = Array(preview_paths).detect do |preview_path|
+      base_path = Array(Lookbook.config.preview_paths).detect do |preview_path|
         Dir["#{preview_path}/#{name.underscore}.rb"].first
       end
       Pathname.new(Dir["#{base_path}/#{name.underscore}.rb"].first)
     end
 
     def url_path
-      inspect_path lookup_path
-    end
-
-    def preview_paths
-      ViewComponent::Base.preview_paths
+      lookbook_inspect_path lookup_path
     end
 
     def parent_collections_names
@@ -96,6 +92,27 @@ module Lookbook
       true
     end
 
+    def component
+      components.first
+    end
+
+    def components
+      component_classes = @preview_inspector&.components.any? ? @preview_inspector&.components : [guess_component]
+      component_classes.map do |class_name|
+        Component.new(class_name.to_s)
+      end
+    end
+
+    protected
+
+    def guess_component
+      begin
+        name.chomp("Preview").constantize
+      rescue
+        nil
+      end
+    end
+
     class << self
       def find(path)
         all.find { |p| p.lookup_path == path }

data/lib/lookbook/preview_example.rb

@@ -15,7 +15,7 @@ module Lookbook
     end
 
     def url_path
-      inspect_path lookup_path
+      lookbook_inspect_path lookup_path
     end
 
     def label
@@ -30,7 +30,7 @@ module Lookbook
       @example_inspector.source.split("\n")[1..-2].join("\n").strip_heredoc
     end
 
-    def source_lang
+    def lang
       Lookbook::Lang.find(:ruby)
     end
 

data/lib/lookbook/preview_group.rb

@@ -10,7 +10,7 @@ module Lookbook
     end
 
     def url_path
-      inspect_path lookup_path
+      lookbook_inspect_path lookup_path
     end
 
     def label

data/lib/lookbook/source_inspector.rb

@@ -39,6 +39,16 @@ module Lookbook
       code_object&.tag(:position)&.text&.to_i || 10000
     end
 
+    def components
+      if code_object&.tags(:component).present?
+        code_object.tags(:component).map do |component|
+          component.text.constantize
+        end
+      else
+        []
+      end
+    end
+
     def display_params
       display_params = {}.with_indifferent_access
       if code_object&.tags(:display).present?

data/lib/lookbook/utils.rb

@@ -16,7 +16,7 @@ module Lookbook
       class_name(klass).to_s.chomp("ComponentPreview").chomp("Component::Preview").chomp("::Preview").chomp("Component").chomp("Preview").chomp("::")
     end
 
-    def preview_class_name(klass)
+    def preview_class_path(klass)
       preview_class_basename(klass).underscore
     end
 
@@ -49,7 +49,7 @@ module Lookbook
     end
 
     def to_preview_path(*args)
-      args.flatten.map { |arg| preview_class_name(arg) }.join("/")
+      args.flatten.map { |arg| preview_class_path(arg) }.join("/")
     end
 
     protected

data/lib/lookbook/version.rb

@@ -1,3 +1,3 @@
 module Lookbook
-  VERSION = "1.0.0.beta.1"
+  VERSION = "1.0.0.beta.4"
 end

data/lib/lookbook.rb

@@ -27,16 +27,5 @@ module Lookbook
   autoload :Markdown, "lookbook/markdown"
   autoload :Theme, "lookbook/theme"
   autoload :Store, "lookbook/store"
-
-  class << self
-    include Utils
-
-    def previews
-      Preview.all
-    end
-
-    def pages
-      Page.all
-    end
-  end
+  autoload :Component, "lookbook/component"
 end