Module: Ast::Template

Defined in:
lib/ast/template.rb,
lib/ast/template/version.rb,
sig/ast/template.rbs

Defined Under Namespace

Modules: Version

Constant Summary collapse

MODES = 
%w[plan apply reapply].freeze
SESSION_STATUS_TRANSPORT_VERSION = 
1
SESSION_DIAGNOSTICS_TRANSPORT_VERSION = 
1
SESSION_OUTCOME_TRANSPORT_VERSION = 
1
SESSION_INSPECTION_TRANSPORT_VERSION = 
1
SESSION_REQUEST_TRANSPORT_VERSION = 
1
SESSION_RUNNER_REQUEST_TRANSPORT_VERSION = 
1
SESSION_RUNNER_PAYLOAD_TRANSPORT_VERSION = 
1
SESSION_ENTRYPOINT_TRANSPORT_VERSION = 
1
SESSION_COMMAND_TRANSPORT_VERSION = 
1
SESSION_COMMAND_PAYLOAD_TRANSPORT_VERSION = 
1
SESSION_INVOCATION_TRANSPORT_VERSION = 
1
README_FAMILY_LANGUAGE_ORDER = 
%w[go ruby rust typescript].freeze
README_FAMILY_LANGUAGE_LABELS = 
{
  'go' => 'Go',
  'ruby' => 'Ruby',
  'rust' => 'Rust',
  'typescript' => 'TypeScript'
}.freeze
VERSION =

Current gem version exposed at the traditional constant location.

Returns:

  • (String) 
Version::VERSION

Class Method Summary collapse

Class Method Details

.apply_readme_family_section(template_partial, package_metadata, family_metadata, destination_content, config = nil) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/ast/template.rb', line 76

def apply_readme_family_section(template_partial, package_metadata, family_metadata, destination_content,
                                config = nil)
  package_entry = Ast::Merge.normalize_value(package_metadata || {})
  family = Ast::Merge.normalize_value(family_metadata || {})
  rendered_section = render_readme_family_section(template_partial, family, config).rstrip
  base_content = if destination_content.nil?
                   "# #{package_entry[:name]}\n\n#{package_entry[:summary]}\n"
                 else
                   destination_content.to_s
                 end
  content = replace_or_insert_markdown_heading_section(
    base_content,
    family[:section_heading].to_s,
    2,
    rendered_section
  )
  {
    content: content,
    changed: content != base_content
  }
end

.apply_readme_family_sections_to_package_directories(root, template_partial, packages, config = nil) ⇒ Object 



98
99
100
 
# File 'lib/ast/template.rb', line 98

def apply_readme_family_sections_to_package_directories(root, template_partial, packages, config = nil)
  run_readme_family_sections_for_package_directories(root, template_partial, packages, true, config)
end

.apply_template_directory_session_diagnostics_with_default_registry_to_directory(template_root, destination_root, context, default_strategy, overrides, replacements, allowed_families = nil, config = nil) ⇒ Object 



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/ast/template.rb', line 591

def apply_template_directory_session_diagnostics_with_default_registry_to_directory(template_root, destination_root,
                                                                                    context, default_strategy, overrides, replacements, allowed_families = nil, config = nil)
  registry = default_family_merge_adapter_registry(allowed_families)
  result = Ast::Merge.apply_template_tree_execution_to_directory(
    template_root,
    destination_root,
    context,
    default_strategy,
    overrides,
    replacements,
    config
  ) do |entry|
    merge_prepared_content_from_registry(registry, entry)
  end
  report_template_directory_session_diagnostics(
    :apply,
    result[:execution_plan],
    report_adapter_capabilities(result[:execution_plan], registry),
    result
  )
end

.apply_template_directory_session_envelope_with_default_registry_to_directory(template_root, destination_root, context, default_strategy, overrides, replacements, allowed_families = nil, config = nil) ⇒ Object 



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
 
# File 'lib/ast/template.rb', line 422

def apply_template_directory_session_envelope_with_default_registry_to_directory(template_root, destination_root,
                                                                                 context, default_strategy, overrides, replacements, allowed_families = nil, config = nil)
  report_template_directory_session_envelope(
    apply_template_directory_session_with_default_registry_to_directory(
      template_root,
      destination_root,
      context,
      default_strategy,
      overrides,
      replacements,
      allowed_families,
      config
    ),
    report_default_adapter_capabilities_from_directories(
      template_root,
      destination_root,
      context,
      default_strategy,
      overrides,
      replacements,
      allowed_families,
      config
    )
  )
end

.apply_template_directory_session_outcome_with_default_registry_to_directory(template_root, destination_root, context, default_strategy, overrides, replacements, allowed_families = nil, config = nil) ⇒ Object 



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'lib/ast/template.rb', line 658

def apply_template_directory_session_outcome_with_default_registry_to_directory(template_root, destination_root,
                                                                                context, default_strategy, overrides, replacements, allowed_families = nil, config = nil)
  registry = default_family_merge_adapter_registry(allowed_families)
  result = Ast::Merge.apply_template_tree_execution_to_directory(
    template_root,
    destination_root,
    context,
    default_strategy,
    overrides,
    replacements,
    config
  ) do |entry|
    merge_prepared_content_from_registry(registry, entry)
  end
  session_report = report_template_directory_registry_session(:apply, result[:execution_plan], registry, result)
  capabilities = report_adapter_capabilities(result[:execution_plan], registry)
  report_template_directory_session_outcome(
    session_report,
    report_template_directory_session_status(
      report_template_directory_session_envelope(session_report, capabilities)
    ),
    report_template_directory_session_diagnostics(
      :apply,
      result[:execution_plan],
      capabilities,
      result
    )
  )
end

.apply_template_directory_session_to_directory(template_root, destination_root, context, default_strategy, overrides, replacements, config = nil, &merge_callback) ⇒ Object 



281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/ast/template.rb', line 281

def apply_template_directory_session_to_directory(template_root, destination_root,
                                                  context, default_strategy, overrides, replacements, config = nil, &merge_callback)
  result = Ast::Merge.apply_template_tree_execution_to_directory(
    template_root,
    destination_root,
    context,
    default_strategy,
    overrides,
    replacements,
    config,
    &merge_callback
  )
  report_template_directory_session(:apply, result[:execution_plan], result)
end

.apply_template_directory_session_with_default_registry_to_directory(template_root, destination_root, context, default_strategy, overrides, replacements, allowed_families = nil, config = nil) ⇒ Object 



327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/ast/template.rb', line 327

def apply_template_directory_session_with_default_registry_to_directory(template_root, destination_root,
                                                                        context, default_strategy, overrides, replacements, allowed_families = nil, config = nil)
  registry = default_family_merge_adapter_registry(allowed_families)
  apply_template_directory_session_with_registry_to_directory(
    template_root,
    destination_root,
    context,
    default_strategy,
    overrides,
    replacements,
    registry,
    config
  )
end

.apply_template_directory_session_with_registry_to_directory(template_root, destination_root, context, default_strategy, overrides, replacements, registry, config = nil) ⇒ Object 



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/ast/template.rb', line 311

def apply_template_directory_session_with_registry_to_directory(template_root, destination_root,
                                                                context, default_strategy, overrides, replacements, registry, config = nil)
  result = Ast::Merge.apply_template_tree_execution_to_directory(
    template_root,
    destination_root,
    context,
    default_strategy,
    overrides,
    replacements,
    config
  ) do |entry|
    merge_prepared_content_from_registry(registry, entry)
  end
  report_template_directory_registry_session(:apply, result[:execution_plan], registry, result)
