Class: Kettle::Jem::Appraisals::CLI

Inherits:
Object
  • Object
show all
Defined in:
lib/kettle/jem/appraisals/cli.rb,
sig/kettle/jem/appraisals.rbs

Overview

CLI entry point for kettle-jem-appraisals.

Auto-detects mode (+scaffold+ vs resolve) based on config state, or accepts explicit --scaffold / --resolve flags.

In scaffold mode, reads the project gemspec, excludes standard-library gems, and writes a skeleton .kettle-jem.yml with tier1 candidates.

In resolve mode, queries RubyGems for version data, assigns gem versions to Ruby-series buckets, generates modular gemfiles, an Appraisals file, and workflow strategy matrix snippets.

Examples:

Run from the command line

Kettle::Jem::Appraisals::CLI.run(["--resolve"])

Instantiate and run

cli = Kettle::Jem::Appraisals::CLI.new(["--scaffold"], project_dir: "/path/to/gem")
cli.run

Constant Summary collapse

CONFIG_FILE =

Returns name of the per-project YAML configuration file.

Returns:

  • (String) —

    name of the per-project YAML configuration file

".kettle-jem.yml"
APPRAISAL_MATRIX_KEY =

Returns top-level key in the YAML config that holds the appraisal matrix.

Returns:

  • (String) —

    top-level key in the YAML config that holds the appraisal matrix

"appraisal_matrix"
DEFAULT_FRESHNESS_TTL =

Returns default freshness TTL in seconds (7 days).

Returns:

  • (Integer) —

    default freshness TTL in seconds (7 days)

604_800

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = [], project_dir: Dir.pwd) ⇒ CLI

Returns a new instance of CLI.

Parameters:

  • args (Array<String>) (defaults to: []) —

    command-line arguments (e.g., ["--scaffold"], ["--resolve"], ["--force"])

  • project_dir (String) (defaults to: Dir.pwd) —

    path to the project root (defaults to the current working directory)

  • project_dir: (String) (defaults to: Dir.pwd) 


44
45
46
47
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 44

def initialize(args = [], project_dir: Dir.pwd)
  @args = args
  @project_dir = project_dir
end

Instance Attribute Details

#args ⇒ Array<String>, String (readonly)

Returns:

  • (Array<String>) —

    command-line arguments

  • (String) —

    absolute path to the project directory



40
41
42
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 40

def args
  @args
end

#project_dir ⇒ Array<String>, String (readonly)

Returns:

  • (Array<String>) —

    command-line arguments

  • (String) —

    absolute path to the project directory



40
41
42
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 40

def project_dir
  @project_dir
end

Class Method Details

.run(args) ⇒ void

This method returns an undefined value.

Convenience entry point: instantiates a CLI and runs it.

Parameters:

  • args (Array<String>) —

    command-line arguments



54
55
56
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 54

def run(args)
  new(args).run
end

Instance Method Details

#build_matrix(tier1_gems, tier2_gems, ruby_series, bucket_ranges, all_seams, all_versions_by_gem, resolver, builder, gemfile_gen, sub_resolver) ⇒ Object

Builds the matrix using optimal bucket assignments. Instead of cross-producting all versions × all buckets, each tier1 version is assigned to its optimal bucket (the newest Ruby where that version is the best choice).

Tier2 versions are all compatible versions for each tier1's bucket.



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 392

