ast-merge 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. checksums.yaml +7 -0
  2. checksums.yaml.gz.sig +0 -0
  3. data/CHANGELOG.md +46 -0
  4. data/CITATION.cff +20 -0
  5. data/CODE_OF_CONDUCT.md +134 -0
  6. data/CONTRIBUTING.md +227 -0
  7. data/FUNDING.md +74 -0
  8. data/LICENSE.txt +21 -0
  9. data/README.md +852 -0
  10. data/REEK +0 -0
  11. data/RUBOCOP.md +71 -0
  12. data/SECURITY.md +21 -0
  13. data/lib/ast/merge/ast_node.rb +87 -0
  14. data/lib/ast/merge/comment/block.rb +195 -0
  15. data/lib/ast/merge/comment/empty.rb +78 -0
  16. data/lib/ast/merge/comment/line.rb +138 -0
  17. data/lib/ast/merge/comment/parser.rb +278 -0
  18. data/lib/ast/merge/comment/style.rb +282 -0
  19. data/lib/ast/merge/comment.rb +36 -0
  20. data/lib/ast/merge/conflict_resolver_base.rb +399 -0
  21. data/lib/ast/merge/debug_logger.rb +271 -0
  22. data/lib/ast/merge/fenced_code_block_detector.rb +211 -0
  23. data/lib/ast/merge/file_analyzable.rb +307 -0
  24. data/lib/ast/merge/freezable.rb +82 -0
  25. data/lib/ast/merge/freeze_node_base.rb +434 -0
  26. data/lib/ast/merge/match_refiner_base.rb +312 -0
  27. data/lib/ast/merge/match_score_base.rb +135 -0
  28. data/lib/ast/merge/merge_result_base.rb +169 -0
  29. data/lib/ast/merge/merger_config.rb +258 -0
  30. data/lib/ast/merge/node_typing.rb +373 -0
  31. data/lib/ast/merge/region.rb +124 -0
  32. data/lib/ast/merge/region_detector_base.rb +114 -0
  33. data/lib/ast/merge/region_mergeable.rb +364 -0
  34. data/lib/ast/merge/rspec/shared_examples/conflict_resolver_base.rb +416 -0
  35. data/lib/ast/merge/rspec/shared_examples/debug_logger.rb +174 -0
  36. data/lib/ast/merge/rspec/shared_examples/file_analyzable.rb +193 -0
  37. data/lib/ast/merge/rspec/shared_examples/freeze_node_base.rb +219 -0
  38. data/lib/ast/merge/rspec/shared_examples/merge_result_base.rb +106 -0
  39. data/lib/ast/merge/rspec/shared_examples/merger_config.rb +202 -0
  40. data/lib/ast/merge/rspec/shared_examples/reproducible_merge.rb +115 -0
  41. data/lib/ast/merge/rspec/shared_examples.rb +26 -0
  42. data/lib/ast/merge/rspec.rb +4 -0
  43. data/lib/ast/merge/section_typing.rb +303 -0
  44. data/lib/ast/merge/smart_merger_base.rb +417 -0
  45. data/lib/ast/merge/text/conflict_resolver.rb +161 -0
  46. data/lib/ast/merge/text/file_analysis.rb +168 -0
  47. data/lib/ast/merge/text/line_node.rb +142 -0
  48. data/lib/ast/merge/text/merge_result.rb +42 -0
  49. data/lib/ast/merge/text/section.rb +93 -0
  50. data/lib/ast/merge/text/section_splitter.rb +397 -0
  51. data/lib/ast/merge/text/smart_merger.rb +141 -0
  52. data/lib/ast/merge/text/word_node.rb +86 -0
  53. data/lib/ast/merge/text.rb +35 -0
  54. data/lib/ast/merge/toml_frontmatter_detector.rb +88 -0
  55. data/lib/ast/merge/version.rb +12 -0
  56. data/lib/ast/merge/yaml_frontmatter_detector.rb +108 -0
  57. data/lib/ast/merge.rb +165 -0
  58. data/lib/ast-merge.rb +4 -0
  59. data/sig/ast/merge.rbs +195 -0
  60. data.tar.gz.sig +0 -0
  61. metadata +326 -0
  62. metadata.gz.sig +0 -0