end

.default_family_merge_adapter_registry(allowed_families = nil) ⇒ Object 



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
 
# File 'lib/ast/template.rb', line 196

def default_family_merge_adapter_registry(allowed_families = nil)
  allowed = Array(allowed_families).map(&:to_s)
  include_family = lambda do |family|
    allowed.empty? || allowed.include?(family)
  end

  registry = {}
  if include_family.call('markdown')
    begin
      require 'markly-merge'
      registry['markdown'] = lambda do |entry|
        {
          ok: true,
          output: Markly::Merge::SmartMerger.new(
            entry[:prepared_template_content],
            entry[:destination_content],
            add_template_only_nodes: true
          ).merge,
          diagnostics: [],
          policies: []
        }
      end
    rescue LoadError
      begin
        require 'markdown-merge'
        registry['markdown'] = lambda do |entry|
          Markdown::Merge.merge_markdown(entry[:prepared_template_content], entry[:destination_content], 'markdown')
        end
      rescue LoadError
      end
    end
  end
  if include_family.call('toml')
    begin
      require 'toml-merge'
      registry['toml'] = lambda do |entry|
        Toml::Merge.merge_toml(entry[:prepared_template_content], entry[:destination_content], 'toml')
      end
    rescue LoadError
    end
  end
  if include_family.call('ruby')
    begin
      require 'prism-merge'
      registry['ruby'] = lambda do |entry|
        Prism::Merge.merge_ruby(entry[:prepared_template_content], entry[:destination_content], 'ruby')
      end
    rescue LoadError
      begin
        require 'ruby-merge'
        registry['ruby'] = lambda do |entry|
          Ruby::Merge.merge_ruby(entry[:prepared_template_content], entry[:destination_content], 'ruby')
        end
      rescue LoadError
      end
    end
  end

  registry
end

.import_template_directory_session_command_envelope(envelope) ⇒ Object 



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'lib/ast/template.rb', line 1340

def import_template_directory_session_command_envelope(envelope)
  unless envelope[:kind] == 'template_directory_session_command'
    return [nil,
            { category: 'kind_mismatch',
              message: 'expected template_directory_session_command envelope kind.' }]
  end
  unless envelope[:version] == SESSION_COMMAND_TRANSPORT_VERSION
    return [nil,
            { category: 'unsupported_version',
              message: "unsupported template_directory_session_command envelope version #{envelope[:version]}." }]
  end

  [deep_dup(envelope[:command]), nil]
end

.import_template_directory_session_command_payload_envelope(envelope) ⇒ Object 



1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
 
# File 'lib/ast/template.rb', line 1363

def import_template_directory_session_command_payload_envelope(envelope)
  unless envelope[:kind] == 'template_directory_session_command_payload'
    return [nil,
            { category: 'kind_mismatch',
              message: 'expected template_directory_session_command_payload envelope kind.' }]
  end
  unless envelope[:version] == SESSION_COMMAND_PAYLOAD_TRANSPORT_VERSION
    return [nil,
            { category: 'unsupported_version',
              message: "unsupported template_directory_session_command_payload envelope version #{envelope[:version]}." }]
  end

  [deep_dup(envelope[:payload]), nil]
end

.import_template_directory_session_diagnostics_envelope(envelope) ⇒ Object 



558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/ast/template.rb', line 558

def import_template_directory_session_diagnostics_envelope(envelope)
  unless envelope[:kind] == 'template_directory_session_diagnostics'
    return [nil,
            { category: 'kind_mismatch',
              message: 'expected template_directory_session_diagnostics envelope kind.' }]
  end
  unless envelope[:version] == SESSION_DIAGNOSTICS_TRANSPORT_VERSION
    return [nil,
            { category: 'unsupported_version',
              message: "unsupported template_directory_session_diagnostics envelope version #{envelope[:version]}." }]
  end

  [deep_dup(envelope[:diagnostics]), nil]
end

.import_template_directory_session_entrypoint_envelope(envelope) ⇒ Object 



1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
 
# File 'lib/ast/template.rb', line 1317

def import_template_directory_session_entrypoint_envelope(envelope)
  unless envelope[:kind] == 'template_directory_session_entrypoint'
    return [nil,
            { category: 'kind_mismatch',
              message: 'expected template_directory_session_entrypoint envelope kind.' }]
  end
  unless envelope[:version] == SESSION_ENTRYPOINT_TRANSPORT_VERSION
    return [nil,
            { category: 'unsupported_version',
              message: "unsupported template_directory_session_entrypoint envelope version #{envelope[:version]}." }]
  end

  [deep_dup(envelope[:entrypoint]), nil]
end

.import_template_directory_session_inspection_envelope(envelope) ⇒ Object 



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/ast/template.rb', line 1231

def import_template_directory_session_inspection_envelope(envelope)
  unless envelope[:kind] == 'template_directory_session_inspection'
    return [nil,
            { category: 'kind_mismatch',
              message: 'expected template_directory_session_inspection envelope kind.' }]
  end
  unless envelope[:version] == SESSION_INSPECTION_TRANSPORT_VERSION
    return [nil,
            { category: 'unsupported_version',
              message: "unsupported template_directory_session_inspection envelope version #{envelope[:version]}." }]
  end

  [deep_dup(envelope[:inspection]), nil]
end

.import_template_directory_session_invocation_envelope(envelope) ⇒ Object 



1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'lib/ast/template.rb', line 1386

def import_template_directory_session_invocation_envelope(envelope)
  unless envelope[:kind] == 'template_directory_session_invocation'
    return [nil,
            { category: 'kind_mismatch',
              message: 'expected template_directory_session_invocation envelope kind.' }]
  end
  unless envelope[:version] == SESSION_INVOCATION_TRANSPORT_VERSION
    return [nil,
            { category: 'unsupported_version',
              message: "unsupported template_directory_session_invocation envelope version #{envelope[:version]}." }]
  end

  [deep_dup(envelope[:invocation]), nil]
end

.import_template_directory_session_outcome_envelope(envelope) ⇒ Object 



883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/ast/template.rb', line 883

def import_template_directory_session_outcome_envelope(envelope)
  unless envelope[:kind] == 'template_directory_session_outcome'
    return [nil,
            { category: 'kind_mismatch',
              message: 'expected template_directory_session_outcome envelope kind.' }]
  end
  unless envelope[:version] == SESSION_OUTCOME_TRANSPORT_VERSION
    return [nil,
            { category: 'unsupported_version',
              message: "unsupported template_directory_session_outcome envelope version #{envelope[:version]}." }]
  end

  [deep_dup(envelope[:outcome]), nil]
end

.import_template_directory_session_request_envelope(envelope) ⇒ Object 



922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'lib/ast/template.rb', line 922

def import_template_directory_session_request_envelope(envelope)
  unless envelope[:kind] == 'template_directory_session_request'
    return [nil,
            { category: 'kind_mismatch',
              message: 'expected template_directory_session_request envelope kind.' }]
  end
  unless envelope[:version] == SESSION_REQUEST_TRANSPORT_VERSION
    return [nil,
            { category: 'unsupported_version',
              message: "unsupported template_directory_session_request envelope version #{envelope[:version]}." }]
  end

  [deep_dup(envelope[:request]), nil]
end

.import_template_directory_session_runner_payload_envelope(envelope) ⇒ Object 



1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'lib/ast/template.rb', line 1076

