lookbook 1.2.1 → 1.3.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lookbook
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Mark Perkins
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2022-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: css_parser
@@ -303,7 +303,10 @@ files:
 - app/components/lookbook/viewport/component.html.erb
 - app/components/lookbook/viewport/component.js
 - app/components/lookbook/viewport/component.rb
+- app/controllers/concerns/lookbook/targetable_concern.rb
+- app/controllers/concerns/lookbook/with_preview_controller_concern.rb
 - app/controllers/lookbook/application_controller.rb
+- app/controllers/lookbook/inspector_controller.rb
 - app/controllers/lookbook/page_controller.rb
 - app/controllers/lookbook/pages_controller.rb
 - app/controllers/lookbook/previews_controller.rb
@@ -321,21 +324,21 @@ files:
 - app/views/lookbook/404.html.erb
 - app/views/lookbook/error.html.erb
 - app/views/lookbook/index.html.erb
+- app/views/lookbook/inspector/inputs/_color.html.erb
+- app/views/lookbook/inspector/inputs/_range.html.erb
+- app/views/lookbook/inspector/inputs/_select.html.erb
+- app/views/lookbook/inspector/inputs/_text.html.erb
+- app/views/lookbook/inspector/inputs/_textarea.html.erb
+- app/views/lookbook/inspector/inputs/_toggle.html.erb
+- app/views/lookbook/inspector/panels/_content.html.erb
+- app/views/lookbook/inspector/panels/_notes.html.erb
+- app/views/lookbook/inspector/panels/_output.html.erb
+- app/views/lookbook/inspector/panels/_params.html.erb
+- app/views/lookbook/inspector/panels/_preview.html.erb
+- app/views/lookbook/inspector/panels/_source.html.erb
+- app/views/lookbook/inspector/show.html.erb
 - app/views/lookbook/pages/show.html.erb
 - app/views/lookbook/preview.html.erb
-- app/views/lookbook/previews/inputs/_color.html.erb
-- app/views/lookbook/previews/inputs/_range.html.erb
-- app/views/lookbook/previews/inputs/_select.html.erb
-- app/views/lookbook/previews/inputs/_text.html.erb
-- app/views/lookbook/previews/inputs/_textarea.html.erb
-- app/views/lookbook/previews/inputs/_toggle.html.erb
-- app/views/lookbook/previews/panels/_content.html.erb
-- app/views/lookbook/previews/panels/_notes.html.erb
-- app/views/lookbook/previews/panels/_output.html.erb
-- app/views/lookbook/previews/panels/_params.html.erb
-- app/views/lookbook/previews/panels/_preview.html.erb
-- app/views/lookbook/previews/panels/_source.html.erb
-- app/views/lookbook/previews/show.html.erb
 - config/app.yml
 - config/hooks.yml
 - config/inputs.yml
@@ -343,29 +346,46 @@ files:
 - config/routes.rb
 - config/tags.yml
 - lib/lookbook.rb
-- lib/lookbook/code_formatter.rb
 - lib/lookbook/collection.rb
 - lib/lookbook/component.rb
 - lib/lookbook/engine.rb
 - lib/lookbook/entity.rb
 - lib/lookbook/error.rb
 - lib/lookbook/features.rb
+- lib/lookbook/file_watcher.rb
 - lib/lookbook/lang.rb
-- lib/lookbook/markdown.rb
 - lib/lookbook/page.rb
 - lib/lookbook/page_collection.rb
 - lib/lookbook/page_section.rb
-- lib/lookbook/params.rb
-- lib/lookbook/parser.rb
+- lib/lookbook/param.rb
 - lib/lookbook/preview.rb
+- lib/lookbook/preview_actions.rb
 - lib/lookbook/preview_collection.rb
-- lib/lookbook/preview_controller.rb
 - lib/lookbook/preview_example.rb
 - lib/lookbook/preview_group.rb
+- lib/lookbook/preview_parser.rb
+- lib/lookbook/process.rb
+- lib/lookbook/services/code/code_beautifier.rb
+- lib/lookbook/services/code/code_highlighter.rb
 - lib/lookbook/services/config_loader.rb
