lookbook 1.5.0 → 2.0.0.beta.0

data/app/helpers/lookbook/component_helper.rb

@@ -1,84 +0,0 @@
-module Lookbook
-  module ComponentHelper
-    COMPONENT_CLASSES = {} # cache for constantized references
-
-    def icon(name, **attrs)
-      lookbook_render :icon, name: name, **attrs
-    end
-
-    def code(language = :html, **attrs, &block)
-      attrs[:language] ||= language
-      lookbook_render :code, **attrs, &block
-    end
-
-    def lookbook_tag(tag = :div, **attrs, &block)
-      lookbook_render :tag, tag: tag, **attrs, &block
-    end
-
-    def lookbook_render(ref, **attrs, &block)
-      comp = if ref.is_a? ViewComponent::Base
-        ref
-      else
-        klass = component_class(ref)
-        attrs.key?(:content) ? klass.new(**attrs.except(:content)).with_content(attrs[:content]) : klass.new(**attrs)
-      end
-      if block && !attrs.key?(:content)
-        public_send render_method_name, comp, &block
-      else
-        public_send render_method_name, comp
-      end
-    end
-
-    unless respond_to? :class_names
-      def class_names(*args)
-        tokens = build_tag_values(*args).flat_map { |value| value.to_s.split(/\s+/) }.uniq
-
-        safe_join(tokens, " ")
-      end
-
-      def build_tag_values(*args)
-        tag_values = []
-
-        args.each do |tag_value|
-          case tag_value
-          when Hash
-            tag_value.each do |key, val|
-              tag_values << key.to_s if val && key.present?
-            end
-          when Array
-            tag_values.concat build_tag_values(*tag_value)
-          else
-            tag_values << tag_value.to_s if tag_value.present?
-          end
-        end
-
-        tag_values
-      end
-    end
-
-    private
-
-    def render_method_name
-      if Rails.application.config.view_component.render_monkey_patch_enabled || Rails.version.to_f >= 6.1
-        :render
-      else
-        :render_component
-      end
-    end
-
-    def component_class(ref)
-      klass = COMPONENT_CLASSES[ref]
-      if klass.nil?
-        ref = ref.to_s.tr("-", "_")
-        class_namespace = ref.camelize
-        begin
-          klass = "Lookbook::#{class_namespace}::Component".constantize
-        rescue
-          klass = "Lookbook::#{class_namespace}Component".constantize
-        end
-        COMPONENT_CLASSES[ref] = klass
-      end
-      klass
-    end
-  end
-end

data/app/helpers/lookbook/output_helper.rb

@@ -1,19 +0,0 @@
-module Lookbook
-  module OutputHelper
-    def markdown(text = nil, &block)
-      MarkdownRenderer.call(block ? capture(&block) : text, Lookbook.config.markdown_options)
-    end
-
-    def highlight(*args, **opts)
-      CodeHighlighter.call(*args, **opts)
-    end
-
-    def beautify(*args, **opts)
-      CodeBeautifier.call(*args, **opts)
-    end
-
-    def pretty_json(obj)
-      JSON.pretty_generate(obj)
-    end
-  end
-end

data/app/helpers/lookbook/page_helper.rb

@@ -1,34 +0,0 @@
-module Lookbook
-  module PageHelper
-    def page_path(id)
-      page = id.is_a?(Page) ? id : Lookbook.pages.find_by_id(id)
-      if page.present?
-        lookbook_page_path page.lookup_path
-      else
-        Lookbook.logger.warn "Could not find page with id ':#{id}'"
-      end
-    end
-
-    def embed(*args, params: {}, type: :preview, max_height: nil, **opts)
-      return unless args.any?
-
-      @embed_counter ||= 0
-
-      preview = if args.first.is_a?(Symbol)
-        Lookbook.previews.find_by_path(args.first)
-      else
-        Lookbook.previews.find_by_preview_class(args.first)
-      end
-
-      example = args[1] ? preview&.example(args[1]) : preview&.default_example
-      embed_id = "#{url_for}/embed/#{example.lookup_path}".delete_prefix("/").tr("/", "-")
-
-      lookbook_render :embed,
-        id: embed_id,
-        example: example,
-        params: params,
-        max_height: max_height,
-        opts: opts
-    end
-  end
-end

data/app/views/layouts/lookbook/inspector.html.erb

@@ -1,7 +0,0 @@
-<%= content_for :main do %>
-  <main class="h-[calc(100vh_-_2.5rem)]">
-    <%= yield %>
-  </main>
-<% end %>
-
-<%= render template: "layouts/lookbook/application" %>