def import_template_directory_session_runner_payload_envelope(envelope)
  unless envelope[:kind] == 'template_directory_session_runner_payload'
    return [nil,
            { category: 'kind_mismatch',
              message: 'expected template_directory_session_runner_payload envelope kind.' }]
  end
  unless envelope[:version] == SESSION_RUNNER_PAYLOAD_TRANSPORT_VERSION
    return [nil,
            { category: 'unsupported_version',
              message: "unsupported template_directory_session_runner_payload envelope version #{envelope[:version]}." }]
  end

  [deep_dup(envelope[:payload]), nil]
end

.import_template_directory_session_runner_request_envelope(envelope) ⇒ Object 



965
966
967
968
969
970
971
972
973
974
975
976
977
978
 
# File 'lib/ast/template.rb', line 965

def import_template_directory_session_runner_request_envelope(envelope)
  unless envelope[:kind] == 'template_directory_session_runner_request'
    return [nil,
            { category: 'kind_mismatch',
              message: 'expected template_directory_session_runner_request envelope kind.' }]
  end
  unless envelope[:version] == SESSION_RUNNER_REQUEST_TRANSPORT_VERSION
    return [nil,
            { category: 'unsupported_version',
              message: "unsupported template_directory_session_runner_request envelope version #{envelope[:version]}." }]
  end

  [deep_dup(envelope[:request]), nil]
end

.import_template_directory_session_status_envelope(envelope) ⇒ Object 



486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/ast/template.rb', line 486

def import_template_directory_session_status_envelope(envelope)
  unless envelope[:kind] == 'template_directory_session_status'
    return [nil,
            { category: 'kind_mismatch',
              message: 'expected template_directory_session_status envelope kind.' }]
  end
  unless envelope[:version] == SESSION_STATUS_TRANSPORT_VERSION
    return [nil,
            { category: 'unsupported_version',
              message: "unsupported template_directory_session_status envelope version #{envelope[:version]}." }]
  end

  [deep_dup(envelope[:status]), nil]
end

.merge_prepared_content_from_registry(registry, entry) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/ast/template.rb', line 162

def merge_prepared_content_from_registry(registry, entry)
  family = entry.dig(:classification, :family) || entry.dig('classification', 'family')
  adapter = registry[family.to_s]
  unless adapter
    return {
      ok: false,
      diagnostics: [{
        severity: 'error',
        category: 'configuration_error',
        message: "missing family adapter for #{family}"
      }],
      policies: []
    }
  end

  adapter.call(deep_dup(entry))
end

.plan_readme_family_sections_for_package_directories(root, template_partial, packages, config = nil) ⇒ Object 



102
103
104
 
# File 'lib/ast/template.rb', line 102

def plan_readme_family_sections_for_package_directories(root, template_partial, packages, config = nil)
  run_readme_family_sections_for_package_directories(root, template_partial, packages, false, config)
end

.plan_template_directory_session_diagnostics_from_directories(template_root, destination_root, context, default_strategy, overrides, replacements, allowed_families = nil, config = nil) ⇒ Object 



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/ast/template.rb', line 573

def plan_template_directory_session_diagnostics_from_directories(template_root, destination_root,
                                                                 context, default_strategy, overrides, replacements, allowed_families = nil, config = nil)
  entries = Ast::Merge.plan_template_tree_execution_from_directories(
    template_root,
    destination_root,
    context,
    default_strategy,
    overrides,
    replacements,
    config
  )
  report_template_directory_session_diagnostics(
    :plan,
    entries,
    report_adapter_capabilities(entries, default_family_merge_adapter_registry(allowed_families))
  )
end

.plan_template_directory_session_envelope_from_directories(template_root, destination_root, context, default_strategy, overrides, replacements, allowed_families = nil, config = nil) ⇒ Object 



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/ast/template.rb', line 397

def plan_template_directory_session_envelope_from_directories(template_root, destination_root,
                                                              context, default_strategy, overrides, replacements, allowed_families = nil, config = nil)
  report_template_directory_session_envelope(
    plan_template_directory_session_from_directories(
      template_root,
      destination_root,
      context,
      default_strategy,
      overrides,
      replacements,
      config
    ),
    report_default_adapter_capabilities_from_directories(
      template_root,
      destination_root,
      context,
      default_strategy,
      overrides,
      replacements,
      allowed_families,
      config
    )
  )
end

.plan_template_directory_session_from_directories(template_root, destination_root, context, default_strategy, overrides, replacements, config = nil) ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/ast/template.rb', line 267

def plan_template_directory_session_from_directories(template_root, destination_root,
                                                     context, default_strategy, overrides, replacements, config = nil)
  entries = Ast::Merge.plan_template_tree_execution_from_directories(
    template_root,
    destination_root,
    context,
    default_strategy,
    overrides,
    replacements,
    config
  )
  report_template_directory_session(:plan, entries)
end

.plan_template_directory_session_outcome_from_directories(template_root, destination_root, context, default_strategy, overrides, replacements, allowed_families = nil, config = nil) ⇒ Object 



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/ast/template.rb', line 621

def plan_template_directory_session_outcome_from_directories(template_root, destination_root,
                                                             context, default_strategy, overrides, replacements, allowed_families = nil, config = nil)
  report_template_directory_session_outcome(
    plan_template_directory_session_from_directories(
      template_root,
      destination_root,
      context,
      default_strategy,
      overrides,
      replacements,
      config
    ),
    report_template_directory_session_status(
      plan_template_directory_session_envelope_from_directories(
        template_root,
        destination_root,
        context,
        default_strategy,
        overrides,
        replacements,
        allowed_families,
        config
      )
    ),
    plan_template_directory_session_diagnostics_from_directories(
      template_root,
      destination_root,
      context,
      default_strategy,
      overrides,
      replacements,
      allowed_families,
      config
    )
  )
end

.readme_family_language_aliases(self_language, language_order = README_FAMILY_LANGUAGE_ORDER) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/ast/template.rb', line 30

def readme_family_language_aliases(self_language, language_order = README_FAMILY_LANGUAGE_ORDER)
  self_id = self_language.to_s
  alternatives = language_order.map(&:to_s).reject { |language| language == self_id }
  aliases = {
    'SELF_LANG' => README_FAMILY_LANGUAGE_LABELS.fetch(self_id, self_id),
    'SELF_LANG_ID' => self_id
  }
  alternatives.each_with_index do |language, index|
    alias_prefix = "IMP_LANG#{index + 1}"
    aliases[alias_prefix] = README_FAMILY_LANGUAGE_LABELS.fetch(language, language)
    aliases["#{alias_prefix}_ID"] = language
  end
  aliases
end

.readme_family_token_values(family_metadata) ⇒ Object 



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
 
# File 'lib/ast/template.rb', line 45

def readme_family_token_values(family_metadata)
  family = Ast::Merge.normalize_value(family_metadata || {})
  self_entry = family.fetch(:self, {})
  self_id = self_entry.fetch(:id).to_s
  implementations = Array(family[:implementations]).each_with_object({}) do |entry, memo|
    normalized_entry = Ast::Merge.normalize_value(entry)
    memo[normalized_entry[:id].to_s] = normalized_entry
  end
  aliases = readme_family_language_aliases(self_id)
  tokens = {
    'FAMILY_SECTION_HEADING' => family[:section_heading].to_s,
    'FAMILY_DESCRIPTION' => family[:description].to_s,
    'SELF_PACKAGE_ROOT' => self_entry[:package_root].to_s,
    'SELF_PACKAGE_MANAGER' => self_entry[:package_manager].to_s
  }.merge(aliases)

  README_FAMILY_LANGUAGE_ORDER.reject { |language| language == self_id }.each_with_index do |language, index|
    implementation = implementations.fetch(language, {})
    alias_prefix = "IMP_LANG#{index + 1}"
    tokens["#{alias_prefix}_PACKAGE_ROOT"] = implementation[:package_root].to_s
    tokens["#{alias_prefix}_PACKAGE_MANAGER"] = implementation[:package_manager].to_s
  end

  tokens