-- lib/lookbook/services/search_param_builder.rb
-- lib/lookbook/services/search_param_parser.rb
+- lib/lookbook/services/data/parsers/data_parser.rb
+- lib/lookbook/services/data/parsers/json_parser.rb
+- lib/lookbook/services/data/parsers/yaml_parser.rb
+- lib/lookbook/services/data/resolvers/data_resolver.rb
+- lib/lookbook/services/data/resolvers/eval_resolver.rb
+- lib/lookbook/services/data/resolvers/file_resolver.rb
+- lib/lookbook/services/data/resolvers/method_resolver.rb
+- lib/lookbook/services/data/resolvers/yaml_resolver.rb
+- lib/lookbook/services/markdown_renderer.rb
+- lib/lookbook/services/string_value_caster.rb
 - lib/lookbook/services/tags/key_value_tag_parser.rb
+- lib/lookbook/services/tags/tag_options_parser.rb
+- lib/lookbook/services/templates/action_view_annotations_handler.rb
+- lib/lookbook/services/templates/action_view_annotations_stripper.rb
+- lib/lookbook/services/templates/frontmatter_extractor.rb
+- lib/lookbook/services/templates/styles_extractor.rb
+- lib/lookbook/services/urls/search_param_builder.rb
+- lib/lookbook/services/urls/search_param_parser.rb
 - lib/lookbook/source_inspector.rb
 - lib/lookbook/stores/config_store.rb
 - lib/lookbook/stores/hook_store.rb
@@ -375,17 +395,26 @@ files:
 - lib/lookbook/support/errors/config_error.rb
 - lib/lookbook/support/errors/lookbook_error.rb
 - lib/lookbook/support/errors/parser_error.rb
+- lib/lookbook/support/null_object.rb
 - lib/lookbook/support/service.rb
 - lib/lookbook/support/store.rb
 - lib/lookbook/support/utils/attribute_utils.rb
 - lib/lookbook/support/utils/path_utils.rb
-- lib/lookbook/tag.rb
-- lib/lookbook/tag_options.rb
-- lib/lookbook/tags.rb
-- lib/lookbook/template_parser.rb
+- lib/lookbook/tags/component_tag.rb
+- lib/lookbook/tags/custom_tag.rb
+- lib/lookbook/tags/display_tag.rb
+- lib/lookbook/tags/hidden_tag.rb
+- lib/lookbook/tags/id_tag.rb
+- lib/lookbook/tags/label_tag.rb
+- lib/lookbook/tags/logical_path_tag.rb
+- lib/lookbook/tags/param_tag.rb
+- lib/lookbook/tags/position_tag.rb
+- lib/lookbook/tags/tag_provider.rb
+- lib/lookbook/tags/yard_tag.rb
 - lib/lookbook/theme.rb
 - lib/lookbook/utils.rb
 - lib/lookbook/version.rb
+- lib/lookbook/websocket.rb
 - lib/tasks/lookbook_tasks.rake
 - public/lookbook-assets/css/app.css
 - public/lookbook-assets/css/app.css.map

data/lib/lookbook/code_formatter.rb

@@ -1,68 +0,0 @@
-require "rouge"
-require "htmlbeautifier"
-require "htmlentities"
-
-module Lookbook
-  module CodeFormatter
-    class << self
-      def highlight(source, **opts)
-        coder = HTMLEntities.new
-        source = coder.decode source
-        language = opts[:language] || "ruby"
-        formatter = Formatter.new(**opts)
-        lexer = Rouge::Lexer.find(language.to_s) || Rouge::Lexer.find("plaintext")
-        formatter.format(lexer.lex(source)).html_safe
-      end
-
-      def beautify(source, **opts)
-        language = opts[:language] || "html"
-        source = source.strip
-        result = language.downcase == "html" ? HtmlBeautifier.beautify(source) : source
-        result.strip.html_safe
-      end
-    end
-  end
-
-  class Formatter < Rouge::Formatters::HTML
-    def initialize(**opts)
-      @opts = opts
-      @highlight_lines = opts[:highlight_lines].to_a || []
-      @start_line = opts[:start_line] || 1
-      @language = opts[:language]
-    end
-
-    def stream(tokens, &block)
-      lines = token_lines(tokens)
-
-      yield "<div class='wrapper'>"
-
-      if @opts[:line_numbers]
-        yield "<div class='line-numbers'>"
-        lines.each.with_index do |line, i|
-          yield "<div class='line #{"highlighted" if highlighted?(i)}'><span class='line-number'>#{line_number(i)}</span></div>"
-        end
-        yield "</div>"
-      end
-
-      yield "<pre class='code highlight' data-lang='#{@language}'><code>"
-      lines.each.with_index do |line_tokens, i|
-        yield "<div class='line#{" highlighted" if highlighted?(i)}'>"
-        line_tokens.each do |token, value|
-          yield span(token, value)
-        end
-        yield "</div>"
-      end
-      yield "</code></pre>"
-
-      yield "</div>"
-    end
-
-    def highlighted?(i)
-      @highlight_lines.include?(i + 1)
-    end
-
-    def line_number(i)
-      @start_line + i
-    end
-  end
-end