def build_matrix(tier1_gems, tier2_gems, ruby_series, bucket_ranges, all_seams, all_versions_by_gem, resolver, builder, gemfile_gen, sub_resolver)
  entries = []

  tier1_gems.each do |t1|
    t1_name = t1["name"]
    t1_versions = t1["versions"] || []
    t1_seams = all_seams[t1_name] || []

    # Assign each tier1 version to its optimal bucket
    t1_assignments = builder.assign_version_buckets(
      t1_name,
      t1_versions,
      seams: t1_seams,
      buckets: ruby_series,
      bucket_ranges: bucket_ranges,
      all_versions: all_versions_by_gem[t1_name]
    )

    if t1_assignments.empty?
      puts "    ⚠️  No bucket assignments for #{t1_name}, falling back to latest bucket"
      t1_assignments = t1_versions.map { |v| {version: v, bucket: ruby_series.last} }
    end

    # Show assignments
    t1_assignments.each do |a|
      label = a[:filler] ? " (filler)" : ""
      puts "    📌 #{t1_name} #{a[:version]} → #{a[:bucket]}#{label}"
    end

    if tier2_gems.empty?
      # Tier1-only entries (no tier2 cross)
      t1_assignments.each do |t1_a|
        t1_ver = t1_a[:version]
        rs = t1_a[:bucket]
        ruby_min = bucket_ranges.dig(rs, :floor)
        sub_deps = sub_resolver.resolve(t1_name, t1_ver, ruby_min: ruby_min)

        t1_gemfile = gemfile_gen.generate(
          gem_name: t1_name,
          version: t1_ver,
          ruby_series: rs,
          sub_deps: sub_deps
        )

        x_std_libs_gemfile = "gemfiles/modular/x_std_libs/#{rs}/libs.gemfile"

        entries << {
          name: GemAbbreviations.appraisal_name(t1_name, t1_ver, nil, nil, rs),
          tier1_version: t1_ver,
          tier1_gemfile: t1_gemfile,
          tier2_gemfile: nil,
          x_std_libs_gemfile: x_std_libs_gemfile,
          ruby_series: rs
        }
      end
    else
      tier2_gems.each do |t2|
        t2_name = t2["name"]
        t2_versions = t2["versions"] || []

        t1_assignments.each do |t1_a|
          t1_ver = t1_a[:version]
          rs = t1_a[:bucket]

          # Find compatible tier2 versions for this bucket
          compatible_t2 = t2_versions.select { |t2_ver|
            compatible?(t2_name, t2_ver, rs, bucket_ranges, resolver)
          }

          # If no compatible tier2 versions, skip
          next if compatible_t2.empty?

          compatible_t2.each do |t2_ver|
            ruby_min = bucket_ranges.dig(rs, :floor)
            sub_deps = sub_resolver.resolve(t1_name, t1_ver, ruby_min: ruby_min)

            t1_gemfile = gemfile_gen.generate(
              gem_name: t1_name,
              version: t1_ver,
              ruby_series: rs,
              sub_deps: sub_deps
            )
            t2_gemfile = gemfile_gen.generate_tier2(
              gem_name: t2_name, version: t2_ver, ruby_series: rs
            )

            x_std_libs_gemfile = "gemfiles/modular/x_std_libs/#{rs}/libs.gemfile"

            entries << {
              name: GemAbbreviations.appraisal_name(t1_name, t1_ver, t2_name, t2_ver, rs),
              tier1_version: t1_ver,
              tier2_version: t2_ver,
              tier1_gemfile: t1_gemfile,
              tier2_gemfile: t2_gemfile,
              x_std_libs_gemfile: x_std_libs_gemfile,
              ruby_series: rs
            }
          end
        end
      end
    end
  end

  entries
end

#cleanup_stale_gemfiles(current_entries) ⇒ void

This method returns an undefined value.

Removes stale kja-* flat gemfiles from gemfiles/ that are no longer in the current matrix. Only touches files matching the PREFIX pattern.

Parameters:

  • current_entries (Array[Hash[Symbol, untyped]]) 


309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 309

def cleanup_stale_gemfiles(current_entries)
  prefix = GemAbbreviations::PREFIX
  gemfiles_dir = File.join(project_dir, "gemfiles")
  return unless File.directory?(gemfiles_dir)

  current_names = current_entries.map { |e| e[:name] }.to_set
  stale = Dir.glob(File.join(gemfiles_dir, "#{prefix}-*.gemfile")).reject { |f|
    basename = File.basename(f, ".gemfile")
    current_names.include?(basename)
  }

  return if stale.empty?

  stale.each { |f| FileUtils.rm_f(f) }
  puts "  🗑️  Removed #{stale.size} stale gemfile(s)"
end

#compatible?(gem_name, gem_ver, ruby_series, bucket_ranges, resolver) ⇒ Boolean

Checks if a tier2 gem version is compatible with a Ruby series bucket.

Parameters:

  • gem_name (String)
  • version (String)
  • ruby_series (String)
  • bucket_ranges (Hash[String, Hash[Symbol, Gem::Version]])
  • resolver (GemVersionResolver)

Returns:

  • (Boolean) 


499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 499

def compatible?(gem_name, gem_ver, ruby_series, bucket_ranges, resolver)
  range = bucket_ranges[ruby_series]
  return true unless range

  gem_ruby = resolver.min_ruby_version(gem_name, latest_minor_patch(gem_name, gem_ver, resolver))
  # If gem requires a Ruby newer than the bucket's ceiling, incompatible
  return false if gem_ruby && gem_ruby > range[:ceiling]

  true
