lookbook 1.2.1 → 1.3.1

data/lib/lookbook/stores/config_store.rb

@@ -14,13 +14,15 @@ module Lookbook
     end
 
     def page_paths=(paths = nil)
-      store[:page_paths] ||= []
-      store[:page_paths] += paths.to_a
+      store[:page_paths].push(*paths.to_a)
+    end
+
+    def page_extensions=(extensions = nil)
+      store[:page_extensions].push(*extensions.to_a).uniq!
     end
 
     def preview_paths=(paths = nil)
-      store[:preview_paths] ||= []
-      store[:preview_paths] += paths.to_a
+      store[:preview_paths].push(*paths.to_a)
     end
 
     def preview_display_params
@@ -34,13 +36,10 @@ module Lookbook
     end
 
     def listen_extensions=(extensions = nil)
-      store[:listen_extensions] ||= []
-      store[:listen_extensions] += extensions.to_a
-      store[:listen_extensions].uniq!
+      store[:listen_extensions].push(*extensions.to_a).uniq!
     end
 
     def markdown_options=(options = nil)
-      store[:markdown_options] ||= {}
       store[:markdown_options].merge!(options.to_h)
     end
 

data/lib/lookbook/stores/input_store.rb

@@ -18,11 +18,11 @@ module Lookbook
     end
 
     def add_input(input, *args)
-      store[input.to_sym] = build_config(input, *args)
+      store[normalize_name(input)] = build_config(input, *args)
     end
 
     def get_input(input)
-      store[input.to_sym]
+      store[normalize_name(input)]
     end
 
     def self.init_from_config
@@ -35,6 +35,10 @@ module Lookbook
 
     protected
 
+    def normalize_name(name)
+      name.to_s.tr("-", "_").to_sym
+    end
+
     def build_config(name, *args)
       partial = nil
       opts = nil
@@ -48,7 +52,7 @@ module Lookbook
         Store.new({
           name: name.to_sym,
           partial: partial,
-          opts: DEFAULTS.merge(opts.to_h)
+          options: DEFAULTS.merge(opts.to_h)
         })
       else
         raise ConfigError.new("inputs must define a partial path", scope: "inputs.config")

data/lib/lookbook/stores/tag_store.rb

@@ -7,7 +7,7 @@ module Lookbook
 
     def initialize(config = nil)
       @store = {}
-      config.to_h.each { add_tag(_1, _2) }
+      config.to_h.each { |k, v| add_tag(k, v) }
     end
 
     def add_tag(name, opts = nil)
@@ -34,12 +34,10 @@ module Lookbook
     protected
 
     def build_config(name, opts = nil)
-      opts = opts.to_h
       Store.new({
         name: name.to_sym,
-        label: opts[:label] || name.to_s.titleize,
-        yard_parser: opts[:yard_parser]&.to_sym,
-        opts: opts[:opts].to_h
+        label: name.to_s.titleize,
+        options: opts.to_h
       })
     end
   end

data/lib/lookbook/support/null_object.rb

@@ -0,0 +1,10 @@
+module Lookbook
+  class NullObject < BasicObject
+    def method_missing(*)
+    end
+
+    def respond_to_missing?(name)
+      true
+    end
+  end
+end

data/lib/lookbook/support/service.rb

@@ -1,7 +1,7 @@
 module Lookbook
   class Service
-    def self.call(*args, **kwargs)
-      new(*args, **kwargs).call
+    def self.call(*args, **kwargs, &block)
+      new(*args, **kwargs).call(&block)
     end
   end
 end

data/lib/lookbook/support/store.rb

@@ -3,7 +3,7 @@ module Lookbook
     def initialize(initial_data = nil, opts = {})
       @recursive = opts[:recursive] || false
       super()
-      initial_data.to_h.each { self[_1] = _2 }
+      initial_data.to_h.each { |k, v| self[k] = v }
     end
 
     def []=(key, value)

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

@@ -2,7 +2,12 @@ module Lookbook
   module AttributeUtils
     class << self
       def dom_id(*args)
-        ["lookbook", *args].join("-").parameterize.dasherize
+        entity_id(["lookbook", *args])
+      end
+
+      def entity_id(*args)
+        parts = args.map { |arg| arg.to_s.force_encoding("UTF-8").parameterize.dasherize }
+        parts.join("-").tr("/_", "-").delete_prefix("-").delete_suffix("-").gsub("--", "-")
       end
     end
   end

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

