lookbook 1.3.4 → 1.4.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lookbook
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.1
 platform: ruby
 authors:
 - Mark Perkins
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2022-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: css_parser
@@ -266,7 +266,11 @@ files:
 - app/components/lookbook/nav/component.html.erb
 - app/components/lookbook/nav/component.js
 - app/components/lookbook/nav/component.rb
-- app/components/lookbook/nav/item/component.html.erb
+- app/components/lookbook/nav/directory/component.html.erb
+- app/components/lookbook/nav/directory/component.rb
+- app/components/lookbook/nav/entity/component.html.erb
+- app/components/lookbook/nav/entity/component.rb
+- app/components/lookbook/nav/item/component.css
 - app/components/lookbook/nav/item/component.js
 - app/components/lookbook/nav/item/component.rb
 - app/components/lookbook/page_tabs/component.html.erb
@@ -344,31 +348,41 @@ files:
 - config/app.yml
 - config/hooks.yml
 - config/inputs.yml
+- config/languages.yml
 - config/panels.yml
 - config/routes.rb
 - config/tags.yml
 - lib/lookbook.rb
-- lib/lookbook/collection.rb
-- lib/lookbook/component.rb
 - lib/lookbook/engine.rb
-- lib/lookbook/entity.rb
+- lib/lookbook/entities/collections/component_collection.rb
+- lib/lookbook/entities/collections/concerns/hierarchical_collection.rb
+- lib/lookbook/entities/collections/entity_collection.rb
+- lib/lookbook/entities/collections/page_collection.rb
+- lib/lookbook/entities/collections/preview_collection.rb
+- lib/lookbook/entities/collections/preview_example_collection.rb
+- lib/lookbook/entities/component.rb
+- lib/lookbook/entities/concerns/annotatable.rb
+- lib/lookbook/entities/concerns/inspectable.rb
+- lib/lookbook/entities/concerns/locatable.rb
+- lib/lookbook/entities/concerns/navigable.rb
+- lib/lookbook/entities/entity.rb
+- lib/lookbook/entities/page.rb
+- lib/lookbook/entities/page_section.rb
+- lib/lookbook/entities/preview.rb
+- lib/lookbook/entities/preview_example.rb
+- lib/lookbook/entities/preview_group.rb
 - lib/lookbook/error.rb
 - lib/lookbook/features.rb
 - lib/lookbook/file_watcher.rb
 - lib/lookbook/lang.rb
-- lib/lookbook/page.rb
-- lib/lookbook/page_collection.rb
-- lib/lookbook/page_section.rb
 - lib/lookbook/param.rb
-- lib/lookbook/preview.rb
 - lib/lookbook/preview_actions.rb
-- lib/lookbook/preview_collection.rb
-- lib/lookbook/preview_example.rb
-- lib/lookbook/preview_group.rb
 - lib/lookbook/preview_parser.rb
 - lib/lookbook/process.rb
+- lib/lookbook/rendered_example.rb
 - lib/lookbook/services/code/code_beautifier.rb
 - lib/lookbook/services/code/code_highlighter.rb
+- lib/lookbook/services/code/code_indenter.rb
 - lib/lookbook/services/config_loader.rb
 - lib/lookbook/services/data/parsers/data_parser.rb
 - lib/lookbook/services/data/parsers/json_parser.rb
@@ -378,7 +392,9 @@ files:
 - 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/entities/entity_tree_builder.rb
 - lib/lookbook/services/markdown_renderer.rb
+- lib/lookbook/services/position_prefix_parser.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
@@ -388,7 +404,6 @@ files:
 - 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
 - lib/lookbook/stores/input_store.rb
@@ -400,8 +415,9 @@ files:
 - 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/tree_node.rb
 - lib/lookbook/support/utils/path_utils.rb
+- lib/lookbook/support/utils/utils.rb
 - lib/lookbook/tags/component_tag.rb
 - lib/lookbook/tags/custom_tag.rb
 - lib/lookbook/tags/display_tag.rb