data/app/views/layouts/lookbook/page.html.erb

@@ -1,53 +0,0 @@
-<%= content_for :main do %>
-  <div
-    class="h-[calc(100vh_-_40px)]"
-    x-data="{}"
-    @navigation:complete.window="$refs.scroller.scrollTop = 0">
-  
-    <div class="h-full bg-lookbook-page-bg relative">
-      <% unless @error %>
-        
-        <div class="absolute top-0 right-0 pt-1 pr-0 pl-1 pb-1 rounded-bl-md">
-          <div class="bg-lookbook-page-bg opacity-90 absolute inset-0 w-full h-full z-0"></div>
-          <div class="relative z-10 flex items-center">
-          
-          <% if @previous_page %>
-            <%= lookbook_render :button,
-              size: :lg,
-              icon: :chevron_left,
-              tooltip: "Previous page",
-              href: lookbook_page_path(@previous_page.path),
-              class: "pr-0.5 bg-transparent" %>
-          <% else %>
-            <%= lookbook_render :button,
-              size: :lg,
-              icon: :chevron_left,
-              disabled: true,
-              class: "opacity-50 !cursor-default pr-0.5 bg-transparent" %>
-          <% end %>
-
-          <% if @next_page %>
-            <%= lookbook_render :button,
-              size: :lg,
-              icon: :chevron_right,
-              tooltip: "Next page",
-              href: lookbook_page_path(@next_page.path),
-              class: "pl-0.5 bg-transparent" %>
-          <% else %>
-            <%= lookbook_render :button,
-              size: :lg,
-              icon: :chevron_right,
-              disabled: true,
-              class: "opacity-50 !cursor-default pl-0.5 bg-transparent" %>
-          <% end %>
-          </div>
-        </div>
-      <% end %>
-
-      <%= yield %>
-    </div>
-    
-  </div>
-<% end %>
-
-<%= render template: "layouts/lookbook/application" %>

data/app/views/layouts/lookbook/standalone.html.erb

@@ -1,5 +0,0 @@
-<%= content_for :body do %>
-  <%= yield %>
-<% end %>
-
-<%= render template: "layouts/lookbook/skeleton" %>

data/lib/lookbook/entities/collections/component_collection.rb

@@ -1,4 +0,0 @@
-module Lookbook
-  class ComponentCollection < EntityCollection
-  end
-end

data/lib/lookbook/entities/collections/preview_example_collection.rb

@@ -1,4 +0,0 @@
-module Lookbook
-  class PreviewExampleCollection < EntityCollection
-  end
-end

data/lib/lookbook/entities/component.rb

@@ -1,31 +0,0 @@
-module Lookbook
-  class Component < Entity
-    include Locatable
-
-    attr_reader :component_class
-
-    def initialize(component_class)
-      @component_class = component_class
-      @file_path = "#{Engine.component_paths.first}/#{name.underscore}.rb"
-      @base_directories = Engine.component_paths
-      @lookup_path = PathUtils.to_lookup_path(relative_file_path)
-    end
-
-    def name
-      component_class.name
-    end
-
-    def template_file_path
-      Dir.glob("#{directory_path}/#{file_name(true)}.*.erb").first
-    end
-
-    def inline?
-      template_file_path.present?
-    end
-
-    def template_path
-      Lookbook.logger.warn "The `template_path` method has been deprecated - use `template_file_path` instead. `template_file_path` will be removed in v2.0"
-      template_file_path
-    end
-  end
-end

data/lib/lookbook/entities/concerns/navigable.rb

@@ -1,43 +0,0 @@
-module Lookbook
-  module Navigable
-    extend ActiveSupport::Concern
-
-    included do
-      def hidden?
-        fetch_config(:hidden, false)
-      end
-
-      def visible?
-        !hidden?
-      end
-
-      def position
-        return @_position if @_position
-
-        pos = if @position_prefixes && respond_to?(:file_name)
-          PositionPrefixParser.call(file_name).first || default_position
-        else
-          fetch_config(:position, default_position)
-        end
-
-        @_position ||= pos.to_i
-      end
-
-      def depth
-        path.split("/").size
-      end
-
-      def default_position
-        @default_position || 10000
-      end
-
-      def <=>(other)
-        if respond_to?(:sort_handler, true)
-          sort_handler(other)
-        else
-          [position, label] <=> [other.position, other.label]
-        end
-      end
-    end
-  end
-end

data/lib/lookbook/entities/preview.rb

