Class: Kettle::Dev::LockfileReset

Inherits:
Object
  • Object
show all
Defined in:
lib/kettle/dev/lockfile_reset.rb

Constant Summary collapse

DEFAULT_DISABLED_ENV = 
{
  "KETTLE_DEV_DEV" => "false",
  "K_JEM_TEMPLATING" => "false",
  "STRUCTUREDMERGE_DEV" => "false",
  "TREE_SITTER_LANGUAGE_PACK_DEV" => "false",
  "RUBOCOP_LTS_LOCAL" => "false",
  "GALTZO_FLOSS_DEV" => "false",
  "UR_BRAIN_DEV" => "false"
}.freeze
RELEASE_LOCKFILES_TARGET = 
"release-lockfiles"
SUPPORTED_TARGETS = 
["Gemfile.lock", "Appraisal.root.gemfile.lock", RELEASE_LOCKFILES_TARGET].freeze
UNBUNDLED_ENV_KEYS = 
(BundlerEnvGuard::RESET_ENV_KEYS + %w[
  RUBYLIB
  RUBYOPT
]).freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(root:, command_runner:) ⇒ LockfileReset

Returns a new instance of LockfileReset.



109
110
111
112
113
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 109

def initialize(root:, command_runner:)
  @root = root
  @command_runner = command_runner
  @release_platforms = {}
end

Class Method Details

.checksum_entries_from_source(lockfile_source) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 49

def checksum_entries_from_source(lockfile_source)
  in_checksums = false
  entries = {}
  lockfile_source.each_line do |line|
    stripped = line.chomp
    if stripped == "CHECKSUMS"
      in_checksums = true
      next
    end
    next unless in_checksums
    break if !stripped.empty? && stripped == stripped.upcase && !stripped.start_with?(" ")
    next unless stripped.start_with?("  ")

    parsed = parse_lockfile_spec_line(stripped)
    entries[[parsed.fetch(:name), parsed.fetch(:version)]] = parsed.fetch(:suffix) if parsed
  end
  in_checksums ? entries : nil
end

.gem_specs_from_source(lockfile_source) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 68

def gem_specs_from_source(lockfile_source)
  in_gem = false
  in_specs = false
  specs = []
  lockfile_source.each_line do |line|
    stripped = line.chomp
    if stripped == "GEM"
      in_gem = true
      in_specs = false
      next
    end
    next unless in_gem
    break if !stripped.empty? && stripped == stripped.upcase && !stripped.start_with?(" ")

    if stripped == "  specs:"
      in_specs = true
      next
    end
    next unless in_specs
    next unless line.start_with?("    ") && !line.start_with?("      ")

    parsed = parse_lockfile_spec_line(stripped)
    specs << [parsed.fetch(:name), parsed.fetch(:version)] if parsed
  end
  specs.uniq
end

.local_path_remote_lines_from_source(lockfile_source) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 32

def local_path_remote_lines_from_source(lockfile_source)
  in_path = false
  lockfile_source.each_line.with_index(1).filter_map do |line, index|
    stripped = line.strip
    if stripped.match?(/\A[A-Z][A-Z ]*\z/)
      in_path = stripped == "PATH"
      next
    end
    next unless in_path
    next unless stripped.start_with?("remote:")
    next if stripped == "remote: ."
    next unless stripped.start_with?("remote: /", "remote: ./", "remote: ../")

    index
  end
end

Instance Method Details

#diagnostics(path) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 252

def diagnostics(path)
  diagnostics = []
  local_path_remote_lines(path).each do |line_number|
    diagnostics << "#{display_path(path)} has local path remote at line #{line_number}"
  end
  empty_registry_checksums(path).each do |name, version, line_number|
    diagnostics << "#{display_path(path)} CHECKSUMS has no sha256 for #{name} #{version} at line #{line_number}"
  end
  unreleased_workspace_registry_specs(path).each do |name, version, line_number|
    diagnostics << "#{display_path(path)} locks local workspace gem #{name} #{version} as a registry gem, but that version is not resolvable from the configured gem source at line #{line_number}"
  end
  diagnostics