rescue
  true
end

#detect_mode ⇒ Symbol

Returns:

  • (Symbol) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 77

def detect_mode
  return :scaffold if args.include?("--scaffold")
  return :resolve if args.include?("--resolve")

  config = load_config
  matrix = config[APPRAISAL_MATRIX_KEY]

  # Auto-detect: if no versions are present, scaffold mode
  if matrix.nil? || !has_versions?(matrix)
    :scaffold
  else
    :resolve
  end
end

#detect_project_min_ruby(config = load_config) ⇒ Gem::Version?

Extracts the project's min_ruby from its gemspec (used as a floor).

Returns:

  • (Gem::Version, nil) 


369
370
371
372
373
374
375
376
377
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 369

def detect_project_min_ruby(config = load_config)
  floors = []
  min_ruby = Kettle::Jem::GemSpecReader.load(project_dir)[:min_ruby]
  floors << Gem::Version.new(min_ruby) if min_ruby

  test_minimum = config.dig("ruby", "test_minimum")
  floors << Gem::Version.new(test_minimum.to_s) if test_minimum
  floors.max
end

#extract_runtime_deps(gemspec_path) ⇒ Array[String]

Parameters:

  • gemspec_path (String)

Returns:

  • (Array[String]) 


343
344
345
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 343

def extract_runtime_deps(gemspec_path)
  load_gemspec(gemspec_path).runtime_dependencies.map(&:name).uniq
end

#find_gemspec ⇒ String?

Returns:

  • (String, nil) 


338
339
340
341
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 338

def find_gemspec
  pattern = File.join(project_dir, "*.gemspec")
  Dir.glob(pattern).first
end

#fresh?(matrix) ⇒ Boolean

Parameters:

  • matrix (Hash[String, untyped])

Returns:

  • (Boolean) 


347
348
349
350
351
352
353
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 347

def fresh?(matrix)
  resolved_at = matrix["resolved_at"]
  return false unless resolved_at

  ttl = matrix["freshness_ttl"] || DEFAULT_FRESHNESS_TTL
  (Time.now.to_i - resolved_at) < ttl
end

#has_versions?(matrix) ⇒ Boolean

Parameters:

  • matrix (Hash[String, untyped])

Returns:

  • (Boolean) 


92
93
94
95
96
97
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 92

def has_versions?(matrix)
  gems = matrix["gems"] || {}
  %w[tier1 tier2].any? { |tier|
    (gems[tier] || []).any? { |g| g["versions"] && !g["versions"].empty? }
  }
end

#load_config ⇒ Hash[String, untyped]

Returns:

  • (Hash[String, untyped]) 


326
327
328
329
330
331
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 326

def load_config
  path = File.join(project_dir, CONFIG_FILE)
  return {} unless File.exist?(path)

  YAML.safe_load_file(path, permitted_classes: [Symbol]) || {}
end

#run ⇒ void

This method returns an undefined value.

Detects the appropriate mode and dispatches to scaffold or resolve.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 62

def run
  mode = detect_mode
  case mode
  when :scaffold
    run_scaffold
  when :resolve
    run_resolve
  else
    warn "Unknown mode: #{mode}"
    exit(1)
  end
end

#run_resolve ⇒ void

This method returns an undefined value.

── Resolve Mode ─────────────────────────────────────────────────



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 137

