lookbook 1.5.0 → 2.0.0.beta.0

data/lib/lookbook/runtime_context.rb

@@ -0,0 +1,49 @@
+module Lookbook
+  class RuntimeContext
+    attr_reader :env
+
+    def initialize(env: Rails.env)
+      @env = env
+    end
+
+    def app_name
+      return @_app_name if @_app_name
+
+      app_class = Rails.application.class
+      name = app_class.respond_to?(:module_parent_name) ? app_class.module_parent_name : app_class.parent_name
+      @_app_name ||= name.underscore
+    end
+
+    def rails_older_than?(version)
+      Gem::Version.new(Rails.version) < Gem::Version.new(version)
+    end
+
+    def rails_newer_than?(version)
+      Gem::Version.new(Rails.version) >= Gem::Version.new(version)
+    end
+
+    def actioncable_installed?
+      gem_installed?("actioncable")
+    end
+
+    def listen_installed?
+      gem_installed?("listen")
+    end
+
+    def gem_installed?(name)
+      Gem.loaded_specs.has_key?(name)
+    end
+
+    def web?
+      !rake_task? && !Rails.const_defined?(:Console)
+    end
+
+    def rake_task?
+      if defined?(Rake) && Rake.respond_to?(:application)
+        File.basename($0) == "rake" || Rake.application.top_level_tasks.any?
+      else
+        false
+      end
+    end
+  end
+end

data/lib/lookbook/services/data/resolvers/data_resolver.rb

@@ -5,10 +5,9 @@ module Lookbook
 
     attr_reader :eval_context, :base_dir, :file, :fallback
 
-    def initialize(input, eval_context: nil, permit_eval: false, fail_silently: false, base_dir: Rails.root, file: nil, fallback: nil)
+    def initialize(input, eval_context: nil, fail_silently: false, base_dir: Rails.root, file: nil, fallback: nil)
       @input = input.to_s
       @eval_context = eval_context
-      @permit_eval = permit_eval
       @fail_silently = fail_silently
       @fallback = fallback
       @base_dir = base_dir.to_s
@@ -44,7 +43,9 @@ module Lookbook
     def evaluate(input, fallback = @fallback)
       if evaluatable?
         begin
-          eval_context.instance_eval(input.to_s)
+          proc {
+            eval_context.instance_eval(input.to_s)
+          }.call
         rescue => exception
           raise_error "Could not evaluate statetment (#{exception.message})", exception
         end
@@ -61,9 +62,6 @@ module Lookbook
     private
 
     def evaluatable?
-      if !@permit_eval
-        raise_error "Runtime evaluation is not permitted"
-      end
       eval_context.present?
     end
   end

data/lib/lookbook/services/entities/entity_tree_builder.rb

@@ -13,15 +13,15 @@ module Lookbook
         current_node = root_node
         path_segments = parse_segments(entity.logical_path)
         path_segments.each.with_index(1) do |segment, i|
-          name, position_prefix = segment
+          name, priority_prefix = segment
           content = entity if entity.depth == i # entities are always on the leaf nodes
 
-          current_node.add_child(name, content, position: position_prefix) unless current_node.has_child?(name)
+          current_node.add_child(name, content, priority: priority_prefix) unless current_node.has_child?(name)
           current_node = current_node.get_child(name)
 
           if content && content.type == :preview
-            content.visible_examples.each do |example|
-              current_node.add_child(example.name, example)
+            content.visible_scenarios.each do |scenario|
+              current_node.add_child(scenario.name, scenario)
             end
           end
         end
@@ -32,8 +32,8 @@ module Lookbook
     def parse_segments(path)
       path.split("/").map do |segment|
         unless segment.start_with?(".")
-          position, name = PositionPrefixParser.call(segment)
-          [name, position || 10000]
+          priority, name = PriorityPrefixParser.call(segment)
+          [name, priority || 10000]
         end
       end.compact
     end

data/lib/lookbook/services/list_resolver.rb

@@ -0,0 +1,35 @@
+module Lookbook
+  class ListResolver < Service
+    attr_reader :item_set
+
+    def initialize(to_include = nil, item_set = nil)
+      @to_include = to_include
+      @item_set = Array(item_set).compact.uniq.map(&:to_s)
+    end
+
+    def call(&resolver)
+      included = to_include.inject([]) do |result, name|
+        if name == "*"
+          result += item_set.select { |item| !result.include?(item) }
+        elsif item_set.include?(name)
+          result << name
+        end
+        result
+      end
+
+      resolved = resolver ? included.map { |item| resolver.call(item) } : included
+      resolved.compact
+    end
+
+    def to_include
+      case @to_include
+      when true
+        ["*"]
+      when false
+        []
+      else
+        Array(@to_include).compact.uniq.map(&:to_s)
+      end
+    end
+  end
+end