@@ -411,10 +427,10 @@ files:
 - lib/lookbook/tags/logical_path_tag.rb
 - lib/lookbook/tags/param_tag.rb
 - lib/lookbook/tags/position_tag.rb
+- lib/lookbook/tags/source_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
@@ -441,10 +457,11 @@ files:
 - public/lookbook-assets/js/embed.js.map
 - public/lookbook-assets/js/lookbook.js
 - public/lookbook-assets/js/lookbook.js.map
-homepage: https://github.com/allmarkedup/lookbook
+homepage: https://github.com/ViewComponent/lookbook
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/lookbook/collection.rb

@@ -1,161 +0,0 @@
-module Lookbook
-  class Collection < Entity
-    include Enumerable
-
-    delegate :size, :each, to: :items
-
-    def initialize(path = "", items = [])
-      @items = []
-      if path.is_a?(Array)
-        items = path
-        path = ""
-      end
-
-      @path = path.delete_prefix("/").delete_suffix("/")
-      super(@path)
-
-      items.each { |item| add(item) }
-    end
-
-    def id
-      lookup_path.present? ? super : "root"
-    end
-
-    def name
-      @name ||= remove_position_prefix(basename)
-    end
-
-    def label
-      name&.titleize
-    end
-
-    def position
-      @position ||= parse_position_prefix(basename).first
-    end
-
-    def items
-      @items.sort_by { |item| [item.hierarchy_depth, item&.position, item.label] }
-    end
-
-    def clear
-      @items = []
-    end
-
-    def visible_items
-      reject { |i| i.hidden? }
-    end
-
-    def non_empty_items
-      items.select do |item|
-        !item.is_a?(Lookbook::Collection) || item.items.any?
-      end
-    end
-
-    def add(item)
-      @ordered_entities = nil
-      @tree = nil
-      if item.is_a?(String)
-        item = Collection.new([@path, item].join("/"))
-      end
-      @items << item
-      item
-    end
-
-    def get(name)
-      name = name.underscore
-      items.find { |item| item.name.underscore == name }
-    end
-
-    def get_or_create(name)
-      get(remove_position_prefix(name)).presence || add(name)
-    end
-
-    def find(lookup = nil, &block)
-      if lookup
-        lookup.is_a?(Symbol) ? find_by_id(lookup) : find_by_path(lookup)
-      elsif block
-        items.find(&block)
-      end
-    end
-
-    def find_by_id(id)
-      id = id.to_s.tr("_", "-")
-      items.find { |i| i.id.to_s == id }
-    end
-
-    def find_by_path(path)
-      items.find { |i| i.lookup_path == path }
-    end
-
-    def find_parent(child)
-      parent_path = child.lookup_path.split("/").pop.join("/")
-      find_by_path(parent_path)
-    end
-
-    def ordered_entities
-      return @ordered_entities if @ordered_entities.present?
-      entities = []
-      as_tree.items.each do |item|
-        entities.append(item.is_a?(Collection) ? item.ordered_entities : item)
-      end
-      @ordered_entities ||= entities.flatten
-    end
-
-    def find_first
-      ordered_entities.first
-    end
-
-    def find_next(item)
-      index = ordered_entities.find_index { |i| i.lookup_path == item.lookup_path }
-      ordered_entities[index + 1] unless index.nil?
-    end
-
-    def find_previous(item)
-      index = ordered_entities.find_index { |i| i.lookup_path == item.lookup_path }
-      ordered_entities[index - 1] if !index.nil? && index > 0
-    end
-
-    def as_tree(filter_hidden: true)
-      return self if hierarchy_depth > 0
-      return @tree if @tree.present?
-      @tree = self.class.new
-      candidates = filter_hidden ? visible_items : items
-      candidates.each do |item|
-        current = @tree
-        if item.hierarchy_depth == 1
-          current.add(item)
-        else
-          item.parent_collections_names.each.with_index(1) do |name, i|
-            target = current.get_or_create(name)
-            if item.hierarchy_depth == i + 1
-              target.add(item)
-            else
-              current = target
-            end
-          end
-        end
-      end
-      @tree
-    end
-
-    def collapsible?
-      false
-    end
-
-    def type
-      :collection
-    end
-
-    protected
-
-    def basename
-      @path.present? ? @path.split("/").last : ""
-    end
-
-    class << self
-      def describe_as
-        "items"
-      end
-    end
-  end
-end

