Module: Kettle::Dev::Tasks::TemplateTask
- Defined in:
- lib/kettle/dev/tasks/template_task.rb
Overview
Thin wrapper to expose the kettle:dev:template task logic as a callable API
for testability. The rake task should only call this method.
Constant Summary collapse
- MODULAR_GEMFILE_DIR =
"gemfiles/modular"
Class Method Summary collapse
-
.normalize_heading_spacing(text) ⇒ Object
Ensure every Markdown atx-style heading line has exactly one blank line before and after, skipping content inside fenced code blocks.
-
.run ⇒ Object
Execute the template operation into the current project.
-
.task_abort(msg) ⇒ Object
Abort wrapper that avoids terminating the entire process during specs.
Class Method Details
.normalize_heading_spacing(text) ⇒ Object
Ensure every Markdown atx-style heading line has exactly one blank line
before and after, skipping content inside fenced code blocks.
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# File 'lib/kettle/dev/tasks/template_task.rb', line 15 def normalize_heading_spacing(text) lines = text.split("\n", -1) out = [] in_fence = false fence_re = /^\s*```/ heading_re = /^\s*#+\s+.+/ lines.each_with_index do |ln, idx| if ln =~ fence_re in_fence = !in_fence out << ln next end if !in_fence && ln =~ heading_re prev_blank = out.empty? ? false : out.last.to_s.strip == "" out << "" unless out.empty? || prev_blank out << ln nxt = lines[idx + 1] out << "" unless nxt.to_s.strip == "" else out << ln end end # Collapse accidental multiple blanks collapsed = [] out.each do |l| if l.strip == "" && collapsed.last.to_s.strip == "" next end collapsed << l end collapsed.join("\n") end |
.run ⇒ Object
Execute the template operation into the current project.
All options/IO are controlled via TemplateHelpers and ENV.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 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 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 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 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 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 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 497 498 499 500 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 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 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 657 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 687 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 717 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 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 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 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 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 |
# File 'lib/kettle/dev/tasks/template_task.rb', line 55 def run # Inline the former rake task body, but using helpers directly. helpers = Kettle::Dev::TemplateHelpers project_root = helpers.project_root gem_checkout_root = helpers.gem_checkout_root # Ensure git working tree is clean before making changes (when run standalone) helpers.ensure_clean_git!(root: project_root, task_label: "kettle:dev:template") = helpers.(project_root) gem_name = [:gem_name] min_ruby = [:min_ruby] forge_org = [:forge_org] || [:gh_org] funding_org = [:funding_org] || forge_org entrypoint_require = [:entrypoint_require] namespace = [:namespace] namespace_shield = [:namespace_shield] gem_shield = [:gem_shield] # 1) .devcontainer directory helpers.copy_dir_with_prompt(File.join(gem_checkout_root, ".devcontainer"), File.join(project_root, ".devcontainer")) # 2) .github/**/*.yml with FUNDING.yml customizations source_github_dir = File.join(gem_checkout_root, ".github") if Dir.exist?(source_github_dir) # Build a unique set of logical .yml paths, preferring the .example variant when present candidates = Dir.glob(File.join(source_github_dir, "**", "*.yml")) + Dir.glob(File.join(source_github_dir, "**", "*.yml.example")) selected = {} candidates.each do |path| # Key by the path without the optional .example suffix key = path.sub(/\.example\z/, "") # Prefer example: overwrite a plain selection with .example, but do not downgrade if path.end_with?(".example") selected[key] = path else selected[key] ||= path end end # Parse optional include patterns (comma-separated globs relative to project root) include_raw = ENV["include"].to_s include_patterns = include_raw.split(",").map { |s| s.strip }.reject(&:empty?) matches_include = lambda do |abs_dest| return false if include_patterns.empty? begin rel_dest = abs_dest.to_s proj = project_root.to_s if rel_dest.start_with?(proj + "/") rel_dest = rel_dest[(proj.length + 1)..-1] elsif rel_dest == proj rel_dest = "" end include_patterns.any? do |pat| if pat.end_with?("/**") base = pat[0..-4] rel_dest == base || rel_dest.start_with?(base + "/") else File.fnmatch?(pat, rel_dest, File::FNM_PATHNAME | File::FNM_EXTGLOB | File::FNM_DOTMATCH) end end rescue StandardError => e Kettle::Dev.debug_error(e, __method__) false end end selected.values.each do |orig_src| src = helpers.prefer_example(orig_src) # Destination path should never include the .example suffix. rel = orig_src.sub(/^#{Regexp.escape(gem_checkout_root)}\/?/, "").sub(/\.example\z/, "") dest = File.join(project_root, rel) # Optional file: .github/workflows/discord-notifier.yml should NOT be copied by default. # Only copy when --include matches it. if rel == ".github/workflows/discord-notifier.yml" unless matches_include.call(dest) # Explicitly skip without prompting next end end if File.basename(rel) == "FUNDING.yml" helpers.copy_file_with_prompt(src, dest, allow_create: true, allow_replace: true) do |content| c = content.dup c = c.gsub(/^open_collective:\s+.*$/i) { |line| funding_org ? "open_collective: #{funding_org}" : line } if gem_name && !gem_name.empty? c = c.gsub(/^tidelift:\s+.*$/i, "tidelift: rubygems/#{gem_name}") end # Also apply common replacements for org/gem/namespace/shields helpers.apply_common_replacements( c, org: forge_org, funding_org: funding_org, gem_name: gem_name, namespace: namespace, namespace_shield: namespace_shield, gem_shield: gem_shield, min_ruby: min_ruby, ) end else helpers.copy_file_with_prompt(src, dest, allow_create: true, allow_replace: true) do |content| helpers.apply_common_replacements( content, org: forge_org, funding_org: funding_org, gem_name: gem_name, namespace: namespace, namespace_shield: namespace_shield, gem_shield: gem_shield, min_ruby: min_ruby, ) end end end end # 3) .qlty/qlty.toml helpers.copy_file_with_prompt( helpers.prefer_example(File.join(gem_checkout_root, ".qlty/qlty.toml")), File.join(project_root, ".qlty/qlty.toml"), allow_create: true, allow_replace: true, ) # 4) gemfiles/modular/* and nested directories (delegated for DRYness) Kettle::Dev::ModularGemfiles.sync!( helpers: helpers, project_root: project_root, gem_checkout_root: gem_checkout_root, min_ruby: min_ruby, ) # 5) spec/spec_helper.rb (no create) dest_spec_helper = File.join(project_root, "spec/spec_helper.rb") if File.file?(dest_spec_helper) old = File.read(dest_spec_helper) if old.include?('require "kettle/dev"') || old.include?("require 'kettle/dev'") replacement = %(require "#{entrypoint_require}") new_content = old.gsub(/require\s+["']kettle\/dev["']/, replacement) if new_content != old if helpers.ask("Replace require \"kettle/dev\" in spec/spec_helper.rb with #{replacement}?", true) helpers.write_file(dest_spec_helper, new_content) puts "Updated require in spec/spec_helper.rb" else puts "Skipped modifying spec/spec_helper.rb" end end end end # 6) .env.local special case: never read or touch .env.local from source; only copy .env.local.example to .env.local.example begin envlocal_src = File.join(gem_checkout_root, ".env.local.example") envlocal_dest = File.join(project_root, ".env.local.example") if File.exist?(envlocal_src) helpers.copy_file_with_prompt(envlocal_src, envlocal_dest, allow_create: true, allow_replace: true) end rescue StandardError => e Kettle::Dev.debug_error(e, __method__) puts "WARNING: Skipped .env.local example copy due to #{e.class}: #{e.}" end # 7) Root and other files # 7a) Special-case: gemspec example must be renamed to destination gem's name begin # Prefer the .example variant when present gemspec_template_src = helpers.prefer_example(File.join(gem_checkout_root, "kettle-dev.gemspec")) if File.exist?(gemspec_template_src) dest_gemspec = if gem_name && !gem_name.to_s.empty? File.join(project_root, "#{gem_name}.gemspec") else # Fallback rules: # 1) Prefer any existing gemspec in the destination project existing = Dir.glob(File.join(project_root, "*.gemspec")).sort.first if existing existing else # 2) If none, use the example file's name with ".example" removed fallback_name = File.basename(gemspec_template_src).sub(/\.example\z/, "") File.join(project_root, fallback_name) end end # If a destination gemspec already exists, get metadata from GemSpecReader via helpers = nil if File.exist?(dest_gemspec) begin = helpers.(File.dirname(dest_gemspec)) rescue StandardError => e Kettle::Dev.debug_error(e, __method__) = nil end end helpers.copy_file_with_prompt(gemspec_template_src, dest_gemspec, allow_create: true, allow_replace: true) do |content| # First apply standard replacements from the template example, but only # when we have a usable gem_name. If gem_name is unknown, leave content as-is # to allow filename fallback behavior without raising. c = if gem_name && !gem_name.to_s.empty? helpers.apply_common_replacements( content, org: forge_org, funding_org: funding_org, gem_name: gem_name, namespace: namespace, namespace_shield: namespace_shield, gem_shield: gem_shield, min_ruby: min_ruby, ) else content.dup end if # Replace a scalar string assignment like: spec.field = "..." replace_string_field = lambda do |txt, field, value| v = value.to_s txt.gsub(/(\bspec\.#{Regexp.escape(field)}\s*=\s*)(["']).*?(\2)/) do pre = Regexp.last_match(1) q = '"' pre + q + v.gsub('"', '\\"') + q end end # Replace an array assignment like: spec.field = ["a", "b"] replace_array_field = lambda do |txt, field, ary| ary = Array(ary).compact.map(&:to_s).reject(&:empty?).uniq # literal = "[" + arr.map { |e| '"' + e.gsub('"', '\\"') + '"' }.join(", ") + "]" literal = ary.inspect if txt =~ /(\bspec\.#{Regexp.escape(field)}\s*=\s*)\[[^\]]*\]/ txt.gsub(/(\bspec\.#{Regexp.escape(field)}\s*=\s*)\[[^\]]*\]/, "\\1#{literal}") else # If no existing assignment, insert a new line after spec.version if possible insert_after = (txt =~ /^\s*spec\.version\s*=.*$/) ? :version : nil if insert_after == :version txt.sub(/^(\s*spec\.version\s*=.*$)/) { |line| line + "\n spec.#{field} = #{literal}" } else txt + "\n spec.#{field} = #{literal}\n" end end end begin # 1. spec.name — retain original if (name = [:gem_name]) && !name.to_s.empty? c = replace_string_field.call(c, "name", name) end # 2. spec.authors — retain original, normalize to array orig_auth = [:authors] c = replace_array_field.call(c, "authors", orig_auth) # 3. spec.email — retain original, normalize to array orig_email = [:email] c = replace_array_field.call(c, "email", orig_email) # 4. spec.summary — retain original; grapheme emoji prefix handled by "install" task if (sum = [:summary]) && !sum.to_s.empty? c = replace_string_field.call(c, "summary", sum) end # 5. spec.description — retain original; grapheme emoji prefix handled by "install" task if (desc = [:description]) && !desc.to_s.empty? c = replace_string_field.call(c, "description", desc) end # 6. spec.licenses — retain original, normalize to array lic = [:licenses] if lic && !lic.empty? c = replace_array_field.call(c, "licenses", lic) end # 7. spec.required_ruby_version — retain original if (rrv = [:required_ruby_version].to_s) && !rrv.empty? c = replace_string_field.call(c, "required_ruby_version", rrv) end # 8. spec.require_paths — retain original, normalize to array req_paths = [:require_paths] unless req_paths.empty? c = replace_array_field.call(c, "require_paths", req_paths) end # 9. spec.bindir — retain original if (bd = [:bindir]) && !bd.to_s.empty? c = replace_string_field.call(c, "bindir", bd) end # 10. spec.executables — retain original, normalize to array exes = [:executables] unless exes.empty? c = replace_array_field.call(c, "executables", exes) end rescue StandardError => e Kettle::Dev.debug_error(e, __method__) # Best-effort carry-over; ignore any individual failure end end # Ensure we do not introduce a self-dependency when templating the gemspec. # If the template included a dependency on the template gem (e.g., "kettle-dev"), # the common replacements would have turned it into the destination gem's name. # Strip any dependency lines that name the destination gem. begin if gem_name && !gem_name.to_s.empty? name_escaped = Regexp.escape(gem_name) # Matches both runtime and development dependency lines, with or without parentheses. # Examples matched: # spec.add_dependency("my-gem", "~> 1.0") # spec.add_dependency 'my-gem' # spec.add_development_dependency "my-gem" # spec.add_development_dependency 'my-gem', ">= 0" self_dep_re = /\A\s*spec\.add_(?:development_)?dependency(?:\s*\(|\s+)\s*["']#{name_escaped}["'][^\n]*\)?\s*\z/ c = c.lines.reject { |ln| self_dep_re =~ ln }.join end rescue StandardError => e Kettle::Dev.debug_error(e, __method__) # If anything goes wrong, keep the content as-is rather than failing the task end c end end rescue StandardError => e Kettle::Dev.debug_error(e, __method__) # Do not fail the entire template task if gemspec copy has issues end files_to_copy = %w[ .aiignore .envrc .gitignore .gitlab-ci.yml .junie/guidelines-rbs.md .junie/guidelines.md .licenserc.yaml .opencollective.yml .rspec .rubocop.yml .rubocop_rspec.yml .simplecov .tool-versions .yard_gfm_support.rb .yardopts Appraisal.root.gemfile Appraisals CHANGELOG.md CITATION.cff CODE_OF_CONDUCT.md CONTRIBUTING.md FUNDING.md Gemfile README.md RUBOCOP.md Rakefile SECURITY.md ] # Snapshot existing README content once (for H1 prefix preservation after write) existing_readme_before = begin path = File.join(project_root, "README.md") File.file?(path) ? File.read(path) : nil rescue StandardError => e Kettle::Dev.debug_error(e, __method__) nil end files_to_copy.each do |rel| src = helpers.prefer_example(File.join(gem_checkout_root, rel)) dest = File.join(project_root, rel) next unless File.exist?(src) if File.basename(rel) == "README.md" # Precompute destination README H1 prefix (emoji(s) or first grapheme) before any overwrite occurs prev_readme = File.exist?(dest) ? File.read(dest) : nil begin if prev_readme first_h1_prev = prev_readme.lines.find { |ln| ln =~ /^#\s+/ } if first_h1_prev emoji_re = Kettle::EmojiRegex::REGEX tail = first_h1_prev.sub(/^#\s+/, "") # Extract consecutive leading emoji graphemes out = +"" s = tail.dup loop do cluster = s[/\A\X/u] break if cluster.nil? || cluster.empty? if emoji_re =~ cluster out << cluster s = s[cluster.length..-1].to_s else break end end if !out.empty? out else # Fallback to first grapheme tail[/\A\X/u] end end end rescue StandardError => e Kettle::Dev.debug_error(e, __method__) # ignore, leave dest_preserve_prefix as nil end helpers.copy_file_with_prompt(src, dest, allow_create: true, allow_replace: true) do |content| # 1) Do token replacements on the template content (org/gem/namespace/shields) c = helpers.apply_common_replacements( content, org: forge_org, funding_org: funding_org, gem_name: gem_name, namespace: namespace, namespace_shield: namespace_shield, gem_shield: gem_shield, min_ruby: min_ruby, ) # 2) Merge specific sections from destination README, if present begin dest_existing = prev_readme # Parse Markdown headings while ignoring fenced code blocks (``` ... ```) build_sections = lambda do |md| return {lines: [], sections: [], line_count: 0} unless md lines = md.split("\n", -1) line_count = lines.length sections = [] in_code = false fence_re = /^\s*```/ # start or end of fenced block lines.each_with_index do |ln, i| if ln =~ fence_re in_code = !in_code next end next if in_code if (m = ln.match(/^(#+)\s+.+/)) level = m[1].length title = ln.sub(/^#+\s+/, "") base = title.sub(/\A[^\p{Alnum}]+/u, "").strip.downcase sections << {start: i, level: level, heading: ln, base: base} end end # Compute stop indices based on next heading of same or higher level sections.each_with_index do |sec, i| j = i + 1 stop = line_count - 1 while j < sections.length if sections[j][:level] <= sec[:level] stop = sections[j][:start] - 1 break end j += 1 end sec[:stop_to_next_any] = stop body_lines_any = lines[(sec[:start] + 1)..stop] || [] sec[:body_to_next_any] = body_lines_any.join("\n") end {lines: lines, sections: sections, line_count: line_count} end # Helper: Compute the branch end (inclusive) for a section at index i branch_end_index = lambda do |sections_arr, i, total_lines| current = sections_arr[i] j = i + 1 while j < sections_arr.length return sections_arr[j][:start] - 1 if sections_arr[j][:level] <= current[:level] j += 1 end total_lines - 1 end src_parsed = build_sections.call(c) dest_parsed = build_sections.call(dest_existing) # Build lookup for destination sections by base title, using full branch body (to next heading of same or higher level) dest_lookup = {} if dest_parsed && dest_parsed[:sections] dest_parsed[:sections].each_with_index do |s, idx| base = s[:base] # Only set once (first occurrence wins) next if dest_lookup.key?(base) be = branch_end_index.call(dest_parsed[:sections], idx, dest_parsed[:line_count]) body_lines = dest_parsed[:lines][(s[:start] + 1)..be] || [] dest_lookup[base] = {body_branch: body_lines.join("\n"), level: s[:level]} end end # Build targets to merge: existing curated list plus any NOTE sections at any level note_bases = [] if src_parsed && src_parsed[:sections] note_bases = src_parsed[:sections] .select { |s| s[:heading] =~ /^#+\s+note:.*/i } .map { |s| s[:base] } end targets = ["synopsis", "configuration", "basic usage"] + note_bases # Replace matching sections in src using full branch ranges if src_parsed && src_parsed[:sections] && !src_parsed[:sections].empty? lines = src_parsed[:lines].dup # Iterate in reverse to keep indices valid src_parsed[:sections].reverse_each.with_index do |sec, rev_i| next unless targets.include?(sec[:base]) # Determine branch range in src for this section # rev_i is reverse index; compute forward index i = src_parsed[:sections].length - 1 - rev_i src_end = branch_end_index.call(src_parsed[:sections], i, src_parsed[:line_count]) dest_entry = dest_lookup[sec[:base]] new_body = dest_entry ? dest_entry[:body_branch] : "\n\n" new_block = [sec[:heading], new_body].join("\n") range_start = sec[:start] range_end = src_end # Remove old range lines.slice!(range_start..range_end) # Insert new block (split preserves potential empty tail) insert_lines = new_block.split("\n", -1) lines.insert(range_start, *insert_lines) end c = lines.join("\n") end # 3) Preserve entire H1 line from destination README, if any begin if dest_existing dest_h1 = dest_existing.lines.find { |ln| ln =~ /^#\s+/ } if dest_h1 lines_new = c.split("\n", -1) src_h1_idx = lines_new.index { |ln| ln =~ /^#\s+/ } if src_h1_idx # Replace the entire H1 line with the destination's H1 exactly lines_new[src_h1_idx] = dest_h1.chomp c = lines_new.join("\n") end end end rescue StandardError => e Kettle::Dev.debug_error(e, __method__) # ignore H1 preservation errors end rescue StandardError => e Kettle::Dev.debug_error(e, __method__) # Best effort; if anything fails, keep c as-is end c end elsif ["CHANGELOG.md", "CITATION.cff", "CONTRIBUTING.md", ".opencollective.yml", "FUNDING.md", ".junie/guidelines.md"].include?(rel) helpers.copy_file_with_prompt(src, dest, allow_create: true, allow_replace: true) do |content| c = helpers.apply_common_replacements( content, org: forge_org, funding_org: funding_org, gem_name: gem_name, namespace: namespace, namespace_shield: namespace_shield, gem_shield: gem_shield, min_ruby: min_ruby, ) if File.basename(rel) == "CHANGELOG.md" begin # Special handling for CHANGELOG.md # 1) Take template header through Unreleased section (inclusive) src_lines = c.split("\n", -1) tpl_unrel_idx = src_lines.index { |ln| ln =~ /^##\s*\[\s*Unreleased\s*\]/i } if tpl_unrel_idx # Find end of Unreleased in template (next ## or # heading) tpl_end_idx = src_lines.length - 1 j = tpl_unrel_idx + 1 while j < src_lines.length if src_lines[j] =~ /^##\s+\[/ || src_lines[j] =~ /^#\s+/ || src_lines[j] =~ /^##\s+[^\[]/ tpl_end_idx = j - 1 break end j += 1 end tpl_header_pre = src_lines[0...tpl_unrel_idx] # lines before Unreleased heading tpl_unrel_heading = src_lines[tpl_unrel_idx] src_lines[(tpl_unrel_idx + 1)..tpl_end_idx] || [] # 2) Extract destination Unreleased content, preserving list items under any standard headings dest_content = File.file?(dest) ? File.read(dest) : "" dest_lines = dest_content.split("\n", -1) dest_unrel_idx = dest_lines.index { |ln| ln =~ /^##\s*\[\s*Unreleased\s*\]/i } dest_end_idx = if dest_unrel_idx k = dest_unrel_idx + 1 e = dest_lines.length - 1 while k < dest_lines.length if dest_lines[k] =~ /^##\s+\[/ || dest_lines[k] =~ /^#\s+/ || dest_lines[k] =~ /^##\s+[^\[]/ e = k - 1 break end k += 1 end e end dest_unrel_body = dest_unrel_idx ? (dest_lines[(dest_unrel_idx + 1)..dest_end_idx] || []) : [] # Helper: parse body into map of heading=>items (only '- ' markdown items) std_heads = [ "### Added", "### Changed", "### Deprecated", "### Removed", "### Fixed", "### Security", ] parse_items = lambda do |body_lines| result = {} cur = nil i = 0 while i < body_lines.length ln = body_lines[i] if ln.start_with?("### ") cur = ln.strip result[cur] ||= [] i += 1 next end # Detect a list item bullet (allow optional indentation) if (m = ln.match(/^(\s*)[-*]\s/)) result[cur] ||= [] base_indent = m[1].length # Start a new item: include the bullet line result[cur] << ln.rstrip i += 1 # Include subsequent lines that belong to this list item: # - blank lines # - lines with indentation greater than the bullet's indentation # - any lines inside fenced code blocks (```), regardless of indentation until fence closes in_fence = false fence_re = /^\s*```/ while i < body_lines.length l2 = body_lines[i] # Stop if next sibling/top-level bullet of same or smaller indent and not inside a fence if !in_fence && l2 =~ /^(\s*)[-*]\s/ ind = Regexp.last_match(1).length break if ind <= base_indent end # Break if a new section heading appears and we're not in a fence break if !in_fence && l2.start_with?("### ") if l2 =~ fence_re in_fence = !in_fence result[cur] << l2.rstrip i += 1 next end # Include blanks and lines indented more than base indent, or anything while in fence if in_fence || l2.strip.empty? || (l2[/^\s*/].length > base_indent) result[cur] << l2.rstrip i += 1 next end # Otherwise, this line does not belong to the current list item break end next end # Non-bullet, non-heading line: just advance i += 1 end result end dest_items = parse_items.call(dest_unrel_body) # 3) Build a single canonical Unreleased section: heading + the six standard subheads in order new_unrel_block = [] new_unrel_block << tpl_unrel_heading std_heads.each do |h| new_unrel_block << h if dest_items[h] && !dest_items[h].empty? new_unrel_block.concat(dest_items[h]) end end # 4) Compose final content: template preface + new unreleased + rest of destination (after its unreleased) tail_after_unrel = [] if dest_unrel_idx tail_after_unrel = dest_lines[(dest_end_idx + 1)..-1] || [] end # Ensure exactly one blank line between the Unreleased chunk and the next version chunk # - Strip trailing blanks from the newly built Unreleased block while new_unrel_block.any? && new_unrel_block.last.to_s.strip == "" new_unrel_block.pop end # - Strip leading blanks from the tail while tail_after_unrel.any? && tail_after_unrel.first.to_s.strip == "" tail_after_unrel.shift end merged_lines = tpl_header_pre + new_unrel_block # Insert a single separator blank line if there is any tail content merged_lines << "" if tail_after_unrel.any? merged_lines.concat(tail_after_unrel) c = merged_lines.join("\n") end # Collapse repeated whitespace in release headers only lines = c.split("\n", -1) lines.map! do |ln| if ln =~ /^##\s+\[.*\]/ ln.gsub(/[ \t]+/, " ") else ln end end c = lines.join("\n") rescue StandardError => e Kettle::Dev.debug_error(e, __method__) # Fallback: whitespace normalization lines = c.split("\n", -1) lines.map! { |ln| (ln =~ /^##\s+\[.*\]/) ? ln.gsub(/[ \t]+/, " ") : ln } c = lines.join("\n") end end # Normalize spacing around Markdown headings for broad renderer compatibility c = normalize_heading_spacing(c) c end else helpers.copy_file_with_prompt(src, dest, allow_create: true, allow_replace: true) end end # Post-process README H1 preservation using snapshot (replace entire H1 line) begin if existing_readme_before readme_path = File.join(project_root, "README.md") if File.file?(readme_path) prev = existing_readme_before newc = File.read(readme_path) prev_h1 = prev.lines.find { |ln| ln =~ /^#\s+/ } lines = newc.split("\n", -1) cur_h1_idx = lines.index { |ln| ln =~ /^#\s+/ } if prev_h1 && cur_h1_idx # Replace the entire H1 line with the previous README's H1 exactly lines[cur_h1_idx] = prev_h1.chomp File.open(readme_path, "w") { |f| f.write(lines.join("\n")) } end end end rescue StandardError => e Kettle::Dev.debug_error(e, __method__) # ignore post-processing errors end # 7b) certs/pboling.pem begin cert_src = File.join(gem_checkout_root, "certs", "pboling.pem") cert_dest = File.join(project_root, "certs", "pboling.pem") if File.exist?(cert_src) helpers.copy_file_with_prompt(cert_src, cert_dest, allow_create: true, allow_replace: true) end rescue StandardError => e puts "WARNING: Skipped copying certs/pboling.pem due to #{e.class}: #{e.}" end # After creating or replacing .envrc or .env.local.example, require review and exit unless allowed begin envrc_path = File.join(project_root, ".envrc") envlocal_example_path = File.join(project_root, ".env.local.example") changed_env_files = [] changed_env_files << envrc_path if helpers.modified_by_template?(envrc_path) changed_env_files << envlocal_example_path if helpers.modified_by_template?(envlocal_example_path) if !changed_env_files.empty? if ENV.fetch("allowed", "").to_s =~ /\A(1|true|y|yes)\z/i puts "Detected updates to #{changed_env_files.map { |p| File.basename(p) }.join(" and ")}. Proceeding because allowed=true." else puts puts "IMPORTANT: The following environment-related files were created/updated:" changed_env_files.each { |p| puts " - #{p}" } puts puts "Please review these files. If .envrc changed, run:" puts " direnv allow" puts puts "After that, re-run to resume:" puts " bundle exec rake kettle:dev:template allowed=true" puts " # or to run the full install afterwards:" puts " bundle exec rake kettle:dev:install allowed=true" task_abort("Aborting: review of environment files required before continuing.") end end rescue StandardError => e # Do not swallow intentional task aborts raise if e.is_a?(Kettle::Dev::Error) puts "WARNING: Could not determine env file changes: #{e.class}: #{e.}" end # Handle .git-hooks files (see original rake task for details) source_hooks_dir = File.join(gem_checkout_root, ".git-hooks") if Dir.exist?(source_hooks_dir) # Honor ENV["only"]: skip entire .git-hooks handling unless patterns include .git-hooks begin only_raw = ENV["only"].to_s if !only_raw.empty? patterns = only_raw.split(",").map { |s| s.strip }.reject(&:empty?) if !patterns.empty? proj = helpers.project_root.to_s target_dir = File.join(proj, ".git-hooks") # Determine if any pattern would match either the directory itself (with /** semantics) or files within it matches = patterns.any? do |pat| if pat.end_with?("/**") base = pat[0..-4] base == ".git-hooks" || base == target_dir.sub(/^#{Regexp.escape(proj)}\/?/, "") else # Check for explicit .git-hooks or subpaths File.fnmatch?(pat, ".git-hooks", File::FNM_PATHNAME | File::FNM_EXTGLOB | File::FNM_DOTMATCH) || File.fnmatch?(pat, ".git-hooks/*", File::FNM_PATHNAME | File::FNM_EXTGLOB | File::FNM_DOTMATCH) end end unless matches # No interest in .git-hooks => skip prompts and copies for hooks entirely # Note: we intentionally do not record template_results for hooks return end end end rescue StandardError => e Kettle::Dev.debug_error(e, __method__) # If filter parsing fails, proceed as before end # Prefer .example variant when present for .git-hooks goalie_src = helpers.prefer_example(File.join(source_hooks_dir, "commit-subjects-goalie.txt")) = helpers.prefer_example(File.join(source_hooks_dir, "footer-template.erb.txt")) hook_ruby_src = helpers.prefer_example(File.join(source_hooks_dir, "commit-msg")) hook_sh_src = helpers.prefer_example(File.join(source_hooks_dir, "prepare-commit-msg")) # First: templates (.txt) — ask local/global/skip if File.file?(goalie_src) && File.file?() puts puts "Git hooks templates found:" puts " - #{goalie_src}" puts " - #{}" puts puts "About these files:" puts "- commit-subjects-goalie.txt:" puts " Lists commit subject prefixes to look for; if a commit subject starts with any listed prefix," puts " kettle-commit-msg will append a footer to the commit message (when GIT_HOOK_FOOTER_APPEND=true)." puts " Defaults include release prep (🔖 Prepare release v) and checksum commits (🔒️ Checksums for v)." puts "- footer-template.erb.txt:" puts " ERB template rendered to produce the footer. You can customize its contents and variables." puts puts "Where would you like to install these two templates?" puts " [l] Local to this project (#{File.join(project_root, ".git-hooks")})" puts " [g] Global for this user (#{File.join(ENV["HOME"], ".git-hooks")})" puts " [s] Skip copying" # Allow non-interactive selection via environment # Precedence: CLI switch (hook_templates) > KETTLE_DEV_HOOK_TEMPLATES > prompt env_choice = ENV["hook_templates"] env_choice = ENV["KETTLE_DEV_HOOK_TEMPLATES"] if env_choice.nil? || env_choice.strip.empty? choice = env_choice&.strip unless choice && !choice.empty? print("Choose (l/g/s) [l]: ") choice = Kettle::Dev::InputAdapter.gets&.strip end choice = "l" if choice.nil? || choice.empty? dest_dir = case choice.downcase when "g", "global" then File.join(ENV["HOME"], ".git-hooks") when "s", "skip" then nil else File.join(project_root, ".git-hooks") end if dest_dir FileUtils.mkdir_p(dest_dir) [[goalie_src, "commit-subjects-goalie.txt"], [, "footer-template.erb.txt"]].each do |src, base| dest = File.join(dest_dir, base) # Allow create/replace prompts for these files (question applies to them) helpers.copy_file_with_prompt(src, dest, allow_create: true, allow_replace: true) # Ensure readable (0644). These are data/templates, not executables. begin File.chmod(0o644, dest) if File.exist?(dest) rescue StandardError => e Kettle::Dev.debug_error(e, __method__) # ignore permission issues end end else puts "Skipping copy of .git-hooks templates." end end # Second: hook scripts — copy only to local project; prompt only on overwrite hook_dests = [File.join(project_root, ".git-hooks")] hook_pairs = [[hook_ruby_src, "commit-msg", 0o755], [hook_sh_src, "prepare-commit-msg", 0o755]] hook_pairs.each do |src, base, mode| next unless File.file?(src) hook_dests.each do |dstdir| begin FileUtils.mkdir_p(dstdir) dest = File.join(dstdir, base) # Create without prompt if missing; if exists, ask to replace if File.exist?(dest) if helpers.ask("Overwrite existing #{dest}?", true) content = File.read(src) helpers.write_file(dest, content) begin File.chmod(mode, dest) rescue StandardError => e Kettle::Dev.debug_error(e, __method__) # ignore permission issues end puts "Replaced #{dest}" else puts "Kept existing #{dest}" end else content = File.read(src) helpers.write_file(dest, content) begin File.chmod(mode, dest) rescue StandardError => e Kettle::Dev.debug_error(e, __method__) # ignore permission issues end puts "Installed #{dest}" end rescue StandardError => e puts "WARNING: Could not install hook #{base} to #{dstdir}: #{e.class}: #{e.}" end end end end # Done nil end |