lookbook 1.0.0 → 1.0.8

data/lib/lookbook/config.rb

@@ -5,7 +5,7 @@ require "lookbook/store"
 module Lookbook
   class Config
     def initialize
-      @options = Store.new
+      @options = Store.new({}, true)
 
       @options.set({
         project_name: "Lookbook",
@@ -24,6 +24,7 @@ module Lookbook
         preview_display_params: {},
         preview_srcdoc: nil,
         preview_tags: {},
+        preview_disable_action_view_annotations: true,
         sort_examples: false,
 
         listen: Rails.env.development?,
@@ -31,10 +32,9 @@ module Lookbook
         listen_extensions: ["rb", "html.*"],
         listen_use_polling: false,
 
-        cable_mount_path: "/lookbook-cable",
+        cable_mount_path: "/cable",
         cable_logger: Lookbook.logger,
 
-        runtime_parsing: !Rails.env.production?,
         parser_registry_path: "tmp/storage/.yardoc",
 
         ui_theme: "indigo",
@@ -104,6 +104,10 @@ module Lookbook
       })
     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

data/lib/lookbook/data.rb

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

data/lib/lookbook/engine.rb

@@ -1,7 +1,6 @@
 require "view_component"
 require "action_cable/engine"
 require "listen"
-require "rake"
 
 module Lookbook
   autoload :Config, "lookbook/config"
@@ -36,7 +35,7 @@ module Lookbook
       {
         version: version,
         env: Rails.env.to_s,
-        config: config
+        config: config.to_h
       }
     end
 
@@ -44,18 +43,10 @@ module Lookbook
       Preview.all
     end
 
-    def previews?
-      Preview.any?
-    end
-
     def pages
       Page.all
     end
 
-    def pages?
-      Page.any?
-    end
-
     def broadcast(event_name, data = {})
       Engine.websocket&.broadcast(event_name.to_s, data)
     end
@@ -100,6 +91,11 @@ module Lookbook
       @preview_controller = Lookbook.config.preview_controller.constantize
       @preview_controller.include(Lookbook::PreviewController)
 
+      parser.after_parse do |registry|
+        Preview.load!(registry.all(:class))
+        reload_ui
+      end
+
       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
@@ -107,89 +103,82 @@ module Lookbook
         end
       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?
+        unless Lookbook::Engine.prevent_listening?
           init_listeners
         end
       end
 
-      if config.lookbook.runtime_parsing
-        Lookbook::Engine.parser.parse
-      else
-        unless File.exist?(config.lookbook.parser_registry_path)
-          Lookbook.logger.warn "
-            Runtime parsing is disabled but no registry file has been found.
-            Did you run `rake lookbook:preparse` before starting the app?
-            Expected to find registry file at #{config.lookbook.parser_registry_path}
-          "
-        end
+      parser.parse do
+        Lookbook::Engine.run_hooks(:after_initialize)
       end
-
-      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 Lookbook::Engine.listeners.any?
         Lookbook.logger.debug "Stopping listeners"
-        Lookbook::Engine.listeners.each { |listener| listener.stop }
+        Lookbook::Engine.stop_listeners
       end
       Lookbook::Engine.run_hooks(:before_exit)
     end
 
     class << self
