outline_tag.rb

# @author Copyright 2022 {https://www.mslinn.com Michael Slinn}

require 'jekyll_draft'
require 'jekyll_plugin_logger'
require 'jekyll_plugin_support'
require 'yaml'
require_relative 'jekyll_outline/version'

module OutlineTag
  PLUGIN_NAME = 'outline'.freeze

  # Interleaves with docs
  class Header
    attr_accessor :order, :title

    def initialize(yaml)
      @order = yaml[0]
      @published = true
      @title = yaml[1]
    end

    def to_s
      "  <h3 class='post_title clear' id=\"title_#{@order}\">#{@title}</h3>"
    end
  end

  class OutlineTag < JekyllSupport::JekyllBlock
    include JekyllOutlineVersion

    FIXNUM_MAX = (2**((0.size * 8) - 2)) - 1

    def render_impl(text)
      headers = make_headers(super) # Process the block content.

      @helper.gem_file __FILE__
      @collection_name = @helper.remaining_markup
      abort 'OutlineTag: collection_name was not specified' unless @collection_name

      collection = headers + obtain_docs(@collection_name)
      <<~HEREDOC
        <div class="outer_posts">
        #{make_entries(collection)&.join("\n")}
        </div>
        #{@helper.attribute if @helper.attribution}
      HEREDOC
    end

    private

    def header?(variable)
      variable.instance_of?(Header)
    end

    def make_headers(content)
      yaml = YAML.safe_load(remove_leading_zeros(content))
      yaml.map { |entry| Header.new entry }
    end

    # @section_state can have values: :head, :in_body
    # @param collection Array of Jekyll::Document and Outline::Header
    # @return Array of String
    def make_entries(collection) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
      sorted = collection.sort_by(&obtain_order)
      pruned = remove_empty_headers(sorted)
      @section_state = :head
      @section_id = 0
      result = pruned.map do |entry|
        if entry.instance_of? Header
          @header_order = entry.order
          section_end = "  </div>\n" if @section_state == :in_body
          @section_state = :head
          entry = section_end + entry.to_s if section_end
          entry
        else
          if @section_state == :head
            section_start = "<div id='posts_wrapper_#{@header_order}' class='clearfix'>\n    " \
                            "<div id='posts_#{@header_order}' class='posts'>\n"
          end
          @section_state = :in_body
          date = entry.data['last_modified_at'] # "%Y-%m-%d"
          draft = Jekyll::Draft.draft_html(entry)
          result = "    <span>#{date}</span> <span><a href='#{entry.url}'>#{entry.data['title']}</a>#{draft}</span>"
          result = section_start + result if section_start
          result
        end
      end
      result << "    </div>\n  </div>" if @section_state == :in_body
      result
    end

    # Ignores files called index.html
    def obtain_docs(collection_name)
      abort "#{@collection_name} is not a valid collection." unless @site.collections.key? @collection_name
      @site
        .collections[collection_name]
        .docs
        .reject { |doc| doc.path.end_with? 'index.html' }
    end

    # Sort entries without an order property at the end
    def obtain_order
      proc do |entry|
        if entry.respond_to? :data
          entry.data.key?('order') ? entry.data['order'] : FIXNUM_MAX
        else
          entry.order
        end
      end
    end

    def remove_empty_headers(array)
      i = 0
      while i < array.length - 1
        if header?(array[i]) && header?(array[i + 1])
          array.delete_at(i)
        else
          i += 1
        end
      end

      array.delete_at(array.length - 1) if header?(array.last)
      array
    end

    def remove_leading_zeros(multiline)
      multiline
        .strip
        .split("\n")
        .map { |x| x.gsub(/(?<= |\A)0+(?=\d)/, '') }
        .join("\n")
    end

    JekyllPluginHelper.register(self, PLUGIN_NAME)
  end
end