Module: Kettle::Jem::MaintenanceChangelog

Defined in:
lib/kettle/jem/maintenance_changelog.rb

Constant Summary collapse

TEMPLATE_CHANGELOG_INTERNAL_PATHS = 
%w[
  CHANGELOG.md
  .structuredmerge/kettle-jem.lock
  .kettle-jem.lock
].freeze
TEMPLATE_CHANGE_CATEGORIES = 
{
  workflows: ->(path) { path.start_with?(".github/workflows/") },
  dependencies: ->(path) {
    path == "Gemfile" || path == "Appraisals" || path.end_with?(".gemspec", ".gemfile", ".gemfile.lock") ||
      path.start_with?("gemfiles/")
  },
  documentation: ->(path) { %w[README.md CONTRIBUTING.md SECURITY.md].include?(path) || path.start_with?("docs/") },
  configuration: ->(path) { path.start_with?(".structuredmerge/") || path == "mise.toml" || path == ".gitignore" },
  code_and_tests: ->(path) { path.start_with?("lib/", "spec/", "test/", "bin/") || path == "Rakefile" }
}.freeze
TEMPLATE_CHANGELOG_KEYS = 
{
  "Apply kettle-jem templates" => "kettle-jem/template",
  "Prepare project for kettle-jem templates" => "kettle-jem/prepare"
}.freeze
BUNDLER_ENVIRONMENT = 
%w[
  BUNDLE_BIN_PATH
  BUNDLE_FROZEN
  BUNDLE_GEMFILE
  BUNDLE_LOCKFILE
  BUNDLER_SETUP
  BUNDLER_VERSION
  RUBYLIB
  RUBYOPT
].freeze

Class Method Summary collapse

Class Method Details

.add_unreleased_entry(project_root:, section:, entry:) ⇒ Object 



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
 
# File 'lib/kettle/jem/maintenance_changelog.rb', line 43

def add_unreleased_entry(project_root:, section:, entry:)
  command = [
    RbConfig.ruby,
    "-rrubygems",
    "-e",
    'exec Gem.ruby, Gem.bin_path("kettle-changelog", "kettle-changelog"), *ARGV',
    "--",
    "--add-unreleased-entry",
    "--json",
    "--section",
    section.to_s,
    "--entry",
    entry.to_s
  ]
  environment = BUNDLER_ENVIRONMENT.to_h { |key| [key, nil] }
  stdout, stderr, status = Open3.capture3(environment, *command, chdir: project_root)
  unless status.success?
    detail = [stdout, stderr].reject(&:empty?).join("\n")
    raise "kettle-changelog failed (exit #{status.exitstatus}): #{detail}"
  end

  result = JSON.parse(stdout)
  {
    status: result.fetch("changed") ? "updated" : "unchanged",
    section: result.fetch("section"),
    entry: result.fetch("entry")
  }
rescue JSON::ParserError => error
  raise "kettle-changelog returned invalid JSON: #{error.message}"
rescue Gem::Exception => error
  raise "kettle-changelog executable is not installed: #{error.message}"
end

.bootstrap_only_report?(report) ⇒ Boolean

Returns:

  • (Boolean) 


157
158
159
 
# File 'lib/kettle/jem/maintenance_changelog.rb', line 157

def bootstrap_only_report?(report)
  report.fetch(:setup_status, "").to_s.start_with?("bootstrap_")
end

.record_template_run(project_root:, report:, run_options: {}, label: "Apply kettle-jem templates") ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/kettle/jem/maintenance_changelog.rb', line 87

def record_template_run(project_root:, report:, run_options: {}, label: "Apply kettle-jem templates")
  report = report.to_h
  if template_changelog_disabled?(run_options) || bootstrap_only_report?(report)
    return report.merge(changelog: {status: "skipped", reason: template_changelog_disabled?(run_options) ? "disabled" : "bootstrap_only"})
  end

  changed_files = template_changed_files(report.fetch(:changed_files, []))
  if changed_files.empty?
    return report.merge(changelog: {status: "skipped", reason: "no_template_changes", changed_files: []})
  end

  unless File.file?(File.join(project_root, "CHANGELOG.md"))
    return report.merge(changelog: {status: "skipped", reason: "missing_changelog"})
  end

  key = TEMPLATE_CHANGELOG_KEYS.fetch(label, "kettle-jem/template")
  entry = ->(matches) { template_run_entry(changed_files, matches) }
  result = upsert_unreleased_entry(project_root: project_root, section: "Changed", key: key, entry: entry)
  changelog = result.merge(changed_files: changed_files, entry: result.fetch(:entry))
  changed_files_with_changelog = if result.fetch(:status) == "updated"
    (Array(report.fetch(:changed_files, [])) + ["CHANGELOG.md"]).uniq.sort
  else
    Array(report.fetch(:changed_files, [])).uniq.sort
  end
  report.merge(changelog: changelog, changed_files: changed_files_with_changelog)
end

.template_change_category(path) ⇒ Object 



145
146
147
148
149
150
 
# File 'lib/kettle/jem/maintenance_changelog.rb', line 145

def template_change_category(path)
  TEMPLATE_CHANGE_CATEGORIES.each do |category, matcher|
    return category if matcher.call(path)
  end
  :other
end

.template_changed_files(changed_files) ⇒ Object 



114
115
116
117
118
 
# File 'lib/kettle/jem/maintenance_changelog.rb', line 114

def template_changed_files(changed_files)
  Array(changed_files).map(&:to_s).uniq.sort.reject do |path|
    TEMPLATE_CHANGELOG_INTERNAL_PATHS.include?(path)
  end
end

.template_changelog_disabled?(run_options) ⇒ Boolean

Returns:

  • (Boolean) 


152
153
154
155
 
# File 'lib/kettle/jem/maintenance_changelog.rb', line 152

def template_changelog_disabled?(run_options)
  options = run_options.to_h
  DecisionPolicy.value_to_boolean(options[:skip_changelog] || options["skip_changelog"])
end

.template_entry_counts(matches) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/kettle/jem/maintenance_changelog.rb', line 132

def template_entry_counts(matches)
  source = Array(matches).first.to_h.fetch(:source, "")
  source.lines.filter_map do |line|
    match = line.match(/\A\s{2,}- (.+?) \((\d+)\)\s*\z/)
    next unless match

    category = match[1].tr(" ", "_").to_sym
    next unless TEMPLATE_CHANGE_CATEGORIES.key?(category) || category == :other

    [category, match[2].to_i]
  end.to_h
end

.template_run_entry(changed_files, matches) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/kettle/jem/maintenance_changelog.rb', line 120

def template_run_entry(changed_files, matches)
  counts = template_entry_counts(matches)
  changed_files.group_by { |path| template_change_category(path) }.each do |category, paths|
    counts[category] = counts.fetch(category, 0) + paths.length
  end
  total = counts.values.sum
  details = counts.sort_by { |category, _count| category.to_s }.map do |category, count|
    "  - #{category.to_s.tr("_", " ")} (#{count})"
  end
  ["updated #{total} project file#{"s" unless total == 1}:", *details].join("\n")
end

.upsert_unreleased_entry(project_root:, section:, key:, entry:, legacy_prefixes: []) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/kettle/jem/maintenance_changelog.rb', line 76

def upsert_unreleased_entry(project_root:, section:, key:, entry:, legacy_prefixes: [])
  result = Kettle::Changelog::KeyedEntryUpserter.new(
    root: project_root,
    section: section,
    key: key,
    entry: entry,
    legacy_prefixes: legacy_prefixes
  ).run
  result.merge(status: result.fetch(:changed) ? "updated" : "unchanged")
end