@@ -6,14 +6,17 @@ module Lookbook
       end
 
       def normalize_all(paths, allow_root: false)
-        root = Rails.application.root.to_s
-        paths.map do |path|
+        Array(paths).map do |path|
           full_path = to_absolute(path)
           if Dir.exist?(full_path)
-            full_path if allow_root || full_path.to_s != root
+            full_path if allow_root || !root_path?(full_path)
           end
         end.compact.uniq
       end
+
+      def root_path?(path)
+        Rails.application.root.to_s == path.to_s
+      end
     end
   end
 end

data/lib/lookbook/tags/component_tag.rb

@@ -0,0 +1,7 @@
+module Lookbook
+  class ComponentTag < YardTag
+    def value
+      text.constantize if text.present?
+    end
+  end
+end

data/lib/lookbook/tags/custom_tag.rb

@@ -0,0 +1,59 @@
+module Lookbook
+  class CustomTag < YardTag
+    attr_reader :arg_names, :tag_args
+
+    def initialize(tag_name, text = nil, *args)
+      tag_definition = Engine.tags.get_tag(tag_name)
+      unless tag_definition
+        raise ParserError.new "Unknown custom tag type '#{tag_name}'"
+      end
+
+      super(tag_name, text.to_s, *args)
+
+      @custom_attributes = Store.new
+      @arg_names = tag_definition.options.fetch(:named_args, [])
+      @after_parse = tag_definition.options.fetch(:after_parse, nil)
+
+      validate_arg_names
+
+      @tag_args = parse_tag
+      @after_parse.call(self) if @after_parse.respond_to?(:call)
+    end
+
+    # Method aliases to keep compatability with
+    # the original custom tag implementation
+    alias_method :tag_body, :text
+    alias_method :opts, :options
+
+    protected
+
+    def parse_tag
+      text_tokens = Shellwords.split(text)
+      values = text_tokens.slice(0, arg_names.size)
+
+      arg_names.map.with_index do |name, i|
+        [name.to_sym, values[i]]
+      end.to_h
+    end
+
+    def validate_arg_names
+      arg_names.each do |name|
+        if methods.include? name.to_sym
+          raise ParserError.new "'#{name}' is a reserved word and cannot be used as an argument name."
+        end
+      end
+    end
+
+    def method_missing(name, *args)
+      if name.end_with? "="
+        @custom_attributes[name.to_s.chomp("=")] = args.first
+      else
+        @custom_attributes.public_send(name, *args) || tag_args[name]
+      end
+    end
+
+    def respond_to_missing?(name, include_private)
+      @custom_attributes.key?(name) || tag_args.key?(name) || super
+    end
+  end
+end

data/lib/lookbook/tags/display_tag.rb

@@ -0,0 +1,15 @@
+module Lookbook
+  class DisplayTag < YardTag
+    def key
+      parts.first
+    end
+
+    def value
+      parts.second
+    end
+
+    def parts
+      @parts ||= KeyValueTagParser.call(text)
+    end
+  end
+end

data/lib/lookbook/tags/hidden_tag.rb

@@ -0,0 +1,13 @@
+module Lookbook
+  class HiddenTag < YardTag
+    def value
+      text != "false"
+    end
+
+    def to_s
+      value ? "true" : "false"
+    end
+
+    alias_method :to_bool, :value
+  end
+end

data/lib/lookbook/tags/id_tag.rb

@@ -0,0 +1,7 @@
+module Lookbook
+  class IdTag < YardTag
+    def value
+      AttributeUtils.entity_id(text) if text.present?
+    end
+  end
+end

data/lib/lookbook/tags/label_tag.rb

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

data/lib/lookbook/tags/logical_path_tag.rb

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

data/lib/lookbook/tags/param_tag.rb