@@ -1,87 +0,0 @@
-module Lookbook
-  class Preview < Entity
-    include Annotatable
-    include Locatable
-    include Navigable
-
-    delegate :render_args, to: :preview_class
-
-    attr_reader :preview_class
-
-    def initialize(code_object)
-      @code_object = code_object
-      @preview_class = code_object.path.constantize
-      @file_path = Pathname(code_object.file)
-      @base_directories = Engine.preview_paths
-
-      cleaned_path = relative_file_path.to_s
-        .gsub(/\/(component_preview|preview)(\..*)$/, "")
-        .gsub(/(_component_preview|_preview)(\..*)$/, "")
-
-      @lookup_path = PathUtils.to_lookup_path(cleaned_path)
-    end
-
-    def examples
-      @_examples ||= PreviewExampleCollection.new(load_examples)
-    end
-
-    def example(example_name)
-      examples.find { |m| m.name == example_name.to_s }
-    end
-
-    def visible_examples
-      @_visible_examples ||= PreviewExampleCollection.new(examples.select(&:visible?))
-    end
-
-    def default_example
-      visible_examples.first
-    end
-
-    def components
-      @_components ||= ComponentCollection.new(examples.flat_map(&:components).uniq(&:path))
-    end
-
-    def component
-      components.first
-    end
-
-    def display_options
-      global_options = Lookbook.config.preview_display_options
-      global_options.deep_merge(fetch_config(:display_options, {}))
-    end
-
-    def layout
-      preview_class.instance_variable_get(:@layout)
-    end
-
-    def url_path
-      lookbook_inspect_path(path)
-    end
-
-    def preview_class_name
-      preview_class.name
-    end
-
-    def guess_components
-      [preview_class.name.chomp("Preview").constantize]
-    rescue
-      []
-    end
-
-    protected
-
-    def load_examples
-      return example_entities unless code_object.groups.any?
-
-      example_entities.group_by(&:group).flat_map do |group_name, grouped_examples|
-        group_name.nil? ? grouped_examples : PreviewGroup.new(group_name.presence || label.pluralize, grouped_examples, self)
-      end
-    end
-
-    def example_entities
-      public_methods = preview_class.public_instance_methods(false)
-      method_objects = code_object.meths.select { |m| public_methods.include?(m.name) }
-      method_objects.map.with_index { |code_object, i| PreviewExample.new(code_object, self, position: i) }
-    end
-  end
-end

data/lib/lookbook/entities/preview_example.rb

@@ -1,100 +0,0 @@
-module Lookbook
-  class PreviewExample < Entity
-    include Inspectable
-    include Annotatable
-    include Navigable
-
-    delegate :group, to: :code_object
-
-    attr_reader :preview
-
-    def initialize(code_object, preview, position: nil)
-      @code_object = code_object
-      @preview = preview
-      @default_position = position
-      @lookup_path = "#{parent.lookup_path}/#{name}"
-    end
-
-    def id
-      @_id ||= Utils.id(fetch_config(:id) { "#{parent.id}-#{code_object.name}" })
-    end
-
-    def name
-      @_name ||= Utils.name(code_object.name)
-    end
-
-    def display_options
-      parent.display_options.merge(fetch_config(:display_options, {}))
-    end
-
-    def components
-      @_components ||= ComponentCollection.new(load_components)
-    end
-
-    def component
-      components.first
-    end
-
-    def examples
-      [self]
-    end
-
-    def template_source(template_path)
-      source_path = template_file_path(template_path)
-      source_path ? File.read(source_path) : nil
-    end
-
-    def template_lang(template_path)
-      path = template_file_path(template_path)
-      Lookbook::Lang.guess(path) || Lookbook::Lang.find(:html)
-    end
-
-    def search_terms
-      [parent.label, label]
-    end
-
-    def url_path
-      lookbook_inspect_path(path)
-    end
-
-    def type
-      :example
-    end
-
-    alias_method :parent, :preview
-    alias_method :lang, :source_lang
-
-    protected
-
-    def sort_handler(other_entity)
-      if Lookbook.config.sort_examples
-        label <=> other_entity.label
-      else
-        [position, label] <=> [other_entity.position, other_entity.label]
-      end
-    end
-
-    def format_source(source)
-      source.sub(/^def \w+\s?(\([^)]+\))?/m, "").split("\n")[0..-2].join("\n")
-    end
-
-    def template_file_path(template_path)
-      return full_template_path(template_path) if respond_to?(:full_template_path, true)
-
-      template_path = template_path.to_s.sub(/\..*$/, "")
-      base_path = Engine.preview_paths.detect do |p|
-        Dir["#{p}/#{template_path}.html.*"].first
-      end
-      path = Dir["#{base_path}/#{template_path}.html.*"].first
-      Pathname(path) if path
-    end
-
-    def load_components
-      component_classes = [*fetch_config(:components, []), *preview.send(:fetch_config, :components, [])]
-      component_classes = preview.guess_components if component_classes.empty?
-
-      components = component_classes.map { |klass| Component.new(klass) }
-      components.uniq(&:path)
-    end
-  end
-end