data/README.md ADDED
@@ -0,0 +1,852 @@
1
+ | 📍 NOTE |
2
+ |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
3
+ | RubyGems (the [GitHub org][rubygems-org], not the website) [suffered][draper-security] a [hostile takeover][ellen-takeover] in September 2025. |
4
+ | Ultimately [4 maintainers][simi-removed] were [hard removed][martin-removed] and a reason has been given for only 1 of those, while 2 others resigned in protest. |
5
+ | It is a [complicated story][draper-takeover] which is difficult to [parse quickly][draper-lies]. |
6
+ | Simply put - there was active policy for adding or removing maintainers/owners of [rubygems][rubygems-maint-policy] and [bundler][bundler-maint-policy], and those [policies were not followed][policy-fail]. |
7
+ | I'm adding notes like this to gems because I [don't condone theft][draper-theft] of repositories or gems from their rightful owners. |
8
+ | If a similar theft happened with my repos/gems, I'd hope some would stand up for me. |
9
+ | Disenfranchised former-maintainers have started [gem.coop][gem-coop]. |
10
+ | Once available I will publish there exclusively; unless RubyCentral makes amends with the community. |
11
+ | The ["Technology for Humans: Joel Draper"][reinteractive-podcast] podcast episode by [reinteractive][reinteractive] is the most cogent summary I'm aware of. |
12
+ | See [here][gem-naming], [here][gem-coop] and [here][martin-ann] for more info on what comes next. |
13
+ | What I'm doing: A (WIP) proposal for [bundler/gem scopes][gem-scopes], and a (WIP) proposal for a federated [gem server][gem-server]. |
14
+
15
+ [rubygems-org]: https://github.com/rubygems/
16
+ [draper-security]: https://joel.drapper.me/p/ruby-central-security-measures/
17
+ [draper-takeover]: https://joel.drapper.me/p/ruby-central-takeover/
18
+ [ellen-takeover]: https://pup-e.com/blog/goodbye-rubygems/
19
+ [simi-removed]: https://www.reddit.com/r/ruby/s/gOk42POCaV
20
+ [martin-removed]: https://bsky.app/profile/martinemde.com/post/3m3occezxxs2q
21
+ [draper-lies]: https://joel.drapper.me/p/ruby-central-fact-check/
22
+ [draper-theft]: https://joel.drapper.me/p/ruby-central/
23
+ [reinteractive]: https://reinteractive.com/ruby-on-rails
24
+ [gem-coop]: https://gem.coop
25
+ [gem-naming]: https://github.com/gem-coop/gem.coop/issues/12
26
+ [martin-ann]: https://martinemde.com/2025/10/05/announcing-gem-coop.html
27
+ [gem-scopes]: https://github.com/galtzo-floss/bundle-namespace
28
+ [gem-server]: https://github.com/galtzo-floss/gem-server
29
+ [reinteractive-podcast]: https://youtu.be/_H4qbtC5qzU?si=BvuBU90R2wAqD2E6
30
+ [bundler-maint-policy]: https://github.com/ruby/rubygems/blob/b1ab33a3d52310a84d16b193991af07f5a6a07c0/doc/bundler/playbooks/TEAM_CHANGES.md
31
+ [rubygems-maint-policy]: https://github.com/ruby/rubygems/blob/b1ab33a3d52310a84d16b193991af07f5a6a07c0/doc/rubygems/POLICIES.md?plain=1#L187-L196
32
+ [policy-fail]: https://www.reddit.com/r/ruby/comments/1ove9vp/rubycentral_hates_this_one_fact/
33
+
34
+ [![Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0][🖼️galtzo-i]][🖼️galtzo-discord] [![ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5][🖼️ruby-lang-i]][🖼️ruby-lang] [![kettle-rb Logo by Aboling0, CC BY-SA 4.0][🖼️kettle-rb-i]][🖼️kettle-rb]
35
+
36
+ [🖼️galtzo-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-192px.svg
37
+ [🖼️galtzo-discord]: https://discord.gg/3qme4XHNKN
38
+ [🖼️ruby-lang-i]: https://logos.galtzo.com/assets/images/ruby-lang/avatar-192px.svg
39
+ [🖼️ruby-lang]: https://www.ruby-lang.org/
40
+ [🖼️kettle-rb-i]: https://logos.galtzo.com/assets/images/kettle-rb/avatar-192px.svg
41
+ [🖼️kettle-rb]: https://github.com/kettle-rb
42
+
43
+ # ☯️ Ast::Merge
44
+
45
+ [![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license-ref] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![Open Source Helpers][👽oss-helpi]][👽oss-help] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Supported][🚎6-s-wfi]][🚎6-s-wf] [![CI Legacy][🚎4-lg-wfi]][🚎4-lg-wf] [![CI Unsupported][🚎7-us-wfi]][🚎7-us-wf] [![CI Ancient][🚎1-an-wfi]][🚎1-an-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
46
+
47
+ `if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][🖼️galtzo-discord], as I may have missed the [discord notification][🖼️galtzo-discord].
48
+
49
+ ---
50
+
51
+ `if ci_badges.map(&:color).all? { it == "green"}` 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.
52
+
53
+ [![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate at ko-fi.com][🖇kofi-img]][🖇kofi]
54
+
55
+ ## 🌻 Synopsis
56
+
57
+ Ast::Merge is **not typically used directly** - instead, use one of the format-specific gems built on top of it.
58
+
59
+ ### The `*-merge` Gem Family
60
+
61
+ | Gem | Format | Parser | Description |
62
+ |-----|--------|--------|-------------|
63
+ | [ast-merge][ast-merge] | Text | internal | Shared infrastructure for all `*-merge` gems |
64
+ | [prism-merge][prism-merge] | Ruby | [Prism][prism] | Smart merge for Ruby source files |
65
+ | [psych-merge][psych-merge] | YAML | [Psych][psych] | Smart merge for YAML files |
66
+ | [json-merge][json-merge] | JSON | [tree-sitter-json][ts-json] | Smart merge for JSON files |
67
+ | [jsonc-merge][jsonc-merge] | JSONC | [tree-sitter-jsonc][ts-jsonc] | ⚠️ Proof of concept; Smart merge for JSON with Comments |
68
+ | [bash-merge][bash-merge] | Bash | [tree-sitter-bash][ts-bash] | Smart merge for Bash scripts |
69
+ | [rbs-merge][rbs-merge] | RBS | [RBS][rbs] | Smart merge for Ruby type signatures |
70
+ | [dotenv-merge][dotenv-merge] | Dotenv | internal ([dotenv][dotenv]) | Smart merge for `.env` files |
71
+ | [toml-merge][toml-merge] | TOML | [tree-sitter-toml][ts-toml] | Smart merge for TOML files |
72
+ | [markdown-merge][markdown-merge] | Markdown | _base classes_ | Shared foundation for Markdown mergers |
73
+ | [markly-merge][markly-merge] | Markdown | [Markly][markly] | Smart merge for Markdown (CommonMark via libcmark-gfm) |
74
+ | [commonmarker-merge][commonmarker-merge] | Markdown | [Commonmarker][commonmarker] | Smart merge for Markdown (CommonMark via comrak) |
75
+
76
+ **Example implementations** for the gem templating use case:
77
+
78
+ | Gem | Purpose | Description |
79
+ |-----|---------|-------------|
80
+ | [kettle-dev][kettle-dev] | Gem Development | Gem templating tool using `*-merge` gems |
81
+ | [kettle-jem][kettle-jem] | Gem Templating | Gem template library with smart merge support |
82
+
83
+ [ast-merge]: https://github.com/kettle-rb/ast-merge
84
+ [prism-merge]: https://github.com/kettle-rb/prism-merge
85
+ [psych-merge]: https://github.com/kettle-rb/psych-merge
86
+ [json-merge]: https://github.com/kettle-rb/json-merge
87
+ [jsonc-merge]: https://github.com/kettle-rb/jsonc-merge
88
+ [bash-merge]: https://github.com/kettle-rb/bash-merge
89
+ [rbs-merge]: https://github.com/kettle-rb/rbs-merge
90
+ [dotenv-merge]: https://github.com/kettle-rb/dotenv-merge
91
+ [toml-merge]: https://github.com/kettle-rb/toml-merge
92
+ [markdown-merge]: https://github.com/kettle-rb/markdown-merge
93
+ [markly-merge]: https://github.com/kettle-rb/markly-merge
94
+ [commonmarker-merge]: https://github.com/kettle-rb/commonmarker-merge
95
+ [kettle-dev]: https://github.com/kettle-rb/kettle-dev
96
+ [kettle-jem]: https://github.com/kettle-rb/kettle-jem
97
+ [prism]: https://github.com/ruby/prism
98
+ [psych]: https://github.com/ruby/psych
99
+ [ts-json]: https://github.com/tree-sitter/tree-sitter-json
100
+ [ts-jsonc]: https://gitlab.com/WhyNotHugo/tree-sitter-jsonc
101
+ [ts-bash]: https://github.com/tree-sitter/tree-sitter-bash
102
+ [ts-toml]: https://github.com/tree-sitter-grammars/tree-sitter-toml
103
+ [rbs]: https://github.com/ruby/rbs
104
+ [dotenv]: https://github.com/bkeepers/dotenv
105
+ [markly]: https://github.com/kivikakk/markly
106
+ [commonmarker]: https://github.com/gjtorikian/commonmarker
107
+
108
+ ### What Ast::Merge Provides
109
+
110
+ - **Base Classes**: `FreezeNode`, `MergeResult` base classes with unified constructors
111
+ - **Shared Modules**: `FileAnalysisBase`, `MergerConfig`, `DebugLogger`
112
+ - **Freeze Block Support**: Configurable marker patterns for multiple comment syntaxes
113
+ - **Error Classes**: `ParseError`, `TemplateParseError`, `DestinationParseError`
114
+ - **RSpec Shared Examples**: Test helpers for implementing new merge gems
115
+
116
+ ### Creating a New Merge Gem
117
+
118
+ ```ruby
119
+ require "ast/merge"
120
+
121
+ module MyFormat
122
+ module Merge
123
+ class FreezeNode < Ast::Merge::FreezeNode
124
+ # Override methods as needed for your format
125
+ end
126
+
127
+ class MergeResult < Ast::Merge::MergeResult
128
+ # Add format-specific output methods
129
+ def to_my_format
130
+ to_s
131
+ end
132
+ end
133
+
134
+ class FileAnalysis
135
+ include Ast::Merge::FileAnalysisBase
136
+
137
+ # Implement required methods:
138
+ # - compute_node_signature(node)
139
+ # - extract_freeze_blocks
140
+ end
141
+
142
+ class SmartMerger
143
+ include Ast::Merge::MergerConfig
144
+
145
+ # Implement merge logic
146
+ end
147
+ end
148
+ end
149
+ ```
150
+
151
+ ## 💡 Info you can shake a stick at
152
+
153
+ | Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
154
+ |-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
155
+ | Works with JRuby | [![JRuby 10.0 Compat][💎jruby-c-i]][🚎11-c-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf] |
156
+ | Works with Truffle Ruby | [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎9-t-wf] [![Truffle Ruby 24.1 Compat][💎truby-c-i]][🚎11-c-wf] |
157
+ | Works with MRI Ruby 3 | [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎6-s-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎6-s-wf] [![Ruby 3.4 Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf] |
158
+ | Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor] |
159
+ | Source | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on Github.com][📜src-gh-img]][📜src-gh] [![The best SHA: dQw4w9WgXcQ!][🧮kloc-img]][🧮kloc] |
160
+ | Documentation | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog] [![GitLab Wiki][📜gl-wiki-img]][📜gl-wiki] [![GitHub Wiki][📜gh-wiki-img]][📜gh-wiki] |
161
+ | Compliance | [![License: MIT][📄license-img]][📄license-ref] [![Compatible with Apache Software Projects: Verified by SkyWalking Eyes][📄license-compat-img]][📄license-compat] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
162
+ | Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] [![Compatibility appraised by: appraisal2][💎appraisal2-img]][💎appraisal2] |
163
+ | Maintainer 🎖️ | [![Follow Me on LinkedIn][💖🖇linkedin-img]][💖🖇linkedin] [![Follow Me on Ruby.Social][💖🐘ruby-mast-img]][💖🐘ruby-mast] [![Follow Me on Bluesky][💖🦋bluesky-img]][💖🦋bluesky] [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact] [![My technical writing][💖💁🏼‍♂️devto-img]][💖💁🏼‍♂️devto] |
164
+ | `...` 💖 | [![Find Me on WellFound:][💖✌️wellfound-img]][💖✌️wellfound] [![Find Me on CrunchBase][💖💲crunchbase-img]][💖💲crunchbase] [![My LinkTree][💖🌳linktree-img]][💖🌳linktree] [![More About Me][💖💁🏼‍♂️aboutme-img]][💖💁🏼‍♂️aboutme] [🧊][💖🧊berg] [🐙][💖🐙hub] [🛖][💖🛖hut] [🧪][💖🧪lab] |
165
+
166
+ ### Compatibility
167
+
168
+ Compatible with MRI Ruby 3.2.0+, and concordant releases of JRuby, and TruffleRuby.
169
+
170
+ | 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
171
+ |------------------------------------------------|--------------------------------------------------------|
172
+ | 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
173
+
174
+ ### Federated DVCS
175
+
176
+ <details markdown="1">
177
+ <summary>Find this repo on federated forges (Coming soon!)</summary>
178
+
179
+ | Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
180
+ |-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
181
+ | 🧪 [kettle-rb/ast-merge on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ |
182
+ | 🧊 [kettle-rb/ast-merge on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
183
+ | 🐙 [kettle-rb/ast-merge on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
184
+ | 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
185
+
186
+ </details>
187
+
188
+ [gh-discussions]: https://github.com/kettle-rb/ast-merge/discussions
189
+
190
+ ### Enterprise Support [![Tidelift](https://tidelift.com/badges/package/rubygems/ast-merge)](https://tidelift.com/subscription/pkg/rubygems-ast-merge?utm_source=rubygems-ast-merge&utm_medium=referral&utm_campaign=readme)
191
+
192
+ Available as part of the Tidelift Subscription.
193
+
194
+ <details markdown="1">
195
+ <summary>Need enterprise-level guarantees?</summary>
196
+
197
+ The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.
198
+
199
+ [![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
200
+
201
+ - 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies
202
+ - 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
203
+ - 💡Tidelift pays maintainers to maintain the software you depend on!<br/>📊`@`Pointy Haired Boss: An [enterprise support][🏙️entsup-tidelift] subscription is "[never gonna let you down][🧮kloc]", and *supports* open source maintainers
204
+
205
+ Alternatively:
206
+
207
+ - [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
208
+ - [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork]
209
+ - [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor]
210
+
211
+ </details>
212
+
213
+ ## ✨ Installation
214
+
215
+ Install the gem and add to the application's Gemfile by executing:
216
+
217
+ ```console
218
+ bundle add ast-merge
219
+ ```
220
+
221
+ If bundler is not being used to manage dependencies, install the gem by executing:
222
+
223
+ ```console
224
+ gem install ast-merge
225
+ ```
226
+
227
+ ### 🔒 Secure Installation
228
+
229
+ <details markdown="1">
230
+ <summary>For Medium or High Security Installations</summary>
231
+
232
+ This gem is cryptographically signed, and has verifiable [SHA-256 and SHA-512][💎SHA_checksums] checksums by
233
+ [stone_checksums][💎stone_checksums]. Be sure the gem you install hasn’t been tampered with
234
+ by following the instructions below.
235
+
236
+ Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:
237
+
238
+ ```console
239
+ gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)
240
+ ```
241
+
242
+ You only need to do that once. Then proceed to install with:
243
+
244
+ ```console
245
+ gem install ast-merge -P HighSecurity
246
+ ```
247
+
248
+ The `HighSecurity` trust profile will verify signed gems, and not allow the installation of unsigned dependencies.
249
+
250
+ If you want to up your security game full-time:
251
+
252
+ ```console
253
+ bundle config set --global trust-policy MediumSecurity
254
+ ```
255
+
256
+ `MediumSecurity` instead of `HighSecurity` is necessary if not all the gems you use are signed.
257
+
258
+ NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
259
+
260
+ </details>
261
+
262
+ ## ⚙️ Configuration
263
+
264
+ `ast-merge` provides base classes and shared interfaces for building format-specific merge tools.
265
+ Each implementation (like `prism-merge`, `psych-merge`, etc.) has its own SmartMerger with format-specific configuration.
266
+
267
+ ### Common Configuration Options
268
+
269
+ All SmartMerger implementations share these configuration options:
270
+
271
+ ```ruby
272
+ merger = SomeFormat::Merge::SmartMerger.new(
273
+ template,
274
+ destination,
275
+ # When conflicts occur, prefer template or destination values
276
+ preference: :template, # or :destination (default), or a Hash for per-node-type
277
+ # Add nodes that only exist in template
278
+ add_template_only_nodes: true, # default: false
279
+ # Custom node type handling
280
+ node_typing: {}, # optional, for per-node-type preference
281
+ )
282
+ ```
283
+
284
+ ### Signature Match Preference
285
+
286
+ Control which source wins when both files have the same structural element:
287
+
288
+ - **`:template`** - Template values replace destination values
289
+ - **`:destination`** (default) - Destination values are preserved
290
+ - **Hash** - Per-node-type preference (see Advanced Configuration)
291
+
292
+ ### Template-Only Nodes
293
+
294
+ Control whether to add nodes that only exist in the template:
295
+
296
+ - **`true`** - Add new nodes from template
297
+ - **`false`** (default) - Skip template-only nodes
298
+
299
+ ## 🔧 Basic Usage
300
+
301
+ ### Using Shared Examples in Tests
302
+
303
+ ```ruby
304
+ # spec/spec_helper.rb
305
+ require "ast/merge/rspec/shared_examples"
306
+
307
+ # spec/my_format/merge/freeze_node_spec.rb
308
+ RSpec.describe(MyFormat::Merge::FreezeNode) do
309
+ it_behaves_like "Ast::Merge::FreezeNode" do
310
+ let(:freeze_node_class) { described_class }
311
+ let(:default_pattern_type) { :hash_comment }
312
+ let(:build_freeze_node) do
313
+ lambda { |start_line:, end_line:, **opts|
314
+ # Build a freeze node for your format
315
+ }
316
+ end
317
+ end
318
+ end
319
+ ```
320
+
321
+ ### Available Shared Examples
322
+
323
+ - `"Ast::Merge::FreezeNode"` - Tests for FreezeNode implementations
324
+ - `"Ast::Merge::MergeResult"` - Tests for MergeResult implementations
325
+ - `"Ast::Merge::DebugLogger"` - Tests for DebugLogger implementations
326
+ - `"Ast::Merge::FileAnalysisBase"` - Tests for FileAnalysis implementations
327
+ - `"Ast::Merge::MergerConfig"` - Tests for SmartMerger implementations
328
+
329
+ ## 🎛️ Advanced Configuration
330
+
331
+ ### Freeze Blocks
332
+
333
+ **Freeze blocks** are special comment-delimited regions in your files that tell the merge tool
334
+ to preserve content exactly as-is, preventing any changes from the template.
335
+ This is useful for hand-edited customizations you never want overwritten.
336
+
337
+ A freeze block consists of:
338
+ - A **start marker** comment (e.g., `# mytoken:freeze`)
339
+ - The protected content
340
+ - An **end marker** comment (e.g., `# mytoken:unfreeze`)
341
+
342
+ ```ruby
343
+ # In a Ruby file with prism-merge:
344
+ class MyApp
345
+ # prism-merge:freeze
346
+ # Custom configuration that should never be overwritten
347
+ CUSTOM_SETTING = "my-value"
348
+ # prism-merge:unfreeze
349
+
350
+ VERSION = "1.0.0" # This can be updated by template
351
+ end
352
+ ```
353
+
354
+ The `FreezeNode` class represents these protected regions internally.
355
+ Each format-specific merge gem (like `prism-merge`, `psych-merge`, etc.) configures its own
356
+ freeze token (the `token` in `token:freeze`), which defaults to the gem name (e.g., `prism-merge`).
357
+
358
+ ### Supported Comment Patterns
359
+
360
+ Different file formats use different comment syntaxes. The merge tools detect freeze markers
361
+ using the appropriate pattern for each format:
362
+
363
+ | Pattern Type | Start Marker | End Marker | Languages |
364
+ |--------------|--------------|------------|-----------|
365
+ | `:hash_comment` | `# token:freeze` | `# token:unfreeze` | Ruby, Python, YAML, Bash, Shell |
366
+ | `:html_comment` | `<!-- token:freeze -->` | `<!-- token:unfreeze -->` | HTML, XML, Markdown |
367
+ | `:c_style_line` | `// token:freeze` | `// token:unfreeze` | C (C99+), C++, JavaScript, TypeScript, Java, C#, Go, Rust, Swift, Kotlin, PHP, JSONC |
368
+ | `:c_style_block` | `/* token:freeze */` | `/* token:unfreeze */` | C, C++, JavaScript, TypeScript, Java, C#, Go, Rust, Swift, Kotlin, PHP, CSS |
369
+
370
+ | 📍 NOTE |
371
+ |-----------------------------------------------------------------------------------------------------|
372
+ | CSS only supports block comments (`/* */`), not line comments. |
373
+ | JSON does not support comments; use JSONC for JSON with comments. |
374
+
375
+ ### Per-Node-Type Preference with `node_typing`
376
+
377
+ The `node_typing` option allows you to customize merge behavior on a per-node-type basis.
378
+ When combined with a Hash-based `preference`, you can specify different merge
379
+ preferences for different types of nodes (e.g., prefer template for linter configs but destination for everything else).
380
+
381
+ #### How It Works
382
+
383
+ 1. **Define a `node_typing`**: A Hash mapping node type symbols to callables that receive a node and return either:
384
+ - The original node (no special handling)
385
+ - A wrapped node with a `merge_type` attribute (via `Ast::Merge::NodeTyping::Wrapper`)
386
+
387
+ 2. **Use a Hash-based preference**: Instead of a simple `:destination` or `:template` Symbol, pass a Hash with:
388
+ - `:default` key for the fallback preference
389
+ - Custom keys matching the `merge_type` values from your `node_typing`
390
+
391
+ ```ruby
392
+ # Example: Prefer template for lint gem configs, destination for everything else
393
+ node_typing = {
394
+ call_node: ->(node) {
395
+ if node.name == :gem && node.arguments&.arguments&.first&.unescaped&.match?(/rubocop|standard|reek/)
396
+ Ast::Merge::NodeTyping::Wrapper.new(node, :lint_gem)
397
+ else
398
+ node
399
+ end
400
+ },
401
+ }
402
+
403
+ merger = Prism::Merge::SmartMerger.new(
404
+ template_content,
405
+ dest_content,
406
+ node_typing: node_typing,
407
+ preference: {
408
+ default: :destination,
409
+ lint_gem: :template,
410
+ },
411
+ )
412
+ ```
413
+
414
+ #### NodeTyping::Wrapper
415
+
416
+ The `Ast::Merge::NodeTyping::Wrapper` class wraps an AST node and adds a `merge_type` attribute.
417
+ It delegates all method calls to the wrapped node, so it can be used transparently in place of the original node.
418
+
419
+ ```ruby
420
+ # Wrap a node with a custom merge_type
421
+ wrapped = Ast::Merge::NodeTyping::Wrapper.new(original_node, :special_config)
422
+ wrapped.merge_type # => :special_config
423
+ wrapped.class # => Ast::Merge::NodeTyping::Wrapper
424
+ wrapped.location # => delegates to original_node.location
425
+ ```
426
+
427
+ #### NodeTyping Utility Methods
428
+
429
+ ```ruby
430
+ # Process a node through the node_typing configuration
431
+ processed = Ast::Merge::NodeTyping.process(node, node_typing_config)
432
+
433
+ # Check if a node has been wrapped with a merge_type
434
+ Ast::Merge::NodeTyping.typed_node?(node) # => true/false
435
+
436
+ # Get the merge_type from a wrapped node (or nil)
437
+ Ast::Merge::NodeTyping.merge_type_for(node) # => Symbol or nil
438
+
439
+ # Unwrap a node type wrapper to get the original
440
+ Ast::Merge::NodeTyping.unwrap(wrapped_node) # => original_node
441
+ ```
442
+
443
+ ### Hash-Based Preference (without node_typing)
444
+
445
+ Even without `node_typing`, you can use a Hash-based preference to set a default
446
+ and document your intention for future per-type customization:
447
+
448
+ ```ruby
449
+ # Simple Hash preference (functionally equivalent to preference: :destination)
450
+ merger = MyMerger.new(
451
+ template_content,
452
+ dest_content,
453
+ preference: {default: :destination},
454
+ )
455
+ ```
456
+
457
+ ### MergerConfig Factory Methods
458
+
459
+ The `MergerConfig` class provides factory methods that support all options:
460
+
461
+ ```ruby
462
+ # Create config preferring destination
463
+ config = Ast::Merge::MergerConfig.destination_wins(
464
+ freeze_token: "my-freeze",
465
+ signature_generator: my_generator,
466
+ node_typing: my_typing,
467
+ )
468
+
469
+ # Create config preferring template
470
+ config = Ast::Merge::MergerConfig.template_wins(
471
+ freeze_token: "my-freeze",
472
+ signature_generator: my_generator,
473
+ node_typing: my_typing,
474
+ )
475
+ ```
476
+
477
+ ## 🦷 FLOSS Funding
478
+
479
+ While kettle-rb tools are free software and will always be, the project would benefit immensely from some funding.
480
+ Raising a monthly budget of... "dollars" would make the project more sustainable.
481
+
482
+ We welcome both individual and corporate sponsors! We also offer a
483
+ wide array of funding channels to account for your preferences
484
+ (although currently [Open Collective][🖇osc] is our preferred funding platform).
485
+
486
+ **If you're working in a company that's making significant use of kettle-rb tools we'd
487
+ appreciate it if you suggest to your company to become a kettle-rb sponsor.**
488
+
489
+ You can support the development of kettle-rb tools via
490
+ [GitHub Sponsors][🖇sponsor],
491
+ [Liberapay][⛳liberapay],
492
+ [PayPal][🖇paypal],
493
+ [Open Collective][🖇osc]
494
+ and [Tidelift][🏙️entsup-tidelift].
495
+
496
+ | 📍 NOTE |
497
+ |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
498
+ | If doing a sponsorship in the form of donation is problematic for your company <br/> from an accounting standpoint, we'd recommend the use of Tidelift, <br/> where you can get a support-like subscription instead. |
499
+
500
+ ### Open Collective for Individuals
501
+
502
+ Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/kettle-rb#backer)]
503
+
504
+ NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
505
+
506
+ <!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
507
+ No backers yet. Be the first!
508
+ <!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
509
+
510
+ ### Open Collective for Organizations
511
+
512
+ Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/kettle-rb#sponsor)]
513
+
514
+ NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
515
+
516
+ <!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
517
+ No sponsors yet. Be the first!
518
+ <!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
519
+
520
+ [kettle-readme-backers]: https://github.com/kettle-rb/ast-merge/blob/main/exe/kettle-readme-backers
521
+
522
+ ### Another way to support open-source
523
+
524
+ I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).
525
+
526
+ If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in `bundle fund`.
527
+
528
+ I’m developing a new library, [floss_funding][🖇floss-funding-gem], designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
529
+
530
+ **[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
531
+
532
+ [![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS efforts using Patreon][🖇patreon-img]][🖇patreon]
533
+
534
+ ## 🔐 Security
535
+
536
+ See [SECURITY.md][🔐security].
537
+
538
+ ## 🤝 Contributing
539
+
540
+ If you need some ideas of where to help, you could work on adding more code coverage,
541
+ or if it is already 💯 (see [below](#code-coverage)) check [reek](REEK), [issues][🤝gh-issues], or [PRs][🤝gh-pulls],
542
+ or use the gem and think about how it could be better.
543
+
544
+ We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
545
+
546
+ See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
547
+
548
+ ### 🚀 Release Instructions
549
+
550
+ See [CONTRIBUTING.md][🤝contributing].
551
+
552
+ ### Code Coverage
553
+
554
+ [![Coverage Graph][🏀codecov-g]][🏀codecov]
555
+
556
+ [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
557
+
558
+ [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
559
+
560
+ ### 🪇 Code of Conduct
561
+
562
+ Everyone interacting with this project's codebases, issue trackers,
563
+ chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
564
+
565
+ ## 🌈 Contributors
566
+
567
+ [![Contributors][🖐contributors-img]][🖐contributors]
568
+
569
+ Made with [contributors-img][🖐contrib-rocks].
570
+
571
+ Also see GitLab Contributors: [https://gitlab.com/kettle-rb/ast-merge/-/graphs/main][🚎contributors-gl]
572
+
573
+ <details>
574
+ <summary>⭐️ Star History</summary>
575
+
576
+ <a href="https://star-history.com/#kettle-rb/ast-merge&Date">
577
+ <picture>
578
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=kettle-rb/ast-merge&type=Date&theme=dark" />
579
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=kettle-rb/ast-merge&type=Date" />
580
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=kettle-rb/ast-merge&type=Date" />
581
+ </picture>
582
+ </a>
583
+
584
+ </details>
585
+
586
+ ## 📌 Versioning
587
+
588
+ This Library adheres to [![Semantic Versioning 2.0.0][📌semver-img]][📌semver].
589
+ Violations of this scheme should be reported as bugs.
590
+ Specifically, if a minor or patch version is released that breaks backward compatibility,
591
+ a new version should be immediately released that restores compatibility.
592
+ Breaking changes to the public API will only be introduced with new major versions.
593
+
594
+ > dropping support for a platform is both obviously and objectively a breaking change <br/>
595
+ >—Jordan Harband ([@ljharb](https://github.com/ljharb), maintainer of SemVer) [in SemVer issue 716][📌semver-breaking]
596
+
597
+ I understand that policy doesn't work universally ("exceptions to every rule!"),
598
+ but it is the policy here.
599
+ As such, in many cases it is good to specify a dependency on this library using
600
+ the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
601
+
602
+ For example:
603
+
604
+ ```ruby
605
+ spec.add_dependency("ast-merge", "~> 1.0")
606
+ ```
607
+
608
+ <details markdown="1">
609
+ <summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
610
+
611
+ SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms
612
+ is a *breaking change* to an API, and for that reason the bike shedding is endless.
613
+
614
+ To get a better understanding of how SemVer is intended to work over a project's lifetime,
615
+ read this article from the creator of SemVer:
616
+
617
+ - ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
618
+
619
+ </details>
620
+
621
+ See [CHANGELOG.md][📌changelog] for a list of releases.
622
+
623
+ ## 📄 License
624
+
625
+ The gem is available as open source under the terms of
626
+ the [MIT License][📄license] [![License: MIT][📄license-img]][📄license-ref].
627
+ See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright-notice-explainer].
628
+
629
+ ### © Copyright
630
+
631
+ <ul>
632
+ <li>
633
+ Copyright (c) 2025 Peter H. Boling, of
634
+ <a href="https://discord.gg/3qme4XHNKN">
635
+ Galtzo.com
636
+ <picture>
637
+ <img src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px-blank.svg" alt="Galtzo.com Logo (Wordless) by Aboling0, CC BY-SA 4.0" width="24">
638
+ </picture>
639
+ </a>, and ast-merge contributors.
640
+ </li>
641
+ </ul>
642
+
643
+ ## 🤑 A request for help
644
+
645
+ Maintainers have teeth and need to pay their dentists.
646
+ After getting laid off in an RIF in March, and encountering difficulty finding a new one,
647
+ I began spending most of my time building open source tools.
648
+ I'm hoping to be able to pay for my kids' health insurance this month,
649
+ so if you value the work I am doing, I need your support.
650
+ Please consider sponsoring me or the project.
651
+
652
+ To join the community or get help 👇️ Join the Discord.
653
+
654
+ [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
655
+
656
+ To say "thanks!" ☝️ Join the Discord or 👇️ send money.
657
+
658
+ [![Sponsor kettle-rb/ast-merge on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal]
659
+
660
+ ### Please give the project a star ⭐ ♥.
661
+
662
+ Thanks for RTFM. ☺️
663
+
664
+ [⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
665
+ [⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
666
+ [⛳liberapay]: https://liberapay.com/pboling/donate
667
+ [🖇osc-all-img]: https://img.shields.io/opencollective/all/kettle-rb
668
+ [🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/kettle-rb
669
+ [🖇osc-backers-img]: https://img.shields.io/opencollective/backers/kettle-rb
670
+ [🖇osc-backers]: https://opencollective.com/kettle-rb#backer
671
+ [🖇osc-backers-i]: https://opencollective.com/kettle-rb/backers/badge.svg?style=flat
672
+ [🖇osc-sponsors]: https://opencollective.com/kettle-rb#sponsor
673
+ [🖇osc-sponsors-i]: https://opencollective.com/kettle-rb/sponsors/badge.svg?style=flat
674
+ [🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/kettle-rb?style=for-the-badge
675
+ [🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/kettle-rb?style=for-the-badge
676
+ [🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/kettle-rb?style=for-the-badge
677
+ [🖇osc]: https://opencollective.com/kettle-rb
678
+ [🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
679
+ [🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
680
+ [🖇sponsor]: https://github.com/sponsors/pboling
681
+ [🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
682
+ [🖇polar]: https://polar.sh/pboling
683
+ [🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
684
+ [🖇kofi]: https://ko-fi.com/O5O86SNP4
685
+ [🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
686
+ [🖇patreon]: https://patreon.com/galtzo
687
+ [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
688
+ [🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
689
+ [🖇buyme]: https://www.buymeacoffee.com/pboling
690
+ [🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
691
+ [🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
692
+ [🖇paypal]: https://www.paypal.com/paypalme/peterboling
693
+ [🖇floss-funding.dev]: https://floss-funding.dev
694
+ [🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
695
+ [✉️discord-invite]: https://discord.gg/3qme4XHNKN
696
+ [✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
697
+ [✉️ruby-friends-img]: https://img.shields.io/badge/daily.dev-%F0%9F%92%8E_Ruby_Friends-0A0A0A?style=for-the-badge&logo=dailydotdev&logoColor=white
698
+ [✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
699
+
700
+ [✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
701
+ [⛳️gem-namespace]: https://github.com/kettle-rb/ast-merge
702
+ [⛳️namespace-img]: https://img.shields.io/badge/namespace-Ast::Merge-3C2D2D.svg?style=square&logo=ruby&logoColor=white
703
+ [⛳️gem-name]: https://bestgems.org/gems/ast-merge
704
+ [⛳️name-img]: https://img.shields.io/badge/name-ast--merge-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
705
+ [⛳️tag-img]: https://img.shields.io/github/tag/kettle-rb/ast-merge.svg
706
+ [⛳️tag]: http://github.com/kettle-rb/ast-merge/releases
707
+ [🚂maint-blog]: http://www.railsbling.com/tags/ast-merge
708
+ [🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
709
+ [🚂maint-contact]: http://www.railsbling.com/contact
710
+ [🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
711
+ [💖🖇linkedin]: http://www.linkedin.com/in/peterboling
712
+ [💖🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-LinkedIn-0B66C2?style=flat&logo=newjapanprowrestling
713
+ [💖✌️wellfound]: https://wellfound.com/u/peter-boling
714
+ [💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
715
+ [💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
716
+ [💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
717
+ [💖🐘ruby-mast]: https://ruby.social/@galtzo
718
+ [💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@galtzo
719
+ [💖🦋bluesky]: https://bsky.app/profile/galtzo.com
720
+ [💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
721
+ [💖🌳linktree]: https://linktr.ee/galtzo
722
+ [💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
723
+ [💖💁🏼‍♂️devto]: https://dev.to/galtzo
724
+ [💖💁🏼‍♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
725
+ [💖💁🏼‍♂️aboutme]: https://about.me/peter.boling
726
+ [💖💁🏼‍♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
727
+ [💖🧊berg]: https://codeberg.org/pboling
728
+ [💖🐙hub]: https://github.org/pboling
729
+ [💖🛖hut]: https://sr.ht/~galtzo/
730
+ [💖🧪lab]: https://gitlab.com/pboling
731
+ [👨🏼‍🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
732
+ [👨🏼‍🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
733
+ [👨🏼‍🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
734
+ [👨🏼‍🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
735
+ [🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-ast-merge?utm_source=rubygems-ast-merge&utm_medium=referral&utm_campaign=readme
736
+ [🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
737
+ [🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
738
+ [💁🏼‍♂️peterboling]: http://www.peterboling.com
739
+ [🚂railsbling]: http://www.railsbling.com
740
+ [📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
741
+ [📜src-gl]: https://gitlab.com/kettle-rb/ast-merge/
742
+ [📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
743
+ [📜src-cb]: https://codeberg.org/kettle-rb/ast-merge
744
+ [📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
745
+ [📜src-gh]: https://github.com/kettle-rb/ast-merge
746
+ [📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
747
+ [📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
748
+ [📜gl-wiki]: https://gitlab.com/kettle-rb/ast-merge/-/wikis/home
749
+ [📜gh-wiki]: https://github.com/kettle-rb/ast-merge/wiki
750
+ [📜gl-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
751
+ [📜gh-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
752
+ [👽dl-rank]: https://bestgems.org/gems/ast-merge
753
+ [👽dl-ranki]: https://img.shields.io/gem/rd/ast-merge.svg
754
+ [👽oss-help]: https://www.codetriage.com/kettle-rb/ast-merge
755
+ [👽oss-helpi]: https://www.codetriage.com/kettle-rb/ast-merge/badges/users.svg
756
+ [👽version]: https://bestgems.org/gems/ast-merge
757
+ [👽versioni]: https://img.shields.io/gem/v/ast-merge.svg
758
+ [🏀qlty-mnt]: https://qlty.sh/gh/kettle-rb/projects/ast-merge
759
+ [🏀qlty-mnti]: https://qlty.sh/gh/kettle-rb/projects/ast-merge/maintainability.svg
760
+ [🏀qlty-cov]: https://qlty.sh/gh/kettle-rb/projects/ast-merge/metrics/code?sort=coverageRating
761
+ [🏀qlty-covi]: https://qlty.sh/gh/kettle-rb/projects/ast-merge/coverage.svg
762
+ [🏀codecov]: https://codecov.io/gh/kettle-rb/ast-merge
763
+ [🏀codecovi]: https://codecov.io/gh/kettle-rb/ast-merge/graph/badge.svg
764
+ [🏀coveralls]: https://coveralls.io/github/kettle-rb/ast-merge?branch=main
765
+ [🏀coveralls-img]: https://coveralls.io/repos/github/kettle-rb/ast-merge/badge.svg?branch=main
766
+ [🖐codeQL]: https://github.com/kettle-rb/ast-merge/security/code-scanning
767
+ [🖐codeQL-img]: https://github.com/kettle-rb/ast-merge/actions/workflows/codeql-analysis.yml/badge.svg
768
+ [🚎1-an-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/ancient.yml
769
+ [🚎1-an-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/ancient.yml/badge.svg
770
+ [🚎2-cov-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/coverage.yml
771
+ [🚎2-cov-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/coverage.yml/badge.svg
772
+ [🚎3-hd-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/heads.yml
773
+ [🚎3-hd-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/heads.yml/badge.svg
774
+ [🚎4-lg-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/legacy.yml
775
+ [🚎4-lg-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/legacy.yml/badge.svg
776
+ [🚎5-st-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/style.yml
777
+ [🚎5-st-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/style.yml/badge.svg
778
+ [🚎6-s-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/supported.yml
779
+ [🚎6-s-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/supported.yml/badge.svg
780
+ [🚎7-us-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/unsupported.yml
781
+ [🚎7-us-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/unsupported.yml/badge.svg
782
+ [🚎8-ho-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/hoary.yml
783
+ [🚎8-ho-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/hoary.yml/badge.svg
784
+ [🚎9-t-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/truffle.yml
785
+ [🚎9-t-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/truffle.yml/badge.svg
786
+ [🚎10-j-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/jruby.yml
787
+ [🚎10-j-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/jruby.yml/badge.svg
788
+ [🚎11-c-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/current.yml
789
+ [🚎11-c-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/current.yml/badge.svg
790
+ [🚎12-crh-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/dep-heads.yml
791
+ [🚎12-crh-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/dep-heads.yml/badge.svg
792
+ [🚎13-🔒️-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/locked_deps.yml
793
+ [🚎13-🔒️-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/locked_deps.yml/badge.svg
794
+ [🚎14-🔓️-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/unlocked_deps.yml
795
+ [🚎14-🔓️-wfi]: https://github.com/kettle-rb/ast-merge/actions/workflows/unlocked_deps.yml/badge.svg
796
+ [🚎15-🪪-wf]: https://github.com/kettle-rb/ast-merge/actions/workflows/license-eye.yml
797
+ [🚎15-🪪-wfi]: https://github.com/kettle-rb/prism-merge/actions/workflows/license-eye.yml/badge.svg
798
+ [💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
799
+ [💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
800
+ [💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
801
+ [💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
802
+ [💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
803
+ [💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
804
+ [💎truby-headi]: https://img.shields.io/badge/Truffle_Ruby-HEAD-34BCB1?style=for-the-badge&logo=ruby&logoColor=blue
805
+ [💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
806
+ [💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
807
+ [🤝gh-issues]: https://github.com/kettle-rb/ast-merge/issues
808
+ [🤝gh-pulls]: https://github.com/kettle-rb/ast-merge/pulls
809
+ [🤝gl-issues]: https://gitlab.com/kettle-rb/ast-merge/-/issues
810
+ [🤝gl-pulls]: https://gitlab.com/kettle-rb/ast-merge/-/merge_requests
811
+ [🤝cb-issues]: https://codeberg.org/kettle-rb/ast-merge/issues
812
+ [🤝cb-pulls]: https://codeberg.org/kettle-rb/ast-merge/pulls
813
+ [🤝cb-donate]: https://donate.codeberg.org/
814
+ [🤝contributing]: CONTRIBUTING.md
815
+ [🏀codecov-g]: https://codecov.io/gh/kettle-rb/ast-merge/graphs/tree.svg
816
+ [🖐contrib-rocks]: https://contrib.rocks
817
+ [🖐contributors]: https://github.com/kettle-rb/ast-merge/graphs/contributors
818
+ [🖐contributors-img]: https://contrib.rocks/image?repo=kettle-rb/ast-merge
819
+ [🚎contributors-gl]: https://gitlab.com/kettle-rb/ast-merge/-/graphs/main
820
+ [🪇conduct]: CODE_OF_CONDUCT.md
821
+ [🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
822
+ [📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
823
+ [📌semver]: https://semver.org/spec/v2.0.0.html
824
+ [📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
825
+ [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
826
+ [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
827
+ [📌changelog]: CHANGELOG.md
828
+ [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
829
+ [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
830
+ [📌gitmoji]: https://gitmoji.dev
831
+ [📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
832
+ [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
833
+ [🧮kloc-img]: https://img.shields.io/badge/KLOC-2.382-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
834
+ [🔐security]: SECURITY.md
835
+ [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
836
+ [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
837
+ [📄license]: LICENSE.txt
838
+ [📄license-ref]: https://opensource.org/licenses/MIT
839
+ [📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
840
+ [📄license-compat]: https://dev.to/galtzo/how-to-check-license-compatibility-41h0
841
+ [📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-%E2%9C%93-259D6C.svg?style=flat&logo=Apache
842
+ [📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
843
+ [📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
844
+ [🚎yard-current]: http://rubydoc.info/gems/ast-merge
845
+ [🚎yard-head]: https://ast-merge.galtzo.com
846
+ [💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
847
+ [💎SHA_checksums]: https://gitlab.com/kettle-rb/ast-merge/-/tree/main/checksums
848
+ [💎rlts]: https://github.com/rubocop-lts/rubocop-lts
849
+ [💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
850
+ [💎appraisal2]: https://github.com/appraisal-rb/appraisal2
851
+ [💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
852
+ [💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/