@@ -0,0 +1,61 @@
+module Lookbook
+  class ParamTag < YardTag
+    VALUE_TYPE_MATCHER = /^(\[\s?([A-Z]{1}\w+)\s?\])/
+    DESCRIPTION_MATCHER = /"(.*[^\\])"$/
+
+    attr_reader :tag_args
+
+    def initialize(text)
+      @name, text_without_name = extract_name(text)
+      @tag_args = parse_tag_body(text_without_name)
+      super("param", tag_args[:rest], nil, @name)
+    end
+
+    def input
+      tag_args[:input]&.downcase&.tr("_", "-")
+    end
+
+    def description
+      tag_args[:description]
+    end
+
+    def value_type
+      tag_args[:value_type]&.downcase
+    end
+
+    def value_default
+      default_value_parts = object.parameters.find { |parts| parts[0].chomp(":") == name }
+      if default_value_parts
+        object.instance_eval(default_value_parts[1])
+      else
+        raise ParserError.new "Unknown method parameter '#{name}'"
+      end
+    end
+
+    protected
+
+    def extract_name(text)
+      parts = text.to_s.split(" ")
+      [parts.shift, parts.join(" ")]
+    end
+
+    def parse_tag_body(text)
+      value_type = nil
+      description = nil
+
+      text.match(VALUE_TYPE_MATCHER) do |match_data|
+        value_type = match_data[2]
+        text.gsub!(VALUE_TYPE_MATCHER, "").strip!
+      end
+
+      text.match(DESCRIPTION_MATCHER) do |match_data|
+        description = match_data[1]
+        text.gsub!(DESCRIPTION_MATCHER, "").strip!
+      end
+
+      input, rest = text.split(" ", 2)
+
+      {input: input, value_type: value_type, description: description, rest: rest}
+    end
+  end
+end

data/lib/lookbook/tags/position_tag.rb

@@ -0,0 +1,16 @@
+module Lookbook
+  class PositionTag < YardTag
+    DEFAULT_POSITION = 100000
+
+    def value
+      if text.present?
+        int = text.to_i
+        int == 0 ? DEFAULT_POSITION : int
+      else
+        DEFAULT_POSITION
+      end
+    end
+
+    alias_method :to_i, :value
+  end
+end

data/lib/lookbook/tags/tag_provider.rb

@@ -0,0 +1,18 @@
+module Lookbook
+  class TagProvider < ::YARD::Tags::Tag
+    def self.new(tag_name, text, types = nil, name = nil)
+      tag_name = tag_name.to_s
+
+      if tag_name == "custom"
+        raise NameError.new "'custom' is a reserved tag name and cannot be used"
+      end
+
+      begin
+        tag_class = "Lookbook::#{tag_name.camelize}Tag".constantize
+        tag_class.new(text)
+      rescue NameError
+        CustomTag.new(tag_name, text)
+      end
+    end
+  end
+end

data/lib/lookbook/tags/yard_tag.rb

@@ -0,0 +1,62 @@
+module Lookbook
+  class YardTag < ::YARD::Tags::Tag
+    def initialize(*args)
+      if args.size < 2
+        tag_name = self.class.name.demodulize.underscore.chomp("_tag")
+        super(tag_name, args.first, nil, @name)
+      else
+        super(*args)
+      end
+    end
+
+    def text
+      tag_parts[:text]
+    end
+
+    def options
+      tag_parts[:options]
+    end
+
+    def to_s
+      value.to_s
+    end
+
+    # The `value` attribute should be overriden in child classes
+    # to return the resolved value of the tag, where appropriate.
+    # i.e. for the @hidden tag this would return boolean true/false.
+    alias_method :value, :text
+
+    protected
+
+    def tag_parts
+      if @tag_parts.nil?
+        options, text = TagOptionsParser.call(@text, {
+          file: host_file,
+          base_dir: (File.dirname(host_file) if host_file),
+          eval_context: host_class_instance,
+          permit_eval: Lookbook.config.preview_params_options_eval
+        })
+      end
+      @tag_parts ||= {options: options, text: text}
+    end
+
+    def host_file
+      location = object&.files&.first # [file, line_number]
+      location&.first
+    end
+
+    def host_class_instance
+      host_class = lookup_host_class
+      host_class&.new
+    end
+
+    def lookup_host_class
+      host_code_object = if object.is_a?(YARD::CodeObjects::MethodObject)
+        object.parent
+      elsif object.is_a?(YARD::CodeObjects::ClassObject)
+        object
+      end
+      host_code_object&.path&.constantize
+    end
+  end
+end