def run_resolve
  puts "🍲 kettle-jem-appraisals: resolve mode"

  config = load_config
  matrix = config[APPRAISAL_MATRIX_KEY]
  unless matrix
    warn "  ❌ No #{APPRAISAL_MATRIX_KEY} in #{CONFIG_FILE}. Run --scaffold first."
    exit(1)
  end

  # Check freshness TTL
  if !args.include?("--force") && fresh?(matrix)
    puts "  ⏩ Matrix is still fresh (resolved #{time_ago(matrix["resolved_at"])} ago). Use --force to re-resolve."
    return
  end

  global_mode = matrix["mode"] || "semver"
  gems_config = matrix["gems"] || {}
  tier1_gems = gems_config["tier1"] || []
  tier2_gems = gems_config["tier2"] || []

  if tier1_gems.empty?
    warn "  ❌ No tier1 gems configured. Run --scaffold first."
    exit(1)
  end

  resolver = GemVersionResolver.new
  builder = MatrixBuilder.new(resolver: resolver)
  sub_resolver = SubDepResolver.new(resolver: resolver)
  gemfile_gen = ModularGemfileGenerator.new(base_dir: project_dir)

  # Resolve tier1 versions
  tier1_gems.each do |gem_config|
    name = gem_config["name"]
    mode = gem_config["mode"] || gems_config.dig("tier1_mode") || global_mode
    requirements = gem_requirements(gem_config)
    include_versions = gem_include_versions(gem_config)
    exclude_versions = gem_exclude_versions(gem_config)
    puts "  🔄 Resolving #{name} (mode: #{mode})..."
    selected_versions = builder.select_versions(name, mode: mode, requirements: requirements)
    gem_config["versions"] = finalize_versions(selected_versions, include_versions, exclude_versions)
    puts "    → #{gem_config["versions"].size} versions: #{gem_config["versions"].join(", ")}"
  end

  # Resolve tier2 versions
  tier2_gems.each do |gem_config|
    name = gem_config["name"]
    mode = gem_config["mode"] || gems_config.dig("tier2_mode") || global_mode
    requirements = gem_requirements(gem_config)
    include_versions = gem_include_versions(gem_config)
    exclude_versions = gem_exclude_versions(gem_config)
    puts "  🔄 Resolving #{name} (mode: #{mode})..."
    selected_versions = builder.select_versions(name, mode: mode, requirements: requirements)
    gem_config["versions"] = finalize_versions(selected_versions, include_versions, exclude_versions)
    puts "    → #{gem_config["versions"].size} versions: #{gem_config["versions"].join(", ")}"
  end

  # Resolve sub-deps for tier1 gems
  tier1_gems.each do |gem_config|
    name = gem_config["name"]
    # Use the latest version to determine sub-deps
    latest = gem_config["versions"]&.last
    next unless latest

    deps = sub_resolver.resolve(name, latest)
    gem_config["deps"] = deps.keys unless deps.empty?
    puts "    📦 #{name} sub-deps: #{deps.keys.join(", ")}" unless deps.empty?
  end

  # Detect Ruby series from ALL version seams (not just selected versions).
  # The full seam set determines the bucket landscape — modes only affect
  # which versions we TEST, not which Ruby ranges exist.
  series_detector = RubySeriesDetector.new(resolver: resolver)
  project_min_ruby = detect_project_min_ruby(config)

  # Build full-version gem configs for seam detection
  all_versions_by_gem = {}
  all_version_configs = (tier1_gems + tier2_gems).map do |gc|
    tier_mode =
      if tier1_gems.include?(gc)
        gems_config.dig("tier1_mode") || global_mode
      else
        gems_config.dig("tier2_mode") || global_mode
      end
    mode = gc["mode"] || tier_mode
    requirements = gem_requirements(gc)
    include_versions = gem_include_versions(gc)
    exclude_versions = gem_exclude_versions(gc)
    all_versions = all_versions_for(
      resolver,
      gc["name"],
      mode: mode,
      requirements: requirements,
      include_versions: include_versions,
      exclude_versions: exclude_versions
    )
    all_versions_by_gem[gc["name"]] = all_versions
    {"name" => gc["name"], "versions" => all_versions}
  end
  detection = series_detector.detect_with_ranges(all_version_configs, [], project_min_ruby: project_min_ruby)
  ruby_series = detection[:buckets]
  bucket_ranges = detection[:bucket_ranges]
  puts "  🔴 Ruby series: #{ruby_series.join(", ")}"

  # Compute seams from ALL versions (for assignment) and show analysis
  all_seams = {}
  (tier1_gems + tier2_gems).each do |gem_config|
    all_versions = all_versions_by_gem[gem_config["name"]] || []
    seams = series_detector.find_seams(gem_config["name"], all_versions)
    all_seams[gem_config["name"]] = seams
    next if seams.empty?

    seam_str = seams.map { |s| "#{s[:version]}→ruby≥#{s[:min_ruby]}" }.join(", ")
    puts "    🔗 #{gem_config["name"]} seams: #{seam_str}"
  end

  appraisal_entries = build_matrix(
    tier1_gems,
    tier2_gems,
    ruby_series,
    bucket_ranges,
    all_seams,
    all_versions_by_gem,
    resolver,
    builder,
    gemfile_gen,
    sub_resolver
  )
  annotate_extra_gemfiles(appraisal_entries, matrix_extra_gemfiles(matrix))
  annotate_standard_appraisal_collapses(appraisal_entries, bucket_ranges, matrix)

  puts "  📊 Generated #{appraisal_entries.size} appraisal entries"

  # Generate workflow strategy matrix snippets
  workflow_gen = WorkflowStrategyGenerator.new(
    bucket_ranges: bucket_ranges,
    exec_cmd: matrix.dig("exec_cmd") || "rake spec"
  )
  workflow_groups = workflow_gen.generate(appraisal_entries)
  workflow_groups.each do |lifecycle, entries|
    puts "    🔧 #{lifecycle}.yml: #{entries.size} matrix entries"
  end

  # Clean up stale kja-* flat gemfiles from previous runs
  cleanup_stale_gemfiles(appraisal_entries)

  # Write Appraisals file
  appraisals_content = AppraisalsGenerator.generate(appraisal_entries)
  appraisals_path = File.join(project_dir, "Appraisals")
  File.write(appraisals_path, appraisals_content)
  puts "  📝 Wrote #{Kettle::Jem::Appraisals.display_path(appraisals_path)}"

  # Update config with resolved_at timestamp
  matrix["resolved_at"] = Time.now.to_i
  config[APPRAISAL_MATRIX_KEY] = matrix
  write_config(config)

  # Run bin/appraisal generate
  if File.exist?(File.join(project_dir, "bin", "appraisal"))
    puts "  🔧 Running bin/appraisal generate..."
    system("bin/appraisal", "generate", chdir: project_dir)
  else
    puts "  ⚠️  bin/appraisal not found — run `bundle binstubs appraisal2` then `bin/appraisal generate`"
  end

  puts "  ✅ Resolve complete"
