lookbook 1.5.2 → 2.3.7

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,104 +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 preview_path
-      lookbook_preview_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,52 +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 preview_path
-      lookbook_preview_path(path)
-    end
-
-    def type
-      :group
-    end
-
-    alias_method :parent, :preview
-  end
-end

data/lib/lookbook/error.rb

@@ -1,120 +0,0 @@
-module Lookbook
-  class Error < StandardError
-    delegate :full_message, :backtrace, :to_s, to: :target
-
-    LINES_AROUND = 3
-
-    def initialize(original = nil, title: nil, message: nil, file_path: nil, file_name: nil, line_number: nil, source_code: nil)
-      @original = original
-      @title = title
-      @message = message
-      @file_path = file_path
-      @file_name = file_name
-      @line_number = line_number
-      @source_code = source_code
-      super()
-    end
-
-    def source_code
-      lines = source_code_lines
-
-      if lines.present? && line_number.is_a?(Integer)
-        start_line = source_code_start_line(lines)
-        end_line = source_code_end_line(lines)
-        highlighted_line = source_code_highlighted_line(lines)
-
-        line_count = end_line - start_line
-        relevant_lines = lines.slice(start_line - 1, line_count + 1)
-        if relevant_lines.present?
-          empty_start_lines = 0
-          relevant_lines.each do |line|
-            break unless line.strip.empty?
-            empty_start_lines += 1
-          end
-
-          {
-            code: relevant_lines.join("\n").lstrip,
-            start_line: start_line,
-            highlighted_line: highlighted_line - empty_start_lines
-          }
-        end
-
-      end
-    end
-
-    def source_code_lines
-      if file_path || @source_code
-        if @source_code
-          @source_code.split("\n")
-        else
-          full_path = Rails.root.join(file_path)
-          File.read(full_path).split("\n") if File.exist? full_path
-        end
-      end
-    end
-
-    def file_lang
-      lang = Lookbook::Lang.guess(file_path)
-      lang.present? ? lang[:name] : "plaintext"
-    end
-
-    def title
-      @title || target.class.to_s
-    end
-
-    def message
-      (@message || target.message).gsub("(<unknown>):", "").strip.upcase_first
-    end
-
-    def file_name
-      if @file_name == false
-        nil
-      else
-        @file_name || file_path
-      end
-    end
-
-    def file_path
-      path = if @file_path.nil?
-        parsed_backtrace[0][0] if parsed_backtrace.any?
-      else
-        @file_path.presence || nil
-      end
-      path&.to_s&.delete_prefix("#{Rails.root}/")
-    end
-
-    def line_number
-      number = if @line_number.nil?
-        parsed_backtrace[0][1] if parsed_backtrace.any?
-      else
-        @line_number.presence || nil
-      end
-      number.present? ? number.to_i : number
-    end
-
-    def parsed_backtrace
-      backtrace.map do |x|
-        x =~ /^(.+?):(\d+)(|:in `(.+)')$/
-        [$1, $2, $4]
-      end
-    end
-
-    protected
-
-    def target
-      @original.presence || self
-    end
-
-    def source_code_start_line(lines)
-      [(line_number - LINES_AROUND), 1].max unless line_number.nil?
-    end
-
-    def source_code_end_line(lines)
-      [line_number + LINES_AROUND, lines&.size || Infinity].min
-    end
-
-    def source_code_highlighted_line(lines)
-      [line_number - source_code_start_line(lines) + 1, 1].max unless line_number.nil?
-    end
-  end
-end

data/lib/lookbook/features.rb

@@ -1,24 +0,0 @@
-module Lookbook
-  module Features
-    EXPERIMENTAL_FEATURES = []
-
-    def self.experimental_feature?(name)
-      EXPERIMENTAL_FEATURES.include?(name.to_sym)
-    end
-
-    def self.enabled?(name)
-      return true unless experimental_feature?(name)
-      enabled.include?(name.to_sym)
-    end
-
-    def self.enabled
-      if Lookbook.config.experimental_features == true
-        EXPERIMENTAL_FEATURES
-      elsif Lookbook.config.experimental_features.blank?
-        []
-      else
-        Lookbook.config.experimental_features.map(&:to_sym)
-      end
-    end
-  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/entities/entity_tree_builder.rb

@@ -1,45 +0,0 @@
-module Lookbook
-  class EntityTreeBuilder < Service
-    attr_reader :include_hidden
-
-    def initialize(entities, include_hidden: false)
-      @entities = entities.to_a
-      @include_hidden = include_hidden
-    end
-
-    def call
-      root_node = TreeNode.new
-      entities.each do |entity|
-        current_node = root_node
-        path_segments = parse_segments(entity.logical_path)
-        path_segments.each.with_index(1) do |segment, i|
-          name, position_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 = current_node.get_child(name)
-
-          if content && content.type == :preview
-            content.visible_examples.each do |example|
-              current_node.add_child(example.name, example)
-            end
-          end
-        end
-      end
-      root_node
-    end
-
-    def parse_segments(path)
-      path.split("/").map do |segment|
-        unless segment.start_with?(".")
-          position, name = PositionPrefixParser.call(segment)
-          [name, position || 10000]
-        end
-      end.compact
-    end
-
-    def entities
-      include_hidden ? @entities : @entities.select(&:visible?)
-    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/templates/action_view_annotations_handler.rb

@@ -1,21 +0,0 @@
-module Lookbook
-  class ActionViewAnnotationsHandler < Service
-    attr_reader :disable_annotations
-
-    def initialize(disable_annotations: true)
-      @disable_annotations = disable_annotations
-    end
-
-    def call
-      if ActionView::Base.respond_to?(:annotate_rendered_view_with_filenames) && disable_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/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/support/errors/lookbook_error.rb

@@ -1,21 +0,0 @@
-module Lookbook
-  class LookbookError < StandardError
-    attr_reader :scope, :original, :message
-
-    def initialize(msg = nil, scope: nil, original: nil)
-      @scope = scope
-      @original = original
-      @message = msg
-      super(msg)
-    end
-
-    def full_message
-      if msg.nil?
-        message
-      else
-        scope_str = scope.nil? ? "[#{scope}]" : ""
-        "#{scope_str} #{message}".strip
-      end
-    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

data/lib/tasks/lookbook_tasks.rake

@@ -1,10 +0,0 @@
-require_relative "../lookbook"
-
-namespace :lookbook do
-  namespace :previews do
-    desc "Preparse the previews"
-    task preparse: :environment do
-      puts "The lookbook:preparse task is no longer required and will be removed in v2.0"
-    end
-  end
-end