end

.reapply_template_directory_session_outcome_with_default_registry_to_directory(template_root, destination_root, context, default_strategy, overrides, replacements, allowed_families = nil, config = nil) ⇒ Object 



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/ast/template.rb', line 688

def reapply_template_directory_session_outcome_with_default_registry_to_directory(template_root, destination_root,
                                                                                  context, default_strategy, overrides, replacements, allowed_families = nil, config = nil)
  registry = default_family_merge_adapter_registry(allowed_families)
  result = Ast::Merge.apply_template_tree_execution_to_directory(
    template_root,
    destination_root,
    context,
    default_strategy,
    overrides,
    replacements,
    config
  ) do |entry|
    merge_prepared_content_from_registry(registry, entry)
  end
  session_report = report_template_directory_registry_session(:reapply, result[:execution_plan], registry, result)
  capabilities = report_adapter_capabilities(result[:execution_plan], registry)
  report_template_directory_session_outcome(
    session_report,
    report_template_directory_session_status(
      report_template_directory_session_envelope(session_report, capabilities)
    ),
    report_template_directory_session_diagnostics(
      :reapply,
      result[:execution_plan],
      capabilities,
      result
    )
  )
end

.reapply_template_directory_session_to_directory(template_root, destination_root, context, default_strategy, overrides, replacements, config = nil, &merge_callback) ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/ast/template.rb', line 296

def reapply_template_directory_session_to_directory(template_root, destination_root,
                                                    context, default_strategy, overrides, replacements, config = nil, &merge_callback)
  result = Ast::Merge.apply_template_tree_execution_to_directory(
    template_root,
    destination_root,
    context,
    default_strategy,
    overrides,
    replacements,
    config,
    &merge_callback
  )
  report_template_directory_session(:reapply, result[:execution_plan], result)
end

.registered_adapter_families(registry) ⇒ Object 



180
181
182
 
# File 'lib/ast/template.rb', line 180

def registered_adapter_families(registry)
  registry.keys.map(&:to_s).sort
end

.render_readme_family_section(template_partial, family_metadata, config = nil) ⇒ Object 



71
72
73
74
 
# File 'lib/ast/template.rb', line 71

def render_readme_family_section(template_partial, family_metadata, config = nil)
  replacements = readme_family_token_values(family_metadata).transform_keys { |key| "SM|#{key}" }
  Ast::Merge.resolve_template_tokens(template_partial.to_s, replacements, config)
end

.report_adapter_capabilities(entries, registry) ⇒ Object 



350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/ast/template.rb', line 350

def report_adapter_capabilities(entries, registry)
  available = registered_adapter_families(registry)
  required = required_families(entries)
  missing = required - available
  {
    required_families: required,
    adapter_families: available,
    missing_families: missing,
    ready: missing.empty?
  }
end

.report_adapter_capabilities_from_directories(template_root, destination_root, context, default_strategy, overrides, replacements, registry, config = nil) ⇒ Object 



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/ast/template.rb', line 362

def report_adapter_capabilities_from_directories(template_root, destination_root,
                                                 context, default_strategy, overrides, replacements, registry, config = nil)
  entries = Ast::Merge.plan_template_tree_execution_from_directories(
    template_root,
    destination_root,
    context,
    default_strategy,
    overrides,
    replacements,
    config
  )
  report_adapter_capabilities(entries, registry)
end

.report_default_adapter_capabilities_from_directories(template_root, destination_root, context, default_strategy, overrides, replacements, allowed_families = nil, config = nil) ⇒ Object 



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/ast/template.rb', line 376

def report_default_adapter_capabilities_from_directories(template_root, destination_root,
                                                         context, default_strategy, overrides, replacements, allowed_families = nil, config = nil)
  report_adapter_capabilities_from_directories(
    template_root,
    destination_root,
    context,
    default_strategy,
    overrides,
    replacements,
    default_family_merge_adapter_registry(allowed_families),
    config
  )
end

.report_session_request_from_runner_request(request, profiles = {}) ⇒ Object 



1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
 
# File 'lib/ast/template.rb', line 1401

def report_session_request_from_runner_request(request, profiles = {})
  normalized = deep_dup(request)
  if (normalized[:request_kind] || normalized['request_kind']).to_s == 'profile'
    return report_template_directory_session_profile_request(
      profiles,
      normalized[:profile_name] || normalized['profile_name'],
      normalized[:overrides] || normalized['overrides'] || {}
    )
  end

  report_template_directory_session_options_request(
    normalized[:options] || normalized['options'] || {}
  )
end

.report_template_directory_registry_session(mode, entries, registry, result = nil) ⇒ Object

Raises:

  • (ArgumentError) 


184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/ast/template.rb', line 184

def report_template_directory_registry_session(mode, entries, registry, result = nil)
  normalized_mode = mode.to_s
  raise ArgumentError, "unsupported template session mode: #{mode}" unless MODES.include?(normalized_mode)

  {
    mode: normalized_mode,
    adapter_families: registered_adapter_families(registry),
    diagnostics: Array(result&.dig(:apply_result, :diagnostics) || result&.dig('apply_result', 'diagnostics')),
    runner_report: Ast::Merge.report_template_directory_runner(entries, result)
  }
end

.report_template_directory_session(mode, entries, result = nil) ⇒ Object

Raises:

  • (ArgumentError) 


257
258
259
260
261
262
263
264
265
 
# File 'lib/ast/template.rb', line 257

def report_template_directory_session(mode, entries, result = nil)
  normalized_mode = mode.to_s
  raise ArgumentError, "unsupported template session mode: #{mode}" unless MODES.include?(normalized_mode)

  {
    mode: normalized_mode,
    runner_report: Ast::Merge.report_template_directory_runner(entries, result)
  }
end

.report_template_directory_session_configuration_outcome(mode, diagnostics) ⇒ Object 



860
861
862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/ast/template.rb', line 860

def report_template_directory_session_configuration_outcome(mode, diagnostics)
  report_template_directory_session_outcome(
    report_template_directory_session(mode, []),
    {
      mode: mode,
      ready: false,
      missing_families: [],
      blocked_paths: [],
      planned_write_count: 0,
      written_count: 0
    },
    diagnostics
  )
end

.report_template_directory_session_diagnostics(mode, entries, adapter_capabilities, result = nil) ⇒ Object 



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/ast/template.rb', line 501

