Module: Primer::Yard::DocsHelper

Extended by:
DocsHelper
Included in:
Backend, DocsHelper, InfoArchDocsHelper, LookbookPage, Registry, RegistryEntry
Defined in:
lib/primer/yard/docs_helper.rb

Overview

Helper methods to use for yard documentation

Instance Method Summary collapse

Instance Method Details



35
36
37
 
# File 'lib/primer/yard/docs_helper.rb', line 35

def link_to_accessibility
  "[Accessibility](#accessibility)"
end

#link_to_component(component) ⇒ Object 



47
48
49
50
51
52
 
# File 'lib/primer/yard/docs_helper.rb', line 47

def link_to_component(component)
  status_module, short_name, class_name = status_module_and_short_name(component)
  status_path = status_module.nil? ? "" : "#{status_module}/"

  "[#{class_name}](/components/#{status_path}#{short_name.downcase})"
end

#link_to_heading_practices ⇒ Object 



58
59
60
 
# File 'lib/primer/yard/docs_helper.rb', line 58

def link_to_heading_practices
  "[Learn more about best heading practices (WAI Headings)](https://www.w3.org/WAI/tutorials/page-structure/headings/)"
end

#link_to_octicons ⇒ Object 



54
55
56
 
# File 'lib/primer/yard/docs_helper.rb', line 54

def link_to_octicons
  "[Octicon](https://primer.style/octicons/)"
end

#link_to_system_arguments_docs ⇒ Object 



39
40
41
 
# File 'lib/primer/yard/docs_helper.rb', line 39

def link_to_system_arguments_docs
  "[System arguments](/system-arguments)"
end

#link_to_typography_docs ⇒ Object 



43
44
45
 
# File 'lib/primer/yard/docs_helper.rb', line 43

def link_to_typography_docs
  "[Typography](/system-arguments#typography)"
end

#one_of(enumerable, lower: false, sort: true) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/primer/yard/docs_helper.rb', line 9

def one_of(enumerable, lower: false, sort: true)
  # Sort the array if requested
  if sort
    enumerable = enumerable.sort do |a, b|
      a.instance_of?(b.class) ? a <=> b : a.class.to_s <=> b.class.to_s
    end
  end

  values =
    case enumerable
    when Hash
      enumerable.map do |key, value|
        "#{pretty_value(key)} (#{pretty_value(value)})"
      end
    else
      enumerable.map do |key|
        pretty_value(key)
      end
    end

  prefix = "One of"
  prefix = prefix.downcase if lower

  "#{prefix} #{values.to_sentence(two_words_connector: ' or ', last_word_connector: ', or ')}."
end

#pretty_default_value(tag, component) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/primer/yard/docs_helper.rb', line 69

def pretty_default_value(tag, component)
  params = tag.object.parameters.find { |param| [tag.name.to_s, "#{tag.name}:"].include?(param[0]) }
  default = tag.defaults&.first || params&.second

  return "N/A" unless default

  constant_name = "#{component.name}::#{default}"
  constant_value = default.safe_constantize || constant_name.safe_constantize

  return pretty_value(default) if constant_value.nil?

  pretty_value(constant_value)
end

#pretty_value(val) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
 
# File 'lib/primer/yard/docs_helper.rb', line 83

def pretty_value(val)
  case val
  when nil
    "`nil`"
  when Symbol
    "`:#{val}`"
  else
    "`#{val}`"
  end
end

#status_module_and_short_name(component) ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/primer/yard/docs_helper.rb', line 62

def status_module_and_short_name(component)
  name_with_status = component.name.gsub(/Primer::|Component/, "")

  m = name_with_status.match(/(?<status>Beta|Alpha|Deprecated)?(?<_colons>::)?(?<name>.*)/)
  [m[:status]&.downcase, m[:name].gsub("::", ""), m[:name]]
end