data/lib/lookbook/component.rb

@@ -1,34 +0,0 @@
-module Lookbook
-  class Component < Entity
-    attr_accessor :name
-
-    def initialize(name)
-      @name = name
-      super(path)
-    end
-
-    def path
-      name.underscore
-    end
-
-    def rel_path
-      Pathname.new("#{path}.rb")
-    end
-
-    def full_path
-      Pathname.new("#{Lookbook.config.components_path}/#{path}.rb")
-    end
-
-    def dir_path
-      full_path.dirname
-    end
-
-    def template_path
-      Dir.glob("#{Lookbook.config.components_path}/#{path}.*.erb").first
-    end
-
-    def inline?
-      template_path.present?
-    end
-  end
-end

data/lib/lookbook/entity.rb

@@ -1,47 +0,0 @@
-module Lookbook
-  class Entity
-    include Utils
-
-    def initialize(reference_path)
-      @refpath = reference_path
-    end
-
-    def id
-      generate_id(lookup_path)
-    end
-
-    def label
-      lookup_path.split("/").last.titleize
-    end
-
-    def type
-      :item
-    end
-
-    def path
-      @refpath
-    end
-
-    def lookup_path
-      @lookup_path ||= to_lookup_path(@refpath)
-    end
-
-    def hierarchy_depth
-      @refpath.present? ? @refpath.split("/").size : 0
-    end
-
-    def position
-      0
-    end
-
-    def hidden?
-      false
-    end
-
-    def matchers
-      nil
-    end
-
-    alias_method :url_path, :lookup_path
-  end
-end

data/lib/lookbook/page.rb