def report_template_directory_session_diagnostics(mode, entries, adapter_capabilities, result = nil)
  missing_families = Array(
    adapter_capabilities[:missing_families] || adapter_capabilities['missing_families']
  ).map(&:to_s)
  blocked_apply_paths = Array(
    result&.dig(:apply_report, :entries) || result&.dig('apply_report', 'entries')
  ).filter_map do |entry|
    destination_path = entry[:destination_path] || entry['destination_path']
    status = entry[:status] || entry['status']
    destination_path if status.to_s == 'blocked' && destination_path
  end

  diagnostics = Array(entries).flat_map do |entry|
    path = entry[:destination_path] || entry['destination_path'] ||
           entry[:logical_destination_path] || entry['logical_destination_path']
    family = entry.dig(:classification, :family) || entry.dig('classification', 'family')
    result_entries = []
    block_reason = entry[:block_reason] || entry['block_reason']
    if (entry[:blocked] || entry['blocked']) && block_reason.to_s == 'unresolved_tokens'
      result_entries << {
        severity: 'error',
        category: 'configuration_error',
        reason: 'unresolved_tokens',
        path: path,
        message: "unresolved template tokens block #{path}"
      }
    end
    if (entry[:execution_action] || entry['execution_action']).to_s == 'merge_prepared_content' &&
       missing_families.include?(family.to_s) &&
       (result.nil? || blocked_apply_paths.empty? || blocked_apply_paths.include?(path))
      result_entries << {
        severity: 'error',
        category: 'configuration_error',
        reason: 'missing_family_adapter',
        path: path,
        family: family.to_s,
        message: "missing family adapter for #{family} blocks #{path}"
      }
    end
    result_entries
  end.sort_by { |entry| [entry[:path].to_s, entry[:reason].to_s, entry[:family].to_s] }

  {
    mode: mode.to_s,
    ready: diagnostics.empty?,
    diagnostics: diagnostics
  }
end

.report_template_directory_session_entrypoint(entrypoint) ⇒ Object 



1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'lib/ast/template.rb', line 1113

def report_template_directory_session_entrypoint(entrypoint)
  normalized = deep_dup(entrypoint)
  if normalized[:payload] || normalized['payload']
    return {
      source_kind: 'payload',
      runner_request: report_template_directory_session_runner_input(
        report_template_directory_session_runner_payload(
          normalized[:payload] || normalized['payload']
        )
      )
    }
  end

  if normalized[:request] || normalized['request']
    return {
      source_kind: 'request',
      runner_request: normalized[:request] || normalized['request']
    }
  end

  {
    source_kind: '',
    runner_request: { request_kind: 'options' }
  }
end

.report_template_directory_session_envelope(session_report, adapter_capabilities) ⇒ Object 



390
391
392
393
394
395
 
# File 'lib/ast/template.rb', line 390

def report_template_directory_session_envelope(session_report, adapter_capabilities)
  {
    session_report: session_report,
    adapter_capabilities: adapter_capabilities
  }
end

.report_template_directory_session_inspection(entrypoint, profiles = {}) ⇒ Object 



1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'lib/ast/template.rb', line 1151

def report_template_directory_session_inspection(entrypoint, profiles = {})
  entrypoint_report = report_template_directory_session_entrypoint(entrypoint)
  session_resolution = report_template_directory_session_resolution(entrypoint, profiles)
  session_request = session_resolution[:session_request]

  unless session_request[:ready] && session_request[:resolved_options]
    return {
      entrypoint_report: entrypoint_report,
      session_resolution: session_resolution,
      adapter_capabilities: {
        required_families: [],
        adapter_families: [],
        missing_families: [],
        ready: false
      },
      status: {
        mode: session_request[:mode],
        ready: false,
        missing_families: [],
        blocked_paths: [],
        planned_write_count: 0,
        written_count: 0
      },
      diagnostics: {
        mode: session_request[:mode],
        ready: false,
        diagnostics: session_request[:diagnostics]
      }
    }
  end

  resolved = session_request[:resolved_options]
  adapter_capabilities = report_default_adapter_capabilities_from_directories(
    resolved[:template_root],
    resolved[:destination_root],
    resolved[:context],
    resolved[:default_strategy],
    resolved[:overrides],
    resolved[:replacements],
    resolved[:allowed_families],
    resolved[:config]
  )
  session_report = plan_template_directory_session_from_directories(
    resolved[:template_root],
    resolved[:destination_root],
    resolved[:context],
    resolved[:default_strategy],
    resolved[:overrides],
    resolved[:replacements],
    resolved[:config]
  )

  {
    entrypoint_report: entrypoint_report,
    session_resolution: session_resolution,
    adapter_capabilities: adapter_capabilities,
    status: report_template_directory_session_status(
      report_template_directory_session_envelope(session_report, adapter_capabilities)
    ),
    diagnostics: plan_template_directory_session_diagnostics_from_directories(
      resolved[:template_root],
      resolved[:destination_root],
      resolved[:context],
      resolved[:default_strategy],
      resolved[:overrides],
      resolved[:replacements],
      resolved[:allowed_families],
      resolved[:config]
    )
  }
end

.report_template_directory_session_options_configuration(options) ⇒ Object 



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/ast/template.rb', line 781

def report_template_directory_session_options_configuration(options)
  normalized = deep_dup(options)
  diagnostics = []
  unless (normalized[:destination_root] || normalized['destination_root']).to_s.length.positive?
    diagnostics << {
      severity: 'error',
      category: 'configuration_error',
      reason: 'missing_destination_root',
      message: 'missing destination_root for template session'
    }
  end
  unless (normalized[:template_root] || normalized['template_root']).to_s.length.positive?
    diagnostics << {
      severity: 'error',
      category: 'configuration_error',
      reason: 'missing_template_root',
      message: 'missing template_root for template session'
    }
  end
  diagnostics.sort_by! { |entry| entry[:reason] }
  {
    mode: normalize_session_mode(normalized[:mode] || normalized['mode']),
    ready: diagnostics.empty?,
    diagnostics: diagnostics
  }
end

.report_template_directory_session_options_request(options) ⇒ Object 



808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/ast/template.rb', line 808

def report_template_directory_session_options_request(options)
  normalized = deep_dup(options)
  configuration = report_template_directory_session_options_configuration(normalized)
  {
    request_kind: 'options',
    mode: configuration[:mode],
    ready: configuration[:ready],
    diagnostics: deep_dup(configuration[:diagnostics]),
    resolved_options: configuration[:ready] ? compact_session_request_options(normalized) : nil
  }
end

.report_template_directory_session_outcome(session_report, status, diagnostics) ⇒ Object 



613
614
615
616
617
618
619
 
# File 'lib/ast/template.rb', line 613

def report_template_directory_session_outcome(session_report, status, diagnostics)
  {
    session_report: session_report,
    status: status,
    diagnostics: diagnostics
  }
end

.report_template_directory_session_profile_configuration(profiles, profile_name, overrides) ⇒ Object 



820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/ast/template.rb', line 820

def report_template_directory_session_profile_configuration(profiles, profile_name, overrides)
  normalized_profiles = deep_dup(profiles)
  normalized_overrides = deep_dup(overrides)
  diagnostics = report_template_directory_session_options_configuration(normalized_overrides)[:diagnostics]
  profile = normalized_profiles[profile_name.to_s] || normalized_profiles[profile_name.to_sym]
  mode = normalize_session_mode(
    normalized_overrides[:mode] || normalized_overrides['mode'] || profile&.[](:mode) || profile&.[]('mode')
  )
  unless profile
    diagnostics << {
      severity: 'error',
      category: 'configuration_error',
      reason: 'missing_profile',
      message: "unknown template session profile: #{profile_name}"
    }
  end
  diagnostics.sort_by! { |entry| entry[:reason] }
  {
    mode: mode,
    ready: diagnostics.empty?,
    diagnostics: diagnostics
  }
end

.report_template_directory_session_profile_request(profiles, profile_name, overrides) ⇒ Object 



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'lib/ast/template.rb', line 844

