lookbook 1.0.0.beta.4 → 1.0.0.beta.7

data/lib/lookbook/config.rb

@@ -22,12 +22,13 @@ module Lookbook
 
         preview_paths: [],
         preview_display_params: {},
-        preview_options: {},
-        preview_srcdoc: false,
-        sort_examples: true,
+        preview_srcdoc: nil,
+        preview_tags: {},
+        sort_examples: false,
 
         listen: Rails.env.development?,
         listen_paths: [],
+        listen_extensions: ["rb", "html.*"],
         listen_use_polling: false,
 
         cable_mount_path: "/lookbook-cable",
@@ -38,6 +39,7 @@ module Lookbook
 
         ui_theme: "indigo",
         ui_theme_overrides: {},
+        ui_favicon: true,
 
         hooks: {
           after_initialize: [],
@@ -56,7 +58,8 @@ module Lookbook
             partial: "lookbook/previews/panels/preview",
             hotkey: "v",
             panel_classes: "overflow-hidden",
-            padded: false
+            padded: false,
+            system: true
           },
           output: {
             pane: :main,
@@ -64,7 +67,8 @@ module Lookbook
             partial: "lookbook/previews/panels/output",
             label: "HTML",
             hotkey: "h",
-            padded: false
+            padded: false,
+            system: true
           },
           source: {
             pane: :drawer,
@@ -73,7 +77,8 @@ module Lookbook
             label: "Source",
             hotkey: "s",
             copy: ->(data) { data.examples.map { |e| e.source }.join("\n") },
-            padded: false
+            padded: false,
+            system: true
           },
           notes: {
             pane: :drawer,
@@ -82,7 +87,8 @@ module Lookbook
             label: "Notes",
             hotkey: "n",
             disabled: ->(data) { data.examples.select { |e| e.notes.present? }.none? },
-            padded: false
+            padded: false,
+            system: true
           },
           params: {
             pane: :drawer,
@@ -91,25 +97,10 @@ module Lookbook
             label: "Params",
             hotkey: "p",
             disabled: ->(data) { data.preview.params.none? },
-            padded: false
+            padded: false,
+            system: true
           }
         },
-
-        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: {},
-          padded: true
-        },
       })
     end
 
@@ -121,18 +112,35 @@ module Lookbook
       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
@@ -147,16 +155,13 @@ module Lookbook
     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
+      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
@@ -173,6 +178,25 @@ module Lookbook
       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: {},
+        padded: true,
+        system: false
+      }
+    end
+
     def ui_theme=(name)
       name = name.to_s
       if Theme.valid_theme?(name)
@@ -218,8 +242,11 @@ module Lookbook
     protected
 
     def normalize_paths(paths)
-      paths.map! { |path| absolute_path(path) }
-      paths.select { |path| Dir.exist?(path) }
+      paths.map! do |path|
+        full_path = absolute_path(path)
+        full_path if Dir.exist?(full_path)
+      end.compact!
+      paths
     end
 
     def absolute_path(path)

data/lib/lookbook/data.rb

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

data/lib/lookbook/engine.rb

@@ -2,12 +2,22 @@ require "rails"
 require "view_component"
 require "action_cable/engine"
 require "listen"
+require "rake"
 
 module Lookbook
 
   autoload :Config, "lookbook/config"
-  
+  autoload :Data, "lookbook/data"
+  autoload :Hooks, "lookbook/hooks"
+  autoload :Panels, "lookbook/panels"
+  autoload :Tags, "lookbook/tags"
+
   class << self
+    include Lookbook::Data
+    include Lookbook::Hooks
+    include Lookbook::Panels
+    include Lookbook::Tags
+
     def version
       Lookbook::VERSION
     end
@@ -36,42 +46,24 @@ module Lookbook
       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)
+    def previews?
+      Preview.any?
     end
 
-    def amend_panel(name, opts = {})
-      config.amend_inspector_panel(name, opts)
+    def pages
+      Page.all
     end
 
-    def remove_panel(name)
-      config.remove_inspector_panel(name)
+    def pages?
+      Page.any?
     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
+    def theme
+      @theme ||= Lookbook::Theme.new(config.ui_theme, config.ui_theme_overrides)
     end
   end
 
@@ -96,7 +88,7 @@ module Lookbook
     end
 
     initializer "lookbook.parser.tags" do
-      Lookbook::Parser.define_tags
+      Lookbook::Parser.define_tags(Lookbook.config.preview_tags)
     end
 
     initializer "lookbook.assets.serve" do
@@ -110,38 +102,20 @@ module Lookbook
       @preview_controller = Lookbook.config.preview_controller.constantize
       @preview_controller.include(Lookbook::PreviewController)
 