end

#display_path(path) ⇒ Object 



414
415
416
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 414

def display_path(path)
  Kettle::Dev.display_path(path)
end

#dynamic_local_path_env ⇒ Object 



314
315
316
317
318
319
320
321
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 314

def dynamic_local_path_env
  ENV.each_with_object({}) do |(key, value), env|
    next unless key.end_with?("_DEV", "_LOCAL")
    next unless local_path_env_value?(value)

    env[key] = "false"
  end
end

#empty_registry_checksums(path) ⇒ Object 



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 339

def empty_registry_checksums(path)
  non_registry_gems = non_registry_source_gems(path) | path_dependency_gems(path)
  in_checksums = false
  entries = File.readlines(path).filter_map.with_index(1) do |line, index|
    stripped = line.strip
    if stripped == "CHECKSUMS"
      in_checksums = true
      next
    end
    next unless in_checksums
    next if stripped.empty?
    next if stripped == "BUNDLED WITH"

    match = stripped.match(/\A([A-Za-z0-9_.-]+) \(([^)]+)\)(?:\s+(sha256=.*))?\z/)
    next unless match

    name = match[1]
    checksum = match[3].to_s
    next unless checksum.empty?
    next if non_registry_gems.include?(name)

    [name, match[2], index]
  end
  return [] unless has_any_sha_checksum?(path)

  entries
end

#gemfile_for_lockfile(path) ⇒ Object 



303
304
305
306
307
308
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 303

def gemfile_for_lockfile(path)
  basename = File.basename(path)
  return File.join(root, "Gemfile") if basename == "Gemfile.lock"

  path.delete_suffix(".lock")
end

#has_any_sha_checksum?(path) ⇒ Boolean

Returns:

  • (Boolean) 


380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 380

def has_any_sha_checksum?(path)
  in_checksums = false
  File.readlines(path).any? do |line|
    stripped = line.strip
    if stripped == "CHECKSUMS"
      in_checksums = true
      next false
    end
    next false unless in_checksums

    stripped.include?("sha256=")
  end
end

#has_local_path_remote?(path) ⇒ Boolean

Returns:

  • (Boolean) 


331
332
333
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 331

def has_local_path_remote?(path)
  !local_path_remote_lines(path).empty?
end

#local_path_env_value?(value) ⇒ Boolean

Returns:

  • (Boolean) 


323
324
325
326
327
328
329
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 323

def local_path_env_value?(value)
  text = value.to_s.strip
  return false if text.empty? || text.casecmp("false").zero?
  return true if text.start_with?("/", "./", "../", "~")

  text.include?(File::SEPARATOR)
end

#local_path_remote_lines(path) ⇒ Object 



335
336
337
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 335

def local_path_remote_lines(path)
  self.class.local_path_remote_lines_from_source(File.read(path))
end

#lockfile_path_for(target) ⇒ Object

Raises:



274
275
276
277
278
279
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 274

def lockfile_path_for(target)
  paths = lockfile_paths_for(target)
  raise Error, "reset target #{target.inspect} resolves to multiple lockfiles; use lockfile_paths_for" if paths.length != 1

  paths.first
end

#lockfile_paths ⇒ Object 



266
267
268
269
270
271
272
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 266

def lockfile_paths
  candidates = [
    File.join(root, "Gemfile.lock"),
    File.join(root, "Appraisal.root.gemfile.lock")
  ]
  candidates.select { |path| File.file?(path) }.sort
end

#lockfile_paths_for(target) ⇒ Object

Raises:



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 281