data/lib/lookbook/utils.rb

@@ -4,29 +4,6 @@ module Lookbook
 
     POSITION_PREFIX_REGEX = /^(\d+?)[-_]/
     FRONTMATTER_REGEX = /\A---(.|\n)*?---/
-    ACTION_VIEW_ANNOTATIONS_REGEX = /<!-- (BEGIN|END) (.*) -->/
-
-    def self.strip_action_view_annotations!(text)
-      text&.gsub!(ACTION_VIEW_ANNOTATIONS_REGEX, "")
-    end
-
-    def self.without_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
-    end
-
-    def self.with_optional_action_view_annotations
-      if ActionView::Base.respond_to?(:annotate_rendered_view_with_filenames) && Lookbook.config.preview_disable_action_view_annotations
-        without_action_view_annotations do
-          yield
-        end
-      else
-        yield
-      end
-    end
 
     protected
 
@@ -59,14 +36,6 @@ module Lookbook
       parse_position_prefix(str).last
     end
 
-    def get_frontmatter(str)
-      parse_frontmatter(str).first
-    end
-
-    def strip_frontmatter(str)
-      parse_frontmatter(str).last
-    end
-
     def to_lookup_path(path)
       path.split("/").map { |segment| remove_position_prefix(segment) }.join("/")
     end
@@ -83,15 +52,6 @@ module Lookbook
 
     private
 
-    def parse_frontmatter(content)
-      frontmatter = content.match(FRONTMATTER_REGEX)
-      if frontmatter.nil?
-        [{}, content]
-      else
-        [YAML.safe_load(frontmatter[0]), content.gsub(FRONTMATTER_REGEX, "")]
-      end
-    end
-
     def parse_position_prefix(str)
       pos = str.match(POSITION_PREFIX_REGEX)
       if pos.nil?

data/lib/lookbook/version.rb

@@ -1,3 +1,3 @@
 module Lookbook
-  VERSION = "1.2.1"
+  VERSION = "1.3.1"
 end

data/lib/lookbook/websocket.rb

@@ -0,0 +1,60 @@
+module Lookbook
+  class Websocket
+    attr_reader :engine_mount_path, :server, :logger
+
+    def initialize(engine_mount_path, logger: Lookbook.logger)
+      @engine_mount_path = engine_mount_path
+      @logger = logger
+
+      logger.info "Initializing websocket"
+
+      if Gem::Version.new(Rails.version) >= Gem::Version.new(6.0)
+        @server = ActionCable::Server::Base.new config: cable_config
+      else
+        @server = ActionCable::Server::Base.new
+        @server.config = cable_config
+      end
+    end
+
+    def broadcast(message, payload = nil)
+      logger.debug message.to_s
+      server.broadcast(message.to_s, payload.to_h)
+    end
+
+    def mount_path
+      "/cable"
+    end
+
+    def full_mount_path
+      "#{engine_mount_path}/#{mount_path}".gsub("//", "/")
+    end
+
+    def mountable?
+      true
+    end
+
+    alias_method :mounted?, :mountable?
+
+    def self.noop
+      NullWebsocket.new
+    end
+
+    protected
+
+    def cable_config
+      cable = ActionCable::Server::Configuration.new
+      cable.cable = {adapter: "async"}.with_indifferent_access
+      cable.mount_path = nil
+      cable.connection_class = -> { Lookbook::Connection }
+      cable.logger = logger
+      cable
+    end
+  end
+
+  class NullWebsocket < NullObject
+    def mountable?
+      false
+    end
+    alias_method :mounted?, :mountable?
+  end
+end

data/lib/lookbook.rb

@@ -6,6 +6,7 @@ loader.ignore("#{__dir__}/lookbook.rb")
 loader.push_dir("#{__dir__}/lookbook", namespace: Lookbook)
 loader.collapse("#{__dir__}/lookbook/*")
 loader.collapse("#{__dir__}/lookbook/*/*")
+loader.collapse("#{__dir__}/lookbook/*/*/*")
 loader.setup
 
 module Lookbook
@@ -88,7 +89,7 @@ module Lookbook
     def define_tag(name, args = nil, &block)
       Engine.tags.add_tag(name, {
         named_args: args.to_a,
-        args_parser: block
+        after_parse: block
       })
     end