-      if config.lookbook.listen
-        Listen.logger = Lookbook.logger
-        preview_listener = Listen.to(
-          *config.lookbook.listen_paths,
-          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.reload_ui(changes)
-          Lookbook::Engine.run_hooks(:after_change, changes)
+      if Gem::Version.new(Rails.version) >= Gem::Version.new("6.1.3.1")
+        # Rails.application.server is only available for newer Rails versions
+        Rails.application.server do
+          init_listeners
         end
-        Lookbook::Engine.register_listener(preview_listener)
-
-        page_listener = Listen.to(
-          *config.lookbook.page_paths,
-          only: /\.(html.*|md.*)$/,
-          force_polling: Lookbook.config.listen_use_polling
-        ) do |modified, added, removed|
-          changes = { modified: modified, added: added, removed: removed }
-          Lookbook::Engine.reload_ui(changes)
-          Lookbook::Engine.run_hooks(:after_change, changes)
+      else
+        # Fallback for older Rails versions - don't start listeners if running in a rake task.
+        unless File.basename($0) == "rake" || Rake.application.top_level_tasks.any?
+          init_listeners 
         end
-        Lookbook::Engine.register_listener(page_listener)
       end
 
       if config.lookbook.runtime_parsing
-        parser.parse
+        Lookbook::Engine.parser.parse
       else
         unless File.exist?(config.lookbook.parser_registry_path)
           Lookbook.logger.warn "
@@ -155,8 +129,41 @@ module Lookbook
       Lookbook::Engine.run_hooks(:after_initialize)
     end
 
+    def init_listeners
+      return unless config.lookbook.listen == true
+      Listen.logger = Lookbook.logger
+      Lookbook.logger.info "Initializing listeners"
+      
+      preview_listener = Listen.to(
+        *config.lookbook.listen_paths,
+        only: /\.(#{config.lookbook.listen_extensions.join("|")})$/,
+        force_polling: config.lookbook.listen_use_polling
+      ) do |modified, added, removed|
+        changes = { modified: modified, added: added, removed: removed }
+        begin
+          Lookbook::Engine.parser.parse
+        rescue
+        end
+        Lookbook::Preview.clear_cache
+        Lookbook::Engine.reload_ui(changes)
+        Lookbook::Engine.run_hooks(:after_change, changes)
+      end
+      Lookbook::Engine.register_listener(preview_listener)
+
+      page_listener = Listen.to(
+        *config.lookbook.page_paths,
+        only: /\.(html.*|md.*)$/,
+        force_polling: config.lookbook.listen_use_polling
+      ) do |modified, added, removed|
+        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
+
     at_exit do
-      if config.lookbook.listen
+      if Lookbook::Engine.listeners.any?
         Lookbook.logger.debug "Stopping listeners"
         Lookbook::Engine.listeners.each { |listener| listener.stop } 
       end
@@ -166,6 +173,7 @@ module Lookbook
     class << self
 
       def websocket
+        return @websocket unless @websocket.nil?
         if config.lookbook.auto_refresh
           cable = ActionCable::Server::Configuration.new
           cable.cable = {adapter: "async"}.with_indifferent_access
@@ -176,9 +184,9 @@ module Lookbook
           @websocket ||= if Rails.version.to_f >= 6.0
             ActionCable::Server::Base.new(config: cable)
           else
-            websocket ||= ActionCable::Server::Base.new
-            websocket.config = cable
-            websocket
+            ws = ActionCable::Server::Base.new
+            ws.config = cable
+            ws
           end
         end
       end
@@ -213,7 +221,7 @@ module Lookbook
       end
 
       def run_hooks(event_name, *args)
-        Lookbook.config.hooks[event_name].each do |hook|
+        config.lookbook.hooks[event_name].each do |hook|
           hook.call(Lookbook, *args)
         end
       end

data/lib/lookbook/hooks.rb

@@ -0,0 +1,21 @@
+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/markdown.rb

@@ -8,10 +8,12 @@ module Lookbook
       disable_indented_code_blocks: true,
       strikethrough: true,
       highlight: true,
-      with_toc_data: true
+      with_toc_data: true,
+      lax_spacing: true
     }
 
     def self.render(text)
+      text&.gsub!(/\<\!\-\- (BEGIN|END) (.*) \-\-\>/, "")
       markdown = Redcarpet::Markdown.new(Renderer, Lookbook.config.markdown_options)
       markdown.render(text).html_safe
     end

data/lib/lookbook/page.rb

@@ -154,6 +154,10 @@ module Lookbook
         !!find(path)
       end
 
+      def any?
+        all.any?
+      end
+
       def all
          pages, sections =
           Array(page_paths).flat_map do |dir|

data/lib/lookbook/panels.rb

@@ -0,0 +1,15 @@
+module Lookbook
+  module Panels
+    def define_panel(name, opts = {})
+      Lookbook.config.define_inspector_panel(name, opts)
+    end
+
+    def amend_panel(name, opts = {})
+      Lookbook.amend_inspector_panel(name, opts)
+    end
+
+    def remove_panel(name)
+      Lookbook.remove_inspector_panel(name)
+    end
+  end
+end

data/lib/lookbook/params.rb

@@ -63,6 +63,14 @@ module Lookbook
             result = []
           end
           result
+        when "datetime"
+          begin
+            result = DateTime.parse(value)
+          rescue Date::Error
+            Lookbook.logger.debug "Failed to parse '#{value}' into a DateTime"
+            result = DateTime.now
+          end
+          result
         else
           begin
             type_class = "ActiveModel::Type::#{type}".constantize
@@ -92,6 +100,8 @@ module Lookbook
           "Boolean"
         elsif default.is_a? Symbol
           "Symbol"
+        elsif ["date", "datetime-local"].include?(input&.downcase) || default.is_a?(DateTime)
+          "DateTime"
         else
           "String"
         end
@@ -99,6 +109,8 @@ module Lookbook
 
       def input_text?(input)
         [
+          "date",
+          "datetime-local",
           "email",
           "number",
           "tel",

data/lib/lookbook/parser.rb

@@ -24,13 +24,16 @@ module Lookbook
     end
 
     class << self
-      def define_tags
+      def define_tags(custom = {})
         YARD::Tags::Library.define_tag("Hidden status", :hidden)
         YARD::Tags::Library.define_tag("Label", :label)
         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)
+        custom.each do |name, opts|
+          YARD::Tags::Library.define_tag(name.to_s.titleize, name)
+        end
       end
     end
   end

data/lib/lookbook/preview.rb

@@ -3,7 +3,7 @@ module Lookbook
     include Utils
 
     delegate :name, :render_args, to: :@preview
-    delegate :position, :group, :notes, :hidden?, to: :@preview_inspector
+    delegate :position, :group, :notes, :hidden?, :tags, :tag, to: :@preview_inspector
 
     def initialize(preview)
       @preview = preview
@@ -122,14 +122,15 @@ module Lookbook
         !!find(path)
       end
 
-      def clear_cache
-        @previews = nil
+      def any?
+        all.any?
       end
 
       def all
         load_previews if preview_files.size > ViewComponent::Preview.descendants.size
 
-        return @previews if @previews.present?
+        @previews = nil if cache_stale?
+        return @previews unless @previews.nil?
 
         previews = ViewComponent::Preview.descendants.map do |p|
           new(p)
@@ -144,15 +145,44 @@ module Lookbook
         end
 
         sorted_previews = previews.compact.sort_by { |preview| [preview.position, preview.label] }
-        @previews ||= PreviewCollection.new(sorted_previews)
+        @previews = PreviewCollection.new(sorted_previews)
+        mark_as_cached if Lookbook.config.listen == true
+        @previews
       end
 
       def errors
         @errors ||= []
       end
 
+      def clear_cache
+        cache_dir = File.dirname(cache_marker_path)
+        FileUtils.mkdir_p(cache_dir) unless File.exists?(cache_dir)
+        File.write(cache_marker_path, Time.now.to_i)
+      end
+
       protected
 
+      def cache_marker_path
+        Rails.root.join("tmp/cache/lookbook-previews")
+      end
+
+      def cache_stale?
+        return false if !File.exists?(cache_marker_path)
+        cache_timestamp = File.read(cache_marker_path).to_i
+        if @last_cache_timestamp.nil? || cache_timestamp > @last_cache_timestamp
+          @last_cache_timestamp = cache_timestamp
+          true
+        else
+          false
+        end
+      end
+
+      def mark_as_cached
+        cache_dir = File.dirname(cache_marker_path)
+        FileUtils.mkdir_p(cache_dir) unless File.exists?(cache_dir)
+        File.write(cache_marker_path, Time.now)
+      end
+
       def load_previews
         @errors = []
         preview_files.each do |file|
@@ -166,7 +196,7 @@ module Lookbook
           )
         end
       end