def lockfile_paths_for(target)
  normalized = target.to_s.strip
  raise Error, "reset requires TARGET" if normalized.empty?
  if release_lockfiles_target?(normalized)
    paths = lockfile_paths
    raise Error, "no release lockfiles found" if paths.empty?

    return paths
  end
  supported = SUPPORTED_TARGETS.reject { |candidate| candidate == RELEASE_LOCKFILES_TARGET }
  match = supported.find { |candidate| candidate.casecmp(normalized).zero? }
  unless match
    raise Error, "reset target #{normalized.inspect} is not supported; supported targets: #{SUPPORTED_TARGETS.join(", ")}"
  end

  [File.join(root, match)]
end

#lockfile_platforms(path) ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 224

def lockfile_platforms(path)
  in_platforms = false
  File.readlines(path).filter_map do |line|
    stripped = line.strip
    if stripped.match?(/\A[A-Z][A-Z ]*\z/)
      in_platforms = stripped == "PLATFORMS"
      next
    end
    next unless in_platforms
    next if stripped.empty?

    stripped
  end
end

#non_registry_source_gems(path) ⇒ Object 



401
402
403
404
405
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 401

def non_registry_source_gems(path)
  lockfile_parser(path).specs.each_with_object(Set.new) do |spec, gems|
    gems << spec.name unless registry_source?(spec.source)
  end
end

#normalization_env ⇒ Object 



310
311
312
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 310

def normalization_env
  DEFAULT_DISABLED_ENV.merge(dynamic_local_path_env)
end

#normalization_needed?(path) ⇒ Boolean

Returns:

  • (Boolean) 


248
249
250
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 248

def normalization_needed?(path)
  has_local_path_remote?(path) || !empty_registry_checksums(path).empty? || !unreleased_workspace_registry_specs(path).empty?
end

#path_dependency_gems(path) ⇒ Object 



407
408
409
410
411
412
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 407

def path_dependency_gems(path)
  lockfile_parser(path).dependencies.each_value.each_with_object(Set.new) do |dependency, gems|
    source = dependency.source
    gems << dependency.name if path_source?(source) && !self_path_source?(source)
  end
end

#path_source_gems(path) ⇒ Object 



394
395
396
397
398
399
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 394

def path_source_gems(path)
  lockfile_parser(path).specs.each_with_object(Set.new) do |spec, gems|
    source = spec.source
    gems << spec.name if path_source?(source) && !self_path_source?(source)
  end
end

#release_lockfiles_target?(target) ⇒ Boolean

Returns:

  • (Boolean) 


299
300
301
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 299

def release_lockfiles_target?(target)
  target.to_s.strip.casecmp(RELEASE_LOCKFILES_TARGET).zero?
end

#release_platforms_for(paths) ⇒ Object 



218
219
220
221
222
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 218

def release_platforms_for(paths)
  paths.each_with_object({}) do |path, platforms|
    platforms[path] = (@release_platforms[path] ||= reset_platforms(path))
  end
end

#reset(target, skip_changelog_dependency: false) ⇒ Object

Raises:



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 115

def reset(target, skip_changelog_dependency: false)
  BundlerEnvGuard.warn_unexpected_env!
  paths = lockfile_paths_for(target)
  force_full_update = release_lockfiles_target?(target)
  platforms = release_platforms_for(paths) if force_full_update
  uninstall_unreleased_local_gems(paths) if force_full_update
  paths.each do |path|
    if force_full_update || normalization_needed?(path)
      reset_lockfile!(
        path,
        full_update: force_full_update,
        platforms: platforms&.fetch(path),
        skip_changelog_dependency: skip_changelog_dependency,
        update_bundler: force_full_update
      )
    end
  end
  if force_full_update && uninstall_unreleased_local_gems(paths)
    paths.each do |path|
      reset_lockfile!(
        path,
        full_update: true,
        platforms: platforms.fetch(path),
        skip_changelog_dependency: skip_changelog_dependency,
        update_bundler: true
      )
    end
  end
  diagnostics = paths.flat_map { |path| diagnostics(path) }
  raise Error, validation_message(target, diagnostics) unless diagnostics.empty?

  paths
end

