Module: StillActive::MarkdownHelper

Extended by:
MarkdownHelper
Included in:
MarkdownHelper
Defined in:
lib/helpers/markdown_helper.rb

Instance Method Summary collapse

Instance Method Details

#alternatives_section(result) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/helpers/markdown_helper.rb', line 89

def alternatives_section(result)
  flagged = result.select do |_name, data|
    data[:alternatives] && !data[:alternatives].empty?
  end
  return "" if flagged.empty?

  lines = ["", "**Alternatives** (Ruby Toolbox leads, verify fit):"]
  flagged.each { |name, data| lines << "- #{MarkdownEscape.code_span(name)}: #{MarkdownEscape.inline(data[:alternatives].join(", "))}" }
  lines.join("\n")
end

#markdown_table_body_line(gem_name:, data:) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/helpers/markdown_helper.rb', line 35

def markdown_table_body_line(gem_name:, data:)
  repository_url = data[:repository_url]
  ruby_gems_url = data[:ruby_gems_url]

  inactive_repository_emoji = data[:last_activity_warning_emoji]
  using_latest_version_emoji = data[:up_to_date_emoji]

  formatted_name = markdown_url(text: gem_name, url: repository_url)

  formatted_version_used = if [:git, :path].include?(data[:source_type])
    data[:version_used] ? "#{data[:version_used]} (#{data[:source_type]})" : "(#{data[:source_type]})"
  elsif data[:version_yanked]
    "#{data[:version_used]} (YANKED #{StillActive.config.critical_warning_emoji})"
  else
    version_with_date(
      text: data[:version_used],
      url: version_url(ruby_gems_url, data[:version_used]),
      date: data[:version_used_release_date],
    )
  end

  formatted_latest_version = version_with_date(
    text: data[:latest_version],
    url: version_url(ruby_gems_url, data[:latest_version]),
    date: data[:latest_version_release_date],
  )

  formatted_latest_pre_release = version_with_date(
    text: data[:latest_pre_release_version],
    url: version_url(ruby_gems_url, data[:latest_pre_release_version]),
    date: data[:latest_pre_release_version_release_date],
  )

  formatted_last_commit = markdown_url(text: year_month(data[:last_commit_date]), url: repository_url)

  unsure = StillActive.config.unsure_emoji

  cells = [
    inactive_repository_emoji || unsure,
    using_latest_version_emoji || unsure,
    format_scorecard(data[:scorecard_score]),
    format_vulns(data),
    formatted_name,
    formatted_version_used || unsure,
    formatted_latest_version || unsure,
    formatted_latest_pre_release || unsure,
    formatted_last_commit || unsure,
    format_libyear(data[:libyear]),
    format_license(data[:license]),
  ]

  "| #{cells.join(" | ")} |"
end

#markdown_table_header_line ⇒ Object 



30
31
32
33
 
# File 'lib/helpers/markdown_helper.rb', line 30

def markdown_table_header_line
  "| activity | up to date? | OpenSSF | vulns | name | version used | latest version | latest pre-release | last commit | libyear | license |\n" \
    "| -------- | ----------- | ------- | ----- | ---- | ------------ | -------------- | ------------------ | ----------- | ------- | ------- |"
end

#ruby_line(ruby_info) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/helpers/markdown_helper.rb', line 11

def ruby_line(ruby_info)
  version = ruby_info[:version]
  latest = ruby_info[:latest_version]
  libyear = ruby_info[:libyear]
  eol = ruby_info[:eol]
  eol_date = ruby_info[:eol_date]

  return "**Ruby #{version}** (latest) #{StillActive.config.success_emoji}" if version == latest

  libyear_part = libyear ? "#{libyear} libyears behind #{latest}" : "behind #{latest}"

  if eol
    eol_part = eol_date ? "EOL #{eol_date.strftime("%Y-%m-%d")}" : "EOL"
    "**Ruby #{version}** (#{eol_part}, #{libyear_part}) #{StillActive.config.critical_warning_emoji}"
  else
    "**Ruby #{version}** (#{libyear_part}) #{StillActive.config.warning_emoji}"
  end
end

#transitive_section(result) ⇒ Object

Flagged transitive gems can’t be swapped directly; name the direct dependency that pulls each one in so the finding becomes actionable (#60).



102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/helpers/markdown_helper.rb', line 102

def transitive_section(result)
  flagged = result.select do |_name, data|
    data[:direct] == false && Array(data[:dependency_path]).length >= 2 && transitive_flagged?(data)
  end
  return "" if flagged.empty?

  lines = ["", "**Transitive findings** (pulled in by a direct dependency):"]
  flagged.each do |name, data|
    lines << "- #{MarkdownEscape.code_span(name)} via #{MarkdownEscape.code_span(data[:dependency_path].first)}"
  end
  lines.join("\n")
end