+      def init_listeners
+        config = Lookbook.config
+        return unless config.listen == true
+        Listen.logger = Lookbook.logger
+
+        listen_paths = config.listen_paths.uniq
+        if listen_paths.any?
+          preview_listener = Listen.to(*listen_paths,
+            only: /\.(#{config.listen_extensions.join("|")})$/,
+            force_polling: config.listen_use_polling) do |modified, added, removed|
+            parser.parse do
+              run_hooks(:after_change, {modified: modified, added: added, removed: removed})
+            end
+          end
+          register_listener(preview_listener)
+        end
+
+        page_paths = config.page_paths.uniq
+        if page_paths.any?
+          page_listener = Listen.to(*page_paths,
+            only: /\.(html.*|md.*)$/,
+            force_polling: config.listen_use_polling) do |modified, added, removed|
+            changes = {modified: modified, added: added, removed: removed}
+            reload_ui
+            run_hooks(:after_change, changes)
+          end
+          register_listener(page_listener)
+        end
+      end
+
       def websocket
+        config = Lookbook.config
         return @websocket unless @websocket.nil?
-        if config.lookbook.auto_refresh
-          cable = ActionCable::Server::Configuration.new
-          cable.cable = {adapter: "async"}.with_indifferent_access
-          cable.mount_path = config.lookbook.cable_mount_path
-          cable.connection_class = -> { Lookbook::Connection }
-          cable.logger = config.lookbook.cable_logger
-
-          @websocket ||= if Rails.version.to_f >= 6.0
-            ActionCable::Server::Base.new(config: cable)
-          else
-            ws = ActionCable::Server::Base.new
-            ws.config = cable
-            ws
-          end
+        return unless config.auto_refresh == true && config.listen == true && !Rails.env.test?
+        Lookbook.logger.info "Initializing websocket"
+
+        cable = ActionCable::Server::Configuration.new
+        cable.cable = {adapter: "async"}.with_indifferent_access
+        cable.mount_path = nil
+        cable.connection_class = -> { Lookbook::Connection }
+        cable.logger = config.cable_logger
+
+        @websocket ||= if Gem::Version.new(Rails.version) >= Gem::Version.new(6.0)
+          ActionCable::Server::Base.new(config: cable)
+        else
+          ws = ActionCable::Server::Base.new
+          ws.config = cable
+          ws
         end
       end
 
       def websocket_mount_path
-        "#{mounted_path}#{config.lookbook.cable_mount_path}" if websocket
+        "#{mounted_path}#{config.lookbook.cable_mount_path}".gsub("//", "/") if websocket?
+      end
+
+      def websocket?
+        websocket.present?
       end
 
       def mounted_path
@@ -197,7 +186,7 @@ module Lookbook
       end
 
       def parser
-        @parser ||= Lookbook::Parser.new(config.lookbook.preview_paths, config.lookbook.parser_registry_path)
+        @parser ||= Lookbook::Parser.new(config.lookbook.preview_paths)
       end
 
       def log_level
@@ -222,14 +211,30 @@ module Lookbook
         @listeners ||= []
       end
 
+      def stop_listeners
+        listeners.each { |listener| listener.stop }
+      end
+
       def run_hooks(event_name, *args)
         config.lookbook.hooks[event_name].each do |hook|
           hook.call(Lookbook, *args)
         end
       end
 
-      def reload_ui(changed = {})
-        websocket&.broadcast("reload", changed)
+      def reload_ui
+        websocket&.broadcast("reload", {})
+      end
+
+      def prevent_listening?
+        Rails.env.test? || running_in_rake_task?
+      end
+
+      def running_in_rake_task?
+        if defined?(Rake) && Rake.respond_to?(:application)
+          File.basename($0) == "rake" || Rake.application.top_level_tasks.any?
+        else
+          false
+        end
       end
 
       attr_reader :preview_controller

data/lib/lookbook/page.rb

@@ -13,7 +13,7 @@ module Lookbook
       :data
     ]
 
-    attr_reader :errors
+    attr_reader :errors, :rel_path
     attr_accessor :sections
 
     def initialize(path, base_path)
@@ -23,8 +23,8 @@ module Lookbook
       @errors = []
       @sections = []
       @page_name = remove_position_prefix(path_name)
-      rel_path = @pathname.relative_path_from(@base_path)
-      page_path = rel_path.dirname.to_s == "." ? @page_name : "#{rel_path.dirname}/#{@page_name}"
+      @rel_path = @pathname.relative_path_from(@base_path)
+      page_path = @rel_path.dirname.to_s == "." ? @page_name : "#{@rel_path.dirname}/#{@page_name}"
       super(page_path)
     end
 
@@ -33,7 +33,7 @@ module Lookbook
     end
 
     def full_path
-      Rails.root.join(@pathname.to_s)
+      Pathname.new Rails.root.join(@pathname.to_s)
     end
 
     def name

data/lib/lookbook/parser.rb

@@ -3,24 +3,32 @@ require "yard"
 module Lookbook
   class Parser
     attr_reader :registry_path
-    def initialize(paths, registry_path)
+    def initialize(paths)
       @paths = paths.map { |p| "#{p}/**/*preview.rb" }
-      @registry_path = registry_path.to_s
-      YARD::Registry.yardoc_file = registry_path
+      @after_parse_callbacks = []
+      @after_parse_once_callbacks = []
+      @parsing = false
+
+      YARD::Parser::SourceParser.after_parse_list do
+        [*@after_parse_callbacks, *@after_parse_once_callbacks].each do |callback|
+          callback.call(YARD::Registry)
+        end
+        @after_parse_once_callbacks = []
+        @parsing = false
+      end
     end
 
-    def parse
-      YARD::Registry.clear
-      YARD::Registry.lock_for_writing do
+    def parse(&block)
+      unless @parsing
+        @parsing = true
+        @after_parse_once_callbacks << block if block
+        YARD::Registry.clear
         YARD.parse(@paths)