#reset_command(path:, gemfile:, full_update: false, platforms: nil, skip_changelog_dependency: false, update_bundler: false, isolated_gem_home: nil) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 174

def reset_command(path:, gemfile:, full_update: false, platforms: nil, skip_changelog_dependency: false, update_bundler: false, isolated_gem_home: nil)
  update_gems = (full_update || has_local_path_remote?(path)) ? [] : reset_update_gems(path)
  platforms ||= reset_platforms(path)
  removed_platforms = full_update ? [] : lockfile_platforms(path) - platforms
  env = normalization_env.merge(
    "BUNDLE_GEMFILE" => gemfile,
    "BUNDLE_LOCKFILE" => path
  )
  env["KETTLE_DEV_SKIP_CHANGELOG_DEPENDENCY"] = "true" if skip_changelog_dependency
  if isolated_gem_home
    env["GEM_HOME"] = isolated_gem_home
    env["GEM_PATH"] = isolated_gem_home
  end
  command = +"env"
  UNBUNDLED_ENV_KEYS.each do |key|
    command << " -u #{key}"
  end
  env.each do |key, value|
    command << " #{key}=#{Shellwords.escape(value)}"
  end
  command << " bundle lock"
  removed_platforms.sort.each do |platform|
    command << " --remove-platform=#{Shellwords.escape(platform)}"
  end
  platforms.each do |platform|
    command << " --add-platform=#{Shellwords.escape(platform)}"
  end
  command << " --update"
  command << " #{update_gems.map { |gem_name| Shellwords.escape(gem_name) }.join(" ")}" unless update_gems.empty?
  # Bundler preserves BUNDLED WITH during a normal lockfile update.
  # Release lockfiles must record the Bundler that performed the final
  # reset, or the next release command can dirty them after the prep
  # commit by reconciling to a newer installed Bundler.
  command << " --bundler" if update_bundler
  command << " --add-checksums"
  command
end

#reset_lockfile!(path, full_update: false, platforms: nil, skip_changelog_dependency: false, update_bundler: false) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 149

def reset_lockfile!(path, full_update: false, platforms: nil, skip_changelog_dependency: false, update_bundler: false)
  gemfile = gemfile_for_lockfile(path)
  unless gemfile && File.file?(gemfile)
    warn("Cannot reset #{display_path(path)} because its Gemfile was not found.")
    return
  end

  with_isolated_gem_paths do |gem_home|
    command = reset_command(
      path: path,
      gemfile: gemfile,
      full_update: full_update,
      platforms: platforms,
      skip_changelog_dependency: skip_changelog_dependency,
      update_bundler: update_bundler,
      isolated_gem_home: gem_home
    )
    if full_update || has_local_path_remote?(path)
      rebuild_lockfile(path) { command_runner.call(command) }
    else
      command_runner.call(command)
    end
  end
end

#reset_platforms(path) ⇒ Object 



212
213
214
215
216
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 212

def reset_platforms(path)
  platforms = lockfile_platforms(path)
  platforms = [Gem::Platform.local.to_s] if platforms.empty?
  platforms.reject(&:empty?).sort
end

#reset_update_gems(path) ⇒ Object 



239
240
241
242
243
244
245
246
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 239

def reset_update_gems(path)
  (
    path_source_gems(path).to_a |
    path_dependency_gems(path).to_a |
    empty_registry_checksums(path).map(&:first) |
    unreleased_workspace_registry_specs(path).map(&:first)
  ).uniq.sort
end

#unreleased_workspace_registry_specs(path) ⇒ Object 



367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/kettle/dev/lockfile_reset.rb', line 367

def unreleased_workspace_registry_specs(path)
  local_names = local_workspace_gem_names
  return [] if local_names.empty?

  source_urls = registry_source_urls(path)
  registry_specs_with_lines(path).filter_map do |name, version, line_number|
    next unless local_names.include?(name)
    next if gem_source_version_available?(name, version, source_urls)

    [name, version, line_number]
  end
end