data/lib/lookbook/markdown.rb

@@ -1,22 +0,0 @@
-require "redcarpet"
-
-module Lookbook
-  class Markdown
-    def self.render(text)
-      Utils.strip_action_view_annotations!(text)
-      markdown = Redcarpet::Markdown.new(Renderer, Lookbook.config.markdown_options.to_h)
-      markdown.render(text).html_safe
-    end
-
-    class Renderer < 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)
-      end
-    end
-  end
-end

data/lib/lookbook/params.rb

@@ -1,157 +0,0 @@
-require "active_model"
-
-module Lookbook
-  module Params
-    VALUE_TYPE_MATCH_REGEXP = /^(\[\s?([A-Z]{1}\w+)\s?\])/
-    DESCRIPTION_MATCH_REGEXP = /"(.*[^\\])"$/
-
-    PARAM_OPTION_KEYS = %i[name input label hint description value_type value_default].freeze
-
-    class << self
-      def build_param(param, default: nil, eval_scope: nil)
-        input, value_type, options_str, description = parse_param_tag_text(param.text)
-
-        tag_options = Lookbook::TagOptions.new(options_str,
-          base_dir: (File.dirname(param.object.files.first[0]) if param.object.files.any?),
-          eval_scope: eval_scope).options
-
-        if tag_options.is_a? Array
-          # handle special case legacy situation for selects where
-          # options are an array of choices rather than a Hash
-          tag_options = {choices: tag_options}
-        end
-
-        param_options = tag_options.select { |key| PARAM_OPTION_KEYS.include? key }
-        input_options = tag_options.except(*PARAM_OPTION_KEYS)
-
-        value_type ||= param_options[:value_type]
-        input ||= param_options[:input] || guess_input(value_type, default)
-        name = param.name.to_s
-
-        {
-          name: name,
-          label: param_options[:label] || name.titleize,
-          hint: param_options[:hint],
-          description: description || param_options[:description],
-          input: input.to_s.tr("_", "-"),
-          input_options: input_options,
-          value: nil,
-          value_type: value_type || guess_value_type(input, default),
-          value_default: default
-        }
-      end
-
-      # Parses param tag strings with the format: `[<value_type>] <input> <description?> <opts?>`
-      def parse_param_tag_text(text)
-        text = (text.presence || "").strip
-
-        value_type = nil
-        text.match(VALUE_TYPE_MATCH_REGEXP) do |m|
-          value_type = m[2]
-          text.gsub!(VALUE_TYPE_MATCH_REGEXP, "").strip!
-        end
-
-        text, options_str = Lookbook::TagOptions.extract_options(text)
-
-        description = nil
-        text.match(DESCRIPTION_MATCH_REGEXP) do |m|
-          description = m[1]
-          text.gsub!(DESCRIPTION_MATCH_REGEXP, "").strip!
-        end
-
-        input, rest = text.split(" ", 2)
-
-        [input, value_type, options_str, description, rest]
-      end
-
-      def parse_method_param_str(param_str)
-        return nil if param_str[0].nil? || param_str[1].nil?
-        name = param_str[0].chomp(":")
-        value = param_str[1]&.strip
-        value = case value
-        when "nil"
-          nil
-        else
-          if value&.first == ":"
-            value.delete_prefix(":").to_sym
-          else
-            YAML.safe_load(value)
-          end
-        end
-        [name, value]
-      end
-
-      def cast(value, type = "String")
-        case type.downcase
-        when "symbol"
-          value.presence&.delete_prefix(":")&.to_sym
-        when "hash"
-          result = safe_parse_yaml(value, {})
-          unless result.is_a? Hash
-            Lookbook.logger.debug "Failed to parse '#{value}' into a Hash"
-            result = {}
-          end
-          result
-        when "array"
-          result = safe_parse_yaml(value, [])
-          unless result.is_a? Array
-            Lookbook.logger.debug "Failed to parse '#{value}' into an Array"
-            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
-            type_class.new.cast(value)
-          rescue NameError
-            raise ArgumentError, "'#{type}' is not a valid param type to cast to."
-          end
-        end
-      end
-
-      private
-
-      def guess_input(value_type, default)
-        if value_type&.downcase == "boolean" || (value_type.blank? && boolean?(default))
-          "toggle"
-        else
-          "text"
-        end
-      end
-
-      def guess_value_type(input, default)
-        if input&.downcase == "toggle"
-          "Boolean"
-        elsif input&.downcase == "number"
-          "Integer"
-        elsif boolean?(default)
-          "Boolean"
-        elsif default.is_a? Symbol
-          "Symbol"
-        elsif ["date", "datetime-local"].include?(input&.downcase) || default.is_a?(DateTime)
-          "DateTime"
-        else
-          "String"
-        end
-      end
-
-      def safe_parse_yaml(value, fallback)
-        value.present? ? YAML.safe_load(value) : fallback
-      rescue Psych::SyntaxError
-        fallback
-      end
-
-      def boolean?(value)
-        value == true || value == false
-      end
-    end
-  end
-end