data/lib/lookbook/services/markdown_renderer.rb

@@ -6,7 +6,7 @@ module Lookbook
 
     def initialize(text, opts = {})
       @text = text
-      @opts = opts.to_h
+      @opts = Lookbook.config.markdown_options.merge(opts.to_h)
     end
 
     def call
@@ -18,7 +18,17 @@ module Lookbook
     class LookbookMarkdownRenderer < Redcarpet::Render::HTML
       def block_code(code, language = "ruby")
         line_numbers = language.to_s.end_with? "-numbered"
-        ApplicationController.render(Lookbook::Code::Component.new(source: code, language: language.to_s.chomp("-numbered"), line_numbers: line_numbers), layout: nil)
+        ApplicationController.render(Lookbook::Code::Component.new(**{
+          source: code,
+          language: language.to_s.chomp("-numbered"),
+          line_numbers: line_numbers
+        }), layout: nil)
+      end
+
+      def postprocess(full_document)
+        full_document&.gsub!("<p><lookbook", "<lookbook")
+        full_document&.gsub!("</lookbook-embed></p>", "</lookbook-embed>")
+        full_document
       end
     end
   end

data/lib/lookbook/services/priority_prefix_parser.rb

@@ -0,0 +1,16 @@
+module Lookbook
+  class PriorityPrefixParser < Service
+    PRIORITY_PREFIX_REGEX = /^(\d+?)[-_]/
+
+    attr_reader :input
+
+    def initialize(input)
+      @input = String(input)
+    end
+
+    def call
+      matches = input.match(PRIORITY_PREFIX_REGEX)
+      matches ? [matches[1].to_i, input.gsub(PRIORITY_PREFIX_REGEX, "")] : [nil, input]
+    end
+  end
+end

data/lib/lookbook/services/urls/search_param_encoder.rb

@@ -0,0 +1,16 @@
+require "cgi"
+
+module Lookbook
+  class SearchParamEncoder < Service
+    attr_reader :data
+
+    def initialize(data)
+      @data = data.to_h
+    end
+
+    def call
+      json = JSON.generate(data)
+      CGI.escape(json)
+    end
+  end
+end

data/lib/lookbook/services/urls/search_param_parser.rb

@@ -1,15 +1,16 @@
+require "cgi"
+
 module Lookbook
   class SearchParamParser < Service
-    attr_reader :param_value
+    attr_reader :str
 
-    def initialize(param_value)
-      @param_value = param_value.strip
+    def initialize(str)
+      @str = str.to_s.strip
     end
 
     def call
-      pairs_str = param_value.split("|")
-      pairs = pairs_str.map { |pair| [*pair.split(":").map(&:strip)] }
-      pairs.to_h.symbolize_keys
+      json = CGI.unescape(str)
+      JsonParser.call(json)
     end
   end
 end

data/lib/lookbook/stores/config_store.rb

@@ -1,4 +1,18 @@
 module Lookbook
+  # Configuration store for Lookbook.
+  #
+  # Config option values can be get/set using hash property access syntax
+  # or dot-notation syntax.
+  #
+  # @example :ruby
+  #   # Lookbook config access in Rails config files:
+  #   config.lookbook.ui_theme = :zinc
+  #
+  #   # Lookbook config access everywhere else:
+  #   Lookbook.config.ui_theme = :zinc
+  #
+  # @ignore methods
+  # @api public
   class ConfigStore
     CONFIG_FILE = "config/app.yml"
 
@@ -25,14 +39,8 @@ module Lookbook
       store[:preview_paths].push(*paths.to_a)
     end
 
-    def preview_display_params
-      Lookbook.logger.warn "The `preview_display_params` config option has been renamed to `preview_display_options` and will be removed in v2.0"
-      store[:preview_display_options]
-    end
-
-    def preview_display_params=(options)
-      Lookbook.logger.warn "The `preview_display_params` config option has been renamed to `preview_display_options` and will be removed in v2.0"
-      store[:preview_display_options] = options.to_h
+    def component_paths=(paths = nil)
+      store[:component_paths].push(*paths.to_a)
     end
 
     def listen_extensions=(extensions = nil)
