lookbook 1.0.0.beta.6 → 1.0.0.rc.1

data/lib/lookbook/config.rb

@@ -6,14 +6,14 @@ module Lookbook
   class Config
     def initialize
       @options = Store.new
-      
+
       @options.set({
         project_name: "Lookbook",
         log_level: 2,
         auto_refresh: true,
 
         components_path: "app/components",
-        
+
         page_controller: "Lookbook::PageController",
         page_route: "pages",
         page_paths: ["test/components/docs"],
@@ -23,6 +23,7 @@ module Lookbook
         preview_paths: [],
         preview_display_params: {},
         preview_srcdoc: nil,
+        preview_tags: {},
         sort_examples: false,
 
         listen: Rails.env.development?,
@@ -38,11 +39,12 @@ module Lookbook
 
         ui_theme: "indigo",
         ui_theme_overrides: {},
+        ui_favicon: true,
 
         hooks: {
           after_initialize: [],
           before_exit: [],
-          after_change: [],
+          after_change: []
         },
 
         debug_menu: Rails.env.development?,
@@ -98,7 +100,7 @@ module Lookbook
             padded: false,
             system: true
           }
-        },
+        }
       })
     end
 
@@ -145,7 +147,7 @@ module Lookbook
 
     def inspector_panels(&block)
       panels = Store.new(@options.inspector_panels.select { |key, panel| panel != false })
-      if block_given?
+      if block
         yield panels
       else
         panels
@@ -156,7 +158,7 @@ module Lookbook
       pane = opts[:pane].presence || :drawer
       siblings = inspector_panels.select { |key, panel| panel.pane == pane }
       opts[:position] ||= siblings.size + 1
-      @options.inspector_panels[name] = opts      
+      @options.inspector_panels[name] = opts
       siblings.each do |key, panel|
         if panel.position >= opts[:position]
           panel.position += 1
@@ -190,7 +192,6 @@ module Lookbook
         copy: nil,
         panel_classes: nil,
         locals: {},
-        padded: true,
         system: false
       }
     end
@@ -205,7 +206,7 @@ module Lookbook
     end
 
     def ui_theme_overrides(&block)
-      if block_given?
+      if block
         yield @options.ui_theme_overrides
       else
         @options.ui_theme_overrides
@@ -236,7 +237,7 @@ module Lookbook
     def to_json(*a)
       to_h.to_json(*a)
     end
-    
+
     protected
 
     def normalize_paths(paths)
@@ -254,5 +255,9 @@ module Lookbook
     def method_missing(name, *args)
       @options.send(name, *args)
     end
+
+    def respond_to_missing?(name, *)
+      to_h.key? name
+    end
   end
-end
+end

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,21 @@ 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
@@ -48,46 +57,12 @@ module Lookbook
       Page.any?
     end
 
-    def data
-      @data ||= Store.new
-    end
-
-    def data=(props)
-      @data = Store.new(props)
-    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
+    def theme
+      @theme ||= Lookbook::Theme.new(config.ui_theme, config.ui_theme_overrides)
     end
   end
 
@@ -97,14 +72,14 @@ module Lookbook
     config.lookbook = Lookbook.config
     config.autoload_paths << File.expand_path(Lookbook::Engine.root.join("app/components"))
 
-    initializer "lookbook.viewcomponent.config" do      
+    initializer "lookbook.viewcomponent.config" do
       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.lookbook.components_path 
+      config.lookbook.listen_paths << config.lookbook.components_path
     end
 
     initializer "lookbook.logging.development" do
@@ -112,7 +87,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
@@ -126,39 +101,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: /\.(#{config.lookbook.listen_extensions.join("|")})$/,
-          force_polling: config.lookbook.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: 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)
+      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 "
@@ -172,16 +128,48 @@ 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 } 
+        Lookbook::Engine.listeners.each { |listener| listener.stop }
       end
       Lookbook::Engine.run_hooks(:before_exit)
     end
 
     class << self
-
       def websocket
         return @websocket unless @websocket.nil?
         if config.lookbook.auto_refresh
@@ -194,9 +182,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
@@ -218,7 +206,12 @@ module Lookbook
       end
 
       def app_name
-        Rails.application.class.module_parent_name.underscore
+        name = if Gem::Version.new(Rails.version) >= Gem::Version.new("6.1")
+          Rails.application.class.module_parent_name
+        else
+          Rails.application.class.parent_name
+        end
+        name.underscore
       end
 
       def register_listener(listener)
@@ -231,7 +224,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/entity.rb

@@ -44,4 +44,4 @@ module Lookbook
 
     alias_method :url_path, :lookup_path
   end
-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

@@ -13,7 +13,7 @@ module Lookbook
     }
 
     def self.render(text)
-      text&.gsub!(/\<\!\-\- (BEGIN|END) (.*) \-\-\>/, "")
+      text&.gsub!(/<!-- (BEGIN|END) (.*) -->/, "")
       markdown = Redcarpet::Markdown.new(Renderer, Lookbook.config.markdown_options)
       markdown.render(text).html_safe
     end

data/lib/lookbook/page.rb

@@ -1,6 +1,5 @@
 module Lookbook
   class Page < Entity
-
     FRONTMATTER_FIELDS = [
       :id,
       :label,
@@ -76,7 +75,7 @@ module Lookbook
     def type
       :page
     end
-    
+
     def id
       options[:id]
     end
@@ -125,7 +124,7 @@ module Lookbook
         }))
       end
       @options = Lookbook.config.page_options.deep_merge(frontmatter).with_indifferent_access
