lookbook 1.0.0.beta.3 → 1.0.0.beta.6

data/lib/lookbook/config.rb

@@ -6,7 +6,7 @@ module Lookbook
   class Config
     def initialize
       @options = Store.new
-      foobar = "bax"
+      
       @options.set({
         project_name: "Lookbook",
         log_level: 2,
@@ -22,12 +22,12 @@ module Lookbook
 
         preview_paths: [],
         preview_display_params: {},
-        preview_options: {},
-        preview_srcdoc: false,
-        sort_examples: true,
+        preview_srcdoc: nil,
+        sort_examples: false,
 
         listen: Rails.env.development?,
         listen_paths: [],
+        listen_extensions: ["rb", "html.*"],
         listen_use_polling: false,
 
         cable_mount_path: "/lookbook-cable",
@@ -45,6 +45,8 @@ module Lookbook
           after_change: [],
         },
 
+        debug_menu: Rails.env.development?,
+
         experimental_features: false,
 
         inspector_panels: {
@@ -54,7 +56,8 @@ module Lookbook
             partial: "lookbook/previews/panels/preview",
             hotkey: "v",
             panel_classes: "overflow-hidden",
-            padded: false
+            padded: false,
+            system: true
           },
           output: {
             pane: :main,
@@ -62,7 +65,8 @@ module Lookbook
             partial: "lookbook/previews/panels/output",
             label: "HTML",
             hotkey: "h",
-            padded: false
+            padded: false,
+            system: true
           },
           source: {
             pane: :drawer,
@@ -71,7 +75,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,
@@ -80,7 +85,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,
@@ -89,56 +95,80 @@ 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
 
+    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_given?
-        yield get(:inspector_panels)
+        yield panels
       else
-        get(:inspector_panels)
+        panels
       end
     end
 
     def define_inspector_panel(name, opts = {})
-      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
 
     def amend_inspector_panel(name, opts = {})
       if opts == false
-        inspector_panels[name] = false
+        @options.inspector_panels[name] = false
       else
-        inspector_panels[name].merge!(opts)
+        @options.inspector_panels[name].merge!(opts)
       end
     end
 
@@ -146,10 +176,29 @@ 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)
-        @options[:ui_theme] = name
+        @options.ui_theme = name
       else
         Lookbook.logger.warn "'#{name}' is not a valid Lookbook theme. Theme setting not changed."
       end
@@ -157,18 +206,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
@@ -181,22 +239,11 @@ module Lookbook
     
     protected
 
-    def get_inspector_panels(panels)
-      panels.select! { |key, panel| panel }
-      panels
-    end
-
-    def get_project_name(name)
-      name == false ? nil : name
-    end
-
-    def get_components_path(path)
-      absolute_path(path)
-    end
-
     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
 
@@ -204,22 +251,8 @@ module Lookbook
       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

@@ -36,10 +36,26 @@ module Lookbook
       Preview.all
     end
 
+    def previews?
+      Preview.any?
+    end
+
     def pages
       Page.all
     end
 
+    def pages?
+      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
@@ -112,10 +128,11 @@ module Lookbook
 
       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
+          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
@@ -131,7 +148,7 @@ module Lookbook
         page_listener = Listen.to(
           *config.lookbook.page_paths,
           only: /\.(html.*|md.*)$/,
-          force_polling: Lookbook.config.listen_use_polling
+          force_polling: config.lookbook.listen_use_polling
         ) do |modified, added, removed|
           changes = { modified: modified, added: added, removed: removed }
           Lookbook::Engine.reload_ui(changes)
@@ -166,6 +183,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 +194,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
+            @websocket ||= ActionCable::Server::Base.new
+            @websocket.config = cable
+            @websocket
           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/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/preview.rb

@@ -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/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

data/lib/lookbook/version.rb

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

data/lib/tasks/lookbook_tasks.rake

@@ -16,7 +16,7 @@ namespace :lookbook do
 
   namespace :previews do
     desc "Preparse the previews"
-    task :preparse do
+    task :preparse => :environment do
       Lookbook::Engine.parser.parse
       puts "Lookbook preview parsing complete"
     end