data/lib/lookbook/parser.rb

@@ -1,42 +0,0 @@
-require "yard"
-
-module Lookbook
-  class Parser
-    attr_reader :registry_path
-    def initialize(paths)
-      @paths = paths.map { |p| "#{p}/**/*preview.rb" }
-      @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(&block)
-      unless @parsing
-        @parsing = true
-        @after_parse_once_callbacks << block if block
-        YARD::Registry.clear
-        YARD.parse(@paths)
-      end
-    end
-
-    def after_parse(&block)
-      @after_parse_callbacks << block
-    end
-
-    class << self
-      def define_tags(tags = nil)
-        tags.to_h.each do |name, tag|
-          YARD::Tags::Library.define_tag(tag[:label], name, tag[:yard_parser])
-        end
-      end
-    end
-  end
-end

data/lib/lookbook/tag.rb

@@ -1,122 +0,0 @@
-require "shellwords"
-
-module Lookbook
-  class Tag
-    attr_reader :data, :arg_names
-    attr_accessor :args, :opts
-
-    def initialize(tag_object, arg_names = nil, parser: nil, eval_scope: nil, file: nil, **options)
-      @tag_object = tag_object
-      @arg_names = arg_names
-      @args = {}
-      @opts = {}
-      @options = options
-      @parser = parser
-      @eval_scope = eval_scope
-      @file = file
-      @data = Store.new
-      run_parser
-    end
-
-    def tag_name
-      @name ||= @tag_object.tag_name.to_sym
-    end
-
-    def tag_body
-      @tag_object.text
-    end
-
-    def get_opt(key, fallback = nil)
-      opts[key] || fallback
-    end
-
-    def opts_str
-      @opts_str ||= text_tokens.size > args_count ? text_tokens.slice(args_count, text_tokens.size).join(" ") : ""
-    end
-
-    protected
-
-    def parse_args
-      unless arg_names.nil?
-        values = text_tokens.slice(0, args_count)
-        @args = build_args(values)
-      end
-    end
-
-    def parse_opts
-      return @opts if @options[:parse_options] == false
-      tag_opts = Lookbook::TagOptions.new(opts_str,
-        eval_scope: @eval_scope,
-        base_dir: File.dirname(@file))
-      options = tag_opts.resolve || {}
-      @opts = if options.is_a?(Hash)
-        options.with_indifferent_access
-      else
-        Lookbook.logger.warn "'@#{tag_name}' tag options should resolve to a Hash"
-        options
-      end
-    end
-
-    def run_parser
-      parse_args
-      parse_opts
-      @parser.call(self) if @parser.respond_to?(:call)
-    end
-
-    def arg_options
-      return [] if arg_names.nil?
-      @arg_options ||= arg_names.map do |arg|
-        unless arg.is_a? Hash
-          name = arg
-          arg = {
-            name: name.to_sym
-          }
-        end
-        arg[:parse] = false unless arg.key? :parse
-        arg
-      end
-    end
-
-    def validate_arg_names
-      if arg_names.present?
-        arg_names.each do |name|
-          if methods.include? name.to_sym
-            raise ArgumentError, "'#{name}' is a reserved word and cannot be used as an argument name."
-          end
-        end
-      end
-    end
-
-    def args_count
-      arg_options.size
-    end
-
-    def parse_yaml(str, fallback = "~")
-      YAML.safe_load(str || fallback)
-    end
-
-    def text_tokens
-      @tokens ||= Shellwords.split(@tag_object.text)
-    end
-
-    def build_args(values)
-      arg_options.map.with_index do |arg, i|
-        value = values[i]
-        value = parse_arg(value) if arg[:parse] == true && value.present?
-        [arg[:name].to_sym, value]
-      end.to_h
-    end
-
-    def method_missing(name, *method_args)
-      if name.end_with? "="
-        data[name.to_s.chomp("=").to_sym] = method_args.first
-      else
-        data[name] || args[name]
-      end
-    end
-
-    def respond_to_missing?(name, *)
-      data.key?(name) || args.key?(name)
-    end
-  end
-end