data/lib/lookbook/entities/preview_group.rb

@@ -1,48 +0,0 @@
-module Lookbook
-  class PreviewGroup < Entity
-    include Navigable
-
-    attr_reader :examples, :preview
-
-    def initialize(name, examples, preview)
-      @name = Utils.name(name)
-      @examples = PreviewExampleCollection.new(examples)
-      @preview = preview
-      @lookup_path = "#{parent.lookup_path}/#{@name}"
-    end
-
-    def display_options
-      merged = {}
-      examples.to_a.reverse.map do |example|
-        merged.merge!(example.display_options)
-      end
-      merged
-    end
-
-    def components
-      @_components ||= ComponentCollection.new(examples.flat_map(&:components).uniq(&:path))
-    end
-
-    def search_terms
-      [parent.label, label]
-    end
-
-    def tags(tag_name = nil)
-      examples.flat_map { |example| example.tags(tag_name) }
-    end
-
-    def tag(tag_name = nil)
-      tags(tag_name).first
-    end
-
-    def url_path
-      lookbook_inspect_path(path)
-    end
-
-    def type
-      :group
-    end
-
-    alias_method :parent, :preview
-  end
-end

data/lib/lookbook/preview_actions.rb

@@ -1,43 +0,0 @@
-module Lookbook
-  module PreviewActions
-    def self.included(klass)
-      klass.helper Lookbook::PreviewHelper
-    end
-
-    def render_example_to_string(preview, example_name)
-      prepend_application_view_paths
-      prepend_preview_examples_view_path
-      @preview = preview
-      @example_name = example_name
-      @render_args = @preview.render_args(@example_name, params: params.permit!)
-      template = @render_args[:template]
-      locals = @render_args[:locals]
-      opts = {}
-      opts[:layout] = nil
-      opts[:locals] = locals if locals.present?
-
-      with_optional_action_view_annotations do
-        render html: render_to_string(template, **opts)
-      end
-    end
-
-    def render_in_layout_to_string(template, locals, opts = {})
-      append_view_path Lookbook::Engine.root.join("app/views")
-
-      with_optional_action_view_annotations do
-        html = render_to_string(template, locals: locals, **determine_layout(opts[:layout]))
-        if opts[:append_html].present?
-          html += opts[:append_html]
-        end
-        render html: html
-      end
-    end
-
-    protected
-
-    def with_optional_action_view_annotations(&block)
-      disable = Lookbook.config.preview_disable_action_view_annotations
-      ActionViewAnnotationsHandler.call(disable_annotations: disable, &block)
-    end
-  end
-end

data/lib/lookbook/process.rb

@@ -1,21 +0,0 @@
-module Lookbook
-  class Process
-    attr_reader :env
-
-    def initialize(env: Rails.env)
-      @env = env
-    end
-
-    def supports_listening?
-      !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/rendered_example.rb

@@ -1,37 +0,0 @@
-module Lookbook
-  class RenderedExample
-    delegate_missing_to :example
-
-    attr_reader :output, :example
-
-    def initialize(example, output, params)
-      @example = example
-      @params = params
-      @output = output
-    end
-
-    def source
-      has_custom_template? ? template_source(template) : example.source
-    end
-
-    def source_lang
-      has_custom_template? ? template_lang(template) : example.source_lang
-    end
-
-    protected
-
-    attr_reader :params
-
-    def render_args
-      @_render_args ||= preview.render_args(example.name, params: params)
-    end
-
-    def template
-      render_args[:template]
-    end
-
-    def has_custom_template?
-      template != "view_components/preview" && !custom_source?
-    end
-  end
-end

data/lib/lookbook/services/position_prefix_parser.rb

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

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

@@ -1,13 +0,0 @@
-module Lookbook
-  class SearchParamBuilder < Service
-    attr_reader :data
-
-    def initialize(data)
-      @data = data
-    end
-
-    def call
-      data.map { |k, v| "#{k}:#{v}" }.join("|")
-    end
-  end
-end

data/lib/lookbook/tags/component_tag.rb

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