-        YARD::Registry.save(false, registry_path)
       end
     end
 
-    def get_code_object(path)
-      registry = YARD::RegistryStore.new
-      registry.load!(registry_path)
-      registry.get(path)
+    def after_parse(&block)
+      @after_parse_callbacks << block
     end
 
     class << self

data/lib/lookbook/preview.rb

@@ -5,9 +5,9 @@ module Lookbook
     delegate :name, :render_args, to: :@preview
     delegate :position, :group, :notes, :hidden?, :tags, :tag, to: :@preview_inspector
 
-    def initialize(preview)
+    def initialize(preview, code_object)
       @preview = preview
-      @preview_inspector = SourceInspector.new(@preview.name)
+      @preview_inspector = SourceInspector.new(code_object)
       super(preview_class_path(@preview.name))
     end
 
@@ -35,7 +35,7 @@ module Lookbook
       return @examples if @examples.present?
       public_methods = @preview.public_instance_methods(false)
       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) }
+      examples = (public_method_objects || []).map { |m| PreviewExample.new(m.name.to_s, self, m) }
       sorted = Lookbook.config.sort_examples ? examples.sort_by(&:label) : examples
       @examples = []
       if @preview_inspector&.groups&.any?
@@ -61,11 +61,15 @@ module Lookbook
       examples.first
     end
 
+    def rel_path
+      "#{name.underscore}.rb"
+    end
+
     def full_path
       base_path = Array(Lookbook.config.preview_paths).detect do |preview_path|
-        Dir["#{preview_path}/#{name.underscore}.rb"].first
+        Dir["#{preview_path}/#{rel_path}"].first
       end
-      Pathname.new(Dir["#{base_path}/#{name.underscore}.rb"].first)
+      Pathname.new(Dir["#{base_path}/#{rel_path}"].first)
     end
 
     def url_path
@@ -105,6 +109,9 @@ module Lookbook
 
     protected
 
+    @preview_objects = nil
+    @previews = nil
+
     def guess_component
       name.chomp("Preview").constantize
     rescue
@@ -125,26 +132,20 @@ module Lookbook
       end
 
       def all
-        load_previews if preview_files.size > ViewComponent::Preview.descendants.size
-
-        @previews = nil if cache_stale?
-        return @previews unless @previews.nil?
-
-        previews = ViewComponent::Preview.descendants.map do |p|
-          new(p)
-        rescue
-          Rails.logger.error "[lookbook] error instantiating preview\n#{exception.full_message}"
-        end
-
-        if errors.any?
-          errors.each do |error|
-            Rails.logger.error "[lookbook] preview error\n#{error.full_message}\n"
-          end
+        if @previews.nil? && @preview_objects.present?
+          previews = @preview_objects.map do |code_object|
+            klass = code_object.path.constantize
+            new(klass, code_object) if klass.ancestors.include?(ViewComponent::Preview)
+          rescue => exception
+            Lookbook.logger.error Lookbook::Error.new(exception)
+            nil
+          end.compact
+
+          sorted_previews = previews.compact.sort_by { |preview| [preview.position, preview.label] }
+          @previews = PreviewCollection.new(sorted_previews)
+        else
+          PreviewCollection.new([])
         end
-
-        sorted_previews = previews.compact.sort_by { |preview| [preview.position, preview.label] }
-        @previews = PreviewCollection.new(sorted_previews)
-        mark_as_cached if Lookbook.config.listen == true
         @previews
       end
 
@@ -152,60 +153,9 @@ module Lookbook
         @errors ||= []
       end
 
-      def clear_cache
-        cache_dir = File.dirname(cache_marker_path)
-        FileUtils.mkdir_p(cache_dir) unless File.exist?(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.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
-          true
-        else
-          false
-        end
-      end
-
-      def mark_as_cached
-        cache_dir = File.dirname(cache_marker_path)
-        FileUtils.mkdir_p(cache_dir) unless File.exist?(cache_dir)
-        File.write(cache_marker_path, Time.now)
-      end
-
-      def load_previews
-        @errors = []
-        preview_files.each do |file|
-          require_dependency file[:path]
-        rescue SyntaxError, StandardError => exception
-          @errors.push(
-            Lookbook::Error.new(exception,
-              title: "Preview #{exception.class}",
-              file_name: file[:rel_path],
-              file_path: file[:path])
-          )
-        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(Pathname.new(preview_path)).to_s
-            }
-          end
-        end
-        files.flatten
+      def load!(preview_objects)
+        @preview_objects = preview_objects
+        @previews = nil
       end
     end
 