data/lib/lookbook/tag_options.rb

@@ -1,111 +0,0 @@
-module Lookbook
-  class TagOptions
-    SYMBOL_MATCH = /(:([a-zA-Z_\d]+))$/
-    EVAL_OPTION_MATCH = /(\{\{\s?(.*)\s?\}\})$/
-    YAML_HASH_MATCH = /(\{(.*?)\})$/m
-    YAML_ARRAY_MATCH = /(\[(.*?)\])$/m
-    FILE_PATH_MATCH = /(\S+\.(json|yml))$/
-
-    MATCHERS = [YAML_ARRAY_MATCH, YAML_HASH_MATCH, SYMBOL_MATCH, EVAL_OPTION_MATCH, FILE_PATH_MATCH]
-
-    def initialize(options_str, eval_scope: nil, base_dir: nil)
-      @options_str = options_str.is_a?(String) ? options_str.strip : ""
-      @eval_scope = eval_scope
-      @base_dir = base_dir
-    end
-
-    def options
-      resolve.is_a?(Hash) ? resolve.symbolize_keys : resolve
-    end
-
-    def resolve
-      @resolved_options ||= begin
-        if @options_str.present?
-          if @options_str.end_with?(".json", ".yml")
-            file_path = resolve_file_path
-            if file_path
-              options_file_content = File.read(file_path)
-            else
-              raise "Tag options data file not found"
-            end
-          end
-          if file_path&.extname == ".json"
-            JSON.parse(options_file_content)
-          elsif file_path&.extname == ".yml"
-            YAML.safe_load(options_file_content)
-          elsif evaluatable?
-            evaluate
-          else
-            YAML.safe_load(@options_str || "{}")
-          end
-        else
-          {}
-        end
-      rescue => exception
-        Lookbook.logger.warn Lookbook::Error.new(exception)
-        {}
-      end
-    end
-
-    def resolve_file_path
-      path = if @options_str.start_with?(".") && @base_dir.present?
-        File.expand_path(@options_str, @base_dir)
-      else
-        Rails.root.join(@options_str)
-      end
-      Pathname.new path
-    end
-
-    def evaluate
-      if Lookbook.config.preview_params_options_eval == true
-        if @eval_scope.nil?
-          raise "Preview params eval must be scoped to an object"
-        else
-          @eval_scope.instance_eval(statement)
-        end
-      else
-        raise "The config option `preview_params_options_eval` must be set to `true` before param options can be evaluated at runtime"
-      end
-    end
-
-    def self.extract_options(str)
-      str ||= ""
-      str.strip!
-      opts_str = ""
-
-      MATCHERS.each do |regexp|
-        match_data = str.match(regexp)
-        unless match_data.nil?
-          str.gsub!(regexp, "").strip!
-          opts_str = match_data[1]
-          break
-        end
-      end
-
-      [str, opts_str]
-    end
-
-    def self.resolveable?(str)
-      return unless str.is_a?(String)
-      str.strip!
-      MATCHERS.each do |regexp|
-        return true if str.match?(regexp)
-      end
-      false
-    end
-
-    private
-
-    def statement
-      evaluatable? ? eval_match_data[2].strip : "{}"
-    end
-
-    def evaluatable?
-      eval_match_data.present?
-    end
-
-    def eval_match_data
-      @eval_match_data ||= @options_str.match(EVAL_OPTION_MATCH) || @options_str.match(SYMBOL_MATCH)
-    end
-  end
-end

data/lib/lookbook/tags.rb

@@ -1,17 +0,0 @@
-module Lookbook
-  module Tags
-    def self.process_tags(tag_objects, file: nil, eval_scope: nil)
-      return [] if tag_objects.none?
-      tag_objects.map do |tag_object|
-        tag_config = Engine.tags.get_tag(tag_object.tag_name).to_h
-        tag_opts = tag_config[:opts].to_h
-        Lookbook::Tag.new(tag_object,
-          tag_opts[:named_args],
-          parser: tag_opts[:args_parser],
-          **tag_opts.except(:named_args, :args_parser),
-          file: file,
-          eval_scope: eval_scope)
-      end.compact
-    end
-  end
-end