def report_template_directory_session_profile_request(profiles, profile_name, overrides)
  configuration = report_template_directory_session_profile_configuration(profiles, profile_name, overrides)
  {
    request_kind: 'profile',
    profile_name: profile_name.to_s,
    mode: configuration[:mode],
    ready: configuration[:ready],
    diagnostics: deep_dup(configuration[:diagnostics]),
    resolved_options: if configuration[:ready]
                        compact_session_request_options(
                          resolve_template_directory_session_options(profiles, profile_name, overrides)
                        )
                      end
  }
end

.report_template_directory_session_resolution(entrypoint, profiles = {}) ⇒ Object 



1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
 
# File 'lib/ast/template.rb', line 1139

def report_template_directory_session_resolution(entrypoint, profiles = {})
  entrypoint_report = report_template_directory_session_entrypoint(entrypoint)
  {
    source_kind: entrypoint_report[:source_kind],
    runner_request: entrypoint_report[:runner_request],
    session_request: report_session_request_from_runner_request(
      entrypoint_report[:runner_request],
      profiles
    )
  }
end

.report_template_directory_session_runner_input(input) ⇒ Object 



980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'lib/ast/template.rb', line 980

def report_template_directory_session_runner_input(input)
  normalized = deep_dup(input)
  request_kind = (normalized[:request_kind] || normalized['request_kind']).to_s
  options = {
    mode: normalized[:mode] || normalized['mode'],
    template_root: normalized[:template_root] || normalized['template_root'],
    destination_root: normalized[:destination_root] || normalized['destination_root'],
    context: normalized[:context] || normalized['context'] || {},
    default_strategy: normalized[:default_strategy] || normalized['default_strategy'] || 'merge',
    overrides: normalized[:overrides] || normalized['overrides'] || [],
    replacements: normalized[:replacements] || normalized['replacements'] || {},
    allowed_families: if normalized.key?(:allowed_families) || normalized.key?('allowed_families')
                        normalized[:allowed_families] || normalized['allowed_families']
                      end
  }
  if request_kind == 'profile'
    return {
      request_kind: 'profile',
      profile_name: normalized[:profile_name] || normalized['profile_name'],
      overrides: begin
        sparse = {
          mode: normalized[:mode] || normalized['mode'],
          template_root: normalized[:template_root] || normalized['template_root'],
          destination_root: normalized[:destination_root] || normalized['destination_root']
        }
        context = normalized[:context] || normalized['context']
        sparse[:context] = context if context.is_a?(Hash) && (context[:project_name] || context['project_name'])
        strategy = normalized[:default_strategy] || normalized['default_strategy']
        sparse[:default_strategy] = strategy if strategy && strategy != 'merge'
        overrides = normalized[:overrides] || normalized['overrides']
        sparse[:overrides] = overrides if overrides.is_a?(Array) && !overrides.empty?
        replacements = normalized[:replacements] || normalized['replacements']
        sparse[:replacements] = replacements if replacements.is_a?(Hash) && !replacements.empty?
        allowed_families = normalized.key?(:allowed_families) ? normalized[:allowed_families] : normalized['allowed_families']
        sparse[:allowed_families] = allowed_families unless allowed_families.nil?
        sparse
      end
    }
  end

  {
    request_kind: 'options',
    options: options
  }
end

.report_template_directory_session_runner_payload(payload) ⇒ Object 



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/ast/template.rb', line 1026

def report_template_directory_session_runner_payload(payload)
  normalized = deep_dup(payload)
  request_kind = normalized[:request_kind] || normalized['request_kind']
  request_kind = if request_kind.to_s.empty?
                   if normalized.key?(:profile_name) || normalized.key?('profile_name') ||
                      normalized.key?(:default_profile_name) || normalized.key?('default_profile_name')
                     'profile'
                   else
                     'options'
                   end
                 else
                   request_kind.to_s
                 end

  result = {
    request_kind: request_kind,
    mode: normalized[:mode] || normalized['mode'],
    template_root: normalized[:template_root] || normalized['template_root'],
    destination_root: normalized[:destination_root] || normalized['destination_root'],
    context: normalized[:context] || normalized['context'] || {},
    default_strategy: normalized[:default_strategy] || normalized['default_strategy'] || 'merge',
    overrides: normalized[:overrides] || normalized['overrides'] || [],
    replacements: normalized[:replacements] || normalized['replacements'] || {},
    allowed_families: if normalized.key?(:allowed_families) || normalized.key?('allowed_families')
                        normalized.key?(:allowed_families) ? normalized[:allowed_families] : normalized['allowed_families']
                      end
  }
  profile_name = normalized[:profile_name] || normalized['profile_name'] ||
                 normalized[:default_profile_name] || normalized['default_profile_name']
  result[:profile_name] = profile_name if profile_name
  result
end

.report_template_directory_session_status(envelope) ⇒ Object 



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
 
# File 'lib/ast/template.rb', line 448

def report_template_directory_session_status(envelope)
  session_report = envelope[:session_report] || envelope['session_report'] || {}
  adapter_capabilities = envelope[:adapter_capabilities] || envelope['adapter_capabilities'] || {}
  runner_report = session_report[:runner_report] || session_report['runner_report'] || {}
  plan_report = runner_report[:plan_report] || runner_report['plan_report'] || {}
  entries = Array(plan_report[:entries] || plan_report['entries'])
  plan_summary = plan_report[:summary] || plan_report['summary'] || {}
  apply_report = runner_report[:apply_report] || runner_report['apply_report'] || {}
  apply_entries = Array(apply_report[:entries] || apply_report['entries'])
  apply_summary = apply_report[:summary] || apply_report['summary'] || {}
  blocked_paths = (entries + apply_entries).filter_map do |entry|
    status = entry[:status] || entry['status']
    destination_path = entry[:destination_path] || entry['destination_path']
    destination_path if status.to_s == 'blocked' && destination_path
  end.uniq.sort
  missing_families = Array(
    adapter_capabilities[:missing_families] || adapter_capabilities['missing_families']
  ).map(&:to_s).sort

  {
    mode: (session_report[:mode] || session_report['mode']).to_s,
    ready: !(adapter_capabilities[:ready] || adapter_capabilities['ready']).nil? && blocked_paths.empty?,
    missing_families: missing_families,
    blocked_paths: blocked_paths,
    planned_write_count: plan_summary.fetch(:create, plan_summary.fetch('create', 0)) +
      plan_summary.fetch(:update, plan_summary.fetch('update', 0)),
    written_count: apply_summary.fetch(:written, apply_summary.fetch('written', 0))
  }
end

.required_families(entries) ⇒ Object 



342
343
344
345
346
347
348
 
# File 'lib/ast/template.rb', line 342

def required_families(entries)
  Array(entries).filter_map do |entry|
    next unless (entry[:execution_action] || entry['execution_action']).to_s == 'merge_prepared_content'

    entry.dig(:classification, :family) || entry.dig('classification', 'family')
  end.uniq.sort
end

.resolve_template_directory_session_options(profiles, profile_name, overrides) ⇒ Object 



1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/ast/template.rb', line 1416