@@ -1,194 +0,0 @@
-module Lookbook
-  class Page < Entity
-    FRONTMATTER_FIELDS = [
-      :id,
-      :label,
-      :title,
-      :hidden,
-      :landing,
-      :position,
-      :markdown,
-      :header,
-      :footer,
-      :data
-    ]
-
-    attr_reader :errors, :rel_path, :content, :frontmatter
-    attr_accessor :sections
-
-    def initialize(path, base_path)
-      @pathname = Pathname.new path
-      @base_path = Pathname.new base_path
-      @options = nil
-      @errors = []
-      @sections = []
-      @frontmatter = {}
-      @content = ""
-      @page_name = remove_position_prefix(path_name)
-      @rel_path = @pathname.relative_path_from(@base_path)
-      page_path = (@rel_path.dirname.to_s == ".") ? @page_name : "#{@rel_path.dirname}/#{@page_name}"
-      extract_frontmatter(file_contents)
-      super(page_path)
-    end
-
-    def url_path
-      lookbook_page_path lookup_path
-    end
-
-    def full_path
-      Pathname.new Rails.root.join(@pathname.to_s)
-    end
-
-    def name
-      @page_name
-    end
-
-    def hidden?
-      options[:hidden] == true
-    end
-
-    def markdown?
-      options[:markdown] == true
-    end
-
-    def header?
-      options[:header] == true
-    end
-
-    def footer?
-      options[:footer] == true
-    end
-
-    def get(key)
-      options[key]
-    end
-
-    def matchers
-      normalize_matchers(label)
-    end
-
-    def parent_collections_names
-      File.dirname(path).split("/")
-    end
-
-    def type
-      :page
-    end
-
-    def id
-      options[:id]
-    end
-
-    def position
-      options[:position]
-    end
-
-    def hidden
-      options[:hidden]
-    end
-
-    def label
-      options[:label]
-    end
-
-    def method_missing(method_name, *args, &block)
-      if args.none? && !block
-        options[method_name]
-      else
-        super
-      end
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      FRONTMATTER_FIELDS.include? method_name
-    end
-
-    protected
-
-    def file_contents
-      File.read(full_path)
-    end
-
-    def options
-      return @options if @options
-      @options = Lookbook.config.page_options.deep_merge(frontmatter).with_indifferent_access
-      @options[:id] = generate_id(@options[:id] || lookup_path)
-      @options[:label] ||= name.titleize
-      @options[:title] ||= @options[:label]
-      @options[:hidden] ||= false
-      @options[:landing] ||= false
-      @options[:position] = @options[:position] ? @options[:position].to_i : get_position_prefix(path_name)
-      @options[:markdown] ||= markdown_file?
-      @options[:header] = true unless @options.key? :header
-      @options[:footer] = true unless @options.key? :footer
-      @options
-    end
-
-    def extract_frontmatter(content)
-      @frontmatter, @content = FrontmatterExtractor.call(content)
-    rescue => exception
-      line_number_match = exception.message.match(/.*line\s(\d+)/)
-      @errors.push(Lookbook::Error.new(exception, **{
-        title: "YAML frontmatter parsing error",
-        file_path: @pathname.to_s,
-        line_number: line_number_match ? line_number_match[1] : false
-      }))
-    end
-
-    def path_name
-      @pathname.basename(@pathname.extname).to_s.gsub(/\.(html|md)$/, "")
-    end
-
-    def markdown_file?
-      @pathname.basename(@pathname.extname).to_s.end_with?(".md")
-    end
-
-    class << self
-      def find(path)
-        all.find { |p| p.lookup_path == path }
-      end
-
-      def exists?(path)
-        !!find(path)
-      end
-
-      def any?
-        all.any?
-      end
-
-      def all
-        pages, sections =
-          Array(page_paths).flat_map do |dir|
-            Dir["#{dir}/**/*.html.*", "#{dir}/**/*.md.*"].sort.map do |path|
-              create(path, dir)
-            end
-          end.partition { |page| page.type == :page }
-
-        sorted_pages = pages
-          .uniq { |page| page.path }
-          .sort_by { |page| [page.position, page.label] }
-
-        page_dict = sorted_pages.index_by(&:path)
-        sorted_sections = sections.sort_by { |section| [section.position, section.label] }
-
-        sorted_sections.each do |section|
-          page_dict[section.path].sections << section
-        end
-
-        PageCollection.new(sorted_pages)
-      end
-
-      def page_paths
-        PathUtils.normalize_all(Lookbook.config.page_paths)
-      end
-
-      def section_path?(path)
-        !!path.match(%r{\[(.*?\w+)\]})
-      end
-
-      def create(path, base_path)
-        (section_path?(path) ? PageSection : Page).new(path, base_path)
-      end
-    end
-  end
-end

data/lib/lookbook/page_collection.rb

@@ -1,19 +0,0 @@
-module Lookbook
-  class PageCollection < Collection
-    def id
-      generate_id("page-collection", lookup_path || "root")
-    end
-
-    def label
-      "Pages"
-    end
-
-    def type
-      :page_collection
-    end
-
-    def self.describe_as
-      "pages"
-    end
-  end
-end

data/lib/lookbook/page_section.rb

@@ -1,29 +0,0 @@
-module Lookbook
-  class PageSection < Page
-    def name
-      return @name if @name.present?
-      matches = full_path.to_s.match(%r{\[(?<name>\w+)\]})
-      @name ||= matches[:name]
-    end
-
-    def id
-      "#{super}-#{name}"
-    end
-
-    def url_path
-      nil
-    end
-
-    def path
-      super.gsub("[#{name}]", "")
-    end
-
-    def type
-      :page_section
-    end
-
-    def lookup_path
-      "#{super}/#{name}"
-    end
-  end
-end