-      @options[:id] = @options[:id] ? generate_id(@options[:id]) : generate_id(lookup_path)
+      @options[:id] = generate_id(@options[:id] || lookup_path)
       @options[:label] ||= name.titleize
       @options[:title] ||= @options[:label]
       @options[:hidden] ||= false
@@ -159,7 +158,7 @@ module Lookbook
       end
 
       def all
-         pages, sections =
+        pages, sections =
           Array(page_paths).flat_map do |dir|
             Dir["#{dir}/**/*.html.*", "#{dir}/**/*.md.*"].sort.map do |path|
               create(path, dir)
@@ -172,7 +171,7 @@ module Lookbook
 
         page_dict = sorted_pages.index_by(&:path)
         sorted_sections = sections.sort_by { |section| [section.position, section.label] }
-        
+
         sorted_sections.each do |section|
           page_dict[section.path].sections << section
         end

data/lib/lookbook/page_section.rb

@@ -1,6 +1,5 @@
 module Lookbook
   class PageSection < Page
-
     def name
       return @name if @name.present?
       matches = full_path.to_s.match(%r{\[(?<name>\w+)\]})
@@ -24,8 +23,7 @@ module Lookbook
     end
 
     def lookup_path
-       "#{super}/#{name}"
+      "#{super}/#{name}"
     end
-
   end
-end
+end

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/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
@@ -97,7 +97,7 @@ module Lookbook
     end
 
     def components
-      component_classes = @preview_inspector&.components.any? ? @preview_inspector&.components : [guess_component]
+      component_classes = @preview_inspector&.components&.any? ? @preview_inspector&.components : [guess_component]
       component_classes.map do |class_name|
         Component.new(class_name.to_s)
       end
@@ -106,11 +106,9 @@ module Lookbook
     protected
 
     def guess_component
-      begin
-        name.chomp("Preview").constantize
-      rescue
-        nil
-      end
+      name.chomp("Preview").constantize
+    rescue
+      nil
     end
 
     class << self
@@ -156,7 +154,7 @@ module Lookbook
 
       def clear_cache
         cache_dir = File.dirname(cache_marker_path)
-        FileUtils.mkdir_p(cache_dir) unless File.exists?(cache_dir)
+        FileUtils.mkdir_p(cache_dir) unless File.exist?(cache_dir)
         File.write(cache_marker_path, Time.now.to_i)
       end
 
@@ -167,7 +165,7 @@ module Lookbook
       end
 
       def cache_stale?
-        return false if !File.exists?(cache_marker_path)
+        return false if !File.exist?(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
@@ -179,7 +177,7 @@ module Lookbook
 
       def mark_as_cached
         cache_dir = File.dirname(cache_marker_path)
-        FileUtils.mkdir_p(cache_dir) unless File.exists?(cache_dir)
+        FileUtils.mkdir_p(cache_dir) unless File.exist?(cache_dir)
         File.write(cache_marker_path, Time.now)
       end
 
@@ -196,14 +194,14 @@ 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|
             {
               path: path,
               base_path: preview_path,
-              rel_path: Pathname(path).relative_path_from(preview_path).to_s
+              rel_path: Pathname(path).relative_path_from(Pathname.new(preview_path)).to_s
             }
           end
         end

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
@@ -11,7 +11,7 @@ module Lookbook
     end
 
     def id
-      generate_id(@preview.id, name)
+      @example_inspector&.id || generate_id(@preview.id, name)
     end
 
     def url_path

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

@@ -10,37 +10,39 @@ module Lookbook
     end
 
     def hidden?
-      if code_object&.tag(:hidden)
+      @hidden ||= if code_object&.tag(:hidden)
         code_object.tag(:hidden).text.strip != "false"
+      else
+        false
       end
     end
 
     def id
-      if code_object&.tag(:id)&.text&.present?
+      @id ||= if code_object&.tag(:id)&.text&.present?
         generate_id(code_object&.tag(:id)&.text)
       end
     end
 
     def label
-      code_object&.tag(:label)&.text
+      @label ||= code_object&.tag(:label)&.text
     end
 
     def notes
-      if code_object&.docstring
+      @notes ||= if code_object&.docstring
         code_object.docstring.to_s.strip
       end
     end
 
     def group
-      code_object&.group
+      @group ||= code_object&.group
     end
 
     def position
-      code_object&.tag(:position)&.text&.to_i || 10000
+      @position ||= code_object&.tag(:position)&.text&.to_i || 10000
     end
 
     def components
-      if code_object&.tags(:component).present?
+      @components ||= if code_object&.tags(:component).present?
         code_object.tags(:component).map do |component|
           component.text.constantize
         end
@@ -50,7 +52,8 @@ module Lookbook
     end
 
     def display_params
-      display_params = {}.with_indifferent_access
+      return @display_params unless @display_params.nil?
+      @display_params = {}.with_indifferent_access
       if code_object&.tags(:display).present?
         code_object.tags(:display).each do |tag|
           parts = tag.text.strip.match(/^([^\s]*)\s?(.*)$/)
@@ -63,11 +66,11 @@ module Lookbook
           end
         end
       end
-      display_params
+      @display_params
     end
 
     def parameter_defaults
-      code_object&.parameters&.map { |str| Params.parse_method_param_str(str) }&.compact&.to_h
+      @param_defaults ||= code_object&.parameters&.map { |str| Params.parse_method_param_str(str) }&.compact&.to_h
     end
 
     def params
@@ -77,7 +80,16 @@ module Lookbook
     end
 
     def methods
-      code_object&.meths
+      @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