def resolve_template_directory_session_options(profiles, profile_name, overrides)
  profile = profiles[profile_name.to_s] || profiles[profile_name.to_sym]
  return nil unless profile

  normalized_profile = deep_dup(profile)
  normalized_overrides = deep_dup(overrides)
  {
    mode: normalized_overrides[:mode] || normalized_overrides['mode'] ||
      normalized_profile[:mode] || normalized_profile['mode'],
    template_root: normalized_overrides[:template_root] || normalized_overrides['template_root'],
    destination_root: normalized_overrides[:destination_root] || normalized_overrides['destination_root'],
    context: normalized_overrides[:context] || normalized_overrides['context'] ||
      normalized_profile[:context] || normalized_profile['context'] || {},
    default_strategy: normalized_overrides[:default_strategy] || normalized_overrides['default_strategy'] ||
      normalized_profile[:default_strategy] || normalized_profile['default_strategy'],
    overrides: normalized_overrides[:overrides] || normalized_overrides['overrides'] ||
      normalized_profile[:overrides] || normalized_profile['overrides'] || [],
    replacements: normalized_overrides[:replacements] || normalized_overrides['replacements'] ||
      normalized_profile[:replacements] || normalized_profile['replacements'] || {},
    allowed_families: normalized_overrides[:allowed_families] || normalized_overrides['allowed_families'] ||
      normalized_profile[:allowed_families] || normalized_profile['allowed_families'],
    config: normalized_overrides[:config] || normalized_overrides['config'] ||
      normalized_profile[:config] || normalized_profile['config']
  }
end

.run_readme_family_section_command(command, config = nil) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/ast/template.rb', line 106

def run_readme_family_section_command(command, config = nil)
  normalized = Ast::Merge.normalize_value(command || {})
  mode = normalized.fetch(:mode, 'plan').to_s
  write_changes = %w[apply reapply].include?(mode)
  {
    profile_name: normalized.fetch(:profile_name, '').to_s,
    mode: mode,
    runner: run_readme_family_sections_for_package_directories(
      normalized.fetch(:root, '').to_s,
      normalized.fetch(:template_partial, '').to_s,
      Array(normalized[:packages]),
      write_changes,
      config
    )
  }
end

.run_readme_family_sections_for_package_directories(root, template_partial, packages, write_changes, config = nil) ⇒ Object 



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
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/ast/template.rb', line 123

def run_readme_family_sections_for_package_directories(root, template_partial, packages, write_changes,
                                                       config = nil)
  report = {
    package_count: packages.length,
    changed_count: 0,
    created_count: 0,
    entries: []
  }
  packages.each do |package_entry|
    normalized_entry = Ast::Merge.normalize_value(package_entry)
    readme_path = normalized_entry.fetch(:readme_path).to_s
    full_path = File.join(root.to_s, readme_path.split('/'))
    created = !File.exist?(full_path)
    destination_content = created ? nil : File.read(full_path)
    application = apply_readme_family_section(
      template_partial,
      normalized_entry.fetch(:package, {}),
      normalized_entry.fetch(:family, {}),
      destination_content,
      config
    )
    if application[:changed]
      if write_changes
        FileUtils.mkdir_p(File.dirname(full_path))
        File.write(full_path, application[:content])
      end
      report[:changed_count] += 1
      report[:created_count] += 1 if created
    end
    report[:entries] << {
      id: normalized_entry.fetch(:id).to_s,
      readme_path: readme_path,
      changed: application[:changed],
      created: created && application[:changed]
    }
  end
  report
end

.run_template_directory_session(invocation, profiles = {}) ⇒ Object 



1300
1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/ast/template.rb', line 1300

def run_template_directory_session(invocation, profiles = {})
  normalized = deep_dup(invocation)
  if normalized[:payload] || normalized['payload'] || normalized[:request] || normalized['request']
    return run_template_directory_session_command(normalized, profiles)
  end

  run_template_directory_session_command_payload(normalized, profiles)
end

.run_template_directory_session_command(command, profiles = {}) ⇒ Object 



1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/ast/template.rb', line 1265

def run_template_directory_session_command(command, profiles = {})
  normalized = deep_dup(command)
  run_template_directory_session_dispatch(
    normalized[:operation] || normalized['operation'],
    {
      payload: normalized[:payload] || normalized['payload'],
      request: normalized[:request] || normalized['request']
    },
    profiles
  )
end

.run_template_directory_session_command_payload(command, profiles = {}) ⇒ Object 



1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
 
# File 'lib/ast/template.rb', line 1277

def run_template_directory_session_command_payload(command, profiles = {})
  normalized = deep_dup(command)
  run_template_directory_session_command(
    {
      operation: normalized[:operation] || normalized['operation'],
      payload: {
        request_kind: normalized[:request_kind] || normalized['request_kind'],
        default_profile_name: normalized[:default_profile_name] || normalized['default_profile_name'],
        profile_name: normalized[:profile_name] || normalized['profile_name'],
        mode: normalized[:mode] || normalized['mode'],
        template_root: normalized[:template_root] || normalized['template_root'],
        destination_root: normalized[:destination_root] || normalized['destination_root'],
        context: normalized[:context] || normalized['context'],
        default_strategy: normalized[:default_strategy] || normalized['default_strategy'],
        overrides: normalized[:overrides] || normalized['overrides'],
        replacements: normalized[:replacements] || normalized['replacements'],
        allowed_families: normalized.key?(:allowed_families) ? normalized[:allowed_families] : normalized['allowed_families']
      }
    },
    profiles
  )
end

.run_template_directory_session_dispatch(operation, entrypoint, profiles = {}) ⇒ Object 



1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/ast/template.rb', line 1246

def run_template_directory_session_dispatch(operation, entrypoint, profiles = {})
  case operation.to_s
  when 'inspect'
    {
      operation: operation.to_s,
      inspection: report_template_directory_session_inspection(entrypoint, profiles),
      outcome: nil
    }
  when 'run'
    {
      operation: operation.to_s,
      inspection: nil,
      outcome: run_template_directory_session_entrypoint(entrypoint, profiles)
    }
  else
    raise ArgumentError, "unsupported template directory session operation: #{operation}"
  end
end

.run_template_directory_session_entrypoint(entrypoint, profiles = {}) ⇒ Object 



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'lib/ast/template.rb', line 1091

def run_template_directory_session_entrypoint(entrypoint, profiles = {})
  normalized = deep_dup(entrypoint)
  if normalized[:payload] || normalized['payload']
    return run_template_directory_session_runner_payload(
      normalized[:payload] || normalized['payload'],
      profiles
    )
  end

  if normalized[:request] || normalized['request']
    return run_template_directory_session_runner_request(
      normalized[:request] || normalized['request'],
      profiles
    )
  end

  report_template_directory_session_configuration_outcome(
    'plan',
    { mode: 'plan', ready: false, diagnostics: [] }
  )
end

.run_template_directory_session_request(request) ⇒ Object 



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/ast/template.rb', line 898

def run_template_directory_session_request(request)
  normalized = deep_dup(request)
  unless normalized[:ready] || normalized['ready']
    mode = normalized[:mode] || normalized['mode']
    diagnostics = normalized[:diagnostics] || normalized['diagnostics'] || []
    return report_template_directory_session_configuration_outcome(
      mode,
      { mode: mode, ready: false, diagnostics: diagnostics }
    )
  end

  run_template_directory_session_with_options(
    normalized[:resolved_options] || normalized['resolved_options']
  )
end

.run_template_directory_session_runner_payload(payload, profiles = {}) ⇒ Object 



1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'lib/ast/template.rb', line 1059

def run_template_directory_session_runner_payload(payload, profiles = {})
  run_template_directory_session_runner_request(
    report_template_directory_session_runner_input(
      report_template_directory_session_runner_payload(payload)
    ),
    profiles
  )
end

.run_template_directory_session_runner_request(request, profiles = {}) ⇒ Object 



937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
 
# File 'lib/ast/template.rb', line 937