end

#run_scaffold ⇒ void

This method returns an undefined value.

── Scaffold Mode ────────────────────────────────────────────────



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 101

def run_scaffold
  puts "🍲 kettle-jem-appraisals: scaffold mode"
  gemspec_path = find_gemspec
  unless gemspec_path
    warn "  ❌ No gemspec found in #{Kettle::Jem::Appraisals.display_path(project_dir)}"
    exit(1)
  end

  puts "  📦 Reading gemspec: #{File.basename(gemspec_path)}"
  runtime_deps = extract_runtime_deps(gemspec_path)
  exclusions = XStdLibsExclusion.from_template

  filtered = runtime_deps.reject { |name| exclusions.include?(name) }
  puts "  🔍 Found #{runtime_deps.size} runtime deps, #{runtime_deps.size - filtered.size} excluded"
  puts "  📋 Candidates: #{filtered.join(", ")}" unless filtered.empty?

  config = load_config
  matrix = config[APPRAISAL_MATRIX_KEY] || {}
  matrix["mode"] ||= "semver"
  matrix["freshness_ttl"] ||= DEFAULT_FRESHNESS_TTL
  matrix["gems"] ||= {}
  matrix["gems"]["tier1"] = filtered.map { |name| {"name" => name} }
  matrix["gems"]["tier2"] ||= []

  config[APPRAISAL_MATRIX_KEY] = matrix
  write_config(config)

  puts "  ✅ Wrote scaffold to #{CONFIG_FILE}"
  puts ""
  puts "  Next steps:"
  puts "  1. Edit #{CONFIG_FILE} — arrange gems into tier1 and tier2"
  puts "  2. Run `kettle-jem-appraisals` again (or `--resolve`) to generate matrix"
end

#time_ago(timestamp) ⇒ String

Parameters:

  • timestamp (Integer)

Returns:

  • (String) 


355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 355

def time_ago(timestamp)
  return "unknown" unless timestamp

  seconds = Time.now.to_i - timestamp
  if seconds < 3600
    "#{seconds / 60}m"
  elsif seconds < 86_400
    "#{seconds / 3600}h"
  else
    "#{seconds / 86_400}d"
  end
end

#write_config(config) ⇒ void

This method returns an undefined value.

Parameters:

  • config (Hash[String, untyped]) 


333
334
335
336
 
# File 'lib/kettle/jem/appraisals/cli.rb', line 333

def write_config(config)
  path = File.join(project_dir, CONFIG_FILE)
  File.write(path, YAML.dump(config))
end