Module: YARD::Markdown::SectionAssemblyHelper

Defined in:
lib/yard/markdown/section_assembly_helper.rb

Overview

Assembles grouped content into ordered Markdown sections.

Instance Method Summary collapse

Instance Method Details

#append_lines(lines, content, separated: true) ⇒ void

This method returns an undefined value.

Appends non-empty content to a mutable list of lines.

Parameters:

  • lines (Array<String>) —

    Destination line buffer.

  • content (String) —

    Rendered Markdown block to split into lines.

  • separated (Boolean) (defaults to: true) —

    Whether to insert a blank separator line first.



38
39
40
41
42
43
 
# File 'lib/yard/markdown/section_assembly_helper.rb', line 38

def append_lines(lines, content, separated: true)
  return if content.lstrip.empty?

  lines << '' if separated && !lines.empty? && !lines.last.empty?
  lines.concat(content.split("\n"))
end

#grouped_items(items, group_order) ⇒ Array<Array>

Groups items by their YARD group and orders them for rendering.

Parameters:

  • items (Array<#group>) —

    Renderable objects that expose a YARD group name.

  • group_order (Array<String>, nil) —

    Preferred ordering for named groups.

Returns:

  • (Array<Array>) —

    Ordered pairs of group names and grouped items.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/yard/markdown/section_assembly_helper.rb', line 12

def grouped_items(items, group_order)
  grouped = Hash.new { |hash, key| hash[key] = [] }
  items.each { |item| grouped[item.group] << item }

  ordered = []

  Array(group_order).each do |name|
    next unless grouped.key?(name)

    ordered << [name, grouped.delete(name)]
  end

  grouped.keys.compact.sort.each do |name|
    ordered << [name, grouped.delete(name)]
  end

  ordered << [nil, grouped.delete(nil)] if grouped.key?(nil)
  ordered
end