def run_template_directory_session_runner_request(request, profiles = {})
  normalized = deep_dup(request)
  request_kind = normalized[:request_kind] || normalized['request_kind']
  if request_kind.to_s == 'profile'
    return run_template_directory_session_request(
      report_template_directory_session_profile_request(
        profiles,
        normalized[:profile_name] || normalized['profile_name'],
        normalized[:overrides] || normalized['overrides'] || {}
      )
    )
  end

  run_template_directory_session_request(
    report_template_directory_session_options_request(
      normalized[:options] || normalized['options'] || {}
    )
  )
end

.run_template_directory_session_with_default_registry_to_directory(mode, template_root, destination_root, context, default_strategy, overrides, replacements, allowed_families = nil, config = nil) ⇒ Object 



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
 
# File 'lib/ast/template.rb', line 718

def run_template_directory_session_with_default_registry_to_directory(mode, template_root, destination_root,
                                                                      context, default_strategy, overrides, replacements, allowed_families = nil, config = nil)
  case mode.to_s
  when 'plan'
    plan_template_directory_session_outcome_from_directories(
      template_root,
      destination_root,
      context,
      default_strategy,
      overrides,
      replacements,
      allowed_families,
      config
    )
  when 'apply'
    apply_template_directory_session_outcome_with_default_registry_to_directory(
      template_root,
      destination_root,
      context,
      default_strategy,
      overrides,
      replacements,
      allowed_families,
      config
    )
  when 'reapply'
    reapply_template_directory_session_outcome_with_default_registry_to_directory(
      template_root,
      destination_root,
      context,
      default_strategy,
      overrides,
      replacements,
      allowed_families,
      config
    )
  else
    raise ArgumentError, "unsupported template session mode: #{mode}"
  end
end

.run_template_directory_session_with_options(options) ⇒ Object 



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'lib/ast/template.rb', line 759

def run_template_directory_session_with_options(options)
  request = report_template_directory_session_options_request(options)
  unless request[:ready]
    return report_template_directory_session_configuration_outcome(
      request[:mode],
      { mode: request[:mode], ready: request[:ready], diagnostics: request[:diagnostics] }
    )
  end
  normalized = deep_dup(request[:resolved_options])
  run_template_directory_session_with_default_registry_to_directory(
    normalized[:mode] || normalized['mode'],
    normalized[:template_root] || normalized['template_root'],
    normalized[:destination_root] || normalized['destination_root'],
    normalized[:context] || normalized['context'] || {},
    normalized[:default_strategy] || normalized['default_strategy'],
    normalized[:overrides] || normalized['overrides'] || [],
    normalized[:replacements] || normalized['replacements'] || {},
    normalized[:allowed_families] || normalized['allowed_families'],
    normalized[:config] || normalized['config']
  )
end

.run_template_directory_session_with_profile(profiles, profile_name, overrides) ⇒ Object 



1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
 
# File 'lib/ast/template.rb', line 1442

def run_template_directory_session_with_profile(profiles, profile_name, overrides)
  request = report_template_directory_session_profile_request(profiles, profile_name, overrides)
  unless request[:ready]
    return report_template_directory_session_configuration_outcome(
      request[:mode],
      { mode: request[:mode], ready: request[:ready], diagnostics: request[:diagnostics] }
    )
  end

  run_template_directory_session_with_options(request[:resolved_options])
end

.template_directory_session_command_envelope(command) ⇒ Object 



1332
1333
1334
1335
1336
1337
1338
 
# File 'lib/ast/template.rb', line 1332

def template_directory_session_command_envelope(command)
  {
    kind: 'template_directory_session_command',
    version: SESSION_COMMAND_TRANSPORT_VERSION,
    command: deep_dup(command)
  }
end

.template_directory_session_command_payload_envelope(payload) ⇒ Object 



1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/ast/template.rb', line 1355

def template_directory_session_command_payload_envelope(payload)
  {
    kind: 'template_directory_session_command_payload',
    version: SESSION_COMMAND_PAYLOAD_TRANSPORT_VERSION,
    payload: deep_dup(payload)
  }
end

.template_directory_session_diagnostics_envelope(diagnostics) ⇒ Object 



550
551
552
553
554
555
556
 
# File 'lib/ast/template.rb', line 550

def template_directory_session_diagnostics_envelope(diagnostics)
  {
    kind: 'template_directory_session_diagnostics',
    version: SESSION_DIAGNOSTICS_TRANSPORT_VERSION,
    diagnostics: deep_dup(diagnostics)
  }
end

.template_directory_session_entrypoint_envelope(entrypoint) ⇒ Object 



1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/ast/template.rb', line 1309

def template_directory_session_entrypoint_envelope(entrypoint)
  {
    kind: 'template_directory_session_entrypoint',
    version: SESSION_ENTRYPOINT_TRANSPORT_VERSION,
    entrypoint: deep_dup(entrypoint)
  }
end

.template_directory_session_inspection_envelope(inspection) ⇒ Object 



1223
1224
1225
1226
1227
1228
1229
 
# File 'lib/ast/template.rb', line 1223

def template_directory_session_inspection_envelope(inspection)
  {
    kind: 'template_directory_session_inspection',
    version: SESSION_INSPECTION_TRANSPORT_VERSION,
    inspection: deep_dup(inspection)
  }
end

.template_directory_session_invocation_envelope(invocation) ⇒ Object 



1378
1379
1380
1381
1382
1383
1384
 
# File 'lib/ast/template.rb', line 1378

def template_directory_session_invocation_envelope(invocation)
  {
    kind: 'template_directory_session_invocation',
    version: SESSION_INVOCATION_TRANSPORT_VERSION,
    invocation: deep_dup(invocation)
  }
end

.template_directory_session_outcome_envelope(outcome) ⇒ Object 



875
876
877
878
879
880
881
 
# File 'lib/ast/template.rb', line 875

def template_directory_session_outcome_envelope(outcome)
  {
    kind: 'template_directory_session_outcome',
    version: SESSION_OUTCOME_TRANSPORT_VERSION,
    outcome: deep_dup(outcome)
  }
end

.template_directory_session_request_envelope(request) ⇒ Object 



914
915
916
917
918
919
920
 
# File 'lib/ast/template.rb', line 914

def template_directory_session_request_envelope(request)
  {
    kind: 'template_directory_session_request',
    version: SESSION_REQUEST_TRANSPORT_VERSION,
    request: deep_dup(request)
  }
end

.template_directory_session_runner_payload_envelope(payload) ⇒ Object 



1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/ast/template.rb', line 1068

def template_directory_session_runner_payload_envelope(payload)
  {
    kind: 'template_directory_session_runner_payload',
    version: SESSION_RUNNER_PAYLOAD_TRANSPORT_VERSION,
    payload: deep_dup(payload)
  }
end

.template_directory_session_runner_request_envelope(request) ⇒ Object 



957
958
959
960
961
962
963
 
# File 'lib/ast/template.rb', line 957

def template_directory_session_runner_request_envelope(request)
  {
    kind: 'template_directory_session_runner_request',
    version: SESSION_RUNNER_REQUEST_TRANSPORT_VERSION,
    request: deep_dup(request)
  }
end

.template_directory_session_status_envelope(status) ⇒ Object 



478
479
480
481
482
483
484
 
# File 'lib/ast/template.rb', line 478

def template_directory_session_status_envelope(status)
  {
    kind: 'template_directory_session_status',
    version: SESSION_STATUS_TRANSPORT_VERSION,
    status: deep_dup(status)
  }
end