@@ -64,14 +72,6 @@ module Lookbook
       end
     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 preview_srcdoc=(enable)
-      Lookbook.logger.warn "The `preview_srcdoc` config option is deprecated and will be removed in v2.0"
-    end
-
     def self.init_from_config(env: Rails.env)
       new(default_config(env: env))
     end

data/lib/lookbook/stores/input_store.rb

@@ -2,9 +2,7 @@ module Lookbook
   class InputStore
     CONFIG_FILE = "config/inputs.yml"
 
-    DEFAULTS = {
-      # TODO
-    }
+    DEFAULTS = {}
 
     attr_reader :store
     delegate :to_h, to: :store

data/lib/lookbook/stores/panel_store.rb

@@ -3,7 +3,7 @@ module Lookbook
     CONFIG_FILE = "config/panels.yml"
 
     DEFAULTS = {
-      label: lambda { |data| data.name.titleize },
+      label: lambda { |data| data.name.to_s.titleize },
       hotkey: nil,
       disabled: false,
       show: true,
@@ -19,65 +19,53 @@ module Lookbook
       load_config(config)
     end
 
-    def add_panel(name, group_name, *args)
+    def add_panel(name, *args)
       if get_panel(name)
         raise ConfigError.new("panel with name '#{name}' already exists", scope: "panels.config")
       else
-        panel = build_config(name, group_name, *args)
-        insert_at_position(group_name, panel.position, panel)
+        store[Utils.symbolize_name(name)] = build_config(name, *args)
       end
     end
 
     def update_panel(name, opts = {})
       panel = get_panel(name)
       if panel.present?
-        panel.merge!(opts.except(:name, :position))
-        if opts.key?(:position)
-          remove_panel(name)
-          insert_at_position(panel.group, opts[:position], panel)
-        end
+        panel.merge!(opts.except(:name))
       else
         not_found!(name)
       end
     end
 
     def remove_panel(name)
-      store.each do |group_name, panels|
-        return true unless panels.reject! { |p| p.name == name.to_sym }.nil?
-      end
-      not_found!(name)
+      store.delete(Utils.symbolize_name(name)) { |name| not_found!(name) }
     end
 
     def load_config(config)
-      config.to_h.each do |group_name, panels|
-        panels.each do |opts|
-          add_panel(opts[:name], group_name, opts.except(:name))
-        end
-      end
+      config.to_h.each { |name, opts| add_panel(name, opts) }
     end
 
-    def get_panel(name, group_name = nil)
-      panels(group_name).find { |p| p.name == name.to_sym }
+    def get_panel(name)
+      panels.find { |panel| panel.name == Utils.symbolize_name(name) }
     end
 
-    def count_panels(group_name = nil)
-      panels(group_name).count
+    def get_panels(*names)
+      ListResolver.call(names.flatten, panels.map(&:name)) { |name| get_panel(name) }
     end
 
-    def in_group(name)
-      store[name.to_sym] ||= []
+    def panels
+      store.map { |name, panel| panel }
     end
 
-    def panels(group_name = nil)
-      store.to_h.reduce([]) do |result, (name, group_panels)|
-        result.push(*group_panels) if group_name.nil? || name == group_name.to_sym
-      end
+    def names
+      panels.map(&:name)
     end
 
+    alias_method :all, :panels
+
     def self.resolve_config(opts, data)
       if opts[:name].present?
         data = data.is_a?(Store) ? data : Store.new(data)
-        data.name = opts[:name].to_s
+        data.name = Utils.symbolize_name(opts[:name])
         resolved = opts.transform_values do |value|
           value.respond_to?(:call) ? value.call(data) : value
         end
@@ -93,10 +81,14 @@ module Lookbook
 
     def self.default_config
       config = ConfigLoader.call(CONFIG_FILE)
-      config.each do |group, panels|
-        panels.map! do |opts|
-          opts.transform_values! do |value|
-            (value.is_a?(String) && value.start_with?("->")) ? eval(value) : value # standard:disable Security/Eval
+      config.to_h.transform_values! do |opts|
+        opts.transform_values! do |value|
+          if value.is_a?(String) && value.start_with?("->")
+            proc {
+              eval(value) # standard:disable Security/Eval
+            }.call
+          else
+            value
           end
         end
       end
@@ -104,21 +96,8 @@ module Lookbook
 
     protected
 
-    def insert_at_position(group_name, position, opts)
-      group_panels = in_group(group_name)
-      index = insert_index(position, group_panels.count)
-      group_panels.insert(index, opts.except!(:position))
-    end
-
-    def insert_index(position, items_count)
-      index = (position == 0) ? 1 : (position || 0).to_int
-      last_position = items_count + 1
-      index = last_position if index > last_position
-      index - 1
-    end
-
-    def build_config(name, group_name, *args)
-      opts = if args.many? && args.last.is_a?(Hash)
+    def build_config(name, *args)
+      opts = if args.many? && args.first.is_a?(String) && args.last.is_a?(Hash)
         args.last.merge({partial: args.first})
       elsif args.any?
         args.first.is_a?(String) ? {partial: args.first} : args.first
@@ -126,8 +105,7 @@ module Lookbook
         {}
       end
       if opts[:partial].present?
-        opts[:name] = name.to_sym
-        opts[:group] = group_name.to_sym
+        opts[:name] = Utils.symbolize_name(name)
         Store.new(DEFAULTS.merge(opts))
       else
         raise ConfigError.new("panels must define a partial path", scope: "panels.config")

data/lib/lookbook/support/deprecation.rb

@@ -0,0 +1,5 @@
+require "active_support"
+
+module Lookbook
+  Deprecation = ::ActiveSupport::Deprecation.new("3.0", "Lookbook")
+end

data/lib/lookbook/support/errors/preview_template_error.rb

@@ -0,0 +1,7 @@
+module Lookbook
+  class PreviewTemplateError < LookbookError
+    def initialize(msg = nil, scope: "preview", **kwargs)
+      super(msg, scope: scope, **kwargs)
+    end
+  end
+end

data/lib/lookbook/support/evented_file_update_checker.rb

@@ -0,0 +1,69 @@
+require "active_support/evented_file_update_checker"
+
+module Lookbook
+  require "listen" unless Engine.runtime_context.rails_newer_than?("6.1.0")
+
+  class EventedFileUpdateChecker < ActiveSupport::EventedFileUpdateChecker
+    if Engine.runtime_context.rails_newer_than?("6.1.0")
+
+      def initialize(files, dirs = {}, &block)
+        super
+        @core = Core.new(files, dirs)
+      end
+
+      class Core < ActiveSupport::EventedFileUpdateChecker::Core
+        def changed(modified, added, removed)
+          super
+          Engine.files_changed(modified, added, removed) if @updated
+        end
+
+        # Patched to handle regex-style
+        # extension matchers like `.html.*`
+        def watching?(file)
+          return true if super
+
+          file = Pathname(file)
+          name_parts = file.basename.to_s.split(".")
+          ext = "." + name_parts.drop(1).join(".").to_s
+
+          file.dirname.ascend do |dir|
+            matching = @dirs.fetch(dir, []).map { |m| Regexp.new(m) }
+            if matching.empty? || matching.find { |m| m.match?(ext) }
+              break true
+            elsif dir == @common_path || dir.root?
+              break false
+            end
+          end
+        end
+      end
+
+    else
+
+      # Patched to handle regex-style
+      # extension matchers like `.html.*`
+      def watching?(file)
+        return true if super
+
+        file = Pathname(file)
+        name_parts = file.basename.to_s.split(".")
+        ext = "." + name_parts.drop(1).join(".").to_s
+
+        file.dirname.ascend do |dir|
+          matching = @dirs.fetch(dir, []).map { |m| Regexp.new(m) }
+          if matching.empty? || matching.find { |m| m.match?(ext) }
+            break true
+          elsif dir == @lcsp || dir.root?
+            break false
+          end
+        end
+      end
+
+      private
+
+      def changed(modified, added, removed)
+        super
+        Engine.files_changed(modified, added, removed) if updated?
+      end
+    end
+  end
+end

data/lib/lookbook/support/null_websocket.rb

@@ -0,0 +1,9 @@
+module Lookbook
+  class NullWebsocket < NullObject
+    def mountable?
+      false
+    end
+
+    alias_method :mounted?, :mountable?
+  end
+end

data/lib/lookbook/support/store.rb

@@ -1,4 +1,13 @@
 module Lookbook
+  # Generic hash-like key/value store.
+  #
+  # Properties can be get/set using hash access syntax (`data[:key]`)
+  # or dot-notation syntax (`data.key`).
+  #
+  # Based on [ActiveSupport::OrderedOptions](https://api.rubyonrails.org/classes/ActiveSupport/OrderedOptions.html)
+  #
+  # @ignore methods
+  # @api public
   class Store < ActiveSupport::OrderedOptions
     def initialize(initial_data = nil, opts = {})
       @recursive = opts[:recursive] || false

data/lib/lookbook/support/tree_node.rb

@@ -8,10 +8,10 @@ module Lookbook
     attr_accessor :path, :content
     attr_reader :children
 
-    def initialize(path = nil, content = nil, position: 10000)
+    def initialize(path = nil, content = nil, priority: 10000)
       @path = path.to_s
       @content = content
-      @position = position
+      @priority = priority
       @children = []
     end
 
@@ -27,8 +27,8 @@ module Lookbook
       content_value(:label, name.titleize)
     end
 
-    def position
-      content_value(:position, @position)
+    def priority
+      content_value(:priority, @priority)
     end
 
     def type
@@ -39,8 +39,8 @@ module Lookbook
       path.split("/").size
     end
 
-    def add_child(name, content = nil, position: 10000)
-      children << TreeNode.new("#{path}/#{name}", content, position: position)
+    def add_child(name, content = nil, priority: 10000)
+      children << TreeNode.new("#{path}/#{name}", content, priority: priority)
     end
 
     def has_child?(name)
@@ -69,7 +69,7 @@ module Lookbook
       if content?
         content <=> (other.content? ? other.content : other)
       else
-        [position, label] <=> [other.position, other.label]
+        [priority, label] <=> [other.priority, other.label]
       end
     end
 

data/lib/lookbook/support/utils/path_utils.rb

@@ -15,7 +15,7 @@ module Lookbook
 
         segments = [*directory_path&.split("/"), file_name].compact
         stripped_segments = segments.map! do |segment|
-          PositionPrefixParser.call(segment).last.tr("-", "_")
+          PriorityPrefixParser.call(segment).last.tr("-", "_")
         end
 
         to_path(stripped_segments)
@@ -41,6 +41,12 @@ module Lookbook
       def strip_slashes(path)
         path.to_s.gsub(/\A\/|\/\z/, "")
       end
+
+      def determine_full_path(rel_path, search_dirs = [])
+        base_path = search_dirs.detect { |p| Dir["#{p}/#{rel_path}"].first }
+        path = Dir["#{base_path}/#{rel_path}"].first
+        Pathname(path) if path
+      end
     end
   end
 end

data/lib/lookbook/support/utils/utils.rb

@@ -7,10 +7,18 @@ module Lookbook
         PathUtils.strip_slashes(id_str).tr("/", "-").gsub("--", "-")
       end
 
+      def temp_id(prefix: nil)
+        [prefix, (Time.now.to_f * 1000).to_i + rand(0..100)].compact.join("-")
+      end
+
       def name(str)
         str.to_s.parameterize.tr("-", "_")
       end
 
+      def symbolize_name(str)
+        name(str).to_sym
+      end
+
       def value_or_fallback(value, fallback = nil, &block)
         if value.nil?
           fallback_block = block || proc { fallback }

data/lib/lookbook/tags/{position_tag.rb → priority_tag.rb}

@@ -1,13 +1,13 @@
 module Lookbook
-  class PositionTag < YardTag
-    DEFAULT_POSITION = 100000
+  class PriorityTag < YardTag
+    DEFAULT_PRIORITY = 100000
 
     def value
       if text.present?
         int = text.to_i
-        (int == 0) ? DEFAULT_POSITION : int
+        (int == 0) ? DEFAULT_PRIORITY : int
       else
-        DEFAULT_POSITION
+        DEFAULT_PRIORITY
       end
     end
 

data/lib/lookbook/tags/renders_tag.rb

@@ -0,0 +1,4 @@
+module Lookbook
+  class RendersTag < YardTag
+  end
+end

data/lib/lookbook/tags/tag_provider.rb

@@ -7,6 +7,9 @@ module Lookbook
         raise NameError.new "'custom' is a reserved tag name and cannot be used"
       end
 
+      # Handle aliasing of removed `@component` tags
+      tag_name = "renders" if tag_name == "component"
+
       begin
         tag_class = "Lookbook::#{tag_name.camelize}Tag".constantize
         tag_class.new(text)