-
+    
       def preview_files
         files = Array(Lookbook.config.preview_paths).map do |preview_path|
           Dir["#{preview_path}/**/*preview.rb"].map do |path|

data/lib/lookbook/preview_example.rb

@@ -1,7 +1,7 @@
 module Lookbook
   class PreviewExample < Entity
     attr_reader :name, :preview
-    delegate :params, :position, :group, :notes, :hidden?, :source, to: :@example_inspector
+    delegate :params, :position, :group, :notes, :hidden?, :source, :tags, :tag, to: :@example_inspector
 
     def initialize(name, preview)
       @name = name

data/lib/lookbook/preview_group.rb

@@ -49,6 +49,14 @@ module Lookbook
       @preview.hierarchy_depth + 1
     end
 
+    def tags(name = nil)
+      examples.map { |example| example.tags(name) }.flatten
+    end
+
+    def tag(name = nil)
+      tags(name).first
+    end
+
     alias_method :lookup_path, :path
   end
 end

data/lib/lookbook/source_inspector.rb

@@ -79,5 +79,14 @@ module Lookbook
     def methods
       code_object&.meths
     end
+
+    def tags(name = nil)
+      tag_objects = code_object&.tags(name).presence || []
+      Lookbook::Tags.process_tags(tag_objects)
+    end
+
+    def tag(name = nil)
+      tags(name).first
+    end
   end
 end

data/lib/lookbook/store.rb

@@ -21,6 +21,14 @@ module Lookbook
       self
     end
 
+    def get(key, fallback = nil)
+      if self.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