data/lib/lookbook/preview_controller.rb

@@ -11,7 +11,10 @@ module Lookbook
       opts = {}
       opts[:layout] = nil
       opts[:locals] = locals if locals.present?
-      render html: render_to_string(template, **opts)
+
+      with_optional_annotations do
+        render html: render_to_string(template, **opts)
+      end
     end
 
     def render_in_layout_to_string(template, locals, opts = {})
@@ -22,5 +25,20 @@ module Lookbook
       end
       render html: html
     end
+
+    def with_optional_annotations
+      if ActionView::Base.respond_to?(:annotate_rendered_view_with_filenames) && Lookbook.config.preview_disable_action_view_annotations
+        original_value = ActionView::Base.annotate_rendered_view_with_filenames
+        ActionView::Base.annotate_rendered_view_with_filenames = false
+
+        res = yield
+
+        ActionView::Base.annotate_rendered_view_with_filenames = original_value
+
+        res
+      else
+        yield
+      end
+    end
   end
 end

data/lib/lookbook/preview_example.rb

@@ -3,10 +3,10 @@ module Lookbook
     attr_reader :name, :preview
     delegate :params, :position, :group, :notes, :hidden?, :source, :tags, :tag, to: :@example_inspector
 
-    def initialize(name, preview)
+    def initialize(name, preview, code_object)
       @name = name
       @preview = preview
-      @example_inspector = SourceInspector.new("#{@preview.name}##{name}")
+      @example_inspector = SourceInspector.new(code_object)
       super("#{@preview.path}/#{name}")
     end
 
@@ -27,7 +27,7 @@ module Lookbook
     end
 
     def method_source
-      @example_inspector.source.split("\n")[1..-2].join("\n").strip_heredoc
+      @example_inspector.source.sub(/^def \w+\s?(\([^)]+\))?/m, "").split("\n")[0..-2].join("\n").strip_heredoc.strip
     end
 
     def lang
@@ -35,7 +35,8 @@ module Lookbook
     end
 
     def template_source(template_path)
-      File.read(full_template_path(template_path))
+      source_path = full_template_path(template_path)
+      source_path ? File.read(source_path) : nil
     end
 
     def template_lang(template_path)
@@ -56,11 +57,17 @@ module Lookbook
 
     protected
 
+    def strip_ext(path)
+      path.sub(/\..*$/, "")
+    end
+
     def full_template_path(template_path)
+      template_path = strip_ext template_path
       base_path = Array(Lookbook.config.preview_paths).detect do |p|
         Dir["#{p}/#{template_path}.html.*"].first
       end
-      Pathname.new(Dir["#{base_path}/#{template_path}.html.*"].first)
+      path = Dir["#{base_path}/#{template_path}.html.*"].first
+      path ? Pathname.new(path) : nil
     end
 
     class << self

data/lib/lookbook/source_inspector.rb

@@ -5,8 +5,8 @@ module Lookbook
     attr_reader :code_object
     delegate :groups, :source, to: :@code_object, allow_nil: true
 
-    def initialize(taggable_object_path)
-      @code_object = Lookbook::Engine.parser.get_code_object(taggable_object_path)
+    def initialize(code_object)
+      @code_object = code_object
     end
 
     def hidden?

data/lib/lookbook/store.rb

@@ -1,6 +1,6 @@
 module Lookbook
   class Store < ActiveSupport::OrderedOptions
-    def initialize(data = {}, deep = true)
+    def initialize(data = {}, deep = false)
       super()
       @deep = deep
       set(data) if data.present?
@@ -42,7 +42,7 @@ module Lookbook
     end
 
     def normalize_value(value)
-      @deep && value.is_a?(Hash) ? Store.new(value) : value
+      @deep && !value.is_a?(Store) && value.is_a?(Hash) ? Store.new(value, @deep) : value
     end
   end
 end

data/lib/lookbook/version.rb

@@ -1,3 +1,3 @@
 module Lookbook
-  VERSION = "1.0.0"
+  VERSION = "1.0.8"
 end

data/lib/tasks/lookbook_tasks.rake

@@ -4,8 +4,7 @@ namespace :lookbook do
   namespace :previews do
     desc "Preparse the previews"
     task preparse: :environment do
-      Lookbook::Engine.parser.parse
-      puts "Lookbook preview parsing complete"
+      puts "The lookbook:preparse task is no longer required and will be removed in v2.0"
     end
   end
 end